SoView2DKeyboardAction Class Reference

#include <SoView2DInteraction.h>

Inheritance diagram for SoView2DKeyboardAction:

Public Member Functions
	SoView2DKeyboardAction (SoView2D *view, const std::string &id, SoKeyboardEvent::Key key, bool withShift=false)
	SoView2DKeyboardAction (SoView2D *view, const std::string &id, SoKeyboardEvent::Key key, SoKeyboardEvent::Key key2)
bool	isNumberKey () const
void	execute () override
	Executes the action. Must be overridden by user.
Public Member Functions inherited from SoCommandAction
	SoCommandAction (SoInteractionOwner *owner, std::string id)
	Standard constructor.
bool	setShortcut (const std::string &shortcut)
	Sets the (only) default key shortcut (as string describing the shortcut, see ManagedKeyboardShortcut::fromString).
void	setShortcut (const Shortcut &shortcut)
	Sets the (only) default key shortcut.
void	addShortcut (const Shortcut &shortcut)
	Adds another default key shortcut.
void	clearShortcuts ()
	Clears all currently set shortcuts.
ShortcutList	getShortcuts () const
	Returns the default key shortcuts.
TriggerList	getTriggers () const
	Alternative name for getShortcuts()
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.
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
	Returns the interaction provider of this entry.
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).
virtual void	setEnabled (bool enabled)
	Sets the enabled status of this interaction.
std::string	getID () const
	Returns the ID of this interaction.
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
	Returns 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
	Returns user-visible name of this item for direct display (e.g., in tool box or menu).
virtual void	setUserName (const std::string &name)
	Sets the user name of this interaction entry.
virtual std::string	getIconFile () const
	Returns the filename of an icon (e.g., for use in a tool box or in menu).
virtual void	setIconFile (const std::string &file)
	Sets the filename of an icon used for this interaction entry.
virtual std::string	getDescription () const
	Returns the description for user help.
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.

Protected Member Functions
SoView2D *	getView () const

Protected Attributes
bool	_numberKey

Additional Inherited Members
Public Types inherited from SoCommandAction
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
	Defines 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 subtypes of this class. More...

Detailed Description

Definition at line 95 of file SoView2DInteraction.h.

Constructor & Destructor Documentation

SoView2DKeyboardAction() [1/2]

SoView2DKeyboardAction::SoView2DKeyboardAction	(	SoView2D *	view,
		const std::string &	id,
		SoKeyboardEvent::Key	key,
		bool	withShift = false
	)

SoView2DKeyboardAction() [2/2]

SoView2DKeyboardAction::SoView2DKeyboardAction	(	SoView2D *	view,
		const std::string &	id,
		SoKeyboardEvent::Key	key,
		SoKeyboardEvent::Key	key2
	)

Member Function Documentation

execute()

void SoView2DKeyboardAction::execute ( )

overridevirtual

Executes the action. Must be overridden by user.

Implements SoCommandAction.

getView()

SoView2D * SoView2DKeyboardAction::getView ( ) const

protected

isNumberKey()

bool SoView2DKeyboardAction::isNumberKey ( ) const

inline

Definition at line 101 of file SoView2DInteraction.h.

References _numberKey.

Member Data Documentation

_numberKey

bool SoView2DKeyboardAction::_numberKey

protected

Definition at line 107 of file SoView2DInteraction.h.

Referenced by isNumberKey().

---

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

• MeVisLab/Standard/Sources/Inventor/SoView2D/SoView2DInteraction.h