SoCommandAction Class Reference

SoCommandAction is the base class for instantaneous actions. More...

#include <SoCommandAction.h>

Inheritance diagram for SoCommandAction:

Public Types
enum	{ TypeId = TypeCommandAction }
typedef ManagedKeyboardShortcut	Shortcut
	Class Shortcut encapsulates the combination of modifier keys and another key that activates a command.
typedef std::list< Shortcut >	ShortcutList
	A list of shortcuts.
typedef ManagedKeyboardShortcut	Trigger
	Also define Trigger as synonym for Shortcut, since that name is used by the other interactions.
typedef std::list< Shortcut >	TriggerList
	Define TriggerList as synonym for ShortcutList.
Public Types inherited from SoInteraction
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 sub-types of this class. More...

Public Member Functions
	SoCommandAction (SoInteractionOwner *owner, std::string id)
	Standard constructor:
bool	setShortcut (const std::string &shortcut)
	Set the (only) default key shortcut (as string describing the shortcut, see ManagedKeyboardShortcut::fromString)
void	setShortcut (const Shortcut &shortcut)
	Set the (only) default key shortcut.
void	addShortcut (const Shortcut &shortcut)
	Add another default key shortcut.
void	clearShortcuts ()
	Clear all currently set shortcuts.
ShortcutList	getShortcuts () const
	Get the default key shortcuts.
TriggerList	getTriggers () const
	Alternative name for getShortcuts()
virtual bool	isShortcut (int modifiers, SoKeyboardEvent::Key keyCode) const
	Check if the given key with the given modifiers is a shortcut for this action; see SoInteraction for possible modifiers.
virtual void	execute ()=0
	Execute the action. Must be overridden by user.
Public Member Functions inherited from SoInteraction
	SoInteraction (InteractionType type, SoInteractionOwner *owner, const std::string &id, bool registerWithOwner=true)
	Standard constructor.
virtual	~SoInteraction ()
	Virtual destructor.
SoInteractionOwner *	getOwner () const
virtual bool	isEnabled () const
virtual void	setEnabled (bool enabled)
	Sets the enabled status of this interaction.
std::string	getID () const
void	setID (const std::string &id)
	Sets the id of this interaction.
std::string	getFullID () const
	Returns the ID string consisting of the id of the provider and this action's id, separated by '.
InteractionType	getInteractionType () const
	Get type of interaction object.
template<class T >
bool	isOfType () const
	Convenience method for checking type.
int	getMenuPriority () const
void	setMenuPriority (int priority)
	Sets the priority value for ordered display in menus/tool boxes.
virtual std::string	getUserName () const
virtual void	setUserName (const std::string &name)
	Sets the user name of this interaction entry.
virtual std::string	getIconFile () const
virtual void	setIconFile (const std::string &file)
	Sets the filename of an icon used for this interaction entry.
virtual std::string	getDescription () const
virtual void	setDescription (const std::string &descr)
	Sets the description for user help.
virtual void	ref ()
virtual void	unref ()
int	getStateVersion () const
void	touch ()
	Increments the version number of attribute state to mark attribute changes.

Detailed Description

SoCommandAction is the base class for instantaneous actions.

You need to override execute() in derived classes!

Some special action IDs should be reserved for special purposes (or rather for standard edit commands): undo, redo, cut, copy, paste, and selectAll; - if you implement these, implement the expected behavior!

Note

If you want to implement commands that act on a specific cursor location you need to override the methods SoInteractionProvider::pointerPosition and SoInteractionProvider::pointerLeftWindow in your node and store the required information in member variables.

You should always disable a SoCommandAction if it currently can't be applied, so that other command actions that use the same keyboard shortcut can be applied instead.

Definition at line 44 of file SoCommandAction.h.

Member Typedef Documentation

Shortcut

typedef ManagedKeyboardShortcut SoCommandAction::Shortcut

Class Shortcut encapsulates the combination of modifier keys and another key that activates a command.

Definition at line 53 of file SoCommandAction.h.

ShortcutList

typedef std::list<Shortcut> SoCommandAction::ShortcutList

A list of shortcuts.

Definition at line 56 of file SoCommandAction.h.

Trigger

typedef ManagedKeyboardShortcut SoCommandAction::Trigger

Also define Trigger as synonym for Shortcut, since that name is used by the other interactions.

Definition at line 59 of file SoCommandAction.h.

TriggerList

typedef std::list<Shortcut> SoCommandAction::TriggerList

Define TriggerList as synonym for ShortcutList.

Definition at line 62 of file SoCommandAction.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
TypeId

Definition at line 49 of file SoCommandAction.h.

Constructor & Destructor Documentation

SoCommandAction()

SoCommandAction::SoCommandAction	(	SoInteractionOwner *	owner,
		std::string	id )

Standard constructor:

Parameters

owner	is the SoInteractionOwner to which the action is added. Ownership is automatically transferred, you don't need to free this object.
id	is the name of this interaction, it should hint at its purpose

Member Function Documentation

addShortcut()

void SoCommandAction::addShortcut

(

const Shortcut &

shortcut

)

Add another default key shortcut.

clearShortcuts()

void SoCommandAction::clearShortcuts ( )

inline

Clear all currently set shortcuts.

Definition at line 81 of file SoCommandAction.h.

execute()

virtual void SoCommandAction::execute ( )

pure virtual

Execute the action. Must be overridden by user.

Implemented in SoCSODrawOnSurfaceCancelCommandAction, SoCSODrawOnSurfaceUndoCommandAction, SoCSODrawOnSurfaceRedoCommandAction, CSOCopyCommandAction, CSOCutCommandAction, CSOPasteCommandAction, CSODeleteSeedPointCommandAction, CSODeleteCSOCommandAction, CSOUndoCommandAction, CSORedoCommandAction, CSOCancelCommandAction, CSORemoveAllCommandAction, and SoView2DKeyboardAction.

getShortcuts()

ShortcutList SoCommandAction::getShortcuts ( ) const

inline

Get the default key shortcuts.

Definition at line 84 of file SoCommandAction.h.

getTriggers()

TriggerList SoCommandAction::getTriggers ( ) const

inline

Alternative name for getShortcuts()

Definition at line 87 of file SoCommandAction.h.

isShortcut()

virtual bool SoCommandAction::isShortcut ( int modifiers, SoKeyboardEvent::Key keyCode ) const

virtual

Check if the given key with the given modifiers is a shortcut for this action; see SoInteraction for possible modifiers.

Overrides from the interaction controller are ignored by this method.

setShortcut() [1/2]

void SoCommandAction::setShortcut

(

const Shortcut &

shortcut

)

Set the (only) default key shortcut.

setShortcut() [2/2]

bool SoCommandAction::setShortcut

(

const std::string &

shortcut

)

Set the (only) default key shortcut (as string describing the shortcut, see ManagedKeyboardShortcut::fromString)

Referenced by SoCSODrawOnSurfaceCancelCommandAction::SoCSODrawOnSurfaceCancelCommandAction(), SoCSODrawOnSurfaceRedoCommandAction::SoCSODrawOnSurfaceRedoCommandAction(), and SoCSODrawOnSurfaceUndoCommandAction::SoCSODrawOnSurfaceUndoCommandAction().

---

The documentation for this class was generated from the following file:

• MeVis/Foundation/Sources/SoManagedInteraction/SoCommandAction.h