IlvDvActionGadgetItem Class Reference

Stores the GUI parameters of a given action. More...

#include <ilviews/appframe/command.h>

Inheritance diagram for IlvDvActionGadgetItem:

Public Member Functions
virtual IlvBitmap *	getBitmap (const IlSymbol *) const
	Gets the bitmap of the action descriptor. More...
IlvGadgetItem *	getGadgetItem () const
	Returns a pointer to the gadget item used by the instance. More...
virtual const char *	getLabel () const
	Gets the label of the action. More...
virtual State	getState () const
	Returns the state of the action descriptor.
virtual void	setBitmap (IlvBitmap *, const IlSymbol *=0)
	Sets the bitmap associated with the action descriptor for a given state. More...
virtual void	setChecked (IlBoolean=IlTrue)
	Sets whether the action descriptor is checked. More...
virtual void	setLabel (const char *)
	Sets the label associated with the action descriptor. More...
virtual void	setState (State)
	Sets the state of the action descriptor. More...
Public Member Functions inherited from IlvDvActionDescriptor
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...

Additional Inherited Members
Public Types inherited from IlvDvActionDescriptor
enum	State { Active, Unactive, Unsensitive }
	Action descriptor date. More...

Detailed Description

Stores the GUI parameters of a given action.

Library: ilvappframe

Member Function Documentation

getBitmap()

virtual IlvBitmap* IlvDvActionGadgetItem::getBitmap ( const IlSymbol *  state ) const

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.

Implements IlvDvActionDescriptor.

getGadgetItem()

IlvGadgetItem* IlvDvActionGadgetItem::getGadgetItem

(

)

const

Returns a pointer to the gadget item used by the instance.

Returns

The gadget item used.

getLabel()

virtual const char* IlvDvActionGadgetItem::getLabel ( ) const

virtual

Gets the label of the action.

Returns

The label associated with the action.

Implements IlvDvActionDescriptor.

setBitmap()

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

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.

Implements IlvDvActionDescriptor.

setChecked()

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

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.

Implements IlvDvActionDescriptor.

setLabel()

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

virtual

Sets the label associated with the action descriptor.

Parameters

label

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

Implements IlvDvActionDescriptor.

setState()

virtual void IlvDvActionGadgetItem::setState ( State  state )

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.

Implements IlvDvActionDescriptor.