IlvDvActionDescriptor Class Reference

Set of description parameters associated with an action. More...

#include <ilviews/appframe/command.h>

Inheritance diagram for IlvDvActionDescriptor:

Public Types
enum	State { Active, Unactive, Unsensitive }
	Action descriptor date. More...

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 for a given state. 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. 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...

Detailed Description

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.

Member Enumeration Documentation

State

enum IlvDvActionDescriptor::State

Action descriptor date.

This enumeration indicates the different states that an action descriptor can have.

Enumerator
Active	Active enumeration value. This enumeration value indicates that the action descriptor is in an active state. Corresponding menu items are not grayed and can be activated.
Unactive	Unactive enumeration value. This enumeration value indicates that the action descriptor is in a non-active state. Corresponding menu items are not grayed but can not be activated.
Unsensitive	Unsensitive enumeration value. This enumeration value indicates that the action descriptor is in an unsensitive state. Corresponding menu items are grayed and can not be activated.

Member Function Documentation

getBitmap()

virtual IlvBitmap* IlvDvActionDescriptor::getBitmap ( const IlSymbol *  state = 0 ) const

pure virtual

Gets the bitmap of the action descriptor.

Returns

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.

Parameters

state

The symbol specifying the state.

Implemented in IlvDvActionGadgetItem.

getLabel()

virtual const char* IlvDvActionDescriptor::getLabel ( ) const

pure virtual

Gets the label of the action.

Returns

The label associated with the action.

Implemented in IlvDvActionGadgetItem.

setBitmap()

virtual void IlvDvActionDescriptor::setBitmap ( IlvBitmap *  bitmap, const IlSymbol *  state = 0  )

pure virtual

Sets the bitmap associated with the action descriptor for a given 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.

Parameters

bitmap	The new bitmap for the action descriptor.
state	The state that the given bitmap applies to.

Implemented in IlvDvActionGadgetItem.

setChecked()

virtual void IlvDvActionDescriptor::setChecked ( IlBoolean  check = IlTrue )

pure virtual

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.

Parameters

check

Indicates whether the action descriptor is to be checked or unchecked.

Implemented in IlvDvActionGadgetItem.

setLabel()

virtual void IlvDvActionDescriptor::setLabel ( const char *  label )

pure virtual

Sets the label associated with the action descriptor.

Parameters

label

The new label for the action. The string is copied.

Implemented in IlvDvActionGadgetItem.

setState()

virtual void IlvDvActionDescriptor::setState ( State  state )

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.

Parameters

state

Indicates the new state for the action descriptor.

Implemented in IlvDvActionGadgetItem.

setValid()

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.

Parameters

valid

Indicates whether the action descriptor is to be active or unsensitive.