Rogue Wave Views Foundation Package API Reference Guide |
Rogue Wave Views Documentation Home |
Flags indicating the properties of an IlvAction
object.
More...
#include <ilviews/base/action.h>
Public Attributes | |
IlUShort | error |
Error flag left whose interpretation is left open to the implementer. More... | |
IlBoolean | isCommand: 2 |
IlBoolean | isDone: 2 |
When set, this flag indicates that the action has been performed. More... | |
IlBoolean | isPersistent: 2 |
IlBoolean | isRepeatable: 2 |
IlUShort IlvActionFlags::error |
Error flag left whose interpretation is left open to the implementer.
Depending on the context, some actions may fail to be executed. This flag should be left to 0 when the action is successfully executed, or set to another value when it fails. Error codes set by an action should be documented to allow the caller of the action to provide feedback to the user.
IlBoolean IlvActionFlags::isCommand |
When set, this flag indicates that the action is a command. This means that it can be undone, or at least saved to a command history.
IlBoolean IlvActionFlags::isDone |
When set, this flag indicates that the action has been performed.
Calling IlvAction::execute()
sets this flag to IlTrue
.
Calling IlvCommand::undo()
sets it to IlFalse
. This flag can also be set independently of these function calls.
IlBoolean IlvActionFlags::isPersistent |
When set, this flag indicates that the action can be saved to a file and read. This means that it can be included in a macro. This feature is not yet implemented.
IlBoolean IlvActionFlags::isRepeatable |
When set, this flag indicates that the action can be repeated.
© Copyright 2016, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.