Rogue Wave Views
Application Framework Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvDvActionGadgetItem Class Reference

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

#include <ilviews/appframe/command.h>

Inheritance diagram for IlvDvActionGadgetItem:
IlvDvActionDescriptor IlvDvSerializable

Public Member Functions

virtual IlvBitmapgetBitmap (const IlSymbol *) const
 Gets the bitmap of the action descriptor. More...
 
IlvGadgetItemgetGadgetItem () const
 
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, 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=IlTrue)
 Sets whether the action descriptor is checked. More...
 
virtual void setLabel (const char *)
 Sets the label associated with the action descriptor to a copy of the label parameter. More...
 
virtual void setState (State 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

Detailed Description

Stores the GUI parameters of a given action.

Library: ilvappframe

Member Function Documentation

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
stateThe symbol specifying the state.

Implements IlvDvActionDescriptor.

IlvGadgetItem* IlvDvActionGadgetItem::getGadgetItem ( ) const

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

Returns
The gadget item used.
virtual const char* IlvDvActionGadgetItem::getLabel ( ) const
virtual

Gets the label of the action.

Returns
The label associated with the action.

Implements IlvDvActionDescriptor.

virtual void IlvDvActionGadgetItem::setBitmap ( IlvBitmap bitmap,
const IlSymbol state = 0 
)
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.

Parameters
bitmapThe new bitmap for the action descriptor.
stateThe state that the given bitmap applies to.

Implements IlvDvActionDescriptor.

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
checkIndicates whether the action descriptor is to be checked or unchecked.

Implements IlvDvActionDescriptor.

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

Sets the label associated with the action descriptor to a copy of the label parameter.

Parameters
labelThe new label for the action.

Implements IlvDvActionDescriptor.

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
stateIndicates the new state for the action descriptor.

Implements IlvDvActionDescriptor.


© 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.