RActionAdapter
Class in Core Module
Header: #include <src/core/RActionAdapter.h>
Inherits: RAction
Inherited by: RNavigationAction
Description
Section titled “Description”Abstract base class for all action classes.
Action classes handle user interaction with a document. A menu, toolbar button or command usually triggers an action.
Scriptable: This class is available in script environments.
\generateScriptShell
Public Functions
Section titled “Public Functions”RActionAdapter(RGuiAction *guiAction=NULL) |
|
| virtual | ~RActionAdapter() |
| virtual void | applyOperation() |
| virtual void | beginEvent()Called as soon as the action is created (menu chosen, toolbutton activated, etc). |
| virtual void | commandEvent(RCommandEvent &)Called when a command is entered in the command line. |
| virtual void | commandEventPreview(RCommandEvent &)Called when a command is being edited in the command line. |
| virtual void | coordinateEvent(RCoordinateEvent &)Called for every coordinate event. |
| virtual void | coordinateEventPreview(RCoordinateEvent &)Called if the action is in PickCoordinate mode and the mouse is moved around. |
| virtual void | enterEvent()Called when user presses enter (e.g. |
| virtual void | entityPickEvent(REntityPickEvent &) |
| virtual void | entityPickEventPreview(REntityPickEvent &) |
| virtual void | escapeEvent()Escape events are triggered if the user clicks the right mouse button or hits the Escape key. |
| virtual void | finishEvent()Called just before the action is deleted. |
| virtual int | getState() |
| virtual void | keyPressEvent(QKeyEvent &) |
| virtual void | keyReleaseEvent(QKeyEvent &) |
| virtual void | mouseDoubleClickEvent(RMouseEvent &)Called on mouse double click events. |
| virtual void | mouseMoveEvent(RMouseEvent &)Called on mouse move events. |
| virtual void | mousePressEvent(RMouseEvent &)Called on mouse press events. |
| virtual void | mouseReleaseEvent(RMouseEvent &)Called on mouse release events. |
| virtual void | panGestureEvent(QPanGesture &)Called on pan gesture events. |
| virtual void | pinchGestureEvent(QPinchGesture &)Called on pinch gesture events. |
| virtual void | propertyChangeEvent(RPropertyEvent &)Called when the value of a property is modified while this action is active. |
| virtual void | resumeEvent()Resumes the action (for example when another action became active and then terminated or if the mouse cursor enters the view). |
| virtual void | setGraphicsView(RGraphicsView *)Called if this action is set as a navigation action of a graphics view. |
| virtual void | suspendEvent()Called when the action is suspended, for example when another action becomes active or the mouse cursor leaves the view. |
| virtual void | swipeGestureEvent(QSwipeGesture &)Called on swipe gesture events. |
| virtual void | tabletEvent(RTabletEvent &)Called on tablet events. |
| virtual void | updatePreview() |
| virtual void | wheelEvent(RWheelEvent &)Called on mouse wheel events. |
| virtual void | zoomChangeEvent(RGraphicsView &)Called when the zoom factor or offset changed in the given view. |
Member Documentation
Section titled “Member Documentation”RActionAdapter
Section titled “RActionAdapter”RActionAdapter::RActionAdapter(RGuiAction *guiAction=NULL)inline
~RActionAdapter
Section titled “~RActionAdapter”virtual RActionAdapter::~RActionAdapter()virtual inline
applyOperation
Section titled “applyOperation”virtual void RActionAdapter::applyOperation()virtual inline
Reimplemented from applyOperation.
beginEvent
Section titled “beginEvent”virtual void RActionAdapter::beginEvent()virtual inline
Called as soon as the action is created (menu chosen, toolbutton activated, etc).
Reimplemented from beginEvent.
commandEvent
Section titled “commandEvent”virtual void RActionAdapter::commandEvent(RCommandEvent &)virtual inline
Called when a command is entered in the command line.
Reimplemented from commandEvent.
commandEventPreview
Section titled “commandEventPreview”virtual void RActionAdapter::commandEventPreview(RCommandEvent &)virtual inline
Called when a command is being edited in the command line.
Reimplemented from commandEventPreview.
coordinateEvent
Section titled “coordinateEvent”virtual void RActionAdapter::coordinateEvent(RCoordinateEvent &)virtual inline
Called for every coordinate event.
Coordinate events can be the result of a mouse click or an entered coordinate from the command line. These events are fired after mouse click events in mode “PickCoordinate”.
Reimplemented from coordinateEvent.
coordinateEventPreview
Section titled “coordinateEventPreview”virtual void RActionAdapter::coordinateEventPreview(RCoordinateEvent &)virtual inline
Called if the action is in PickCoordinate mode and the mouse is moved around.
Typically, some sort of preview is shown to the user to indicate what would happen if that coordinate would be picked.
Reimplemented from coordinateEventPreview.
enterEvent
Section titled “enterEvent”virtual void RActionAdapter::enterEvent()virtual inline
Called when user presses enter (e.g.
to show action dialog with options).
Reimplemented from enterEvent.
entityPickEvent
Section titled “entityPickEvent”virtual void RActionAdapter::entityPickEvent(REntityPickEvent &)virtual inline
Reimplemented from entityPickEvent.
entityPickEventPreview
Section titled “entityPickEventPreview”virtual void RActionAdapter::entityPickEventPreview(REntityPickEvent &)virtual inline
Reimplemented from entityPickEventPreview.
escapeEvent
Section titled “escapeEvent”virtual void RActionAdapter::escapeEvent()virtual inline
Escape events are triggered if the user clicks the right mouse button or hits the Escape key.
The action is expected to go one step back, to the last state or terminate itself.
Reimplemented from escapeEvent.
finishEvent
Section titled “finishEvent”virtual void RActionAdapter::finishEvent()virtual inline
Called just before the action is deleted.
Reimplemented from finishEvent.
getState
Section titled “getState”virtual int RActionAdapter::getState()virtual inline
Reimplemented from getState.
keyPressEvent
Section titled “keyPressEvent”virtual void RActionAdapter::keyPressEvent(QKeyEvent &)virtual inline
Reimplemented from keyPressEvent.
keyReleaseEvent
Section titled “keyReleaseEvent”virtual void RActionAdapter::keyReleaseEvent(QKeyEvent &)virtual inline
Reimplemented from keyReleaseEvent.
mouseDoubleClickEvent
Section titled “mouseDoubleClickEvent”virtual void RActionAdapter::mouseDoubleClickEvent(RMouseEvent &)virtual inline
Called on mouse double click events.
Reimplemented from mouseDoubleClickEvent.
mouseMoveEvent
Section titled “mouseMoveEvent”virtual void RActionAdapter::mouseMoveEvent(RMouseEvent &)virtual inline
Called on mouse move events.
Reimplemented from mouseMoveEvent.
Reimplemented in mouseMoveEvent.
mousePressEvent
Section titled “mousePressEvent”virtual void RActionAdapter::mousePressEvent(RMouseEvent &)virtual inline
Called on mouse press events.
Reimplemented from mousePressEvent.
Reimplemented in mousePressEvent.
mouseReleaseEvent
Section titled “mouseReleaseEvent”virtual void RActionAdapter::mouseReleaseEvent(RMouseEvent &)virtual inline
Called on mouse release events.
Reimplemented from mouseReleaseEvent.
Reimplemented in mouseReleaseEvent.
panGestureEvent
Section titled “panGestureEvent”virtual void RActionAdapter::panGestureEvent(QPanGesture &)virtual inline
Called on pan gesture events.
Reimplemented from panGestureEvent.
pinchGestureEvent
Section titled “pinchGestureEvent”virtual void RActionAdapter::pinchGestureEvent(QPinchGesture &)virtual inline
Called on pinch gesture events.
Reimplemented from pinchGestureEvent.
propertyChangeEvent
Section titled “propertyChangeEvent”virtual void RActionAdapter::propertyChangeEvent(RPropertyEvent &)virtual inline
Called when the value of a property is modified while this action is active.
Reimplemented from propertyChangeEvent.
resumeEvent
Section titled “resumeEvent”virtual void RActionAdapter::resumeEvent()virtual inline
Resumes the action (for example when another action became active and then terminated or if the mouse cursor enters the view).
Reimplemented from resumeEvent.
setGraphicsView
Section titled “setGraphicsView”virtual void RActionAdapter::setGraphicsView(RGraphicsView *)virtual inline
Called if this action is set as a navigation action of a graphics view.
Reimplemented from setGraphicsView.
suspendEvent
Section titled “suspendEvent”virtual void RActionAdapter::suspendEvent()virtual inline
Called when the action is suspended, for example when another action becomes active or the mouse cursor leaves the view.
Reimplemented from suspendEvent.
swipeGestureEvent
Section titled “swipeGestureEvent”virtual void RActionAdapter::swipeGestureEvent(QSwipeGesture &)virtual inline
Called on swipe gesture events.
Reimplemented from swipeGestureEvent.
tabletEvent
Section titled “tabletEvent”virtual void RActionAdapter::tabletEvent(RTabletEvent &)virtual inline
Called on tablet events.
Reimplemented from tabletEvent.
updatePreview
Section titled “updatePreview”virtual void RActionAdapter::updatePreview()virtual inline
Reimplemented from updatePreview.
wheelEvent
Section titled “wheelEvent”virtual void RActionAdapter::wheelEvent(RWheelEvent &)virtual inline
Called on mouse wheel events.
Reimplemented from wheelEvent.
zoomChangeEvent
Section titled “zoomChangeEvent”virtual void RActionAdapter::zoomChangeEvent(RGraphicsView &)virtual inline
Called when the zoom factor or offset changed in the given view.
Reimplemented from zoomChangeEvent.