Tecplot GUI Builder


Functions
void	TecGUIDialogEnableActionArea (LgIndex_t DialogID, Boolean_t EnableActionArea)
	Set/Unset the dialog to always be on top of other windows.
void	TecGUIDialogApplySetSensitivity (LgIndex_t DialogID, Boolean_t IsSensitive)
	Sets the sensitivity of the Apply button in a dialog.
void	TecGUIDialogSetTopmost (LgIndex_t DialogID, Boolean_t MakeTopmost)
	Sets a modal or modeless dialog to be the topmost window.
void	TecGUIDialogSetPosition (LgIndex_t DialogID, AnchorAlignment_e Placement, LgIndex_t OffsetX, LgIndex_t OffsetY)
	Sets the position of the add-on dialog.
void	TecGUIDialogSetLaunchPosition (LgIndex_t DialogID, AnchorAlignment_e Placement, LgIndex_t OffsetX, LgIndex_t OffsetY)

void	TecGUIDialogSetPositionX (ArgList_pa ArgList)
	Set the position of an add-on dialog.
void	TecGUIDialogSetLaunchPositionX (ArgList_pa ArgList)

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.
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.
void	TecGUIBlockForModalDialog (Boolean_t *DoneWithModalDialog)
	Call this function if your code is structured such that it must wait for a modal dialog to close.
LgIndex_t	TecGUIColoredButtonAdd (LgIndex_t ParentDialogID, LgIndex_t X, LgIndex_t Y, LgIndex_t Width, LgIndex_t Height, const char *LabelString, ColorIndex_t ColorIndex, TecGUIVoidCallback_pf ButtonCallback)
	Adds a colored button to a dialog.
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.
void	TecGUIColoredButtonSetColor (LgIndex_t ButtonID, ColorIndex_t Color)
	Sets background color of a button.
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.
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.
void	TecGUISetToolTip (LgIndex_t ControlID, const char *ToolTipText)
	Sets a tool tip help string for the specified control.
void	TecGUISetStatusLine (LgIndex_t ControlID, const char *StatusLineText)
	Sets a status line help string for the specified control.
void	TecGUIButtonSetDefault (LgIndex_t DialogID, LgIndex_t ButtonID)
	Used to identify the button control to receive the default action for a dialog.
void	TecGUIButtonSetText (LgIndex_t ButtonID, const char *NewText)
	Sets the text of a button control.
void	TecGUISetSensitivity (LgIndex_t ControlID, Boolean_t IsSensitive)
	Sets the sensitivity (in Windows, the enabled state) of a control.
void	TecGUISetVisibility (LgIndex_t ControlID, Boolean_t MakeVisible)
	Sets the visibility of a control.
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.
void	TecGUIOptionMenuSet (LgIndex_t OptionMenuID, LgIndex_t Selection)
	Set the current option in an option menu.
LgIndex_t	TecGUIOptionMenuSetByString (LgIndex_t OptionMenuID, const char *Name)
	Set the current item of an option menu to the item that matches the string.
LgIndex_t	TecGUIOptionMenuGet (LgIndex_t OptionMenuID)
	Gets the position index currently selected option menu item.
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.
LgIndex_t	TecGUIListGetItemCount (LgIndex_t ListID)
	Gets the number of items in a list control.
void	TecGUIListAppendItem (LgIndex_t ListID, const char *Item)
	Appends an item to a list control.
char *	TecGUIListGetString (LgIndex_t ListID, LgIndex_t Position)
	Gets the text of an item in a list box.
void	TecGUIListReplaceItem (LgIndex_t ListID, const char *Item, LgIndex_t Position)
	Replaces the text of an item in a list control.
void	TecGUIListDeleteAllItems (LgIndex_t ListID)
	Removes all the items from a list control.
void	TecGUIListDeleteItemAtPos (LgIndex_t ListID, LgIndex_t Position)
	Deletes an item in a list control.
void	TecGUIListDeselectAllItems (LgIndex_t ListID)
	Deselects all items in a list control.
void	TecGUIListSetSelectedItem (LgIndex_t ListID, LgIndex_t Position)
	Selects an item in a list control.
void	TecGUIListGetSelectedItems (LgIndex_t ListID, LgIndex_t *SelectedItemList, LgIndex_t SelectedItemCount)
	Gets the indices of all selected items in a list control.
void	TecGUIListSetSelectedItems (LgIndex_t ListID, LgIndex_t *SelectedItemList, LgIndex_t SelectedItemCount)
	Selects one or more items in a multi-selection list control.
LgIndex_t	TecGUIListGetSelectedItem (LgIndex_t ListID)
	Gets the position index of the single selected item in a list control.
void	TecGUIListSelectAllItems (LgIndex_t ListID)
	Selects all items in a list control (if multi-selection).
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.
void	TecGUIToggleSet (LgIndex_t ToggleID, Boolean_t SetOn)
	Sets or clears a toggle control.
Boolean_t	TecGUIToggleGet (LgIndex_t ToggleID)
	Get the current value of a toggle.
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.
void	TecGUIRadioBoxSetToggle (LgIndex_t RadioBox, LgIndex_t ToggleNumber)
	Sets a radio button in radio box control.
LgIndex_t	TecGUIRadioBoxGetToggle (LgIndex_t RadioBox)
	Get the current radio box selection.
LgIndex_t	TecGUILabelAdd (LgIndex_t ParentDialogID, LgIndex_t X, LgIndex_t Y, const char *Label)
	Adds a static text label to a dialog.
void	TecGUILabelSetText (LgIndex_t LabelID, const char *LabelString)
	Sets the text of a static label control.
void	TecGUILabelSetLgIndex (LgIndex_t LabelID, LgIndex_t Value)
	Formats an integer value and assigns it as the label string.
void	TecGUILabelSetDouble (LgIndex_t LabelID, double Value, const char *Format)
	Formats a double value and assigns it as the label string.
void	TecGUILabelSetSet (LgIndex_t LabelID, Set_pa Set, Boolean_t IncludeSquareBrackets)
	Formats a set and assigns it as the label string.
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.
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.
void	TecGUITextAddKeyEventCallback (LgIndex_t TextOrTextFieldID, TecGUIIntCallback_pf KeyEventCallback)
	Add a key event callback for a multi-line text or text field control.
void	TecGUITextSetInsertPos (LgIndex_t Text, LgIndex_t Position)
	Set the text insert position at the specified position in the text string.
void	TecGUITextSetMinInsertPos (LgIndex_t Text)
	Set the insert position to before the first character in text string maintained by the multi-line text control.
void	TecGUITextSetMaxInsertPos (LgIndex_t Text)
	Set the text insert position at the maximum position in the text string.
void	TecGUITextSetString (LgIndex_t Text, const char *TextString)
	Sets the text in a multi-line text control.
char *	TecGUITextGetString (LgIndex_t Text)
	Gets the text in a multi-line text control.
void	TecGUITextInsertString (LgIndex_t Text, const char *TextString)
	Inserts text into a multi-line text control.
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.
void	TecGUIScaleSetValue (LgIndex_t ScaleID, LgIndex_t NewValue)
	Sets the current position of a scale control.
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.
LgIndex_t	TecGUIScaleGetValue (LgIndex_t ScaleID)
	Sets the current position of a scale control.
LgIndex_t	TecGUIVertSeparatorAdd (LgIndex_t ParentDialogID, LgIndex_t X, LgIndex_t Y, LgIndex_t Height)
	Adds a vertical separator to a dialog.
LgIndex_t	TecGUIHorzSeparatorAdd (LgIndex_t ParentDialogID, LgIndex_t X, LgIndex_t Y, LgIndex_t Width)
	Adds a horizontal separator to a dialog.
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.
void	TecGUITextFieldSetString (LgIndex_t TextFieldID, const char *TextString)
	Sets the text in a text field control.
char *	TecGUITextFieldGetString (LgIndex_t TextFieldID)
	Gets the text in a text field control.
Boolean_t	TecGUITextFieldGetLgIndex (LgIndex_t TextFieldID, LgIndex_t *Value)
	Gets the integer value from the text field.
Boolean_t	TecGUITextFieldGetDouble (LgIndex_t TextFieldID, double *Value)
	Gets the double precision value from the text field.
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.
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.
Boolean_t	TecGUITextFieldGetSet (LgIndex_t TextFieldID, Set_pa *Set)
	Gets the set represented by the contents of the text field.
void	TecGUITextFieldSetLgIndex (LgIndex_t TextFieldID, LgIndex_t Value, Boolean_t UseMx)
	Formats an integer value and assigns it as the text field string.
void	TecGUITextFieldSetDouble (LgIndex_t TextFieldID, double Value, const char *Format)
	Formats a double value and assigns it as the text field string.
void	TecGUITextFieldSetSet (LgIndex_t TextFieldID, Set_pa Set, Boolean_t IncludeSquareBrackets)
	Formats a set and assigns it as the text field string.
void	TecGUIDialogLaunch (LgIndex_t DialogID)
	Displays a dialog created with TecGUIDialogCreatexxx().
void	TecGUIDialogDrop (LgIndex_t DialogID)
	Closes a dialog.
Boolean_t	TecGUIDialogIsUp (LgIndex_t DialogID)
	Returns TRUE if a dialog is currently displayed.
void	TecGUIDialogSetTitle (LgIndex_t DialogID, const char *NewTitle)
	Sets the title text of a dialog.
void	TecGUITextAppendString (LgIndex_t TextID, const char *TextString)
	Appends a string to the end of a multi-line text control.
LgIndex_t	TecGUIMenuBarAdd (LgIndex_t ParentDialogID)
	Add a menu bar to an existing dialog.
LgIndex_t	TecGUIMenuAdd (LgIndex_t ParentMenuID, const char *Label)
	Add a menu to a menu bar or a walking menu to a menu list.
LgIndex_t	TecGUIMenuAddItem (LgIndex_t ParentMenuID, const char Label, const char StatusLineText, TecGUIVoidCallback_pf Callback)
	Add a menu item to a menu list.
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.
void	TecGUIMenuAddSeparator (LgIndex_t ParentMenuID)
	Add a separator to a menu list.
void	TecGUIMenuItemSetText (LgIndex_t MenuItemID, const char *NewText)
	Set the text for a menu item.
void	TecGUIMenuSetToggle (LgIndex_t MenuItemID, Boolean_t SetOn)
	Set the state of a menu item toggle.
void	TecGUIMenuDeleteItem (LgIndex_t MenuItemID)
	Delete a menu item from a menu list.
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.
LgIndex_t	TecGUITabAddPage (LgIndex_t TabID, const char *Caption)
	Adds a page to a tab control.
void	TecGUITabSetCurrentPage (LgIndex_t TabID, LgIndex_t PageID)
	Sets a specific tab page of a tab control as the current tab page.
LgIndex_t	TecGUIFormAdd (LgIndex_t ParentDialogID, LgIndex_t X, LgIndex_t Y, LgIndex_t Width, LgIndex_t Height)
	Adds a new form control.
LgIndex_t	TecGUIFormAddPage (LgIndex_t ParentFormID)
	Creates a new form page.
void	TecGUIFormSetCurrentPage (LgIndex_t FormID)
	Sets a specific form page to be displayed.
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.
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.
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.
void	TecGUIOptionMenuDeleteItemAtPos (LgIndex_t OptionMenuID, LgIndex_t Position)
	Delete an item in an option menu control.
void	TecGUIOptionMenuAppendItem (LgIndex_t OptionMenuID, const char *Item)
	Appends an item to an option menu control.
LgIndex_t	TecGUIOptionMenuGetItemCount (LgIndex_t OptionMenuID)
	Get the number of items in an option menu.
void	TecGUIOptionMenuDeleteAllItems (LgIndex_t OptionMenuID)
	Remove all items from an option menu.
char *	TecGUIOptionMenuGetString (LgIndex_t OptionMenuID, LgIndex_t Position)
	Get the text of an item in an option menu.
void	TecGUIOptionMenuReplaceItem (LgIndex_t OptionMenuID, const char *NewText, LgIndex_t Position)
	Replace the text of an item in an option menu control.
void	TecGUIScaleShowNumericDisplay (LgIndex_t ScaleID, Boolean_t ShowDisplay)
	Turns numeric display of a scale on or off.
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.
void	TecGUISidebarActivate (LgIndex_t SidebarID)
	Activates the specified sidebar replacing the current one.
void	TecGUISidebarDeactivateAll (void)
	Deactivates any activate sidebar causing it to no longer be visible.
Boolean_t	TecGUISidebarIsActive (LgIndex_t SidebarID)
	Given a sidebar ID, return TRUE if the sidebar is currently active, FALSE otherwise.
LgIndex_t	TecGUIListGetCapacity (LgIndex_t ListID)
	Gets the number of items that the list control can visibly display.
LgIndex_t	TecGUIListGetTopItemNum (LgIndex_t ListID)
	Gets the index of the first visible item in a list box.
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.
void	TecGUISetInputFocus (LgIndex_t ControlID)
	Set the input focus to a GUI control.

Function Documentation

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.

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.

Parameters:

	ParentDialogID	D of the parent dialog, sidebar, form page, or tab page.
	X	Left coordinate of the button. Must be greater than zero.
	Y	Top coordinate of the button. Must be greater than zero.
	ButtonWidth	Width of the button. Note that this is not the width of the bitmap. It is the width of the button on which the bitmap will be placed
	ButtonHeight	Height of the button. Note that this is not the height of the bitmap. It is the height of the button on which the bitmap will be placed.
	BitmapWidth	Pixel width of the bitmap to be placed on the button.
	BitmapHeight	Pixel height of the bitmap to be placed on the button
	BitmapData_Array	Array of bitmap data. Data is arranged from top line to bottom line, with each line in the form "RGBRGBRGB...RGBRGB" where R,G,B are byte (const char) values representing the Red, Green, and Blue components of each pixel
	UseTransparentColor	TRUE if the bitmap has a transparent color, FALSE otherwise
	TransparentR	Red component of the transparent color. Ignored if UseTransparentColor is FALSE
	TransparentG	Green component of the transparent color. Ignored if UseTransparentColor is FALSE
	TransparentB	Blue component of the transparent color. Ignored if UseTransparentColor is FALSE
	ButtonCallback	Function that performs a user-defined operation whcn clicked. For more information, see TecGUIVoidCallback_pf

Returns:: The ID of the bitmap button.

Fortran Syntax:

    INTEGER*4 FUNCTION TecGUIBitmapButtonAdd(
         ParentDialogID,
         X,
         Y,
         ButtonWidth,
         ButtonHeight,
         BitmapWidth,
         BitmapHeight,
         BitmapData_Array,
         UseTransparentColor,
         TransparentR,
         TransparentG,
         TransparentB,
         ButtonCallback)
    INTEGER*4 ParentDialogID
    INTEGER*4 X
    INTEGER*4 Y
    INTEGER*4 ButtonWidth
    INTEGER*4 ButtonHeight
    INTEGER*4 BitmapWidth
    INTEGER*4 BitmapHeight
    CHARACTER*(*) BitmapData_Array
    INTEGER*4 UseTransparentColor
    INTEGER*4 TransparentR
    INTEGER*4 TransparentG
    INTEGER*4 TransparentB
    POINTER (ButtonCallbackPtr, ButtonCallback)

Python Syntax:

    This function is not supported in Python.

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.

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.

Parameters:

	ParentDialogID	ID of the parent dialog, sidebar, form page, or tab page
	X	Left coordinate of the button. Must be greater than zero.
	Y	Top coordinate of the button. Must be greater than zero.
	ButtonWidth	Width of the button. Note that this is not the width of the bitmap. It is the width of the button on which the bitmap will be placed
	ButtonHeight	Height of the button. Note that this is not the height of the bitmap. It is the height of the button on which the bitmap will be placed.
	BitmapWidth	Pixel width of the bitmap to be placed on the button.
	BitmapHeight	Pixel height of the bitmap to be placed on the button
	BitmapData_Array	Array of bitmap data. Data is arranged from top line to bottom line, with each line in the form "RGBRGBRGB...RGBRGB" where R,G,B are byte (const char) values representing the Red, Green, and Blue components of each pixel
	UseTransparentColor	TRUE if the bitmap has a transparent color, FALSE otherwise
	TransparentR	Red component of the transparent color. Ignored if UseTransparentColor is FALSE
	TransparentG	Green component of the transparent color. Ignored if UseTransparentColor is FALSE
	TransparentB	Blue component of the transparent color. Ignored if UseTransparentColor is FALSE
	ValueChangedCallback	Function that performs a user-defined operation whcn clicked. For more information, see TecGUIVoidCallback_pf

Returns:: The ID of the bitmap toggle button.

Fortran Syntax:

    INTEGER*4 FUNCTION TecGUIBitmapToggleAdd(
         ParentDialogID,
         X,
         Y,
         ButtonWidth,
         ButtonHeight,
         BitmapWidth,
         BitmapHeight,
         BitmapData_Array,
         UseTransparentColor,
         TransparentR,
         TransparentG,
         TransparentB,
         ValueChangedCallback)
    INTEGER*4 ParentDialogID
    INTEGER*4 X
    INTEGER*4 Y
    INTEGER*4 ButtonWidth
    INTEGER*4 ButtonHeight
    INTEGER*4 BitmapWidth
    INTEGER*4 BitmapHeight
    CHARACTER*(*) BitmapData_Array
    INTEGER*4 UseTransparentColor
    INTEGER*4 TransparentR
    INTEGER*4 TransparentG
    INTEGER*4 TransparentB
    POINTER (ValueChangedCallbackPtr, ValueChangedCallback)

Python Syntax:

    This function is not supported in Python.

void TecGUIBlockForModalDialog ( Boolean_t * DoneWithModalDialog )

Call this function if your code is structured such that it must wait for a modal dialog to close.

Note:: Calls to this function cannot be nested if the modal dialog launches its own modal dialogs. It is only valid for a single modal dialog and will issue an error if it is called when there is more than one modal dialog being displayed.

Parameters:

DoneWithModalDialog

Pointer to a boolean variable which the add-on sets to TRUE to stop blocking. Typically this is done by the add-on in the OK and Cancel callback functions.

Fortran Syntax:

    SUBROUTINE TecGUIBlockForModalDialog(DoneWithModalDialog)
    INTEGER*4 DoneWithModalDialog

Python Syntax:

    This function is not supported in Python.

Launch and block a modal dialog.

   Boolean_t DoneWithModalDialog = FALSE
   
    {
       BuildDialog1(MAINDIALOGID);
       TecGUIDialogLaunch(Dialog1Manager);
   
       // Will not return until DoneWithModalDialog is TRUE.
       // In the OK and Cancel dialog callbacks set DoneWithModalDialog to TRUE
       TecGUIBlockForModalDialog(&DoneWithModalDialog);
   
       TecUtilDialogMessageBox("Finished blocking.",MessageBox_Information);
     }

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.

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.

Parameters:

	ParentDialogID	ID of the parent dialog. This must be a valid dialog ID
	X	Left coordinate of the button in character width units relative to the dialog. Must be greater than or equal to zero
	Y	Top coordinate of the button in character height units relative to the dialog. Must be greater than or equal to zero
	Width	Width of the button in character width units. Must be greater than or equal to zero
	Height	Height of the button in character height units. Must be greater than or equal to zero
	LabelString	Label of the button. Must not be NULL
	ButtonCallback	Function that performs a user-defined operation when clicked. See TecGUIVoidCallback_pf for a definition example

Returns:: The identifier of the button.

Fortran Syntax:

    INTEGER*4 FUNCTION TecGUIButtonAdd(
         ParentDialogID,
         X,
         Y,
         Width,
         Height,
         LabelString,
         ButtonCallback)
    INTEGER*4 ParentDialogID
    INTEGER*4 X
    INTEGER*4 Y
    INTEGER*4 Width
    INTEGER*4 Height
    CHARACTER*(*) LabelString
    POINTER (ButtonCallbackPtr, ButtonCallback)

Python Syntax:

    This function is not supported in Python.

void TecGUIButtonSetDefault	(	LgIndex_t	DialogID,
		LgIndex_t	ButtonID
	)

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.

Parameters:

	DialogID	ID of the dialog for which the default action is to be reassigned
	ButtonID	ID of the button to receive the default action

Fortran Syntax:

    SUBROUTINE TecGUIButtonSetDefault(
         DialogID,
         ButtonID)
    INTEGER*4 DialogID
    INTEGER*4 ButtonID

Python Syntax:

    This function is not supported in Python.

void TecGUIButtonSetText	(	LgIndex_t	ButtonID,
		const char *	NewText
	)

Sets the text of a button control.

Parameters:

	ButtonID	ID of the button
	NewText	New text for the button. This parameter cannot be NULL

Fortran Syntax:

    SUBROUTINE TecGUIButtonSetText(
         ButtonID,
         NewText)
    INTEGER*4 ButtonID
    CHARACTER*(*) NewText

Python Syntax:

    This function is not supported in Python.

LgIndex_t TecGUIColoredButtonAdd	(	LgIndex_t	ParentDialogID,
		LgIndex_t	X,
		LgIndex_t	Y,
		LgIndex_t	Width,
		LgIndex_t	Height,
		const char *	LabelString,
		ColorIndex_t	ColorIndex,
		TecGUIVoidCallback_pf	ButtonCallback
	)

Adds a colored button to a dialog.

You must call this function before calling TecGUIDialogLaunch().

Since:: 10.0-6-008

Note:: TGB automatically generates code that uses this function. Only under rare circumstances will you need to call this function directly yourself.

Parameters:

	ParentDialogID	ID of the parent dialog. This must be a valid dialog ID
	X	Left coordinate of the button in character width units relative to the dialog. Must be greater than or equal to zero
	Y	Top coordinate of the button in character height units relative to the dialog. Must be greater than or equal to zero
	Width	Width of the button in character width units. Must be greater than or equal to zero
	Height	Height of the button in character height units. Must be greater than or equal to zero
	LabelString	Label of the button. Must not be NULL
	ColorIndex	Index of the color for the button to be initialized with. Must not be InvalidColor_C.
	ButtonCallback	Function that performs a user-defined operation when clicked. See TecGUIVoidCallback_pf for a definition example

Returns:: The identifier of the button.

Fortran Syntax:

    INTEGER*4 FUNCTION TecGUIColoredButtonAdd(
         ParentDialogID,
         X,
         Y,
         Width,
         Height,
         LabelString,
         ColorIndex
         ButtonCallback)
    INTEGER*4 ParentDialogID
    INTEGER*4 X
    INTEGER*4 Y
    INTEGER*4 Width
    INTEGER*4 Height
    CHARACTER*(*) LabelString
    INTEGER*4 ColorIndex
    POINTER (ButtonCallbackPtr, ButtonCallback)

Python Syntax:

    This function is not supported in Python.

void TecGUIColoredButtonSetColor	(	LgIndex_t	ButtonID,
		ColorIndex_t	Color
	)

Sets background color of a button.

Since:: 10.0-6-0

Parameters:

	ButtonID	ID of the colored button widget. The button should have been created as <<COLORED;>&gt.
	Color	Color index. Fortran Syntax: SUBROUTINE TecGUIButtonSetColor( ButtonID, Color) INTEGER4 ButtonID INTEGER4 Color

Python Syntax:

    This function is not supported in Python.

void TecGUIDialogApplySetSensitivity	(	LgIndex_t	DialogID,
		Boolean_t	IsSensitive
	)

Sets the sensitivity of the Apply button in a dialog.

Note:: 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.

Parameters:

	DialogID	ID of the dialog for which the default action is to be reassigned
	IsSensitive	Indicates if the Apply button should be made sensitive or not

Fortran Syntax:

    SUBROUTINE TecGUIDialogApplySetSensitivity(
         DialogID,
         IsSensitive)
    INTEGER*4 DialogID
    INTEGER*4 IsSensitive

Python Syntax:

    This function is not supported in Python.

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.

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.

Parameters:

	ParentDialogID	ID of the parent dialog. You can also pass MAINDIALOGID for this parameter
	Width	Width in character width units. Must be greater than or equal to zero
	Height	Height in character height units. Must be greater than or equal to zero
	Title	Caption of the dialog. Must not be NULL
	InitCallback	Function that performs a user-defined operation immediately before the dialog is displayed. See TecGUIVoidCallback_pf for a definition example. If this parameter is NULL no intialization function will be called. The dialog will not be displayed until TecGUIDialogLaunch is called.
	OkButtonCallback	Function that performs a user-defined operation when OK is clicked.
	ApplyButtonCallback	Function that performs a user-defined operation when the dialog's Apply button is clicked. If this option is NULL the Apply button is not added.
	CancelButtonCallback	Function that performs a user-defined operation when Cancel is clicked. See TecGUIVoidCallback_pf for a definition example. If this parameter is NULL the Cancel button is not added
	HelpButtonCallback	Function that performs a user-defined operation when Help is clicked. See TecGUIVoidCallback_pf for a definition example. If this parameter is NULL the Help button is not added.

Returns:: Dialog ID.

Fortran Syntax:

    INTEGER*4 FUNCTION TecGUIDialogCreateModal(
         ParentDialogID,
         Width,
         Height,
         Title,
         InitCallback,
         OkButtonCallback,
         ApplyButtonCallback,
         CancelButtonCallback,
         HelpButtonCallback)
    INTEGER*4 ParentDialogID
    INTEGER*4 Width
    INTEGER*4 Height
    CHARACTER*(*) Title
    POINTER (InitCallbackPtr, InitCallback)
    POINTER (OkButtonCallbackPtr, OkButtonCallback)
    POINTER (ApplyButtonCallbackPtr, ApplyButtonCallback)
    POINTER (CancelButtonCallbackPtr, CancelButtonCallback)
    POINTER (HelpButtonCallbackPtr, HelpButtonCallback)

Python Syntax:

    This function is not supported in Python.

LgIndex_t TecGUIDialogCreateModeless	(	LgIndex_t	ParentDialogID,
		LgIndex_t	Width,
		LgIndex_t	Height,
		const char *	Title,

Tecplot GUI Builder

Functions

Function Documentation