Main Page   File List   Globals  

TECGUI.h

Go to the documentation of this file.
00001 
00004 /*
00005 ******************************************************************
00006 ******************************************************************
00007 *******                                                   ********
00008 ******  (C) 1988-2004 Tecplot, Inc.                        *******
00009 *******                                                   ********
00010 ******************************************************************
00011 ******************************************************************
00012 */
00013 #if defined EXTERN
00014 #undef EXTERN
00015 #endif
00016 #if defined TECUTILGMODULE
00017 #define EXTERN
00018 #else
00019 #define EXTERN extern
00020 #endif
00021 
00022 /*{{<exclude_fglue> 
00023   TecGUIListGetSelectedItems
00024   TecGUIListSetSelectedItems
00025 
00026   </exclude_fglue> }}*/
00027 
00043 typedef LgIndex_t (*TecGUITextCallback_pf)   (const char *TextString);
00054 typedef void      (*TecGUIIntCallback_pf)    (const LgIndex_t *Data);
00059 typedef void      (*TecGUIVoidCallback_pf)   (void);
00060 
00061 #define MAINDIALOGID          -1
00062 #define BADDIALOGID           -2
00063 #define BADGUIID              BADDIALOGID
00064 #define TECGUITECPLOTSIDEBAR  -3
00065 /* CORE SOURCE CODE REMOVED */
00066 
00067 
00068 /* CORE SOURCE CODE REMOVED */
00069 
00108 void TecGUIDialogEnableActionArea(LgIndex_t DialogID,
00109                                                       Boolean_t EnableActionArea);
00137 void TecGUIDialogApplySetSensitivity(LgIndex_t DialogID,
00138                                                          Boolean_t IsSensitive);
00165 void TecGUIDialogSetTopmost(LgIndex_t DialogID,
00166                                                 Boolean_t MakeTopmost);
00167 
00223 void TecGUIDialogSetLaunchPosition(LgIndex_t         DialogID,
00224                                                        AnchorAlignment_e Placement,
00225                                                        LgIndex_t         OffsetX,
00226                                                        LgIndex_t         OffsetY);
00227 
00228 
00229 
00432 void TecGUIDialogSetLaunchPositionX(ArgList_pa ArgList);
00433 
00434 
00435 
00436 
00437 
00496 LgIndex_t TecGUIDialogCreateModeless(LgIndex_t              ParentDialogID,
00497                                                          LgIndex_t              Width,
00498                                                          LgIndex_t              Height,
00499                                                          const char            *Title,
00500                                                          TecGUIVoidCallback_pf  InitCallback,
00501                                                          TecGUIVoidCallback_pf  CloseButtonCallback,
00502                                                          TecGUIVoidCallback_pf  HelpButtonCallback);
00503 
00572 LgIndex_t TecGUIDialogCreateModal(LgIndex_t              ParentDialogID,
00573                                                       LgIndex_t              Width,
00574                                                       LgIndex_t              Height,
00575                                                       const char            *Title,
00576                                                       TecGUIVoidCallback_pf  InitCallback,
00577                                                       TecGUIVoidCallback_pf  OkButtonCallback,
00578                                                       TecGUIVoidCallback_pf  ApplyButtonCallback,
00579                                                       TecGUIVoidCallback_pf  CancelButtonCallback,
00580                                                       TecGUIVoidCallback_pf  HelpButtonCallback);
00581 
00621 void TecGUIBlockForModalDialog(Boolean_t *DoneWithModalDialog);
00622 
00675 LgIndex_t TecGUIButtonAdd(LgIndex_t              ParentDialogID,
00676                                               LgIndex_t              X,
00677                                               LgIndex_t              Y,
00678                                               LgIndex_t              Width,
00679                                               LgIndex_t              Height,
00680                                               const char            *LabelString,
00681                                               TecGUIVoidCallback_pf  ButtonCallback);
00682 
00767 LgIndex_t TecGUIBitmapButtonAdd(LgIndex_t              ParentDialogID,
00768                                                     LgIndex_t              X,
00769                                                     LgIndex_t              Y,
00770                                                     LgIndex_t              ButtonWidth,
00771                                                     LgIndex_t              ButtonHeight,
00772                                                     LgIndex_t              BitmapWidth,
00773                                                     LgIndex_t              BitmapHeight,
00774                                                     const char            *BitmapData_Array,
00775                                                     Boolean_t              UseTransparentColor,
00776                                                     LgIndex_t              TransparentR,
00777                                                     LgIndex_t              TransparentG,
00778                                                     LgIndex_t              TransparentB,
00779                                                     TecGUIVoidCallback_pf  ButtonCallback);
00780 
00867 LgIndex_t TecGUIBitmapToggleAdd(LgIndex_t             ParentDialogID,
00868                                                     LgIndex_t             X,
00869                                                     LgIndex_t             Y,
00870                                                     LgIndex_t             ButtonWidth,
00871                                                     LgIndex_t             ButtonHeight,
00872                                                     LgIndex_t             BitmapWidth,
00873                                                     LgIndex_t             BitmapHeight,
00874                                                     const char           *BitmapData_Array,
00875                                                     Boolean_t             UseTransparentColor,
00876                                                     LgIndex_t             TransparentR,
00877                                                     LgIndex_t             TransparentG,
00878                                                     LgIndex_t             TransparentB,
00879                                                     TecGUIIntCallback_pf  ValueChangedCallback);
00880 
00902 void TecGUISetToolTip(LgIndex_t   ControlID,
00903                                           const char *ToolTipText);
00925 void TecGUISetStatusLine(LgIndex_t   ControlID,
00926                                              const char *StatusLineText);
00927 
00928 
00929 
00954 void TecGUIButtonSetDefault(LgIndex_t DialogID,
00955                                                 LgIndex_t ButtonID);
00977 void TecGUIButtonSetText(LgIndex_t   ButtonID,
00978                                              const char *NewText);
00979 
00980 
00981 
00982 
01004 void TecGUISetSensitivity(LgIndex_t ControlID,
01005                                               Boolean_t IsSensitive);
01006 
01028 void TecGUISetVisibility(LgIndex_t ControlID,
01029                                              Boolean_t MakeVisible);
01030 
01085 LgIndex_t TecGUIOptionMenuAdd(LgIndex_t             ParentDialogID,
01086                                                   LgIndex_t             X,
01087                                                   LgIndex_t             Y,
01088                                                   LgIndex_t             Width,
01089                                                   LgIndex_t             Height,
01090                                                   const char           *OptionList,
01091                                                   TecGUIIntCallback_pf  ValueChangedCallback);
01092 
01111 void TecGUIOptionMenuSet(LgIndex_t OptionMenuID,
01112                                              LgIndex_t Selection);
01113 
01133 LgIndex_t TecGUIOptionMenuSetByString(LgIndex_t   OptionMenuID,
01134                                                           const char *Name);
01135 
01151 LgIndex_t TecGUIOptionMenuGet(LgIndex_t OptionMenuID);
01152 
01153 
01209 LgIndex_t TecGUIListAdd(LgIndex_t            ParentDialogID,
01210                                             LgIndex_t            X,
01211                                             LgIndex_t            Y,
01212                                             LgIndex_t            Width,
01213                                             LgIndex_t            Height,
01214                                             Boolean_t            IsMultiSelection,
01215                                             TecGUIIntCallback_pf ValueChangedCallback);
01216 
01217 
01218 
01234 LgIndex_t TecGUIListGetItemCount(LgIndex_t ListID);
01235 
01257 void TecGUIListAppendItem(LgIndex_t   ListID,
01258                                               const char *Item);
01259 
01286 char * TecGUIListGetString(LgIndex_t ListID,
01287                                                LgIndex_t Position);
01288 
01315 void TecGUIListReplaceItem(LgIndex_t   ListID,
01316                                                const char *Item,
01317                                                LgIndex_t   Position);
01318 
01334 void TecGUIListDeleteAllItems(LgIndex_t ListID);
01335 
01357 void TecGUIListDeleteItemAtPos(LgIndex_t ListID,
01358                                                    LgIndex_t Position);
01359 
01375 void TecGUIListDeselectAllItems(LgIndex_t ListID);
01376 
01398 void TecGUIListSetSelectedItem(LgIndex_t ListID,
01399                                                    LgIndex_t Position);
01400 
01438 void TecGUIListGetSelectedItems(LgIndex_t   ListID, 
01439                                                     LgIndex_t **SelectedItemList,
01440                                                     LgIndex_t  *SelectedItemCount);
01441 
01458 void TecGUIListSetSelectedItems(LgIndex_t  ListID,
01459                                                     LgIndex_t *SelectedItemList,
01460                                                     LgIndex_t  SelectedItemCount);
01461 
01478 LgIndex_t TecGUIListGetSelectedItem(LgIndex_t ListID);
01479 
01496 void TecGUIListSelectAllItems(LgIndex_t ListID);
01497 
01498 
01551 LgIndex_t TecGUIToggleAdd(LgIndex_t             ParentDialogID,
01552                                               LgIndex_t             X,
01553                                               LgIndex_t             Y,
01554                                               LgIndex_t             Width,
01555                                               LgIndex_t             Height,
01556                                               const char           *Label,
01557                                               TecGUIIntCallback_pf  ValueChangedCallback);
01558 
01580 void TecGUIToggleSet(LgIndex_t ToggleID,
01581                                          Boolean_t SetOn);
01582 
01583 
01584 
01600 Boolean_t TecGUIToggleGet(LgIndex_t ToggleID);
01601 
01676 LgIndex_t TecGUIRadioBoxAdd(LgIndex_t             ParentDialogID,
01677                                                 LgIndex_t             X,
01678                                                 LgIndex_t             Y,
01679                                                 LgIndex_t             Width,
01680                                                 LgIndex_t             Height,
01681                                                 const char           *Label1,
01682                                                 const char           *Label2,
01683                                                 const char           *Label3,
01684                                                 const char           *Label4,
01685                                                 const char           *Label5,
01686                                                 TecGUIIntCallback_pf  ValueChangedCallback);
01687 
01706 void TecGUIRadioBoxSetToggle(LgIndex_t RadioBox,
01707                                                  LgIndex_t ToggleNumber);
01708 
01709 
01725 LgIndex_t TecGUIRadioBoxGetToggle(LgIndex_t RadioBox);
01726 
01762 LgIndex_t TecGUILabelAdd(LgIndex_t   ParentDialogID,
01763                                              LgIndex_t   X,
01764                                              LgIndex_t   Y,
01765                                              const char *Label);
01766 
01788 void TecGUILabelSetText(LgIndex_t   LabelID,
01789                                             const char *LabelString);
01790 
01812 void TecGUILabelSetLgIndex(LgIndex_t LabelID,
01813                                                LgIndex_t Value);
01814 
01842 void TecGUILabelSetDouble(LgIndex_t   LabelID,
01843                                               double      Value,
01844                                               const char *Format);
01845 
01872 void TecGUILabelSetSet(LgIndex_t LabelID,
01873                                            Set_pa    Set,
01874                                            Boolean_t IncludeSquareBrackets);
01875 
01922 LgIndex_t TecGUITextFieldAdd(LgIndex_t             ParentDialogID,
01923                                                  LgIndex_t             X,
01924                                                  LgIndex_t             Y,
01925                                                  LgIndex_t             Width,
01926                                                  LgIndex_t             Height,
01927                                                  TecGUITextCallback_pf ValueChangedCallback);
01928 
01980 LgIndex_t TecGUITextAdd(LgIndex_t             ParentDialogID,
01981                                             LgIndex_t             X,
01982                                             LgIndex_t             Y,
01983                                             LgIndex_t             Width,
01984                                             LgIndex_t             Height,
01985                                             Boolean_t             IsReadOnly,
01986                                             TecGUITextCallback_pf ValueChangedCallback);
02015 void TecGUITextSetInsertPos(LgIndex_t Text,
02016                                                 LgIndex_t Position);
02033 void TecGUITextSetMinInsertPos(LgIndex_t Text);
02051 void TecGUITextSetMaxInsertPos(LgIndex_t Text);
02074 void TecGUITextSetString(LgIndex_t   Text,
02075                                              const char *TextString);
02098 char * TecGUITextGetString(LgIndex_t Text);
02122 void TecGUITextInsertString(LgIndex_t   Text,
02123                                                 const char *TextString);
02192 LgIndex_t TecGUIScaleAdd(LgIndex_t            ParentDialogID,
02193                                              LgIndex_t            X,
02194                                              LgIndex_t            Y,
02195                                              LgIndex_t            Width,
02196                                              LgIndex_t            Height,
02197                                              LgIndex_t            ScaleMin,
02198                                              LgIndex_t            ScaleMax,
02199                                              LgIndex_t            DecimalPrecision,
02200                                              TecGUIIntCallback_pf ValueChangedCallback,
02201                                              TecGUIIntCallback_pf DragValueChangedCallback);
02202 
02224 void TecGUIScaleSetValue(LgIndex_t ScaleID,
02225                                              LgIndex_t NewValue);
02226 
02258 void TecGUIScaleSetLimits(LgIndex_t ScaleID,
02259                                               LgIndex_t ScaleMin,
02260                                               LgIndex_t ScaleMax,
02261                                               LgIndex_t DecimalPrecision);
02262 
02278 LgIndex_t TecGUIScaleGetValue(LgIndex_t ScaleID);
02279 
02315 LgIndex_t TecGUIVertSeparatorAdd(LgIndex_t ParentDialogID,
02316                                                      LgIndex_t X,
02317                                                      LgIndex_t Y,
02318                                                      LgIndex_t Height);
02319 
02355 LgIndex_t TecGUIHorzSeparatorAdd(LgIndex_t ParentDialogID,
02356                                                      LgIndex_t X,
02357                                                      LgIndex_t Y,
02358                                                      LgIndex_t Width);
02359 
02407 LgIndex_t TecGUIFrameAdd(LgIndex_t   ParentDialogID,
02408                                              LgIndex_t   X,
02409                                              LgIndex_t   Y,
02410                                              LgIndex_t   Width,
02411                                              LgIndex_t   Height,
02412                                              const char *Label);
02413 
02435 void TecGUITextFieldSetString(LgIndex_t   TextFieldID,
02436                                                   const char *TextString);
02458 char * TecGUITextFieldGetString(LgIndex_t TextFieldID);
02480 Boolean_t TecGUITextFieldGetLgIndex(LgIndex_t  TextFieldID,
02481                                                         LgIndex_t *Value);
02503 Boolean_t TecGUITextFieldGetDouble(LgIndex_t  TextFieldID,
02504                                                        double    *Value);
02546 Boolean_t TecGUITextFieldValidateLgIndex(LgIndex_t   TextFieldID,
02547                                                              const char *TextFieldName,
02548                                                              LgIndex_t   MinDomain,
02549                                                              LgIndex_t   MaxDomain,
02550                                                              Boolean_t   AllowMxSyntax);
02584 Boolean_t TecGUITextFieldValidateDouble(LgIndex_t   TextFieldID,
02585                                                             const char *TextFieldName,
02586                                                             double      MinDomain,
02587                                                             double      MaxDomain);
02614 Boolean_t TecGUITextFieldGetSet(LgIndex_t  TextFieldID,
02615                                                     Set_pa    *Set);
02644 void TecGUITextFieldSetLgIndex(LgIndex_t TextFieldID,
02645                                                    LgIndex_t Value,
02646                                                    Boolean_t UseMx);
02674 void TecGUITextFieldSetDouble(LgIndex_t   TextFieldID,
02675                                                   double      Value,
02676                                                   const char *Format);
02703 void TecGUITextFieldSetSet(LgIndex_t TextFieldID,
02704                                                Set_pa    Set,
02705                                                Boolean_t IncludeSquareBrackets);
02706 
02723 void TecGUIDialogLaunch(LgIndex_t DialogID);
02724 
02743 void TecGUIDialogDrop(LgIndex_t DialogID);
02744 
02760 Boolean_t TecGUIDialogIsUp(LgIndex_t DialogID);
02761 
02783 void TecGUIDialogSetTitle(LgIndex_t   DialogID,
02784                                               const char *NewTitle);
02785 
02807 void TecGUITextAppendString(LgIndex_t   TextID,
02808                                                 const char *TextString);
02809                                             
02825 LgIndex_t TecGUIMenuBarAdd(LgIndex_t ParentDialogID);
02826 
02860 LgIndex_t TecGUIMenuAdd(LgIndex_t   ParentMenuID,
02861                                             const char *Label);
02862 
02895 LgIndex_t TecGUIMenuAddItem(LgIndex_t              ParentMenuID,
02896                                                 const char            *Label,
02897                                                 const char            *StatusLineText,
02898                                                 TecGUIVoidCallback_pf  Callback);
02899 
02934 LgIndex_t TecGUIMenuAddToggle(LgIndex_t             ParentMenuID,
02935                                                   const char           *Label,
02936                                                   const char           *StatusLineText,
02937                                                   TecGUIIntCallback_pf  Callback);
02938 
02954 void TecGUIMenuAddSeparator(LgIndex_t ParentMenuID);
02955 
02977 void TecGUIMenuItemSetText(LgIndex_t   MenuItemID,
02978                                                const char *NewText);
02979 
03001 void TecGUIMenuSetToggle(LgIndex_t MenuItemID,
03002                                              Boolean_t SetOn);
03003 
03019 void TecGUIMenuDeleteItem(LgIndex_t MenuItemID);
03020 
03021 /*** Tabbed dialogs ***/
03072 LgIndex_t TecGUITabAdd(LgIndex_t            ParentDialogID,
03073                                            LgIndex_t            X,
03074                                            LgIndex_t            Y,
03075                                            LgIndex_t            Width,
03076                                            LgIndex_t            Height,
03077                                            TecGUIIntCallback_pf ActivateCallback,
03078                                            TecGUIIntCallback_pf DeactivateCallback);
03079 
03106 LgIndex_t TecGUITabAddPage(LgIndex_t   TabID,
03107                                                const char *Caption);
03108 
03132 void TecGUITabSetCurrentPage(LgIndex_t TabID,
03133                                                  LgIndex_t PageID);
03134 
03135 
03136 
03137 
03138 /*** Forms ***/
03179 LgIndex_t TecGUIFormAdd(LgIndex_t ParentDialogID,
03180                                             LgIndex_t X,
03181                                             LgIndex_t Y,
03182                                             LgIndex_t Width,
03183                                             LgIndex_t Height);
03184 
03203 LgIndex_t TecGUIFormAddPage(LgIndex_t ParentFormID);
03204 
03220 void TecGUIFormSetCurrentPage(LgIndex_t FormID);
03221 
03222 
03223 
03224 /* Spin controls */
03282 LgIndex_t TecGUISpinTextFieldAdd(LgIndex_t             ParentDialogID,
03283                                                      LgIndex_t             X,
03284                                                      LgIndex_t             Y,
03285                                                      LgIndex_t             Width,
03286                                                      LgIndex_t             Height,
03287                                                      TecGUITextCallback_pf ValueChangedCallback,
03288                                                      TecGUIVoidCallback_pf ButtonUpCallback,
03289                                                      TecGUIVoidCallback_pf ButtonDownCallback);
03290 
03326 Boolean_t TecGUISpinTextFieldIncLgIndex(LgIndex_t   SpinTextFieldID,
03327                                                             LgIndex_t   Increment,
03328                                                             LgIndex_t   MinDomain,
03329                                                             LgIndex_t   MaxDomain);
03330 
03373 Boolean_t TecGUISpinTextFieldIncDouble(LgIndex_t   SpinTextFieldID,
03374                                                            const char *Format,
03375                                                            double      Increment,
03376                                                            double      MinDomain,
03377                                                            double      MaxDomain);
03378 
03379 /* Dynamic option menus */
03401 void TecGUIOptionMenuDeleteItemAtPos(LgIndex_t OptionMenuID,
03402                                                          LgIndex_t Position);
03403 
03425 void TecGUIOptionMenuAppendItem(LgIndex_t   OptionMenuID,
03426                                                     const char *Item);
03427 
03443 LgIndex_t TecGUIOptionMenuGetItemCount(LgIndex_t OptionMenuID);
03444 
03460 void TecGUIOptionMenuDeleteAllItems(LgIndex_t OptionMenuID);
03461 
03488 char * TecGUIOptionMenuGetString(LgIndex_t OptionMenuID,
03489                                                      LgIndex_t Position);
03490 
03517 void TecGUIOptionMenuReplaceItem(LgIndex_t   OptionMenuID,
03518                                                      const char *NewText,
03519                                                      LgIndex_t   Position);
03520 
03521 
03522 /* Scale */
03544 void TecGUIScaleShowNumericDisplay(LgIndex_t ScaleID,
03545                                                        Boolean_t ShowDisplay);
03546 
03547 
03548 /* Sidebar */
03595 LgIndex_t TecGUISidebarRegister(const char            *SidebarName,
03596                                                     AddOn_pa               AddOnID,
03597                                                     LgIndex_t              Width,
03598                                                     LgIndex_t              Height,
03599                                                     TecGUIVoidCallback_pf  ActivateCallback,
03600                                                     TecGUIVoidCallback_pf  DeactivateCallback);
03601 
03617 void TecGUISidebarActivate(LgIndex_t SidebarID);
03629 void TecGUISidebarDeactivateAll(void);
03630 
03631 
03653 Boolean_t TecGUISidebarIsActive(LgIndex_t SidebarID);
03654 
03684 LgIndex_t TecGUIListGetCapacity(LgIndex_t ListID);
03708 LgIndex_t TecGUIListGetTopItemNum(LgIndex_t ListID);
03738 void TecGUIListSetTopItemNum(LgIndex_t ListID,
03739                                                  LgIndex_t ItemNum);
03740 
03741 
03742 
03743 
03744 

Generated on Tue May 18 14:14:09 2004 for Tecplot by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002