MeVisLab Toolbox Reference
|
#include <CSOKeyboardCommands.h>
Public Member Functions | |
CSOCancelCommandAction (SoView2DCSOExtensibleEditor *owner) | |
void | execute () override |
Executes the action. Must be overridden by user. More... | |
![]() | |
SoCommandAction (SoInteractionOwner *owner, std::string id) | |
Standard constructor. More... | |
bool | setShortcut (const std::string &shortcut) |
Sets the (only) default key shortcut (as string describing the shortcut, see ManagedKeyboardShortcut::fromString). More... | |
void | setShortcut (const Shortcut &shortcut) |
Sets the (only) default key shortcut. More... | |
void | addShortcut (const Shortcut &shortcut) |
Adds another default key shortcut. More... | |
void | clearShortcuts () |
Clears all currently set shortcuts. More... | |
ShortcutList | getShortcuts () const |
Returns the default key shortcuts. More... | |
TriggerList | getTriggers () const |
Alternative name for getShortcuts() More... | |
virtual bool | isShortcut (int modifiers, SoKeyboardEvent::Key keyCode) const |
Checks whether the given key with the given modifiers is a shortcut for this action; see SoInteraction for possible modifiers. More... | |
![]() | |
SoInteraction (InteractionType type, SoInteractionOwner *owner, const std::string &id, bool registerWithOwner=true) | |
Standard constructor. More... | |
virtual | ~SoInteraction () |
Virtual destructor. More... | |
SoInteractionOwner * | getOwner () const |
Returns the interaction provider of this entry. More... | |
virtual bool | isEnabled () const |
Returns the enabled status of this interaction - if this returns false , the action is not selectable (but if a mouse action has already been started, it will not be aborted if this returns false ). More... | |
virtual void | setEnabled (bool enabled) |
Sets the enabled status of this interaction. More... | |
std::string | getID () const |
Returns the ID of this interaction. More... | |
void | setID (const std::string &id) |
Sets the ID of this interaction. More... | |
std::string | getFullID () const |
Returns the ID string consisting of the ID of the provider and this action's ID, separated by '. More... | |
InteractionType | getInteractionType () const |
Returns type of interaction object. More... | |
template<class T > | |
bool | isOfType () const |
Convenience method for checking type. More... | |
int | getMenuPriority () const |
void | setMenuPriority (int priority) |
Sets the priority value for ordered display in menus/tool boxes. More... | |
virtual std::string | getUserName () const |
Returns user-visible name of this item for direct display (e.g., in tool box or menu). More... | |
virtual void | setUserName (const std::string &name) |
Sets the user name of this interaction entry. More... | |
virtual std::string | getIconFile () const |
Returns the filename of an icon (e.g., for use in a tool box or in menu). More... | |
virtual void | setIconFile (const std::string &file) |
Sets the filename of an icon used for this interaction entry. More... | |
virtual std::string | getDescription () const |
Returns the description for user help. More... | |
virtual void | setDescription (const std::string &descr) |
Sets the description for user help. More... | |
virtual void | ref () |
virtual void | unref () |
int | getStateVersion () const |
void | touch () |
Increments the version number of attribute state to mark attribute changes. More... | |
Additional Inherited Members | |
![]() | |
enum | { TypeId = TypeCommandAction } |
typedef ManagedKeyboardShortcut | Shortcut |
Class Shortcut encapsulates the combination of modifier keys and another key that activates a command. More... | |
typedef std::list< Shortcut > | ShortcutList |
A list of shortcuts. More... | |
typedef ManagedKeyboardShortcut | Trigger |
Also define Trigger as synonym for Shortcut, since that name is used by the other interactions. More... | |
typedef std::list< Shortcut > | TriggerList |
Defines TriggerList as synonym for ShortcutList. More... | |
![]() | |
enum | { NoModifier = ManagedActionTrigger::NoModifier , ShiftModifier = ManagedActionTrigger::ShiftModifier , ControlModifier = ManagedActionTrigger::ControlModifier , AltModifier = ManagedActionTrigger::AltModifier , AllModifiersMask = ManagedActionTrigger::AllModifiersMask , ShiftMask = ShiftModifier , CtrlMask = ControlModifier , AltMask = AltModifier } |
Constants to use where keyboard modifiers must be specified. More... | |
enum | InteractionType { TypePointingAction , TypeCommandAction , TypeOffsetAction } |
Enum identifying subtypes of this class. More... | |
Definition at line 103 of file CSOKeyboardCommands.h.
CSOCancelCommandAction::CSOCancelCommandAction | ( | SoView2DCSOExtensibleEditor * | owner | ) |
|
overridevirtual |
Executes the action. Must be overridden by user.
Implements SoCommandAction.