Go to the source code of this file.
Defines | |
#define | EXTERN extern |
#define | MAINDIALOGID -1 |
#define | BADDIALOGID -2 |
#define | BADGUIID BADDIALOGID |
#define | TECGUITECPLOTSIDEBAR -3 |
Typedefs | |
typedef LgIndex_t(* | TecGUITextCallback_pf )(const char *TextString) |
General GUI callback function with a char* parameter. More... | |
typedef void(* | TecGUIIntCallback_pf )(const LgIndex_t *Data) |
General GUI callback function with an LgIndex_t * parameter. More... | |
typedef void(* | TecGUIVoidCallback_pf )(void) |
General GUI callback function with no parameters. More... | |
Functions | |
void | TecGUIDialogEnableActionArea (LgIndex_t DialogID, Boolean_t EnableActionArea) |
Shows or hides the Close and Help buttons at the bottom of TGB modeless dialogs. More... | |
void | TecGUIDialogApplySetSensitivity (LgIndex_t DialogID, Boolean_t IsSensitive) |
Sets the sensitivity of the Apply button in a dialog. More... | |
void | TecGUIDialogSetTopmost (LgIndex_t DialogID, Boolean_t MakeTopmost) |
Sets a modal or modeless dialog to be the topmost window. More... | |
void | TecGUIDialogSetLaunchPosition (LgIndex_t DialogID, AnchorAlignment_e Placement, LgIndex_t OffsetX, LgIndex_t OffsetY) |
Sets the initial location of the dialog when it is launched. More... | |
void | TecGUIDialogSetLaunchPositionX (ArgList_pa ArgList) |
Set the launch position of an addon dialog. More... | |
LgIndex_t | TecGUIDialogCreateModeless (LgIndex_t ParentDialogID, LgIndex_t Width, LgIndex_t Height, const char *Title, TecGUIVoidCallback_pf InitCallback, TecGUIVoidCallback_pf CloseButtonCallback, TecGUIVoidCallback_pf HelpButtonCallback) |
Creates a modeless dialog and returns the ID of the dialog. More... | |
LgIndex_t | TecGUIDialogCreateModal (LgIndex_t ParentDialogID, LgIndex_t Width, LgIndex_t Height, const char *Title, TecGUIVoidCallback_pf InitCallback, TecGUIVoidCallback_pf OkButtonCallback, TecGUIVoidCallback_pf ApplyButtonCallback, TecGUIVoidCallback_pf CancelButtonCallback, TecGUIVoidCallback_pf HelpButtonCallback) |
Creates a modal dialog and returns the ID of the dialog. More... | |
void | TecGUIBlockForModalDialog (Boolean_t *DoneWithModalDialog) |
Call this function if your code is structured such that it must wait for a modal dialog to close. More... | |
LgIndex_t | TecGUIButtonAdd (LgIndex_t ParentDialogID, LgIndex_t X, LgIndex_t Y, LgIndex_t Width, LgIndex_t Height, const char *LabelString, TecGUIVoidCallback_pf ButtonCallback) |
Adds a button to a dialog. More... | |
LgIndex_t | TecGUIBitmapButtonAdd (LgIndex_t ParentDialogID, LgIndex_t X, LgIndex_t Y, LgIndex_t ButtonWidth, LgIndex_t ButtonHeight, LgIndex_t BitmapWidth, LgIndex_t BitmapHeight, const char *BitmapData_Array, Boolean_t UseTransparentColor, LgIndex_t TransparentR, LgIndex_t TransparentG, LgIndex_t TransparentB, TecGUIVoidCallback_pf ButtonCallback) |
Adds a bitmap button to a dialog. More... | |
LgIndex_t | TecGUIBitmapToggleAdd (LgIndex_t ParentDialogID, LgIndex_t X, LgIndex_t Y, LgIndex_t ButtonWidth, LgIndex_t ButtonHeight, LgIndex_t BitmapWidth, LgIndex_t BitmapHeight, const char *BitmapData_Array, Boolean_t UseTransparentColor, LgIndex_t TransparentR, LgIndex_t TransparentG, LgIndex_t TransparentB, TecGUIIntCallback_pf ValueChangedCallback) |
Adds a bitmap toggle button to a dialog. More... | |
void | TecGUISetToolTip (LgIndex_t ControlID, const char *ToolTipText) |
Sets a tool tip help string for the specified control. More... | |
void | TecGUISetStatusLine (LgIndex_t ControlID, const char *StatusLineText) |
Sets a status line help string for the specified control. More... | |
void | TecGUIButtonSetDefault (LgIndex_t DialogID, LgIndex_t ButtonID) |
Used to identify the button control to receive the default action for a dialog. More... | |
void | TecGUIButtonSetText (LgIndex_t ButtonID, const char *NewText) |
Sets the text of a button control. More... | |
void | TecGUISetSensitivity (LgIndex_t ControlID, Boolean_t IsSensitive) |
Sets the sensitivity (in Windows, the enabled state) of a control. More... | |
void | TecGUISetVisibility (LgIndex_t ControlID, Boolean_t MakeVisible) |
Sets the visibility of a control. More... | |
LgIndex_t | TecGUIOptionMenuAdd (LgIndex_t ParentDialogID, LgIndex_t X, LgIndex_t Y, LgIndex_t Width, LgIndex_t Height, const char *OptionList, TecGUIIntCallback_pf ValueChangedCallback) |
Adds an option menu control to a dialog. More... | |
void | TecGUIOptionMenuSet (LgIndex_t OptionMenuID, LgIndex_t Selection) |
Set the current option in an option menu. More... | |
LgIndex_t | TecGUIOptionMenuSetByString (LgIndex_t OptionMenuID, const char *Name) |
Set the current item of an option menu to the item that matches the string. More... | |
LgIndex_t | TecGUIOptionMenuGet (LgIndex_t OptionMenuID) |
Gets the position index currently selected option menu item. More... | |
LgIndex_t | TecGUIListAdd (LgIndex_t ParentDialogID, LgIndex_t X, LgIndex_t Y, LgIndex_t Width, LgIndex_t Height, Boolean_t IsMultiSelection, TecGUIIntCallback_pf ValueChangedCallback) |
Adds a single or multi-selection list control to a dialog. More... | |
LgIndex_t | TecGUIListGetItemCount (LgIndex_t ListID) |
Gets the number of items in a list control. More... | |
void | TecGUIListAppendItem (LgIndex_t ListID, const char *Item) |
Appends an item to a list control. More... | |
char * | TecGUIListGetString (LgIndex_t ListID, LgIndex_t Position) |
Gets the text of an item in a list box. More... | |
void | TecGUIListReplaceItem (LgIndex_t ListID, const char *Item, LgIndex_t Position) |
Replaces the text of an item in a list control. More... | |
void | TecGUIListDeleteAllItems (LgIndex_t ListID) |
Removes all the items from a list control. More... | |
void | TecGUIListDeleteItemAtPos (LgIndex_t ListID, LgIndex_t Position) |
Deletes an item in a list control. More... | |
void | TecGUIListDeselectAllItems (LgIndex_t ListID) |
Deselects all items in a list control. More... | |
void | TecGUIListSetSelectedItem (LgIndex_t ListID, LgIndex_t Position) |
Selects an item in a list control. More... | |
void | TecGUIListGetSelectedItems (LgIndex_t ListID, LgIndex_t **SelectedItemList, LgIndex_t *SelectedItemCount) |
Gets the indexes of all selected items in a list control. More... | |
void | TecGUIListSetSelectedItems (LgIndex_t ListID, LgIndex_t *SelectedItemList, LgIndex_t SelectedItemCount) |
Selects one or more (if the list is multi-selection) items in a list control. More... | |
LgIndex_t | TecGUIListGetSelectedItem (LgIndex_t ListID) |
Gets the position index of the single selected item in a list control. More... | |
void | TecGUIListSelectAllItems (LgIndex_t ListID) |
Selects all items in a list control (if multi-selection). More... | |
LgIndex_t | TecGUIToggleAdd (LgIndex_t ParentDialogID, LgIndex_t X, LgIndex_t Y, LgIndex_t Width, LgIndex_t Height, const char *Label, TecGUIIntCallback_pf ValueChangedCallback) |
Adds a toggle control to a dialog. More... | |
void | TecGUIToggleSet (LgIndex_t ToggleID, Boolean_t SetOn) |
Sets or clears a toggle control. More... | |
Boolean_t | TecGUIToggleGet (LgIndex_t ToggleID) |
Get the current value of a toggle. More... | |
LgIndex_t | TecGUIRadioBoxAdd (LgIndex_t ParentDialogID, LgIndex_t X, LgIndex_t Y, LgIndex_t Width, LgIndex_t Height, const char *Label1, const char *Label2, const char *Label3, const char *Label4, const char *Label5, TecGUIIntCallback_pf ValueChangedCallback) |
Adds a set of radio box controls to a dialog. More... | |
void | TecGUIRadioBoxSetToggle (LgIndex_t RadioBox, LgIndex_t ToggleNumber) |
Sets a radio button in radio box control. More... | |
LgIndex_t | TecGUIRadioBoxGetToggle (LgIndex_t RadioBox) |
Get the current radio box selection. More... | |
LgIndex_t | TecGUILabelAdd (LgIndex_t ParentDialogID, LgIndex_t X, LgIndex_t Y, const char *Label) |
Adds a static text label to a dialog. More... | |
void | TecGUILabelSetText (LgIndex_t LabelID, const char *LabelString) |
Sets the text of a static label control. More... | |
void | TecGUILabelSetLgIndex (LgIndex_t LabelID, LgIndex_t Value) |
Formats an integer value and assigns it as the label string. More... | |
void | TecGUILabelSetDouble (LgIndex_t LabelID, double Value, const char *Format) |
Formats a double value and assigns it as the label string. More... | |
void | TecGUILabelSetSet (LgIndex_t LabelID, Set_pa Set, Boolean_t IncludeSquareBrackets) |
Formats a set and assigns it as the label string. More... | |
LgIndex_t | TecGUITextFieldAdd (LgIndex_t ParentDialogID, LgIndex_t X, LgIndex_t Y, LgIndex_t Width, LgIndex_t Height, TecGUITextCallback_pf ValueChangedCallback) |
Adds a text field control to a dialog. More... | |
LgIndex_t | TecGUITextAdd (LgIndex_t ParentDialogID, LgIndex_t X, LgIndex_t Y, LgIndex_t Width, LgIndex_t Height, Boolean_t IsReadOnly, TecGUITextCallback_pf ValueChangedCallback) |
Adds a multi-line text control to a dialog. More... | |
void | TecGUITextSetInsertPos (LgIndex_t Text, LgIndex_t Position) |
Set the text insert position at the specified position in the text string. More... | |
void | TecGUITextSetMinInsertPos (LgIndex_t Text) |
Set the insert position to before the first character in text string maintained by the multi-line text control. More... | |
void | TecGUITextSetMaxInsertPos (LgIndex_t Text) |
Set the text insert position at the maximum position in the text string. More... | |
void | TecGUITextSetString (LgIndex_t Text, const char *TextString) |
Sets the text in a multi-line text control. More... | |
char * | TecGUITextGetString (LgIndex_t Text) |
Gets the text in a multi-line text control. More... | |
void | TecGUITextInsertString (LgIndex_t Text, const char *TextString) |
Inserts text into a multi-line text control. More... | |
LgIndex_t | TecGUIScaleAdd (LgIndex_t ParentDialogID, LgIndex_t X, LgIndex_t Y, LgIndex_t Width, LgIndex_t Height, LgIndex_t ScaleMin, LgIndex_t ScaleMax, LgIndex_t DecimalPrecision, TecGUIIntCallback_pf ValueChangedCallback, TecGUIIntCallback_pf DragValueChangedCallback) |
Adds a scale control to a dialog. More... | |
void | TecGUIScaleSetValue (LgIndex_t ScaleID, LgIndex_t NewValue) |
Sets the current position of a scale control. More... | |
void | TecGUIScaleSetLimits (LgIndex_t ScaleID, LgIndex_t ScaleMin, LgIndex_t ScaleMax, LgIndex_t DecimalPrecision) |
Set the limits (that is, minimum and maximum values) and decimal precision of a scale control. More... | |
LgIndex_t | TecGUIScaleGetValue (LgIndex_t ScaleID) |
Sets the current position of a scale control. More... | |
LgIndex_t | TecGUIVertSeparatorAdd (LgIndex_t ParentDialogID, LgIndex_t X, LgIndex_t Y, LgIndex_t Height) |
Adds a vertical separator to a dialog. More... | |
LgIndex_t | TecGUIHorzSeparatorAdd (LgIndex_t ParentDialogID, LgIndex_t X, LgIndex_t Y, LgIndex_t Width) |
Adds a horizontal separator to a dialog. More... | |
LgIndex_t | TecGUIFrameAdd (LgIndex_t ParentDialogID, LgIndex_t X, LgIndex_t Y, LgIndex_t Width, LgIndex_t Height, const char *Label) |
Add a frame to the specified parent dialog. More... | |
void | TecGUITextFieldSetString (LgIndex_t TextFieldID, const char *TextString) |
Sets the text in a text field control. More... | |
char * | TecGUITextFieldGetString (LgIndex_t TextFieldID) |
Gets the text in a text field control. More... | |
Boolean_t | TecGUITextFieldGetLgIndex (LgIndex_t TextFieldID, LgIndex_t *Value) |
Gets the integer value from the text field. More... | |
Boolean_t | TecGUITextFieldGetDouble (LgIndex_t TextFieldID, double *Value) |
Gets the double precision value from the text field. More... | |
Boolean_t | TecGUITextFieldValidateLgIndex (LgIndex_t TextFieldID, const char *TextFieldName, LgIndex_t MinDomain, LgIndex_t MaxDomain, Boolean_t AllowMxSyntax) |
Validates that the contents of the specified text field are within the specified domain. More... | |
Boolean_t | TecGUITextFieldValidateDouble (LgIndex_t TextFieldID, const char *TextFieldName, double MinDomain, double MaxDomain) |
Validates that the contents of the specified text field are within the specified domain. More... | |
Boolean_t | TecGUITextFieldGetSet (LgIndex_t TextFieldID, Set_pa *Set) |
Gets the set represented by the contents of the text field. More... | |
void | TecGUITextFieldSetLgIndex (LgIndex_t TextFieldID, LgIndex_t Value, Boolean_t UseMx) |
Formats an integer value and assigns it as the text field string. More... | |
void | TecGUITextFieldSetDouble (LgIndex_t TextFieldID, double Value, const char *Format) |
Formats a double value and assigns it as the text field string. More... | |
void | TecGUITextFieldSetSet (LgIndex_t TextFieldID, Set_pa Set, Boolean_t IncludeSquareBrackets) |
Formats a set and assigns it as the text field string. More... | |
void | TecGUIDialogLaunch (LgIndex_t DialogID) |
Displays a dialog created with TecGUIDialogCreatexxx(). More... | |
void | TecGUIDialogDrop (LgIndex_t DialogID) |
Closes a dialog. More... | |
Boolean_t | TecGUIDialogIsUp (LgIndex_t DialogID) |
Returns TRUE if a dialog is currently displayed. More... | |
void | TecGUIDialogSetTitle (LgIndex_t DialogID, const char *NewTitle) |
Sets the title text of a dialog. More... | |
void | TecGUITextAppendString (LgIndex_t TextID, const char *TextString) |
Appends a string to the end of a multi-line text control. More... | |
LgIndex_t | TecGUIMenuBarAdd (LgIndex_t ParentDialogID) |
Add a menu bar to an existing dialog. More... | |
LgIndex_t | TecGUIMenuAdd (LgIndex_t ParentMenuID, const char *Label) |
Add a menu to a menu bar or a walking menu to a menu list. More... | |
LgIndex_t | TecGUIMenuAddItem (LgIndex_t ParentMenuID, const char *Label, const char *StatusLineText, TecGUIVoidCallback_pf Callback) |
Add a menu item to a menu list. More... | |
LgIndex_t | TecGUIMenuAddToggle (LgIndex_t ParentMenuID, const char *Label, const char *StatusLineText, TecGUIIntCallback_pf Callback) |
Add a menu item with a toggle to a menu list. More... | |
void | TecGUIMenuAddSeparator (LgIndex_t ParentMenuID) |
Add a separator to a menu list. More... | |
void | TecGUIMenuItemSetText (LgIndex_t MenuItemID, const char *NewText) |
Set the text for a menu item. More... | |
void | TecGUIMenuSetToggle (LgIndex_t MenuItemID, Boolean_t SetOn) |
Set the state of a menu item toggle. More... | |
void | TecGUIMenuDeleteItem (LgIndex_t MenuItemID) |
Delete a menu item from a menu list. More... | |
LgIndex_t | TecGUITabAdd (LgIndex_t ParentDialogID, LgIndex_t X, LgIndex_t Y, LgIndex_t Width, LgIndex_t Height, TecGUIIntCallback_pf ActivateCallback, TecGUIIntCallback_pf DeactivateCallback) |
Adds a tab control to a dialog. More... | |
LgIndex_t | TecGUITabAddPage (LgIndex_t TabID, const char *Caption) |
Adds a page to a tab control. More... | |
void | TecGUITabSetCurrentPage (LgIndex_t TabID, LgIndex_t PageID) |
Sets a specific tab page of a tab control as the current tab page. More... | |
LgIndex_t | TecGUIFormAdd (LgIndex_t ParentDialogID, LgIndex_t X, LgIndex_t Y, LgIndex_t Width, LgIndex_t Height) |
Adds a new form control. More... | |
LgIndex_t | TecGUIFormAddPage (LgIndex_t ParentFormID) |
Creates a new form page. More... | |
void | TecGUIFormSetCurrentPage (LgIndex_t FormID) |
Sets a specific form page to be displayed. More... | |
LgIndex_t | TecGUISpinTextFieldAdd (LgIndex_t ParentDialogID, LgIndex_t X, LgIndex_t Y, LgIndex_t Width, LgIndex_t Height, TecGUITextCallback_pf ValueChangedCallback, TecGUIVoidCallback_pf ButtonUpCallback, TecGUIVoidCallback_pf ButtonDownCallback) |
Adds a spin text field to a dialog. More... | |
Boolean_t | TecGUISpinTextFieldIncLgIndex (LgIndex_t SpinTextFieldID, LgIndex_t Increment, LgIndex_t MinDomain, LgIndex_t MaxDomain) |
The Tecplot GUI Builder creates empty callbacks for the up and down arrow buttons of each spin box used by the add-on. More... | |
Boolean_t | TecGUISpinTextFieldIncDouble (LgIndex_t SpinTextFieldID, const char *Format, double Increment, double MinDomain, double MaxDomain) |
The Tecplot GUI Builder creates empty callbacks for the up and down arrow buttons of each spin box used by the add-on. More... | |
void | TecGUIOptionMenuDeleteItemAtPos (LgIndex_t OptionMenuID, LgIndex_t Position) |
Delete an item in an option menu control. More... | |
void | TecGUIOptionMenuAppendItem (LgIndex_t OptionMenuID, const char *Item) |
Appends an item to an option menu control. More... | |
LgIndex_t | TecGUIOptionMenuGetItemCount (LgIndex_t OptionMenuID) |
Get the number of items in an option menu. More... | |
void | TecGUIOptionMenuDeleteAllItems (LgIndex_t OptionMenuID) |
Remove all items from an option menu. More... | |
char * | TecGUIOptionMenuGetString (LgIndex_t OptionMenuID, LgIndex_t Position) |
Get the text of an item in an option menu. More... | |
void | TecGUIOptionMenuReplaceItem (LgIndex_t OptionMenuID, const char *NewText, LgIndex_t Position) |
Replace the text of an item in an option menu control. More... | |
void | TecGUIScaleShowNumericDisplay (LgIndex_t ScaleID, Boolean_t ShowDisplay) |
Turns numeric display of a scale on or off. More... | |
LgIndex_t | TecGUISidebarRegister (const char *SidebarName, AddOn_pa AddOnID, LgIndex_t Width, LgIndex_t Height, TecGUIVoidCallback_pf ActivateCallback, TecGUIVoidCallback_pf DeactivateCallback) |
Creates and registers the specified sidebar by name with Tecplot. More... | |
void | TecGUISidebarActivate (LgIndex_t SidebarID) |
Activates the specified sidebar replacing the current one. More... | |
void | TecGUISidebarDeactivateAll (void) |
Deactivates any activate sidebar causing it to no longer be visible. More... | |
Boolean_t | TecGUISidebarIsActive (LgIndex_t SidebarID) |
Given a sidebar ID, return TRUE if the sidebar is currently active, FALSE otherwise. More... | |
LgIndex_t | TecGUIListGetCapacity (LgIndex_t ListID) |
Gets the number of items that the list control can visibly display. More... | |
LgIndex_t | TecGUIListGetTopItemNum (LgIndex_t ListID) |
Gets the index of the first visible item in a list box. More... | |
void | TecGUIListSetTopItemNum (LgIndex_t ListID, LgIndex_t ItemNum) |
Scrolls the list box until either the item specified appears at the top of the list box or the maximum scroll range has been reached. More... |
|
|
|
|
|
|
|
|
|
|
|
General GUI callback function with an LgIndex_t * parameter. Many of the TecGUI functions require you to * provide a function that has this function prototype.
|
|
General GUI callback function with a char* parameter. TecGUI functions related to text fields and multi-line text fields require you to provide a function that has this function prototype.
|
|
General GUI callback function with no parameters. Many of the TecGUI functions require you to provide a function that has this function prototype. |
|
Adds a bitmap button to a dialog. The bitmap is centered on the button. It is not stetched to fit the button size. NOTE: TGB automatically generates code to call this function. Only under rare circumstances will you need to call this function directly yourself.
INTEGER*4 FUNCTION TecGUIBitmapButtonAdd( |
|
Adds a bitmap toggle button to a dialog. A bitmap toggle button works like a toggle, except that instead of the checkmark, a bitmap button is used which has a "pushed" appearance when the toggle is selected. The bitmap is centered on the button. It is not stretched to fit the button size. NOTE: TGB automatically generates code to call this function. Only under rare circumstances will you need to call this function directly yourself.
INTEGER*4 FUNCTION TecGUIBitmapToggleAdd( |
|
Call this function if your code is structured such that it must wait for a modal dialog to close.
SUBROUTINE TecGUIBlockForModalDialog(DoneWithModalDialog) Launch and block a modal dialog.
Boolean_t DoneWithModalDialog = FALSE { BuildDialog1(MAINDIALOGID); TecGUIDialogLaunch(Dialog1Manager); TecGUIBlockForModalDialog(&DoneWithModalDialog); / * Will not return until DoneWithModalDialog is TRUE. * / / * In the OK and Cancel dialog callbacks set DoneWithModalDialog to TRUE * / TecUtilDialogMessageBox("Finished blocking.",MessageBox_Information); } |
|
Adds a button to a dialog. Note that you must call this function before calling TecGUIDialogLaunch(). Note: TGB automatically generates code that uses this function. Only under rare circumstances will you need to call this function directly yourself.
INTEGER*4 FUNCTION TecGUIButtonAdd( |
|
Used to identify the button control to receive the default action for a dialog. When a user presses return in a dialog the default action for the dialog is initiated. Usually one of the buttons in the action area of the dialog is defined to handle the default action however it can be assigned to one of your own buttons with this function.
SUBROUTINE TecGUIButtonSetDefault( |
|
Sets the text of a button control.
SUBROUTINE TecGUIButtonSetText( |
|
Sets the sensitivity of the Apply button in a dialog. Note that this function should only be called for modal dialogs that have been assigned an apply button when created. Typically, after a user presses the Apply button in a modal dialog an add-on should make the applicable changes and then set the Apply button to insensitive. When subsequent modification are made to fields in the dialog the Apply button should be made sensitive again.
SUBROUTINE TecGUIDialogApplySetSensitivity( |
|
Creates a modal dialog and returns the ID of the dialog. A modal dialog is one that restricts the user to acting within the dialog, and locks everything else on the screen, until the user clicks OK or Cancel. The dialog is not displayed until you call TecGUIDialogLaunch(). Note: TGB automatically generates code that uses this function. Only under rare circumstances will you need to call this function directly yourself.
INTEGER*4 FUNCTION TecGUIDialogCreateModal( |
|
Creates a modeless dialog and returns the ID of the dialog. A modeless dialog is one that will allow the user to interact with Tecplot and the controls within the dialog concurrently. Note that the dialog is not displayed until you call TecGUIDialogLaunch(). Note: TGB automatically generates code that uses this function. Only under rare circumstances will you need to call this function directly yourself.
INTEGER*4 FUNCTION TecGUIDialogCreateModeless( |
|
Closes a dialog. Usually this is called from the OK, Close, or Cancel button callbacks. Note: TGB automatically generates code that uses this function. Only under rare circumstances will you need to call this function directly yourself.
SUBROUTINE TecGUIDialogDrop(DialogID) |
|
Shows or hides the Close and Help buttons at the bottom of TGB modeless dialogs. Use the function if you do not need the standard set of buttons at the bottom of the dialog, or if you wish to use other buttons or menu options for these functions. This function must be called before the dialog is launched. It will assert if called after a dialog is launched. This function does nothing if called with a modal dialog argument. Note: Do not call this function more than once with different values for the ShowActionArea parameter. Once this function has been called with FALSE, it cannot be called again on the same dialog with TRUE.
SUBROUTINE TecGUIDialogEnableActionArea( |
|
Returns TRUE if a dialog is currently displayed.
INTEGER*4 FUNCTION TecGUIDialogIsUp(DialogID) |
|
Displays a dialog created with TecGUIDialogCreatexxx(). After a dialog is launched, you cannot add any new controls to the dialog.
SUBROUTINE TecGUIDialogLaunch(DialogID) |
|
Sets the initial location of the dialog when it is launched. This is not available in FORTRAN.
AnchorAlignment_TopLeft AnchorAlignment_TopCenter AnchorAlignment_TopRight AnchorAlignment_MiddleLeft AnchorAlignment_MiddleCenter AnchorAlignment_MiddleRight AnchorAlignment_BottomLeft AnchorAlignment_BottomCenter AnchorAlignment_BottomRight *
SUBROUTINE TecGUIDialogSetLaunchPosition( Set the launch position of the dialog with id D7 to be bottom left.
TecGUIDialogSetLaunchPosition(D7, AnchorAlignment_BottomLeft, 0, // OffsetX 0); // OffsetY |
|
Set the launch position of an addon dialog.
INTEGER*4 FUNCTION TecGUIDialogSetLaunchPositionX(ArgListPtr) Make the dialog come up outside of the tecplot process window and to the right.
ArgList_pa ArgList; TecUtilLockStart(AddOnID); // DialogID supplied .... ArgList = TecUtilArgListAlloc(); TecUtilArgListAppendInt(ArgList, SV_DIALOGID, DialogID); TecUtilArgListAppendInt(ArgList, SV_ANCHORALIGNMENT, AnchorAlignment_TopRight); TecUtilArgListAppendInt(ArgList, SV_ANCHORHORIZONTALINSIDE, FALSE); TecGUIDialogSetLaunchPositionX(ArgList); TecUtilArgListDealloc(&ArgList); TecUtilLockFinish(AddOnID); |
|
Sets the title text of a dialog.
SUBROUTINE TecGUIDialogSetTitle( |
|
Sets a modal or modeless dialog to be the topmost window. In Windows, calling this function with MakeTopmost equal to TRUE will add the WS_EX_TOPMOST style to the dialog, otherwise the style will be cleared. If set, the dialog will always remain on top of all other windows. In UNIX, this function does nothing.
SUBROUTINE TecGUIDialogSetTopmost( |
|
Adds a new form control. Note: TGB automatically generates code that uses this function. Only under rare circumstances will you need to call this function directly yourself.
INTEGER*4 FUNCTION TecGUIFormAdd( |
|
Creates a new form page. Note: TGB automatically generates code that uses this function. Only under rare circumstances will you need to call this function directly yourself.
INTEGER*4 FUNCTION TecGUIFormAddPage(ParentFormID) |
|
Sets a specific form page to be displayed.
SUBROUTINE TecGUIFormSetCurrentPage(FormID) |
|
Add a frame to the specified parent dialog. A frame is a box used to visually separate one control, or group of controls, from another. Note: TGB automatically generates code that uses this function. Only under rare circumstances will you need to call this function directly yourself.
INTEGER*4 FUNCTION TecGUIFrameAdd( |
|
Adds a horizontal separator to a dialog. Note: TGB automatically generates code that uses this function. Only under rare circumstances will you need to call this function directly yourself.
INTEGER*4 FUNCTION TecGUIHorzSeparatorAdd( |
|
Adds a static text label to a dialog. Note: TGB automatically generates code that uses this function. Only under rare circumstances will you need to call this function directly yourself.
INTEGER*4 FUNCTION TecGUILabelAdd( |
|
Formats a double value and assigns it as the label string.
SUBROUTINE TecGUILabelSetDouble( |
|
Formats an integer value and assigns it as the label string.
SUBROUTINE TecGUILabelSetLgIndex( |
|
Formats a set and assigns it as the label string.
SUBROUTINE TecGUILabelSetSet( |
|
Sets the text of a static label control.
SUBROUTINE TecGUILabelSetText( |
|
Adds a single or multi-selection list control to a dialog. After adding the list control, you can call TecGUIListAppendItem() to add items to the list control. Note: TGB automatically generates code that uses this function. Only under rare circumstances will you need to call this function directly yourself.
INTEGER*4 FUNCTION TecGUIListAdd( |
|
Appends an item to a list control.
SUBROUTINE TecGUIListAppendItem( |
|
Removes all the items from a list control.
SUBROUTINE TecGUIListDeleteAllItems(ListID) |
|
Deletes an item in a list control.
SUBROUTINE TecGUIListDeleteItemAtPos( |
|
Deselects all items in a list control.
SUBROUTINE TecGUIListDeselectAllItems(ListID) |
|
Gets the number of items that the list control can visibly display. This number is dependant on the height of the list control.
INTEGER*4 FUNCTION TecGUIListGetCapacity(ListID) Change the selected item to appear in the middle of the list box:
LgIndex_t SelectedItem = TecGUIListGetSelectedItem(ID) LgIndex_t ListCapacity = TecGUIListGetCapacity(ID) LgIndex_t NewTopItemPos = SelectedItem - ListCapacity / 2; if (NewTopItemPos > 0) TecGUIListSetTopItemPos(ID,NewTopItemPos); else / * Current selected item is already visible and cannot be moved to the center of the list * / |
|
Gets the number of items in a list control.
INTEGER*4 FUNCTION TecGUIListGetItemCount(ListID) |
|
Gets the position index of the single selected item in a list control.
INTEGER*4 FUNCTION TecGUIListGetSelectedItem(ListID) |
|
Gets the indexes of all selected items in a list control. You can use this function for both single and multi-selected list controls.
LgIndex_t count; LgIndex_t *sel; LgIndex_t i; TecGUIListGetSelectedItems(ListID,&sel,&count); for (i=0;i<count;i++) { / * Do something useful with sel[] * / } TecUtilArrayDealloc(&sel); / * Clean up when done. * / |
|
Gets the text of an item in a list box.
SUBROUTINE TecGUIListGetString( |
|
Gets the index of the first visible item in a list box. This function will assert if there are no items in the list box.
INTEGER*4 FUNCTION TecGUIListGetTopItemNum(ListID) Make the item at index 10 visible if it is not already.
if ( TecGUIListGetTopItemNum(ListID) > 10 ) TecGUIListSetTopItemNum(ListID,10); |
|
Replaces the text of an item in a list control.
SUBROUTINE TecGUIListReplaceItem( |
|
Selects all items in a list control (if multi-selection).
SUBROUTINE TecGUIListSelectAllItems(ListID) |
|
Selects an item in a list control.
SUBROUTINE TecGUIListSetSelectedItem( |
|
Selects one or more (if the list is multi-selection) items in a list control.
|
|
Scrolls the list box until either the item specified appears at the top of the list box or the maximum scroll range has been reached.
SUBROUTINE TecGUIListSetTopItemNum( Make the item at index 10 visible if it is not already.
if ( TecGUIListGetTopItemNum(ID) > 10 ) TecGUIListSetTopItemNum(ID,10) |
|
Add a menu to a menu bar or a walking menu to a menu list.
INTEGER*4 FUNCTION TecGUIMenuAdd( Add a menu item to Menu Bar called Options with t as the mnemonic.
{ LgIndex_t OptionMenuID; OptionMenuID = TecGUIMenuAdd(MenuBar,"Op&tions"); } |
|
Add a menu item to a menu list.
INTEGER*4 FUNCTION TecGUIMenuAddItem( |
|
Add a separator to a menu list.
SUBROUTINE TecGUIMenuAddSeparator(ParentMenuID) |
|
Add a menu item with a toggle to a menu list.
INTEGER*4 FUNCTION TecGUIMenuAddToggle( |
|
Add a menu bar to an existing dialog.
INTEGER*4 FUNCTION TecGUIMenuBarAdd(ParentDialogID) |
|
Delete a menu item from a menu list.
SUBROUTINE TecGUIMenuDeleteItem(MenuItemID) |
|
Set the text for a menu item.
SUBROUTINE TecGUIMenuItemSetText( |
|
Set the state of a menu item toggle.
SUBROUTINE TecGUIMenuSetToggle( |
|
Adds an option menu control to a dialog. Note: TGB automatically generates code that uses this function. Only under rare circumstances will you need to call this function directly yourself.
INTEGER*4 FUNCTION TecGUIOptionMenuAdd( |
|
Appends an item to an option menu control.
SUBROUTINE TecGUIOptionMenuAppendItem( |
|
Remove all items from an option menu.
SUBROUTINE TecGUIOptionMenuDeleteAllItems(OptionMenuID) |
|
Delete an item in an option menu control.
SUBROUTINE TecGUIOptionMenuDeleteItemAtPos( |
|
Gets the position index currently selected option menu item.
INTEGER*4 FUNCTION TecGUIOptionMenuGet(OptionMenuID) |
|
Get the number of items in an option menu.
INTEGER*4 FUNCTION TecGUIOptionMenuGetItemCount(OptionMenuID) |
|
Get the text of an item in an option menu.
SUBROUTINE TecGUIOptionMenuGetString( |
|
Replace the text of an item in an option menu control.
SUBROUTINE TecGUIOptionMenuReplaceItem( |
|
Set the current option in an option menu.
SUBROUTINE TecGUIOptionMenuSet( |
|
Set the current item of an option menu to the item that matches the string.
INTEGER*4 FUNCTION TecGUIOptionMenuSetByString( |
|
Adds a set of radio box controls to a dialog. You must call this function before calling TecGUIDialogLaunch(). Radio boxes are limited to five toggles. Note: TGB automatically generates code that uses this function. Only under rare circumstances will you need to call this function directly yourself.
INTEGER*4 FUNCTION TecGUIRadioBoxAdd( |
|
Get the current radio box selection.
INTEGER*4 FUNCTION TecGUIRadioBoxGetToggle(RadioBox) |
|
Sets a radio button in radio box control.
SUBROUTINE TecGUIRadioBoxSetToggle( |
|
Adds a scale control to a dialog. Note: TGB automatically generates code that uses this function. Only under rare circumstances will you need to call this function directly yourself.
INTEGER*4 FUNCTION TecGUIScaleAdd( |
|
Sets the current position of a scale control.
INTEGER*4 FUNCTION TecGUIScaleGetValue(ScaleID) |
|
Set the limits (that is, minimum and maximum values) and decimal precision of a scale control.
SUBROUTINE TecGUIScaleSetLimits( |
|
Sets the current position of a scale control.
SUBROUTINE TecGUIScaleSetValue( |
|
Turns numeric display of a scale on or off. This function may be called at any time.
SUBROUTINE TecGUIScaleShowNumericDisplay( |
|
Sets the sensitivity (in Windows, the enabled state) of a control.
SUBROUTINE TecGUISetSensitivity( |
|
Sets a status line help string for the specified control.
SUBROUTINE TecGUISetStatusLine( |
|
Sets a tool tip help string for the specified control.
SUBROUTINE TecGUISetToolTip( |
|
Sets the visibility of a control.
SUBROUTINE TecGUISetVisibility( |
|
Activates the specified sidebar replacing the current one.
SUBROUTINE TecGUISidebarActivate(SidebarID) |
|
Deactivates any activate sidebar causing it to no longer be visible.
SUBROUTINE TecGUISidebarDeactivateAll() |
|
Given a sidebar ID, return TRUE if the sidebar is currently active, FALSE otherwise.
INTEGER*4 FUNCTION TecGUISidebarIsActive(SidebarID) Check if the Tecplot sidebar is active:
Boolean_t TecplotSidebarIsActive=TecGUISidebarIsActive(TECGUITECPLOTSIDEBAR); |
|
Creates and registers the specified sidebar by name with Tecplot. REgistered sidebars are placed under Tecplot's Workspace->Sidebar menu.
INTEGER*4 FUNCTION TecGUISidebarRegister( |
|
Adds a spin text field to a dialog. Note: TGB automatically generates code that uses the function. Only in rare circumstances will you need to call this function directly yourself.
INTEGER*4 FUNCTION TecGUISpinTextFieldAdd( |
|
The Tecplot GUI Builder creates empty callbacks for the up and down arrow buttons of each spin box used by the add-on. The add-on developer can add this function to the callback to increment or decrement the value within the specified limits in response to the action.
INTEGER*4 FUNCTION TecGUISpinTextFieldIncDouble( |
|
The Tecplot GUI Builder creates empty callbacks for the up and down arrow buttons of each spin box used by the add-on. The add-on developer can add this function to the callback to increment or decrement the value within the specified limits in response to the action.
INTEGER*4 FUNCTION TecGUISpinTextFieldIncLgIndex( |
|
Adds a tab control to a dialog. Note: TGB automatically generates code that uses the function. Only in rare circumstances will you need to call this function directly yourself.
INTEGER*4 FUNCTION TecGUITabAdd( |
|
Adds a page to a tab control. The ID returned from this function may be passed to any TecGUI*Add function to add controls such as buttons, text fields, and so forth, to this tab page. Note: TGB automatically generates code that uses the function. Only in rare circumstances will you need to call this function directly yourself.
INTEGER*4 FUNCTION TecGUITabAddPage( |
|
Sets a specific tab page of a tab control as the current tab page.
SUBROUTINE TecGUITabSetCurrentPage( |
|
Adds a multi-line text control to a dialog. Note: TGB automatically generates code that uses this function. Only under rare circumstances will you need to call this function directly yourself.
INTEGER*4 FUNCTION TecGUITextAdd( |
|
Appends a string to the end of a multi-line text control.
SUBROUTINE TecGUITextAppendString( |
|
Adds a text field control to a dialog. Note: TGB automatically generates code that uses this function. Only under rare circumstances will you need to call this function directly yourself.
INTEGER*4 FUNCTION TecGUITextFieldAdd( |
|
Gets the double precision value from the text field.
INTEGER*4 FUNCTION TecGUITextFieldGetDouble( |
|
Gets the integer value from the text field.
INTEGER*4 FUNCTION TecGUITextFieldGetLgIndex( |
|
Gets the set represented by the contents of the text field. A set is made of comma separated members that may optionally have outer square brackets. Each set member may be one of the following: a positive number, or a number range of the form n-m:s where n is the starting value, m is the ending value. The :s notation is an optional skip value. The following set defines the members 1, 2, 5, 7, 9, and 11: [1, 2, 5-11:2]
INTEGER*4 FUNCTION TecGUITextFieldGetSet( |
|
Gets the text in a text field control.
SUBROUTINE TecGUITextFieldGetString( |
|
Formats a double value and assigns it as the text field string.
SUBROUTINE TecGUITextFieldSetDouble( |
|
Formats an integer value and assigns it as the text field string.
SUBROUTINE TecGUITextFieldSetLgIndex( |
|
Formats a set and assigns it as the text field string.
SUBROUTINE TecGUITextFieldSetSet( |
|
Sets the text in a text field control. The previous contents of the text field control are erased.
SUBROUTINE TecGUITextFieldSetString( |
|
Validates that the contents of the specified text field are within the specified domain. If not, an error message is displayed and the caller notified.
INTEGER*4 FUNCTION TecGUITextFieldValidateDouble( |
|
Validates that the contents of the specified text field are within the specified domain. If not, an error message is displayed and the caller notified.
INTEGER*4 FUNCTION TecGUITextFieldValidateLgIndex( |
|
Gets the text in a multi-line text control.
Lines are separated by new line characters ('
SUBROUTINE TecGUITextGetString( |
|
Inserts text into a multi-line text control.
The next text is inserted to the right of the current text insert position. Use TecGUITextSetInsertPos to set the text insert position. Individual lines of the text are delimited by the '
SUBROUTINE TecGUITextInsertString( |
|
Set the text insert position at the specified position in the text string. Text is inserted to the right of the specified position. To insert text at the beginning, set the insert position to zero. To insert text at the end, set the insert position to the length of the string currently maintained by the multi-line text control. See also TecGUITextSetMinInsertPos and TecGUITextSetMaxInsertPos. In Windows, the insert position is the position of the caret.
SUBROUTINE TecGUITextSetInsertPos( |
|
Set the text insert position at the maximum position in the text string. Text inserted at the maximum position places the text at the end of the text string maintained by the multi-line text control.
SUBROUTINE TecGUITextSetMaxInsertPos(Text) |
|
Set the insert position to before the first character in text string maintained by the multi-line text control. This is equivalent to calling TecGUITextSetInsertPos(id,0).
SUBROUTINE TecGUITextSetMinInsertPos(Text) |
|
Sets the text in a multi-line text control. The previous contents of the multi-line text control are erased.
SUBROUTINE TecGUITextSetString( |
|
Adds a toggle control to a dialog. Note: TGB automatically generates code that uses this function. Only under rare circumstances will you need to call this function directly yourself.
INTEGER*4 FUNCTION TecGUIToggleAdd( |
|
Get the current value of a toggle.
INTEGER*4 FUNCTION TecGUIToggleGet(ToggleID) |
|
Sets or clears a toggle control.
SUBROUTINE TecGUIToggleSet( |
|
Adds a vertical separator to a dialog. Note: TGB automatically generates code that uses this function. Only under rare circumstances will you need to call this function directly yourself.
INTEGER*4 FUNCTION TecGUIVertSeparatorAdd( |