AFXMainWindow

This class is responsible for constructing the components of the main window. It also provides accessors for the various components constructed.


AFXMainWindow(app, title, icon=None, miniIcon=None, opts=DECOR_ALL, x=0, y=0, w=0, h=0)

Constructor.

ArgumentTypeDefaultDescription
appFXApp FXApp object.
titleString Main window title.
iconFXIconNoneMain window icon.
miniIconFXIconNoneMinimized icon.
optsIntDECOR_ALLMain window options.
xInt0X location of the main window.
yInt0Y location of the main window.
wInt0Width of the main window.
hInt0Height of the main window.


appendApplicableModuleForTreeTab(name, displayedName)

Appends a module name to the list of modules to which a tree tab is applicable.

ArgumentTypeDefaultDescription
nameString Name of the tab item.
displayedNameString Module name to be appended to the list of the tab's applicable modules.


appendTreeTab(text, name)

Appends a new tab item to the tree toolset tab book and returns a vertical frame managed by the new tab item; you must call create() on the vertical frame after you construct all its child widgets.

ArgumentTypeDefaultDescription
textString Text to be shown in the new tab item.
nameString Name of the new tab item.


appendVisibleModuleForTreeTab(name, displayedName)

Appends a module to the list of modules in which a tree tab is visible.

ArgumentTypeDefaultDescription
nameString Name of the tab item.
displayedNameString Module name to be appended to the list of the tab's modules in which it is visible.


create()

Virtual base class method for creating windowing system resources.

Reimplemented from FXTopWindow.


getContextBar()

Returns a pointer to the context bar container.


getCurrentTreeTab()

Returns the current tab item.


getDefaultHeight()

Returns the default main window height.

Reimplemented from FXTopWindow.


getDefaultWidth()

Returns the default main window width.

Reimplemented from FXTopWindow.


getDisplayedNameAtIndex(index)

Returns the displayed name at the given position in the list.

ArgumentTypeDefaultDescription
indexInt Position in the module list.


getDrawingAreaHeight()

Returns the height of the drawing area in pixels.


getDrawingAreaWidth()

Returns the width of the drawing area in pixels.


getHelpToolset()

Returns a pointer to the help toolset.


getMenubar()

Returns a pointer to the menubar.


getModule(name)

Returns the module specified by the given name argument.

ArgumentTypeDefaultDescription
nameString A String that specifies the module to get.


getModuleName(displayedName)

Returns the module name for the given displayed name.

ArgumentTypeDefaultDescription
displayedNameString Displayed module name (English).


getNumModules()

Returns the number of modules.


getPluginToolset()

Returns the Plugin toolset.


getSelectorFromFunction(function)

Returns the selector of the given shortcut function. Throws exception if not found.

ArgumentTypeDefaultDescription
functionString A String specifying the function as shown in the Customize dialog box.


getTargetFromFunction(function)

Returns the target of the given shortcut function. Throws exception if not found.

ArgumentTypeDefaultDescription
functionString A String specifying the function as shown in the Customize dialog box.


getToolbox()

Returns a pointer to the module toolbox container.


getToolMenuPane()

Returns a pointer to the tools menu pane.


getToolMenuTitle()

Returns a pointer to the Tools menu title.


getToolset(name)

Returns the toolset specified by the given name argument.

ArgumentTypeDefaultDescription
nameString A String in the local language that specifies to toolset to get.


getToolsetKernelInitializationCommands()

Returns the command string that should initialize the toolsets in the kernel that are corresponding to the toolsets registered with the main window.


getWorkDirectory()

Returns the current working directory.


hideCli()

Hides the command line interface.


hideMessageArea()

Hides the message area interface.


makeCustomToolsets()

This method has no base class implementation; it may be used by customizers to construct Abaqus/CAE toolsets or toolsets derived from Abaqus/CAE toolsets; constructing those toolsets in this method is necessary to insure that the toolset will be available to standard Abaqus/CAE modules that register that toolset, and to avoid creating duplicate widgets when the toolset is used by a custom toolset.


registerHelpToolset(tool, opts)

Registers the Help toolset.

ArgumentTypeDefaultDescription
toolAFXToolsetGui Pointer to toolset being registered.
optsInt Options for creating toolset GUI components.


registerModule(displayedName, moduleName)

Registers a module to make it available in the module combo; Uses predefined initialization strings for Abaqus modules.

ArgumentTypeDefaultDescription
displayedNameString English Name of the module.
moduleNameString Python module name.


registerModule(displayedName, moduleName, kernelInitializationCommand)

Registers a module to make it available in the module combo; also registers the initialization string to be sent to the kernel the first time the module is loaded.

ArgumentTypeDefaultDescription
displayedNameString English Name of the module.
moduleNameString Python module name.
kernelInitializationCommandString Python command sent to kernel on module load


registerToolset(tool, opts)

Registers a toolset that is always available in the main window.

ArgumentTypeDefaultDescription
toolAFXGuiObjectManager Pointer to the object being registered.
optsInt Options for creating toolset GUI components.


setApplicabilityForTreeTab(name, moduleNames)

Sets the modules that are applicable to the given tree tab. When switching modules, if the current tab is applicable to the new module, it will remain current. When a tree tab is created, it is applicable to all modules--use this method to set the applicability to only certain modules.

ArgumentTypeDefaultDescription
nameString Name of the tab item.
moduleNamesString A String containing module names separated by commas.


setCurrentTreeTab(name)

Sets the tree toolset tab book's current tab item to the tab item specified by the given name.

ArgumentTypeDefaultDescription
nameString Name of the tab item to be set current.


setVisibilityForTreeTab(name, moduleNames)

Sets the modules in which a tree tab is visible. When switching modules, if the tab has not been specified to be visible in the new module, the tab will be hidden; otherwise it will be shown. When a tree tab is created it is visible in all modules--use this method to set the visibility to only certain modules.

ArgumentTypeDefaultDescription
nameString Name of the tab item.
moduleNamesString A String containing module names separated by commas.


setWorkDirectory(directory)

Sets the current working directory.

ArgumentTypeDefaultDescription
directoryString A String specifying the new work directory.


showCli()

Shows the command line interface.


showMessageArea()

Shows the message area interface.


writeToMessageArea(message)

Writes a string to the message area.

ArgumentTypeDefaultDescription
messageString  


Class flags

Message ID's.

ID_QUIT

Used to handle the quit message.

ID_TAB

Used to handle tabbing.

ID_TOGGLE_MODEL_TREE

Toggle the visibility of the model tree.

ID_LAST

Do not use, do not delete; for use by derived classes.