Rogue Wave Views |
Rogue Wave Views Documentation Home |
Annotated text class. More...
#include <ilviews/annotext/accels.h>
Public Member Functions | |
IlvATAccelerator (IlvATAction atAction=0, IlvEventType type=(IlvEventType) 0, IlUShort data=0, IlUShort modifiers=0, IlAny userArg=0, IlUShort modifiersToIgnore=0) | |
Constructor. More... | |
IlvATAction | action () const |
Returns the accelerator action. More... | |
virtual void | activate (IlvAnnoText *atext, IlvEvent &event) const |
Calls the accelerator action. More... | |
void | setAction (IlvATAction atAction, IlAny userArg) |
Sets the accelerator action and the user argument. More... | |
Annotated text class.
Library: ilvatext
This subclass of IlvAccelerator
is specialized for using accelerators in an IlvAnnoText
. It defines a function prototype for the accelerator action and provides storage for this action. Generally, applications do not need to use this class. Instead, they use the IlvAnnoText::addAccelerator()
and IlvAnnoText::removeAccelerator()
member functions.
IlvAnnoText
. IlvATAccelerator::IlvATAccelerator | ( | IlvATAction | atAction = 0 , |
IlvEventType | type = (IlvEventType)0 , |
||
IlUShort | data = 0 , |
||
IlUShort | modifiers = 0 , |
||
IlAny | userArg = 0 , |
||
IlUShort | modifiersToIgnore = 0 |
||
) |
Constructor.
Calls the constructor of the superclass with the event description and sets the accelerator action to atAction.
atAction | The accelerator action. |
type | Specifies the type of event that triggers the action. |
data | Specifies the event data. |
modifiers | The mandatory event modifiers. |
userArg | The user argument for the accelerator action. |
modifiersToIgnore | The optional event modifiers. |
IlvATAction IlvATAccelerator::action | ( | ) | const |
Returns the accelerator action.
|
virtual |
Calls the accelerator action.
Virtual function called when the annotated text atext has received an event fulfilling the conditions to trigger the accelerator. The default implementation is to call the action (if any) associated with the accelerator:
IlvAccelerator::trigger()
. atext | The annotated text object. |
event | The event. |
void IlvATAccelerator::setAction | ( | IlvATAction | atAction, |
IlAny | userArg | ||
) |
Sets the accelerator action and the user argument.
atAction | The accelerator action. |
userArg | The user argument for the accelerator action. |
© Copyright 2015, 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.