Plug-in Registration¶

Plug-in commands register kernel and GUI plug-ins in either the Plug-ins menu or in a toolbox. Plug-in registration commands for accessing both kernel and GUI plug-ins are located in the Abaqus GUI Toolkit Reference Guide.

Classes¶

Other Classes¶

class AFXBoolKeyword( command, name, booleanType=-8844662471667249595, isRequired=False, defaultValue=False, )[source]¶

Bases: AFXKeyword

This class is designed for command keywords that have Boolean values.

Member Details:

ON_OFF : --is-rst--:py:class:`int` = -8844662471667249595[source]¶: Keyword value will be ON or OFF.

TRUE_FALSE : --is-rst--:py:class:`int` = 8431788980803087794[source]¶: Keyword value will be True or False.

getTypeName()[source]¶

Returns the name of the keyword type.

Implements AFXKeyword.

getValue()[source]¶: Returns the keyword’s current value.

getValueAsString()[source]¶

Returns the text string that represents the keyword’s current value.

Implements AFXKeyword.

isValueChanged()[source]¶

Returns True if the keyword value differs from its previous value.

Implements AFXKeyword.

setDefaultValue(defaultValue)[source]¶

Sets the keyword’s default value.

Parameters:¶

defaultValue¶: Default value.

setDefaultValueByString(defaultValueString)[source]¶

Sets the keyword’s default value (returns True if the given text string is valid).

Parameters:¶

defaultValueString¶: Default value in text string form.

setValue(newValue)[source]¶

Sets the keyword’s current value.

Parameters:¶

newValue¶: New value.

setValueByString(newValueString)[source]¶

Sets the keyword’s current value (returns True if the given text string is valid).

Parameters:¶

newValueString¶: New value in text string form.

setValueToDefault(ignoreUnspecified=False)[source]¶

Sets the keyword value to its default.

Parameters:¶

ignoreUnspecified=False¶: Not used.

setValueToPrevious()[source]¶

Sets the keyword value to its previous value.

Implements AFXKeyword.

syncPreviousValue()[source]¶

Sets the keyword’s previous value to its current value.

Implements AFXKeyword.

class AFXCommand(mode, method, objectName="''", registerQuery=False)[source]¶

Bases: FXObject

This class is the abstract base class for command classes that are processed by modes.

Member Details:

activate()[source]¶: Activates the command; active commands will be processed during command generation.

deactivate()[source]¶: Deactivates the command; inactive commands will not be processed during command generation.

getCommandString()[source]¶: Returns the command string based on the current values of the active keywords.

getExpandedObjectName()[source]¶: Returns the expanded object name that has all the “%s“‘s replaced by the current names.

getKeyword(index)[source]¶

Returns the keyword at the given index (returns 0 if the index is out-of-bounds).

Parameters:¶

index¶: Keyword index (0-based).

getMethod()[source]¶: Returns the command’s method.

getNumKeywords()[source]¶: Returns the number of keywords.

getObjectName()[source]¶: Returns the object name (which is not expanded and may include “%s“‘s).

isActive()[source]¶: Returns True if the command is active.

isQueryNeeded()[source]¶: Returns True if the command needs to register a query for kernel state.

isRequired()[source]¶: Returns True if this command is going to be sent even if none of its keywords has been modified, otherwise returns False.

setKeywordValuesToDefaults(ignoreUnspecified=False)[source]¶

Sets the values of all keywords to their defaults.

Parameters:¶

ignoreUnspecified=False¶: Ignore setting the value if the default is unspecified.

setKeywordValuesToPrevious()[source]¶: Sets the values of all keywords to their previous values.

setMethod(method)[source]¶

Sets the command’s method.

Parameters:¶

method¶: Method.

setObjectName(objectName)[source]¶

Sets the object name.

Parameters:¶

objectName¶: Object name.

setRequired(val)[source]¶

Sets this command as required or optional; if True the command will always be sent, if False the command will be sent only if it has modified keywords or if it has no keywords.

Parameters:¶

val¶

syncKeywordPreviousValues()[source]¶: Synchronizes the current values and previous values of all keywords.

verify()[source]¶: Throws an exception if any of the keywords contain invalid data.

class AFXKeyword(command, name, isRequired=False)[source]¶

Bases: FXDataTarget

Abaqus.

Member Details:

ID_ACTIVATE : --is-rst--:py:class:`int` = -6637823829108684625[source]¶: Used to activate the keyword.

ID_DEACTIVATE : --is-rst--:py:class:`int` = 6395275405002665179[source]¶: Used to deactivate the keyword.

activate()[source]¶: Activates the keyword; active keywords will be processed during command generation.

deactivate()[source]¶: Deactivates the keyword; inactive keywords will not be processed during command generation.

getCommandSnippet()[source]¶: Returns the command snippet of the keyword based on its current value.

getName()[source]¶: Returns the keyword name.

getSetupCommands()[source]¶: Returns the keyword’s variable initilization commands (part of the generated command string).

getTypeName()[source]¶

Returns the keyword type name.

Implemented in AFXBoolKeyword, AFXComSymConstKeyword, AFXComTableKeyword, AFXFloatKeyword, AFXIntKeyword, AFXObjectKeyword, AFXStringKeyword, AFXSymConstKeyword, AFXTogglableKeyword, AFXTupleKeyword, and AFXTableKeyword.

getValueAsString()[source]¶

Returns the text string that represents the current keyword value.

isActive()[source]¶: Returns True if the keyword is active.

isRequired()[source]¶: Returns True if the keyword is a required argument of the host command; or returns False if the keyword is optional.

isValueChanged()[source]¶

Returns True if the keyword value differs from its previous value.

Implemented in AFXBoolKeyword, AFXComSymConstKeyword, AFXComTableKeyword, AFXFloatKeyword, AFXIntKeyword, AFXObjectKeyword, AFXStringKeyword, AFXTogglableKeyword, and AFXTupleKeyword.

setRequired(val)[source]¶

Sets this object as a required keyword of the host command.

Parameters:¶

val¶

setSetupCommands(cmds)[source]¶

Sets variable initialization commands needed by the keyword.

Parameters:¶

cmds¶

setValueToDefault(ignoreUnspecified=False)[source]¶

Sets the keyword value to its default.

Parameters:¶

ignoreUnspecified=False¶: Ignore setting the value if the default is unspecified.

setValueToPrevious()[source]¶

Sets the keyword value to its previous value.

Implemented in AFXBoolKeyword, AFXComSymConstKeyword, AFXComTableKeyword, AFXFloatKeyword, AFXIntKeyword, AFXObjectKeyword, AFXStringKeyword, AFXTogglableKeyword, and AFXTupleKeyword.

syncPreviousValue()[source]¶

Sets the keyword’s previous value to its current value.

Implemented in AFXBoolKeyword, AFXComSymConstKeyword, AFXComTableKeyword, AFXFloatKeyword, AFXIntKeyword, AFXObjectKeyword, AFXStringKeyword, AFXTogglableKeyword, and AFXTupleKeyword.

class AFXColumnItems(referenceColumn, tgt=None, sel=0, opts=0)[source]¶

Bases: FXObject

Abaqus.

Member Details:

getReferenceColumn()[source]¶: Returns the index of the table reference column.

getSelector()[source]¶: Returns the message ID.

getTarget()[source]¶: Returns the message target.

setReferenceColumn(index)[source]¶

Sets the table reference column, whose selected items will be sent to the target.

Parameters:¶

index¶: Table column index.

setSelector(sel)[source]¶

Sets the message ID.

Parameters:¶

sel¶: New message ID.

setTarget(tgt)[source]¶

Sets the message target.

Parameters:¶

tgt¶: New message target.

class FXObject[source]¶

Bases: object

Base of all FOX object.

Member Details:

getClassName()[source]¶: Get class name of some object.

handle(sender, sel, ptr)[source]¶

Handles messages sent to this class.

Parameters:¶

sender¶: The sender of the message.
sel¶: The selector of the message.
ptr¶: Associated data.

isMemberOf(metaclass)[source]¶

Check if object is member of metaclass.

Parameters:¶

metaclass¶

onDefault()[source]¶

Called for unhandled messages.

Reimplemented in FXDelegator, FXGLViewer, FXMDIChild, and FXMDIClient.

class AFXComTableKeyword(command, name, isRequired=False, minLength=0, maxLength=-1, opts=0)[source]¶

Bases: AFXKeyword

This class manages values which are sent as tables in a command.

Member Details:

ID_PRINTSNIPPET : --is-rst--:py:class:`int` = 932779659422221073[source]¶: For debugging.

ID_TABLE : --is-rst--:py:class:`int` = -3582227856768922111[source]¶: ID for AFXTable widgets.

ID_VALUE : --is-rst--:py:class:`int` = 9069971876367834452[source]¶: ID for widgets exchanging array strings.

equal(index, a, b)[source]¶

Returns True if the two table element values compare equal (index not used).

Parameters:¶

index¶: Element index (not used).
a¶: First value.
b¶: Second value.

getColumnStyle(index)[source]¶

Returns the style of the column elements. Will never return AFXTABLE_STYLE_DEFAULT!

Parameters:¶

index¶: Column index.

getColumnType(index)[source]¶

Returns the type of the column elements. Will never return AFXTABLE_TYPE_DEFAULT!

Parameters:¶

index¶: Column index.

getDefaultStyle()[source]¶: Returns the default style for the table elements.

getDefaultType()[source]¶: Returns the default type for the table elements.

getDefaultValues()[source]¶: Returns the default values for this table.

getFormattedValue(row, column)[source]¶

Returns the formatted value of the table element, suitable for placing in a command. If the element has AFXTABLE_EVALUATE style, and its contents are invalid, an exception will be thrown.

Parameters:¶

row¶: Row index.
column¶: Column index.

getMaxNumColumns()[source]¶: Returns the maximum number of columns, or -1 for unbounded.

getMinNumColumns()[source]¶: Returns the minimum number of columns.

getNumColumns(row)[source]¶

Returns the number of columns in the row.

Parameters:¶

row¶: Row index.

getNumRows()[source]¶: Returns the number of rows in the table.

getRow(row)[source]¶

Returns a string with the contents of a table row.

Parameters:¶

row¶: Row index.

getTypeName()[source]¶

Returns the name of the table keyword type.

Implements AFXKeyword. Reimplemented in AFXTableKeyword.

getValue(row, column)[source]¶

Returns the value of a table element.

Parameters:¶

row¶: Row index.
column¶: Column index.

getValueAsDouble()[source]¶: Returns the keyword’s value as a float; returns False upon failure.

getValueAsInt()[source]¶: Returns the keyword’s value as an integer; returns False upon failure.

getValueAsString()[source]¶

Returns the formatted string that represents the current keyword value in a command.

Implements AFXKeyword.

getValueForBlank(column)[source]¶

Returns the element value substituted for blank for the column.

Parameters:¶

column¶: Column index.

getValues()[source]¶

Returns a string containing values of the tuple elements.

as entered by the user.

getValuesForBlanks()[source]¶: Returns a string with values substituted for blanks for all table columns.

insertColumns(index, numColumns)[source]¶

Inserts columns starting at the given index.

Parameters:¶

index¶: Starting index.
numColumns¶: Number of columns to insert.

insertRows(index, numRows)[source]¶

Inserts rows starting at the given index.

Parameters:¶

index¶: Starting index.
numRows¶: Number of rows to insert.

isValueChanged()[source]¶

Returns True if the keyword value differs from its previous value.

Implements AFXKeyword.

removeColumns(index, numColumns)[source]¶

Removes columns starting at the given index.

Parameters:¶

index¶: Starting index.
numColumns¶: Number of columns to remove.

removeRows(index, numRows)[source]¶

Removes rows starting at the given index.

Parameters:¶

index¶: Starting index.
numRows¶: Number of rows to remove.

setColumnStyle(index, style)[source]¶

Sets the style of the column elements.

Parameters:¶

index¶: Column index.
style¶: New column style.

setColumnType(index, type)[source]¶

Sets the type of the column elements.

Parameters:¶

index¶: Column index.
type¶: New column type.

setDefaultStyle(style)[source]¶

Sets the default style for the table elements.

Parameters:¶

style¶: New default style.

setDefaultType(type)[source]¶

Sets the default type for table elements.

Parameters:¶

type¶: New default type.

setDefaultValues(values)[source]¶

Sets the default values for this table.

Parameters:¶

values¶: Sequence string with default values.

setMaxNumColumns(length)[source]¶

Sets the maximum number of columns.

Parameters:¶

length¶: New maximum number of columns, or -1 for unbounded.

setMinNumColumns(length)[source]¶

Sets the minimum number of columns.

Parameters:¶

length¶: New minimum length.

setNumColumnsRange(minLength, maxLength)[source]¶

Sets the allowable range for the number of columns.

Parameters:¶

minLength¶: New minimum number of columns.
maxLength¶: New maximum number of columns, or -1 for unbounded.

setRow(row, seq)[source]¶

Sets the contents of a table row.

Parameters:¶

row¶: Row index.
seq¶: Sequence with elements.

setValue(row, column, value)[source]¶

Sets the value of a table element.

Parameters:¶

row¶: Row index.
column¶: Column index.
value¶: New value.

setValueForBlank(column, value)[source]¶

Sets the element value substituted for blank for the column.

Parameters:¶

column¶: Column index.
value¶: New value.

setValueToDefault(ignoreUnspecified=False)[source]¶

Sets the keyword value to its default.

Parameters:¶

ignoreUnspecified=False¶: Should ignore if default is an unspecified value.

setValueToPrevious()[source]¶

Sets the keyword value to its previous value.

Implements AFXKeyword.

setValues(values)[source]¶

Sets all values for the table elements.

Parameters:¶

values¶: Table string with new values.

setValuesForBlanks(values)[source]¶

Sets the values substituted for blanks for all table columns.

Parameters:¶

values¶: String containing comma-separated values.

syncPreviousValue()[source]¶

Sets the keyword’s previous value to its current value.

Implements AFXKeyword.

class AFXMode[source]¶

Bases: FXObject

This class is the base class for modes.

Member Details:

ID_ACTIVATE : --is-rst--:py:class:`int` = -6637823829108684625[source]¶: Activates the mode.

ID_CANCEL : --is-rst--:py:class:`int` = 4793326578772061678[source]¶: Cancels the mode.

ID_CMD_ACTIVATED : --is-rst--:py:class:`int` = 6822158372914340100[source]¶: Indicates that a command is activated.

ID_CMD_DEACTIVATED : --is-rst--:py:class:`int` = 1122293604194256517[source]¶: Indicates that a command is deactivated.

ID_CMD_MODIFIED : --is-rst--:py:class:`int` = 7815605401041404015[source]¶: Indicates that a command is modified.

ID_COMMIT : --is-rst--:py:class:`int` = 6165631414596873395[source]¶: Commits the mode.

ID_DEACTIVATE : --is-rst--:py:class:`int` = 6395275405002665179[source]¶: Deactivates the mode.

ID_GET_NEXT : --is-rst--:py:class:`int` = -833377385423804165[source]¶: Gets the next step/dialog box.

ID_RESUME : --is-rst--:py:class:`int` = -3142132106283729426[source]¶: Resumes the mode.

ID_SET_DEFAULTS : --is-rst--:py:class:`int` = -5273676443748606627[source]¶: Sets defaults.

ID_SUSPEND : --is-rst--:py:class:`int` = 4377339578530554017[source]¶: Suspends the mode.

getCommand(index)[source]¶

Returns the command at the given index (returns 0 if the index is out-of-bounds).

Parameters:¶

index¶: Command index (0-based).

getNumCommands()[source]¶: Returns the number of commands associated with the mode.

isActive()[source]¶: Returns True if the mode is active.

class AFXDataComponent[source]¶

Bases: object

Member Details:

class AFXFloatKeyword(command, name, isRequired=False, defaultValue=0.0, precision=6)[source]¶

Bases: AFXKeyword

This class is designed for the command keywords that have floating-point values.

Member Details:

getPrecision()[source]¶: Returns the precision that is used for converting the keyword’s floating-point value to a text string.

getTypeName()[source]¶

Returns the name of the keyword type.

Implements AFXKeyword.

getValue()[source]¶: Returns the keyword’s current value, or zero if the content expression is invalid.

getValueAsString()[source]¶

Returns the text string that represents the keyword’s current value.

Implements AFXKeyword.

isValueChanged()[source]¶

Returns True if the keyword value differs from its previous value.

Implements AFXKeyword.

setDefaultValue(defaultValue)[source]¶

Sets the keyword’s default value.

Parameters:¶

defaultValue¶: Default value.

setPrecision(precision)[source]¶

Sets the precision that is used for converting the keyword’s floating-point value to a text string.

Parameters:¶

precision¶

setValue(newValue)[source]¶

Sets the keyword’s current value.

Parameters:¶

newValue¶: New value.

setValueToDefault(ignoreUnspecified=False)[source]¶

Sets the keyword value to its default.

Parameters:¶

ignoreUnspecified=False¶: Ignore setting the value if the default is unspecified.

setValueToPrevious()[source]¶

Sets the keyword value to its previous value.

Implements AFXKeyword.

syncPreviousValue()[source]¶

Sets the keyword’s previous value to its current value.

Implements AFXKeyword.

class AFXFloatTarget(initialValue=0.0)[source]¶

Bases: AFXTarget

This class is designed for floating-point targets.

Member Details:

getTypeName()[source]¶

Returns the name of the target type (“Float”).

Implements AFXTarget.

getValue()[source]¶: Returns the target’s current value.

setValue(newValue)[source]¶

Sets the target’s current value.

Parameters:¶

newValue¶: New value.

class AFXTarget[source]¶

Bases: FXObject

This class is the base class for all target objects.

Member Details:

FLOAT : --is-rst--:py:class:`int` = 6493234949119463703[source]¶: Float.

INT : --is-rst--:py:class:`int` = -836284492171758049[source]¶: Integer.

STRING : --is-rst--:py:class:`int` = -4043353692019161185[source]¶: String.

UNSPECIFIED : --is-rst--:py:class:`int` = -4677045714491857346[source]¶: Unspecified.

connect(value)[source]¶

Associates the data with an integer variable.

Parameters:¶

value¶: Variable to be associated with.

getSelector()[source]¶: Returns the message ID of this target object.

getTarget()[source]¶: Returns the target of this target object.

getType()[source]¶: Returns the target type; this method is deprecated in Abaqus 6.6, and its use should be replaced by getTypeName().

getTypeName()[source]¶

Returns the name of the target type.

Implemented in AFXFloatTarget, AFXIntTarget, and AFXStringTarget.

setSelector(msgId)[source]¶

Sets the message ID of this target object.

Parameters:¶

msgId¶: Message ID.

setTarget(target)[source]¶

Sets the target of this target object.

Parameters:¶

target¶: Target.

class AFXIntKeyword(command, name, isRequired=False, defaultValue=0, evalExpression=True)[source]¶

Bases: AFXKeyword

Abaqus.

Member Details:

getTypeName()[source]¶

Returns the name of the keyword type.

Implements AFXKeyword. Reimplemented in AFXSymConstKeyword.

getValue()[source]¶: Returns the keyword’s current value.

getValueAsString()[source]¶

Returns the text string that represents the keyword’s current value.

Implements AFXKeyword. Reimplemented in AFXSymConstKeyword.

isValueChanged()[source]¶

Returns True if the keyword value differs from its previous value.

Implements AFXKeyword.

setDefaultValue(defaultValue)[source]¶

Sets the keyword’s default value.

Parameters:¶

defaultValue¶: Default value.

setValue(newValue)[source]¶

Sets the keyword’s current value.

Parameters:¶

newValue¶: New value.

setValueToDefault(ignoreUnspecified=False)[source]¶

Sets the keyword value to its default.

Parameters:¶

ignoreUnspecified=False¶: Ignore setting the value if the default is unspecified.

setValueToPrevious()[source]¶

Sets the keyword value to its previous value.

Implements AFXKeyword.

syncPreviousValue()[source]¶

Sets the keyword’s previous value to its current value.

Implements AFXKeyword. By clicking on Send, you accept that Dassault Systèmes will process your personal data and may contact you for further information. [Privacy Policy]( https://www.3ds.com/privacy-policy). Total Results: Results per page This page cannot be found. The page might not exist or is temporarily unavailable. Try again or try searching for the topic. Use this form to provide feedback on this help topic. To get product support or to provide product feedback, go to [Frequently Asked Questions]( https://3ds.one/PO). For support for online purchased solutions, go to [Online Purchase Support](https://3ds.one/Q8). * Required Subject: Feedback on User Assistance * I acknowledge I have read and I hereby accept the [privacy policy]( https://www.3ds.com/privacy-policy) under which my personal data will be used by Dassault Systèmes.

class AFXIntTarget(initialValue=0)[source]¶

Bases: AFXTarget

This class is designed for integer targets.

Member Details:

getTypeName()[source]¶

Returns the name of the target type (“Int”).

Implements AFXTarget.

getValue()[source]¶: Returns the target’s current value.

setValue(newValue)[source]¶

Sets the target’s current value.

Parameters:¶

newValue¶: New value.

class AFXItemProvider(initialItems="''")[source]¶

Bases: FXObject

This class provides a way to supply items to widgets, such as AFXComboBox and AFXList.

Member Details:

append(ch)[source]¶

Appends a character to the item string.

Parameters:¶

ch¶

empty()[source]¶: Returns True if the item string is empty.

getItems()[source]¶: Returns a sequence string that contains all of the provider’s items.

getVersion()[source]¶: Returns the version of provider’s items.

reset(sz=0)[source]¶

Clears the contents of the item string and reallocates space.

Parameters:¶

sz=0¶

setItems(newItems)[source]¶

Sets all of the providers’s items, clearing any previous items first.

Parameters:¶

newItems¶: Sequence string with new items.

class FXDataTarget(value, tgt=None, sel=0)[source]¶

Bases: FXObject

A Data Target allows a valuator widget such as a Slider or Text Field to be directly connected with a variable in the program.

Whenever the valuator control changes, the variable connected through the data target is automatically updated; conversely, whenever the program changes a variable, all the connected valuator widgets will be updated to reflect this new value on the display. Data Targets also allow connecting Radio Buttons, Menu Commands, and so on to a variable. In this case, the new value of the connected variable is computed by substracting ID_OPTION from the message ID.

Member Details:

ID_OPTION : --is-rst--:py:class:`int` = -8790033261711428396[source]¶: ID_OPTION+i will set the value to i where -10000<=i<=10000.

ID_VALUE : --is-rst--:py:class:`int` = 9069971876367834452[source]¶: Will cause the FXDataTarget to ask sender for value.

connect()[source]¶: Associate with nothing.

getData()[source]¶: Return pointer to data its connected to.

getSelector()[source]¶: Get the message identifier for this data target.

getTarget()[source]¶: Get the message target object for this data target, if any.

getType()[source]¶: Return type of data its connected to.

setSelector(sel)[source]¶

Set the message identifier for this data target.

Parameters:¶

sel¶

setTarget(t)[source]¶

Set the message target object for this data target.

Parameters:¶

t¶

class AFXObjectKeyword(command, name, isRequired=False, defaultValue="''")[source]¶

Bases: AFXKeyword

This class is designed for the command keywords that have objects as values.

Member Details:

getTypeName()[source]¶

Returns the name of the keyword type.

Implements AFXKeyword.

getValue()[source]¶: Returns the keyword’s current value.

getValueAsString()[source]¶

Returns the text string that represents the keyword’s current value.

Implements AFXKeyword.

isValueChanged()[source]¶

Returns True if the keyword value differs from its previous value.

Implements AFXKeyword.

setDefaultValue(defaultValue)[source]¶

Sets the keyword’s default value.

Parameters:¶

defaultValue¶: Default value.

setValue(newValue)[source]¶

Sets the keyword’s current value.

Parameters:¶

newValue¶: New value.

setValueToDefault(ignoreUnspecified=False)[source]¶

Sets the keyword value to its default.

Parameters:¶

ignoreUnspecified=False¶: If set to True, ignore setting the value if the default is unspecified.

setValueToPrevious()[source]¶

Sets the keyword value to its previous value.

Implements AFXKeyword.

syncPreviousValue()[source]¶

Sets the keyword’s previous value to its current value.

class AFXSequenceString[source]¶

Bases: object

This class supports parsing and modification of strings containing sequences of elements separated with some separator character.

Member Details:

forceNumElements(num, fill)[source]¶

Forces the content string to contain a tuple with the given number of elements.

Parameters:¶

num¶: New number of elements.
fill¶: String to insert in empty spaces.

getContentString()[source]¶

Returns a string containing values of the sequence elements.

Reimplemented in AFX2DArrayConstString.

getElementSeparator()[source]¶: Returns the element separator character.

getLength(index)[source]¶

Returns the length in characters of a sequence element.

Parameters:¶

index¶: Element index.

getNumElements()[source]¶: Returns the number of elements in this sequence.

getPosition(index)[source]¶

Returns the position in the content string of the beginning character of the sequence element.

Parameters:¶

index¶: Element index.

getValue(index)[source]¶

Returns the value of a sequence element.

Parameters:¶

index¶: Element index.

insert(index, numElements, val)[source]¶

Inserts many copies of an element.

Parameters:¶

index¶: Element index at which inserting begins.
numElements¶: Number of elements to insert.
val¶: Value for the new elements.

isValidSequence()[source]¶: Returns True if this object contains a valid sequence.

remove(index, numElements)[source]¶

Removes elements starting at the given index.

Parameters:¶

index¶: Element index at which removal begins.
numElements¶: Number of elements to remove.

setContentString(seqstr)[source]¶

Resets all values for the sequence elements.

Parameters:¶

seqstr¶: Sequence string with new values.

setElementSeparator(sep)[source]¶

Sets the element separator character.

Parameters:¶

sep¶: Separator character.

setLength(index, length)[source]¶

Sets the length of the sequence element.

Parameters:¶

index¶: Element index.
length¶: New length (in characters).

setPosition(index, position)[source]¶

Sets the position of the sequence element.

Parameters:¶

index¶: Element index.
position¶: New position within the string.

setValue(index, value, replaceAll=False)[source]¶

Sets the value of a sequence element.

Parameters:¶

index¶: Element index.
value¶: New value.
replaceAll=False¶: If False (default), leading and trailing spaces will be preserved, otherwise, all space between separators will be replaced with the new value.

trimWhiteSpace(index)[source]¶

Adjusts the position and length of the element to trim leading and trailing white spaces.

Parameters:¶

index¶: Element index.

class AFXStringKeyword(command, name, isRequired=False, defaultValue="''")[source]¶

Bases: AFXKeyword

This class is designed for the command keywords that have text string values.

Member Details:

getTypeName()[source]¶

Returns the name of the keyword type.

Implements AFXKeyword.

getValue()[source]¶: Returns the keyword’s current value.

getValueAsString()[source]¶

Returns the text string that represents the keyword’s current value.

Implements AFXKeyword.

isValueChanged()[source]¶

Returns True if the keyword value differs from its previous value.

Implements AFXKeyword.

setDefaultValue(defaultValue)[source]¶

Sets the keyword’s default value.

Parameters:¶

defaultValue¶: Default value.

setValue(newValue)[source]¶

Sets the keyword’s current value.

Parameters:¶

newValue¶: New value.

setValueToDefault(ignoreUnspecified=False)[source]¶

Sets the keyword value to its default.

Parameters:¶

ignoreUnspecified=False¶: Ignore setting the value if the default is unspecified.

setValueToPrevious()[source]¶

Sets the keyword value to its previous value.

Implements AFXKeyword.

syncPreviousValue()[source]¶

Sets the keyword’s previous value to its current value.

class AFXStringTarget(initialValue="''")[source]¶

Bases: AFXTarget

This class is designed for string targets.

Member Details:

getTypeName()[source]¶

Returns the name of the target type (“String”).

Implements AFXTarget.

getValue()[source]¶: Returns the target’s current value.

setValue(newValue)[source]¶

Sets the target’s current value.

Parameters:¶

newValue¶: New value.

class AFXSymConstKeyword(command, name, isRequired=False, defaultValue=0)[source]¶

Bases: AFXIntKeyword

This class is designed for the command keywords that have symbolic constant values.

Member Details:

getTypeName()[source]¶

Returns the name of the keyword type.

Reimplemented from AFXIntKeyword.

getValueAsString()[source]¶

Returns the text string that represents the keyword’s current value.

Reimplemented from AFXIntKeyword.

setDefaultValue(defaultValue)[source]¶

Sets the keyword’s default value.

Parameters:¶

defaultValue¶: Default value.

setDefaultValueByString(defaultValueString)[source]¶

Sets the keyword’s default value (returns True if the given text string is valid).

Parameters:¶

defaultValueString¶: Default value in text string form.

setValue(newValue)[source]¶

Sets the keyword’s current value.

Parameters:¶

newValue¶: New value.

setValueByString(newValueString)[source]¶

Sets the keyword’s current value (returns True if the given text string is valid).

Parameters:¶

newValueString¶: New value in text string form.

setValueToDefault(ignoreUnspecified=False)[source]¶

Sets the keyword value to its default.

Parameters:¶

ignoreUnspecified=False¶: Ignore setting the value if the default is unspecified.

class AFXTogglableKeyword[source]¶

Bases: object

Member Details:

class AFXTransition(intTarget, op, refValue, tgt, sel, ptr='None')[source]¶

Bases: FXObject

This class is designed for the finite state transition that the GUI (mostly the dialog boxes) can define to perform actions according to state changes.

The first three arguments of the constructors (keyword, op, and refValue) define an expression (keyword.getValue() op refValue). The current value of the keyword is compared with the reference value. When the expression evaluates to True, a message with the given selector will be sent to the specified message target.

Member Details:

EQ : --is-rst--:py:class:`int` = -5088658019261849864[source]¶: Equal to.

GE : --is-rst--:py:class:`int` = -3976218297782360004[source]¶: Greater than or equal to.

GT : --is-rst--:py:class:`int` = -6505449351913038647[source]¶: Greater than.

LE : --is-rst--:py:class:`int` = 4898760796162662931[source]¶: Less than or equal to.

LT : --is-rst--:py:class:`int` = -231591012027862941[source]¶: Less than.

NE : --is-rst--:py:class:`int` = -4845990744494229495[source]¶: Not equal to.

class Operator[source]¶

Bases: object

Member Details:

process(sender)[source]¶

Returns True and sends a message if the expression defined by the constructor arguments evaluates to True; returns False without performing any actions if otherwise.

Parameters:¶

sender¶: Message sender.

class AFXTupleKeyword(command, name, isRequired=False, minLength=0, maxLength=-1, opts=0)[source]¶

Bases: AFXKeyword

This class manages values which are sent as tuples in a command.

Member Details:

ID_PRINTSNIPPET : --is-rst--:py:class:`int` = 932779659422221073[source]¶: For debugging.

equal(index, a, b)[source]¶

Returns True if the two tuple element values compare equal (index is not used).

Parameters:¶

index¶: Element index (not used).
a¶: First value.
b¶: Second value.

getDefaultStyle()[source]¶: Returns the default style for elements.

getDefaultType()[source]¶: Returns the default type for elements.

getDefaultValues()[source]¶: Returns the default values for this tuple.

getElementStyle(index)[source]¶

Returns the style of one element. Will never return AFXTUPLE_STYLE_DEFAULT!

Parameters:¶

index¶: Element index.

getElementType(index)[source]¶

Returns the type of one element. Will never return AFXTUPLE_TYPE_DEFAULT!

Parameters:¶

index¶: Element index.

getFormattedValue(index)[source]¶

Returns the formatted value of the tuple element, suitable for placing in a command. If the element has AFXTUPLE_EVALUATE style and its contents are invalid, an exception will be thrown.

Parameters:¶

index¶: Element index.

getLength()[source]¶: Returns the length of the tuple.

getMaxLength()[source]¶: Returns the maximum length of this tuple, or -1 for unbounded length.

getMinLength()[source]¶: Returns the minimum length of this tuple.

getTypeName()[source]¶

Returns the name of the tuple keyword type.

Implements AFXKeyword.

getValue(index)[source]¶

Returns the value of a tuple element.

Parameters:¶

index¶: Element index.

getValueAsDouble()[source]¶: Returns the keyword’s value as a float; returns False upon failure.

getValueAsInt()[source]¶: Returns the keyword’s value as an integer; returns False upon failure.

getValueAsString()[source]¶

Returns the formatted string that represents the current keyword value in a command.

Implements AFXKeyword.

getValueForBlank(index)[source]¶

Returns the value substituted for blank tuple element.

Parameters:¶

index¶: Element index.

getValues()[source]¶: Returns a string containing values (separated by commas) of the tuple elements.

getValuesForBlanks()[source]¶: Returns a string containing values substituted for blanks for the tuple elements.

insertElements(index, numCols)[source]¶

Inserts elements starting at the given index.

Parameters:¶

index¶: Starting index.
numCols¶: Number of elements to insert.

isValueChanged()[source]¶

Returns True if the keyword value differs from its previous value.

Implements AFXKeyword.

removeElements(index, numCols)[source]¶

Removes elements starting at the given index.

Parameters:¶

index¶: Starting index.
numCols¶: Number of elements to remove.

setDefaultStyle(style)[source]¶

Sets the default style for elements.

Parameters:¶

style¶: New default element style.

setDefaultType(type)[source]¶

Sets the default type for elements.

Parameters:¶

type¶: New default type.

setDefaultValues(values)[source]¶

Sets the default values for this tuple.

Parameters:¶

values¶: Sequence string with default values.

setElementStyle(index, style)[source]¶

Sets the style of one element.

Parameters:¶

index¶: Element index.
style¶: New element style.

setElementType(index, type)[source]¶

Sets the type of one element.

Parameters:¶

index¶: Element index.
type¶: New element type.

setLengthRange(minLength, maxLength)[source]¶

Sets the range of allowable tuple lengths.

Parameters:¶

minLength¶: New minimum length.
maxLength¶: New maximum length, or -1 for unbounded length.

setMaxLength(length)[source]¶

Sets the maximum length of this tuple.

Parameters:¶

length¶: New maximum length, or -1 for unbounded length.

setMinLength(length)[source]¶

Sets the minimum length of this tuple.

Parameters:¶

length¶: New minimum length.

setValue(index, value)[source]¶

Sets the value of the tuple element; returns False upon failure.

Parameters:¶

index¶: Element index.
value¶: New value.

setValueForBlank(index, value)[source]¶

Sets the value substituted for a blank tuple element.

Parameters:¶

index¶: Element index.
value¶: New value.

setValueToDefault(ignoreUnspecified=False)[source]¶

Sets the keyword value to its default.

Parameters:¶

ignoreUnspecified=False¶: Should ignore if default is an unspecified value.

setValueToPrevious()[source]¶

Sets the keyword value to its previous value.

Implements AFXKeyword.

setValues(values)[source]¶

Sets values for all tuple elements (use commas to separate values within the string).

Parameters:¶

values¶: Tuple string with new values.

setValuesForBlanks(values)[source]¶

Sets all values substituted for blanks for the tuple elements.

Parameters:¶

values¶: Tuple string with values.

syncPreviousValue()[source]¶

Sets the keyword’s previous value to its current value.

Implements AFXKeyword.

class FXChore[source]¶

Bases: object

Member Details:

class FXColor[source]¶

Bases: object

Member Details:

class FXDrawable[source]¶

Bases: FXId

Drawable is an abstract base class for any surface that can be drawn upon, such as a FXWindow, or FXImage.

Member Details:

getHeight()[source]¶: Height of drawable.

getVisual()[source]¶: Get the visual.

getWidth()[source]¶: Width of drawable.

resize(w, h)[source]¶

Resize drawable to the specified width and height. Reimplemented in FXBitmap, FXIcon, FXIconList, FXImage, FXMDIChild, FXRootWindow, FXText, FXTopWindow, and FXWindow.

Parameters:¶

w¶
h¶

class FXId[source]¶

Bases: FXObject

Encapsulates server side resource.

Member Details:

create()[source]¶

Create resource.

Reimplemented in FXBitmap, FXColorBar, FXColorSelector, FXColorWell, FXColorWheel, FXComboBox, FXComposite, FXCursor, FXDirBox, FXDirList, FXDockTitle, FXDriveBox, FXFileList, FXFont, FXFontSelector, FXGLCanvas, FXGLContext, FXGLViewer, FXGLVisual, FXGroupBox, FXHeader, FXIcon, FXIconList, FXImage, FXImageView, FXLabel, FXList, FXListBox, FXMDIChild, FXMenuButton, FXMenuCaption, FXMenuCascade, FXProgressBar, FXMenuTitle, FXOptionMenu, FXPrintDialog, FXRootWindow, FXScrollWindow, FXShell, FXSpinner, FXStatusline, FXTabBar, FXTable, FXText, FXTextField, FXToggleButton, FXToolbarShell, FXTooltip, FXTopWindow, FXTreeList, FXTreeListBox, FXVisual, FXWindow, AFXManagerMenuPane, AFXMainWindow, AFXPromptArea, AFXBaseTable, AFXColorButton, AFXColorFlyout, AFXComboBox, AFXDialog, AFXFloatSpinner, AFXFlyoutButton, AFXListBox, AFXNote, AFXOptionTreeItem, AFXPrimFloatSpinner, AFXProgressBar, AFXSpinner, AFXTable, AFXTextField, and AFXVerticalAligner.

destroy()[source]¶

Destroy resource.

Reimplemented in FXBitmap, FXComboBox, FXComposite, FXCursor, FXDirBox, FXDirList, FXDriveBox, FXFileList, FXFont, FXGLCanvas, FXGLContext, FXGLVisual, FXIcon, FXImage, FXListBox, FXMenuCascade, FXOptionMenu, FXRootWindow, FXTreeList, FXTreeListBox, FXVisual, FXWindow, AFXManagerMenuCascade, AFXColorFlyout, and AFXTable.

detach()[source]¶

Detach resource.

Reimplemented in FXBitmap, FXColorBar, FXColorWell, FXColorWheel, FXComboBox, FXComposite, FXCursor, FXDirBox, FXDirList, FXDockTitle, FXDriveBox, FXFileList, FXFont, FXGLCanvas, FXGLContext, FXGLViewer, FXGLVisual, FXGroupBox, FXHeader, FXIcon, FXIconList, FXImage, FXImageView, FXLabel, FXList, FXListBox, FXMDIChild, FXMenuButton, FXMenuCaption, FXMenuCascade, FXProgressBar, FXMenuTitle, FXOptionMenu, FXRootWindow, FXStatusline, FXTable, FXText, FXToggleButton, FXTooltip, FXTopWindow, FXTreeList, FXTreeListBox, FXVisual, FXWindow, AFXBaseTable, AFXColorFlyout, AFXFlyoutButton, AFXNote, and AFXTable.

getApp()[source]¶: Get application.

getUserData()[source]¶: Get user data pointer.

id()[source]¶

Get XID handle.

Reimplemented in FXFont.

setUserData(ptr)[source]¶

Set user data pointer.

Parameters:¶

ptr¶

class FXExponent[source]¶

Bases: object

Member Details:

class FXFontDesc[source]¶

Bases: object

Member Details:

class FXIconItem[source]¶

Bases: FXObject

Icon item.

Member Details:

class FXIconListSortFunc[source]¶

Bases: object

Member Details:

class FXInputHandle[source]¶

Bases: object

Member Details:

class FXListItem[source]¶

Bases: FXObject

List item.

Member Details:

class FXMDIClient[source]¶

Bases: object

Member Details:

class FXMenuPane[source]¶

Bases: object

Member Details:

class FXMenubar[source]¶

Bases: FXToolbar

Menu bar.

Member Details:

class FXToolbar[source]¶

Bases: object

Member Details:

class FXMetaClass[source]¶

Bases: object

Member Details:

class FXSelector[source]¶

Bases: object

Member Details:

class FXObjectList(orig)[source]¶

Bases: object

List of pointers to objects.

Member Details:

append(p)[source]¶

Append element.

Parameters:¶

p¶

clear()[source]¶: Remove all elements.

findb(p, pos=2147483647)[source]¶

Find object in list, searching backward; return position or -1.

Parameters:¶

p¶
pos=2147483647¶

findf(p, pos=0)[source]¶

Find object in list, searching forward; return position or -1.

Parameters:¶

p¶
pos=0¶

insert(pos, p)[source]¶

Insert element at certain position.

Parameters:¶

pos¶
p¶

no()[source]¶: Return number of elements.

remove(pos)[source]¶

Remove element at pos.

Parameters:¶

pos¶

size()[source]¶

Return size of list.

By clicking on Send, you accept that Dassault Systèmes will process your personal data and may contact you for further information. [Privacy Policy]( https://www.3ds.com/privacy-policy). Total Results: Results per page

class FXProgressBar[source]¶

Bases: object

Member Details:

class FXRGB(R, G, B)[source]¶

Bases: FXColor

Member Details:

class FXTimer[source]¶

Bases: object

Member Details:

class FXTreeItem[source]¶

Bases: FXObject

Tree list Item.

Member Details:

class FXVisual[source]¶

Bases: object

Member Details:

FXMAPFUNC(object, messageType, messageId, method)[source]¶

Creates an entry in the object’s message map that will route a message to a method.

Parameters:¶

object¶: An instance of the class in which the message map entry is to be made. Typically this is “self”.
messageType¶: An integer flag specifying the message type (e.g. SEL_COMMAND).
messageId¶: An integer specifying the message ID.
method¶: The method to which the message is to be routed. This method must be specified by including the class name (e.g. MyDB.myMethod).

FXMAPFUNCS(object, messageType, startMessageId, endMessageId, method)[source]¶

Creates multiple entries in the object’s message map that will route messages to a method.

Parameters:¶

object¶: An instance of the class in which the message map entry is to be made. Typically this is “self”.
messageType¶: An integer flag specifying the message type (e.g. SEL_COMMAND).
startMessageId¶: An integer specifying the starting message ID.
endMessageId¶: An integer specifying the ending message ID.
method¶: The method to which the message is to be routed. This method must be specified by including the class name (e.g. MyDB.myMethod).