AFXSymConstKeyword

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


AFXSymConstKeyword(command, name, isRequired=FALSE, defaultValue=0)

Constructor.

ArgumentTypeDefaultDescription
commandAFXCommand Host command.
nameString Keyword name.
isRequiredIntFALSETRUE if the keyword is a required argument of the command.
defaultValueInt0Default value.


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.

ArgumentTypeDefaultDescription
defaultValueInt Default value.


setDefaultValueByString(defaultValueString)

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

ArgumentTypeDefaultDescription
defaultValueStringString Default value in text string form.


setDefaultValueByString(defaultValueString)

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

ArgumentTypeDefaultDescription
defaultValueStringString Default value in text string form.


setValue(newValue)

Sets the keyword's current value.

ArgumentTypeDefaultDescription
newValueInt New value.


setValueByString(newValueString)

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

ArgumentTypeDefaultDescription
newValueStringString New value in text string form.


setValueByString(newValueString)

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

ArgumentTypeDefaultDescription
newValueStringString New value in text string form.


setValueToDefault(ignoreUnspecified=FALSE)

Sets the keyword value to its default.

ArgumentTypeDefaultDescription
ignoreUnspecifiedIntFALSEIgnore setting the value if the default is unspecified.