AFXBoolKeyword

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


AFXBoolKeyword(command, name, booleanType=ON_OFF, isRequired=FALSE, defaultValue=FALSE)

Constructor.

ArgumentTypeDefaultDescription
commandAFXCommand Host command.
nameString Keyword name.
booleanTypeTypeON_OFFType of boolean used in the command.
isRequiredIntFALSETRUE if the keyword is a required argument of the command.
defaultValueIntFALSEDefault value.


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.

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
ignoreUnspecifiedIntFALSENot 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 flags

Flags for the type of the boolean.

ON_OFF

Keyword value will be ON or OFF.

TRUE_FALSE

Keyword value will be TRUE or FALSE.