Rogue Wave Views Application Framework Package API Reference Guide |
Rogue Wave Views Documentation Home |
Set of description parameters associated with an action. More...
#include <ilviews/appframe/command.h>
Public Types |
Public Member Functions | |
virtual IlvBitmap * | getBitmap (const IlSymbol *state=0) const =0 |
Gets the bitmap of the action descriptor. More... | |
virtual const char * | getLabel () const =0 |
Gets the label of the action. More... | |
virtual State | getState () const =0 |
Returns the state of the action descriptor. | |
virtual void | setBitmap (IlvBitmap *bitmap, const IlSymbol *state=0)=0 |
Sets the bitmap associated with the action descriptor, when it is in the state state. If state is omitted or set to 0 , the normal state is assumed.The new bitmap is locked, and the previous bitmap is unlocked. More... | |
virtual void | setChecked (IlBoolean check=IlTrue)=0 |
Sets whether the action descriptor is checked. More... | |
virtual void | setLabel (const char *label)=0 |
Sets the label associated with the action descriptor to a copy of the label parameter. More... | |
virtual void | setState (State state)=0 |
Sets the state of the action descriptor. More... | |
void | setValid (IlBoolean valid) |
Sets the action descriptor to valid or not valid. More... | |
Public Member Functions inherited from IlvDvSerializable | |
virtual void | serialize (IlvDvStream &stream) |
Serializes the object in the stream stream. Typically, the body of the method has the following form: More... | |
Set of description parameters associated with an action.
Library: ilvappframe
Stores the GUI parameters of an action used to initialize menu items associated with the action.
Action descriptor date.
This enumeration indicates the different states that an action descriptor can have.
|
pure virtual |
Gets the bitmap of the action descriptor.
0
, the normal state is assumed. state | The symbol specifying the state. |
Implemented in IlvDvActionGadgetItem.
|
pure virtual |
Gets the label of the action.
Implemented in IlvDvActionGadgetItem.
|
pure virtual |
Sets the bitmap associated with the action descriptor, when it is in the state state.
If state is omitted or set to 0
, the normal state is assumed.
The new bitmap is locked, and the previous bitmap is unlocked.
bitmap | The new bitmap for the action descriptor. |
state | The state that the given bitmap applies to. |
Implemented in IlvDvActionGadgetItem.
Sets whether the action descriptor is checked.
Checks the action descriptor if the check parameter is IlTrue
. In this case, all related menu items are checked. These menu items are pushed if they are in a toolbar, and they are checked if they are in a popup menu.
If the check parameter is IlFalse
, the action descriptor is unchecked. All related menu items are unchecked. These menu items are unpushed if they are in a toolbar, and they are unchecked if they are in a popup menu.
check | Indicates whether the action descriptor is to be checked or unchecked. |
Implemented in IlvDvActionGadgetItem.
|
pure virtual |
Sets the label associated with the action descriptor to a copy of the label parameter.
label | The new label for the action. |
Implemented in IlvDvActionGadgetItem.
|
pure virtual |
Sets the state of the action descriptor.
All menu items that correspond to this action descriptor will be modified with a new state and a new bitmap, according to the state that is specified.
state | Indicates the new state for the action descriptor. |
Implemented in IlvDvActionGadgetItem.
void IlvDvActionDescriptor::setValid | ( | IlBoolean | valid | ) |
Sets the action descriptor to valid or not valid.
If valid is IlTrue
, the Active
state is given to the action descriptor. Otherwise, the action descriptor is set to the Unsensitive
state.
valid | Indicates whether the action descriptor is to be active or unsensitive. |
© 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.