AFXIntKeyword

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


AFXIntKeyword(command, name, isRequired=False, defaultValue=INT_DEFAULT, evalExpression=True)

Constructor.

ArgumentTypeDefaultDescription
commandAFXCommand Host command.
nameString Keyword name.
isRequiredBoolFalseTrue if the keyword is a required argument of the command.
defaultValueIntINT_DEFAULTDefault value.
evalExpressionBoolTrueTrue if the keyword supports expression evaluation.


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.

ArgumentTypeDefaultDescription
defaultValueInt Default value.


setValue(newValue)

Sets the keyword's current value.

ArgumentTypeDefaultDescription
newValueInt New value.


setValueToDefault(ignoreUnspecified=False)

Sets the keyword value to its default.

ArgumentTypeDefaultDescription
ignoreUnspecifiedBoolFalseIgnore 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.