rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Application Framework Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvDvActionGadgetItem Class Reference

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

#include <ilviews/appframe/command.h>

Inheritance diagram for IlvDvActionGadgetItem:
IlvDvActionDescriptor IlvDvSerializable

List of all members.

Public Member Functions

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

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.

Parameters:
label The new label for this action.
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.

Implements IlvDvActionDescriptor.

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:
bitmap The new bitmap for the action descriptor.
state The 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 valid 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:
valid Indicates 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:
label The 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:
state Indicates the new state for the action descriptor.

Implements IlvDvActionDescriptor.


© Copyright 2012, 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.