Developer Documentation
KeyInterface Class Reference

Keyboard Event Interface. More...

#include <OpenFlipper/BasePlugin/KeyInterface.hh>

Inheritance diagram for KeyInterface:
BackupPlugin BSplineCurveSelectionPlugin BSplineSurfaceSelectionPlugin DataControlPlugin MaterialPicker MeshObjectSelectionPlugin MouseAndKeyPlugin MovePlugin ObjectSelectionPlugin PlanePlugin PolyLinePlugin PolyLineSelectionPlugin PrintPlugin PropertyVisPlugin SelectionBasePlugin SkeletonEditingPlugin SplatCloudObjectSelectionPlugin TopologyPlugin TypeHexahedralMeshPlugin TypePolyhedralMeshPlugin TypeTetrahedralMeshPlugin VolumeMeshSelectionPlugin

Public Slots

virtual void slotKeyEvent (QKeyEvent *_event)
 Key Event from Main App. More...
 

Signals

virtual void registerKey (int _key, Qt::KeyboardModifiers _modifiers, QString _description, bool _multiUse=false)
 Register a key-combination for your plugin. More...
 

Public Member Functions

virtual void slotKeyReleaseEvent (QKeyEvent *_event)
 Key Release Event from Main App. More...
 
virtual ~KeyInterface ()
 Destructor.
 

Detailed Description

Keyboard Event Interface.

Detailed description
Using this interface you can react on key events.

Definition at line 59 of file KeyInterface.hh.

Member Function Documentation

◆ registerKey

virtual void KeyInterface::registerKey ( int  _key,
Qt::KeyboardModifiers  _modifiers,
QString  _description,
bool  _multiUse = false 
)
inlinevirtualsignal

Register a key-combination for your plugin.

To obtain key events from the viewer for a certain key-combination, you have to register that combination first

Parameters
_keythe key that should be registered
_modifiersthe keyboard modifiers
_descriptiona short description about the functionality (Will be used in the Options Widget)
_multiUsecan the key additionally be registered by another plugin (You could make a key exclusive by this)

Definition at line 71 of file KeyInterface.hh.

◆ slotKeyEvent

virtual void KeyInterface::slotKeyEvent ( QKeyEvent *  _event)
inlinevirtualslot

Key Event from Main App.

This slot is called if a key event occurred in the Viewer

Parameters
_eventKey event

Definition at line 80 of file KeyInterface.hh.

◆ slotKeyReleaseEvent()

virtual void KeyInterface::slotKeyReleaseEvent ( QKeyEvent *  _event)
inlinevirtual

Key Release Event from Main App.

This slot is called if a key release event occurred in the Viewer

Parameters
_eventKey event

Definition at line 87 of file KeyInterface.hh.


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