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=-8434683142687202265, isRequired=False, defaultValue=False, )[源代码]¶

基类：AFXKeyword

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

Member Details:

ON_OFF : --is-rst--:py:class:`int` = -8434683142687202265[源代码]¶: Keyword value will be ON or OFF.

TRUE_FALSE : --is-rst--:py:class:`int` = -4321448853004341227[源代码]¶: Keyword value will be True or False.

getTypeName()[源代码]¶

Returns the name of the keyword type.

Implements AFXKeyword.

getValue()[源代码]¶: Returns the keyword's current value.

getValueAsString()[源代码]¶

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

Implements AFXKeyword.

isValueChanged()[源代码]¶

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

Implements AFXKeyword.

setDefaultValue(defaultValue)[源代码]¶

Sets the keyword's default value.

参数:¶

defaultValue¶: Default value.

setDefaultValueByString(defaultValueString)[源代码]¶

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

参数:¶

defaultValueString¶: Default value in text string form.

setValue(newValue)[源代码]¶

Sets the keyword's current value.

参数:¶

newValue¶: New value.

setValueByString(newValueString)[源代码]¶

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

参数:¶

newValueString¶: New value in text string form.

setValueToDefault(ignoreUnspecified=False)[源代码]¶

Sets the keyword value to its default.

参数:¶

ignoreUnspecified=False¶: Not used.

setValueToPrevious()[源代码]¶

Sets the keyword value to its previous value.

Implements AFXKeyword.

syncPreviousValue()[源代码]¶

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

Implements AFXKeyword.

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

基类：FXObject

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

Member Details:

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

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

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

getExpandedObjectName()[源代码]¶: Returns the expanded object name that has all the "%s"'s replaced by the current names.

getKeyword(index)[源代码]¶

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

参数:¶

index¶: Keyword index (0-based).

getMethod()[源代码]¶: Returns the command's method.

getNumKeywords()[源代码]¶: Returns the number of keywords.

getObjectName()[源代码]¶: Returns the object name (which is not expanded and may include "%s"'s).

isActive()[源代码]¶: Returns True if the command is active.

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

isRequired()[源代码]¶: 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)[源代码]¶

Sets the values of all keywords to their defaults.

参数:¶

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

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

setMethod(method)[源代码]¶

Sets the command's method.

参数:¶

method¶: Method.

setObjectName(objectName)[源代码]¶

Sets the object name.

参数:¶

objectName¶: Object name.

setRequired(val)[源代码]¶

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.

参数:¶

val¶

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

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

class AFXKeyword(command, name, isRequired=False)[源代码]¶

基类：FXDataTarget

Abaqus.

Member Details:

ID_ACTIVATE : --is-rst--:py:class:`int` = -9169947027948920608[源代码]¶: Used to activate the keyword.

ID_DEACTIVATE : --is-rst--:py:class:`int` = 3904609504633070987[源代码]¶: Used to deactivate the keyword.

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

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

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

getName()[源代码]¶: Returns the keyword name.

getSetupCommands()[源代码]¶: Returns the keyword's variable initilization commands (part of the generated command string).

getTypeName()[源代码]¶

Returns the keyword type name.

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

getValueAsString()[源代码]¶

Returns the text string that represents the current keyword value.

isActive()[源代码]¶: Returns True if the keyword is active.

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

isValueChanged()[源代码]¶

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)[源代码]¶

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

参数:¶

val¶

setSetupCommands(cmds)[源代码]¶

Sets variable initialization commands needed by the keyword.

参数:¶

cmds¶

setValueToDefault(ignoreUnspecified=False)[源代码]¶

Sets the keyword value to its default.

参数:¶

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

setValueToPrevious()[源代码]¶

Sets the keyword value to its previous value.

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

syncPreviousValue()[源代码]¶

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)[源代码]¶

基类：FXObject

Abaqus.

Member Details:

getReferenceColumn()[源代码]¶: Returns the index of the table reference column.

getSelector()[源代码]¶: Returns the message ID.

getTarget()[源代码]¶: Returns the message target.

setReferenceColumn(index)[源代码]¶

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

参数:¶

index¶: Table column index.

setSelector(sel)[源代码]¶

Sets the message ID.

参数:¶

sel¶: New message ID.

setTarget(tgt)[源代码]¶

Sets the message target.

参数:¶

tgt¶: New message target.

class FXObject[源代码]¶

基类：object

Base of all FOX object.

Member Details:

getClassName()[源代码]¶: Get class name of some object.

handle(sender, sel, ptr)[源代码]¶

Handles messages sent to this class.

参数:¶

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

isMemberOf(metaclass)[源代码]¶

Check if object is member of metaclass.

参数:¶

metaclass¶

onDefault()[源代码]¶

Called for unhandled messages.

Reimplemented in FXDelegator, FXGLViewer, FXMDIChild, and FXMDIClient.

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

基类：AFXKeyword

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

Member Details:

ID_PRINTSNIPPET : --is-rst--:py:class:`int` = -2718326084848093570[源代码]¶: For debugging.

ID_TABLE : --is-rst--:py:class:`int` = -5857831397102224404[源代码]¶: ID for AFXTable widgets.

ID_VALUE : --is-rst--:py:class:`int` = 8498724019810277823[源代码]¶: ID for widgets exchanging array strings.

equal(index, a, b)[源代码]¶

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

参数:¶

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

getColumnStyle(index)[源代码]¶

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

参数:¶

index¶: Column index.

getColumnType(index)[源代码]¶

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

参数:¶

index¶: Column index.

getDefaultStyle()[源代码]¶: Returns the default style for the table elements.

getDefaultType()[源代码]¶: Returns the default type for the table elements.

getDefaultValues()[源代码]¶: Returns the default values for this table.

getFormattedValue(row, column)[源代码]¶

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.

参数:¶

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

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

getMinNumColumns()[源代码]¶: Returns the minimum number of columns.

getNumColumns(row)[源代码]¶

Returns the number of columns in the row.

参数:¶

row¶: Row index.

getNumRows()[源代码]¶: Returns the number of rows in the table.

getRow(row)[源代码]¶

Returns a string with the contents of a table row.

参数:¶

row¶: Row index.

getTypeName()[源代码]¶

Returns the name of the table keyword type.

Implements AFXKeyword. Reimplemented in AFXTableKeyword.

getValue(row, column)[源代码]¶

Returns the value of a table element.

参数:¶

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

getValueAsDouble()[源代码]¶: Returns the keyword's value as a float; returns False upon failure.

getValueAsInt()[源代码]¶: Returns the keyword's value as an integer; returns False upon failure.

getValueAsString()[源代码]¶

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

Implements AFXKeyword.

getValueForBlank(column)[源代码]¶

Returns the element value substituted for blank for the column.

参数:¶

column¶: Column index.

getValues()[源代码]¶

Returns a string containing values of the tuple elements.

as entered by the user.

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

insertColumns(index, numColumns)[源代码]¶

Inserts columns starting at the given index.

参数:¶

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

insertRows(index, numRows)[源代码]¶

Inserts rows starting at the given index.

参数:¶

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

isValueChanged()[源代码]¶

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

Implements AFXKeyword.

removeColumns(index, numColumns)[源代码]¶

Removes columns starting at the given index.

参数:¶

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

removeRows(index, numRows)[源代码]¶

Removes rows starting at the given index.

参数:¶

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

setColumnStyle(index, style)[源代码]¶

Sets the style of the column elements.

参数:¶

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

setColumnType(index, type)[源代码]¶

Sets the type of the column elements.

参数:¶

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

setDefaultStyle(style)[源代码]¶

Sets the default style for the table elements.

参数:¶

style¶: New default style.

setDefaultType(type)[源代码]¶

Sets the default type for table elements.

参数:¶

type¶: New default type.

setDefaultValues(values)[源代码]¶

Sets the default values for this table.

参数:¶

values¶: Sequence string with default values.

setMaxNumColumns(length)[源代码]¶

Sets the maximum number of columns.

参数:¶

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

setMinNumColumns(length)[源代码]¶

Sets the minimum number of columns.

参数:¶

length¶: New minimum length.

setNumColumnsRange(minLength, maxLength)[源代码]¶

Sets the allowable range for the number of columns.

参数:¶

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

setRow(row, seq)[源代码]¶

Sets the contents of a table row.

参数:¶

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

setValue(row, column, value)[源代码]¶

Sets the value of a table element.

参数:¶

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

setValueForBlank(column, value)[源代码]¶

Sets the element value substituted for blank for the column.

参数:¶

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

setValueToDefault(ignoreUnspecified=False)[源代码]¶

Sets the keyword value to its default.

参数:¶

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

setValueToPrevious()[源代码]¶

Sets the keyword value to its previous value.

Implements AFXKeyword.

setValues(values)[源代码]¶

Sets all values for the table elements.

参数:¶

values¶: Table string with new values.

setValuesForBlanks(values)[源代码]¶

Sets the values substituted for blanks for all table columns.

参数:¶

values¶: String containing comma-separated values.

syncPreviousValue()[源代码]¶

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

Implements AFXKeyword.

class AFXMode[源代码]¶

基类：FXObject

This class is the base class for modes.

Member Details:

ID_ACTIVATE : --is-rst--:py:class:`int` = -9169947027948920608[源代码]¶: Activates the mode.

ID_CANCEL : --is-rst--:py:class:`int` = 4990950027741121463[源代码]¶: Cancels the mode.

ID_CMD_ACTIVATED : --is-rst--:py:class:`int` = 4769087143243532607[源代码]¶: Indicates that a command is activated.

ID_CMD_DEACTIVATED : --is-rst--:py:class:`int` = 5356797802523292051[源代码]¶: Indicates that a command is deactivated.

ID_CMD_MODIFIED : --is-rst--:py:class:`int` = -7120120157758988921[源代码]¶: Indicates that a command is modified.

ID_COMMIT : --is-rst--:py:class:`int` = 4159448730941889159[源代码]¶: Commits the mode.

ID_DEACTIVATE : --is-rst--:py:class:`int` = 3904609504633070987[源代码]¶: Deactivates the mode.

ID_GET_NEXT : --is-rst--:py:class:`int` = 3931637358392109701[源代码]¶: Gets the next step/dialog box.

ID_RESUME : --is-rst--:py:class:`int` = -4032016757413201800[源代码]¶: Resumes the mode.

ID_SET_DEFAULTS : --is-rst--:py:class:`int` = 3881230980229084254[源代码]¶: Sets defaults.

ID_SUSPEND : --is-rst--:py:class:`int` = -466209462515385501[源代码]¶: Suspends the mode.

getCommand(index)[源代码]¶

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

参数:¶

index¶: Command index (0-based).

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

isActive()[源代码]¶: Returns True if the mode is active.

class AFXDataComponent[源代码]¶

基类：object

Member Details:

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

基类：AFXKeyword

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

Member Details:

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

getTypeName()[源代码]¶

Returns the name of the keyword type.

Implements AFXKeyword.

getValue()[源代码]¶: Returns the keyword's current value, or zero if the content expression is invalid.

getValueAsString()[源代码]¶

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

Implements AFXKeyword.

isValueChanged()[源代码]¶

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

Implements AFXKeyword.

setDefaultValue(defaultValue)[源代码]¶

Sets the keyword's default value.

参数:¶

defaultValue¶: Default value.

setPrecision(precision)[源代码]¶

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

参数:¶

precision¶

setValue(newValue)[源代码]¶

Sets the keyword's current value.

参数:¶

newValue¶: New value.

setValueToDefault(ignoreUnspecified=False)[源代码]¶

Sets the keyword value to its default.

参数:¶

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

setValueToPrevious()[源代码]¶

Sets the keyword value to its previous value.

Implements AFXKeyword.

syncPreviousValue()[源代码]¶

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

Implements AFXKeyword.

class AFXFloatTarget(initialValue=0.0)[源代码]¶

基类：AFXTarget

This class is designed for floating-point targets.

Member Details:

getTypeName()[源代码]¶

Returns the name of the target type ("Float").

Implements AFXTarget.

getValue()[源代码]¶: Returns the target's current value.

setValue(newValue)[源代码]¶

Sets the target's current value.

参数:¶

newValue¶: New value.

class AFXTarget[源代码]¶

基类：FXObject

This class is the base class for all target objects.

Member Details:

FLOAT : --is-rst--:py:class:`int` = -312049883201602406[源代码]¶: Float.

INT : --is-rst--:py:class:`int` = -5099329700439203461[源代码]¶: Integer.

STRING : --is-rst--:py:class:`int` = 2199994925949933621[源代码]¶: String.

UNSPECIFIED : --is-rst--:py:class:`int` = -6920345230672064800[源代码]¶: Unspecified.

connect(value)[源代码]¶

Associates the data with an integer variable.

参数:¶

value¶: Variable to be associated with.

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

getTarget()[源代码]¶: Returns the target of this target object.

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

getTypeName()[源代码]¶

Returns the name of the target type.

Implemented in AFXFloatTarget, AFXIntTarget, and AFXStringTarget.

setSelector(msgId)[源代码]¶

Sets the message ID of this target object.

参数:¶

msgId¶: Message ID.

setTarget(target)[源代码]¶

Sets the target of this target object.

参数:¶

target¶: Target.

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

基类：AFXKeyword

Abaqus.

Member Details:

getTypeName()[源代码]¶

Returns the name of the keyword type.

Implements AFXKeyword. Reimplemented in AFXSymConstKeyword.

getValue()[源代码]¶: Returns the keyword's current value.

getValueAsString()[源代码]¶

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

Implements AFXKeyword. Reimplemented in AFXSymConstKeyword.

isValueChanged()[源代码]¶

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

Implements AFXKeyword.

setDefaultValue(defaultValue)[源代码]¶

Sets the keyword's default value.

参数:¶

defaultValue¶: Default value.

setValue(newValue)[源代码]¶

Sets the keyword's current value.

参数:¶

newValue¶: New value.

setValueToDefault(ignoreUnspecified=False)[源代码]¶

Sets the keyword value to its default.

参数:¶

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

setValueToPrevious()[源代码]¶

Sets the keyword value to its previous value.

Implements AFXKeyword.

syncPreviousValue()[源代码]¶

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)[源代码]¶

基类：AFXTarget

This class is designed for integer targets.

Member Details:

getTypeName()[源代码]¶

Returns the name of the target type ("Int").

Implements AFXTarget.

getValue()[源代码]¶: Returns the target's current value.

setValue(newValue)[源代码]¶

Sets the target's current value.

参数:¶

newValue¶: New value.

class AFXItemProvider(initialItems="''")[源代码]¶

基类：FXObject

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

Member Details:

append(ch)[源代码]¶

Appends a character to the item string.

参数:¶

ch¶

empty()[源代码]¶: Returns True if the item string is empty.

getItems()[源代码]¶: Returns a sequence string that contains all of the provider's items.

getVersion()[源代码]¶: Returns the version of provider's items.

reset(sz=0)[源代码]¶

Clears the contents of the item string and reallocates space.

参数:¶

sz=0¶

setItems(newItems)[源代码]¶

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

参数:¶

newItems¶: Sequence string with new items.

class FXDataTarget(value, tgt=None, sel=0)[源代码]¶

基类：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` = -6181142671286338451[源代码]¶: ID_OPTION+i will set the value to i where -10000<=i<=10000.

ID_VALUE : --is-rst--:py:class:`int` = 8498724019810277823[源代码]¶: Will cause the FXDataTarget to ask sender for value.

connect()[源代码]¶: Associate with nothing.

getData()[源代码]¶: Return pointer to data its connected to.

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

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

getType()[源代码]¶: Return type of data its connected to.

setSelector(sel)[源代码]¶

Set the message identifier for this data target.

参数:¶

sel¶

setTarget(t)[源代码]¶

Set the message target object for this data target.

参数:¶

t¶

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

基类：AFXKeyword

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

Member Details:

getTypeName()[源代码]¶

Returns the name of the keyword type.

Implements AFXKeyword.

getValue()[源代码]¶: Returns the keyword's current value.

getValueAsString()[源代码]¶

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

Implements AFXKeyword.

isValueChanged()[源代码]¶

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

Implements AFXKeyword.

setDefaultValue(defaultValue)[源代码]¶

Sets the keyword's default value.

参数:¶

defaultValue¶: Default value.

setValue(newValue)[源代码]¶

Sets the keyword's current value.

参数:¶

newValue¶: New value.

setValueToDefault(ignoreUnspecified=False)[源代码]¶

Sets the keyword value to its default.

参数:¶

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

setValueToPrevious()[源代码]¶

Sets the keyword value to its previous value.

Implements AFXKeyword.

syncPreviousValue()[源代码]¶

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

class AFXSequenceString[源代码]¶

基类：object

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

Member Details:

forceNumElements(num, fill)[源代码]¶

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

参数:¶

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

getContentString()[源代码]¶

Returns a string containing values of the sequence elements.

Reimplemented in AFX2DArrayConstString.

getElementSeparator()[源代码]¶: Returns the element separator character.

getLength(index)[源代码]¶

Returns the length in characters of a sequence element.

参数:¶

index¶: Element index.

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

getPosition(index)[源代码]¶

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

参数:¶

index¶: Element index.

getValue(index)[源代码]¶

Returns the value of a sequence element.

参数:¶

index¶: Element index.

insert(index, numElements, val)[源代码]¶

Inserts many copies of an element.

参数:¶

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

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

remove(index, numElements)[源代码]¶

Removes elements starting at the given index.

参数:¶

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

setContentString(seqstr)[源代码]¶

Resets all values for the sequence elements.

参数:¶

seqstr¶: Sequence string with new values.

setElementSeparator(sep)[源代码]¶

Sets the element separator character.

参数:¶

sep¶: Separator character.

setLength(index, length)[源代码]¶

Sets the length of the sequence element.

参数:¶

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

setPosition(index, position)[源代码]¶

Sets the position of the sequence element.

参数:¶

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

setValue(index, value, replaceAll=False)[源代码]¶

Sets the value of a sequence element.

参数:¶

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)[源代码]¶

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

参数:¶

index¶: Element index.

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

基类：AFXKeyword

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

Member Details:

getTypeName()[源代码]¶

Returns the name of the keyword type.

Implements AFXKeyword.

getValue()[源代码]¶: Returns the keyword's current value.

getValueAsString()[源代码]¶

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

Implements AFXKeyword.

isValueChanged()[源代码]¶

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

Implements AFXKeyword.

setDefaultValue(defaultValue)[源代码]¶

Sets the keyword's default value.

参数:¶

defaultValue¶: Default value.

setValue(newValue)[源代码]¶

Sets the keyword's current value.

参数:¶

newValue¶: New value.

setValueToDefault(ignoreUnspecified=False)[源代码]¶

Sets the keyword value to its default.

参数:¶

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

setValueToPrevious()[源代码]¶

Sets the keyword value to its previous value.

Implements AFXKeyword.

syncPreviousValue()[源代码]¶

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

class AFXStringTarget(initialValue="''")[源代码]¶

基类：AFXTarget

This class is designed for string targets.

Member Details:

getTypeName()[源代码]¶

Returns the name of the target type ("String").

Implements AFXTarget.

getValue()[源代码]¶: Returns the target's current value.

setValue(newValue)[源代码]¶

Sets the target's current value.

参数:¶

newValue¶: New value.

class AFXSymConstKeyword(command, name, isRequired=False, defaultValue=0)[源代码]¶

基类：AFXIntKeyword

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

Member Details:

getTypeName()[源代码]¶

Returns the name of the keyword type.

Reimplemented from AFXIntKeyword.

getValueAsString()[源代码]¶

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

Reimplemented from AFXIntKeyword.

setDefaultValue(defaultValue)[源代码]¶

Sets the keyword's default value.

参数:¶

defaultValue¶: Default value.

setDefaultValueByString(defaultValueString)[源代码]¶

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

参数:¶

defaultValueString¶: Default value in text string form.

setValue(newValue)[源代码]¶

Sets the keyword's current value.

参数:¶

newValue¶: New value.

setValueByString(newValueString)[源代码]¶

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

参数:¶

newValueString¶: New value in text string form.

setValueToDefault(ignoreUnspecified=False)[源代码]¶

Sets the keyword value to its default.

参数:¶

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

class AFXTogglableKeyword[源代码]¶

基类：object

Member Details:

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

基类：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` = -788312340903285136[源代码]¶: Equal to.

GE : --is-rst--:py:class:`int` = -7182628275175705856[源代码]¶: Greater than or equal to.

GT : --is-rst--:py:class:`int` = 255402661375692868[源代码]¶: Greater than.

LE : --is-rst--:py:class:`int` = -7595473013588948815[源代码]¶: Less than or equal to.

LT : --is-rst--:py:class:`int` = -2595155535706620617[源代码]¶: Less than.

NE : --is-rst--:py:class:`int` = 5125874457507333613[源代码]¶: Not equal to.

class Operator[源代码]¶

基类：object

Member Details:

process(sender)[源代码]¶

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.

参数:¶

sender¶: Message sender.

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

基类：AFXKeyword

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

Member Details:

ID_PRINTSNIPPET : --is-rst--:py:class:`int` = -2718326084848093570[源代码]¶: For debugging.

equal(index, a, b)[源代码]¶

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

参数:¶

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

getDefaultStyle()[源代码]¶: Returns the default style for elements.

getDefaultType()[源代码]¶: Returns the default type for elements.

getDefaultValues()[源代码]¶: Returns the default values for this tuple.

getElementStyle(index)[源代码]¶

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

参数:¶

index¶: Element index.

getElementType(index)[源代码]¶

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

参数:¶

index¶: Element index.

getFormattedValue(index)[源代码]¶

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.

参数:¶

index¶: Element index.

getLength()[源代码]¶: Returns the length of the tuple.

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

getMinLength()[源代码]¶: Returns the minimum length of this tuple.

getTypeName()[源代码]¶

Returns the name of the tuple keyword type.

Implements AFXKeyword.

getValue(index)[源代码]¶

Returns the value of a tuple element.

参数:¶

index¶: Element index.

getValueAsDouble()[源代码]¶: Returns the keyword's value as a float; returns False upon failure.

getValueAsInt()[源代码]¶: Returns the keyword's value as an integer; returns False upon failure.

getValueAsString()[源代码]¶

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

Implements AFXKeyword.

getValueForBlank(index)[源代码]¶

Returns the value substituted for blank tuple element.

参数:¶

index¶: Element index.

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

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

insertElements(index, numCols)[源代码]¶

Inserts elements starting at the given index.

参数:¶

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

isValueChanged()[源代码]¶

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

Implements AFXKeyword.

removeElements(index, numCols)[源代码]¶

Removes elements starting at the given index.

参数:¶

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

setDefaultStyle(style)[源代码]¶

Sets the default style for elements.

参数:¶

style¶: New default element style.

setDefaultType(type)[源代码]¶

Sets the default type for elements.

参数:¶

type¶: New default type.

setDefaultValues(values)[源代码]¶

Sets the default values for this tuple.

参数:¶

values¶: Sequence string with default values.

setElementStyle(index, style)[源代码]¶

Sets the style of one element.

参数:¶

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

setElementType(index, type)[源代码]¶

Sets the type of one element.

参数:¶

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

setLengthRange(minLength, maxLength)[源代码]¶

Sets the range of allowable tuple lengths.

参数:¶

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

setMaxLength(length)[源代码]¶

Sets the maximum length of this tuple.

参数:¶

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

setMinLength(length)[源代码]¶

Sets the minimum length of this tuple.

参数:¶

length¶: New minimum length.

setValue(index, value)[源代码]¶

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

参数:¶

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

setValueForBlank(index, value)[源代码]¶

Sets the value substituted for a blank tuple element.

参数:¶

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

setValueToDefault(ignoreUnspecified=False)[源代码]¶

Sets the keyword value to its default.

参数:¶

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

setValueToPrevious()[源代码]¶

Sets the keyword value to its previous value.

Implements AFXKeyword.

setValues(values)[源代码]¶

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

参数:¶

values¶: Tuple string with new values.

setValuesForBlanks(values)[源代码]¶

Sets all values substituted for blanks for the tuple elements.

参数:¶

values¶: Tuple string with values.

syncPreviousValue()[源代码]¶

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

Implements AFXKeyword.

class FXChore[源代码]¶

基类：object

Member Details:

class FXColor[源代码]¶

基类：object

Member Details:

class FXDrawable[源代码]¶

基类：FXId

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

Member Details:

getHeight()[源代码]¶: Height of drawable.

getVisual()[源代码]¶: Get the visual.

getWidth()[源代码]¶: Width of drawable.

resize(w, h)[源代码]¶

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

参数:¶

w¶
h¶

class FXId[源代码]¶

基类：FXObject

Encapsulates server side resource.

Member Details:

create()[源代码]¶

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()[源代码]¶

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()[源代码]¶

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()[源代码]¶: Get application.

getUserData()[源代码]¶: Get user data pointer.

id()[源代码]¶

Get XID handle.

Reimplemented in FXFont.

setUserData(ptr)[源代码]¶

Set user data pointer.

参数:¶

ptr¶

class FXExponent[源代码]¶

基类：object

Member Details:

class FXFontDesc[源代码]¶

基类：object

Member Details:

class FXIconItem[源代码]¶

基类：FXObject

Icon item.

Member Details:

class FXIconListSortFunc[源代码]¶

基类：object

Member Details:

class FXInputHandle[源代码]¶

基类：object

Member Details:

class FXListItem[源代码]¶

基类：FXObject

List item.

Member Details:

class FXMDIClient[源代码]¶

基类：object

Member Details:

class FXMenuPane[源代码]¶

基类：object

Member Details:

class FXMenubar[源代码]¶

基类：FXToolbar

Menu bar.

Member Details:

class FXToolbar[源代码]¶

基类：object

Member Details:

class FXMetaClass[源代码]¶

基类：object

Member Details:

class FXSelector[源代码]¶

基类：object

Member Details:

class FXObjectList(orig)[源代码]¶

基类：object

List of pointers to objects.

Member Details:

append(p)[源代码]¶

Append element.

参数:¶

p¶

clear()[源代码]¶: Remove all elements.

findb(p, pos=2147483647)[源代码]¶

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

参数:¶

p¶
pos=2147483647¶

findf(p, pos=0)[源代码]¶

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

参数:¶

p¶
pos=0¶

insert(pos, p)[源代码]¶

Insert element at certain position.

参数:¶

pos¶
p¶

no()[源代码]¶: Return number of elements.

remove(pos)[源代码]¶

Remove element at pos.

参数:¶

pos¶

size()[源代码]¶

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[源代码]¶

基类：object

Member Details:

class FXRGB(R, G, B)[源代码]¶

基类：FXColor

Member Details:

class FXTimer[源代码]¶

基类：object

Member Details:

class FXTreeItem[源代码]¶

基类：FXObject

Tree list Item.

Member Details:

class FXVisual[源代码]¶

基类：object

Member Details:

FXMAPFUNC(object, messageType, messageId, method)[源代码]¶

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

参数:¶

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)[源代码]¶

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

参数:¶

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).

MKUINT(messageId, messageType)[源代码]¶

Creates a message selector by combining a message ID and a message type.

参数:¶

messageId¶: An integer specifying the message ID.
messageType¶: An integer flag specifying the message type (e.g. SEL_COMMAND).

SELID(selector)[源代码]¶

Returns the message ID from a message selector.

参数:¶

selector¶: A message selector.

SELTYPE(selector)[源代码]¶

Returns the message type from a message selector.

参数:¶

selector¶: A message selector.

class PluginToolsetBase[源代码]¶

基类：object

Member Details:

class SOCKET[源代码]¶

基类：object

Member Details: