umbrello 2.34.70-5524f40e1
Umbrello UML Modeller is a Unified Modelling Language (UML) diagram program based on KDE Technology
|
#include <toolbarstate.h>
Public Slots | |
virtual void | slotAssociationRemoved (AssociationWidget *association) |
virtual void | slotWidgetRemoved (UMLWidget *widget) |
Signals | |
void | finished () |
Public Member Functions | |
virtual | ~ToolBarState () |
virtual void | init () |
virtual void | cleanBeforeChange () |
virtual void | mousePress (QGraphicsSceneMouseEvent *ome) |
virtual void | mouseRelease (QGraphicsSceneMouseEvent *ome) |
virtual void | mouseDoubleClick (QGraphicsSceneMouseEvent *ome) |
virtual void | mouseMove (QGraphicsSceneMouseEvent *ome) |
Protected Member Functions | |
ToolBarState (UMLScene *umlScene) | |
virtual void | setCurrentElement () |
virtual void | mousePressAssociation () |
virtual void | mousePressWidget () |
virtual void | mousePressEmpty () |
virtual void | mouseReleaseAssociation () |
virtual void | mouseReleaseWidget () |
virtual void | mouseReleaseEmpty () |
virtual void | mouseDoubleClickAssociation () |
virtual void | mouseDoubleClickWidget () |
virtual void | mouseDoubleClickEmpty () |
virtual void | mouseMoveAssociation () |
virtual void | mouseMoveWidget () |
virtual void | mouseMoveEmpty () |
virtual void | changeTool () |
virtual UMLWidget * | currentWidget () const |
virtual void | setCurrentWidget (UMLWidget *widget) |
virtual AssociationWidget * | currentAssociation () const |
virtual void | setCurrentAssociation (AssociationWidget *association) |
void | setMouseEvent (QGraphicsSceneMouseEvent *ome, const QEvent::Type &type) |
AssociationWidget * | associationAt (const QPointF &pos) |
MessageWidget * | messageAt (const QPointF &pos) |
FloatingDashLineWidget * | floatingLineAt (const QPointF &pos) |
Protected Attributes | |
UMLScene * | m_pUMLScene |
The UMLScene. More... | |
QGraphicsSceneMouseEvent * | m_pMouseEvent |
The mouse event currently in use. More... | |
Private Attributes | |
UMLWidget * | m_currentWidget |
The widget currently in use, if any. More... | |
AssociationWidget * | m_currentAssociation |
The association currently in use, if any. More... | |
Base class for toolbar states. All toolbar states inherit directly or indirectly from this class. Toolbar states represent tools that work with the diagram (for example, to create widgets, make associations...). All the mouse events received in the diagram are delivered to the toolbar state currently active. The events are handled in the tool and it executes the needed actions.
All the mouse event handlers can be overridden in subclasses. However, the behaviour of the main handlers shouldn't be modified (apart from extend it, that is, call the base implementation before any other actions in the derived method).
In order to handle the events, each main handler has three protected "sub-handlers" named like the main handler with the suffixes "Association", "Widget" and "Empty". The events received in the main handlers are delivered to the suitable handler, depending on if the event happened on an association, on a widget or on an empty space of the diagram. Those methods are the ones to override or extend to specify the behaviour of the toolbar state.
The mouse events received in main handlers are tweaked to use the inverse position. The modified event is saved in m_pMouseEvent. This is the event that must be used everywhere.
The association or widget that will receive the events is set in press event. How they are set can be tweaked in subclasses overriding setCurrentElement(). Once a press event happens, all the mouse events and the release event are sent to the same widget or association. Mouse events are delivered only when mouse tracking is enabled. It is enabled in press event, and disabled in release event. Also, it is disabled in the toolbar state initialization. Additionally, it can be enabled or disabled in other situations by subclasses if needed.
After handling a release event, the tool is changed if needed. Default implementation sets the default tool if the button released was the right button. Subclasses can override this behaviour if needed.
When a toolbar state is selected, method init is called to revert its state to the initial. Subclasses should extend that method as needed. Also, method cleanBeforeChange() is called before changing it to the new tool. Subclasses should extend that method as needed.
|
virtual |
Destroys this ToolBarState. Frees m_pMouseEvent.
|
protected |
Creates a new ToolBarState. UMLScene is set as parent of this QObject, and name is left empty. Protected to avoid classes other than derived to create objects of this class.
umlScene | The UMLScene to use. |
|
protected |
Returns the AssociationWidget at the specified position, or null if there is none. If there are more than one association at this point, it returns the first found.
pos | The position to get the association. |
|
protectedvirtual |
Changes the current tool to the default one if the right button was released. It can be overridden in subclasses if needed.
Reimplemented in ToolBarStateArrow.
|
virtual |
Called when the current tool is changed to use another tool. Subclasses can extend, but not override, this method as needed. Default implementation does nothing.
Reimplemented in ToolBarStateAssociation, ToolBarStateMessages, and ToolBarStateOneWidget.
|
protectedvirtual |
Returns the association currently in use.
|
protectedvirtual |
Returns the widget currently in use.
|
signal |
|
protected |
Returns the FloatingDashLineWidget at the specified position, or null if there is none. The floatingdashline is only returned if it is visible.
pos | The position to get the floatingLine. |
|
virtual |
Goes back to the initial state. Subclasses can extend, but not override, this method as needed.
Reimplemented in ToolBarStateArrow, ToolBarStateAssociation, ToolBarStateMessages, and ToolBarStateOneWidget.
|
protected |
Returns the MessageWidget at the specified position, or null if there is none. The message is only returned if it is visible. If there are more than one message at this point, it returns the first found.
pos | The position to get the message. |
|
virtual |
Handler for mouse double click events. The current association or widget is set (if any), and events are delivered to the specific methods, depending on where the cursor was pressed. After delivering the events, the current association or widget is cleaned.
ome | The received event. |
|
protectedvirtual |
Called when the double click event happened on an association. Default implementation does nothing.
Reimplemented in ToolBarStateArrow.
|
protectedvirtual |
Called when the double click event happened on an empty space. Default implementation cleans the selection.
|
protectedvirtual |
Called when the double click event happened on a widget. Default implementation does nothing.
Reimplemented in ToolBarStateArrow.
|
virtual |
Handler for mouse move events. Events are delivered to the specific methods, depending on where the cursor was pressed. It uses the current widget or association set in press event, if any. Then, the scene is scrolled if needed (if the cursor is moved in any of the 30 pixels width area from left, top, right or bottom sides, and there is more diagram currently not being shown in that direction). This method is only called when mouse tracking is enabled and the mouse is moved.
ome | The received event. |
Reimplemented in ToolBarStateAssociation, ToolBarStateMessages, and ToolBarStateOneWidget.
|
protectedvirtual |
Called when the move event happened when an association is currently available. Default implementation does nothing.
Reimplemented in ToolBarStateArrow.
|
protectedvirtual |
Called when the move event happened when no association nor widget are currently available. Default implementation does nothing.
Reimplemented in ToolBarStateArrow.
|
protectedvirtual |
Called when the move event happened when a widget is currently available. Default implementation does nothing.
Reimplemented in ToolBarStateArrow.
|
virtual |
Handler for mouse press events. Mouse tracking is enabled, any pop up menu removed, the position of the cursor set and paste state disabled. Then, the current association or widget are set (if any), and events are delivered to the specific methods, depending on where the cursor was pressed.
ome | The received event. |
|
protectedvirtual |
Called when the press event happened on an association. Default implementation does nothing.
Reimplemented in ToolBarStateArrow.
|
protectedvirtual |
Called when the press event happened on an empty space. Default implementation cleans the selection.
Reimplemented in ToolBarStateArrow.
|
protectedvirtual |
Called when the press event happened on a widget. Default implementation does nothing.
Reimplemented in ToolBarStateArrow.
|
virtual |
Handler for mouse release events. Mouse tracking is disabled and the position of the cursor set. The events are delivered to the specific methods, depending on where the cursor was released, and the current association or widget cleaned. Finally, the current tool is changed if needed.
ome | The received event. |
|
protectedvirtual |
Called when the release event happened on an association. Default implementation does nothing.
Reimplemented in ToolBarStateArrow, and ToolBarStateAssociation.
|
protectedvirtual |
Called when the release event happened on an empty space. Default implementation does nothing.
Reimplemented in ToolBarStateArrow, ToolBarStateAssociation, ToolBarStateMessages, ToolBarStateOther, and ToolBarStateOneWidget.
|
protectedvirtual |
Called when the release event happened on a widget. Default implementation does nothing.
Reimplemented in ToolBarStateArrow, ToolBarStateAssociation, ToolBarStateMessages, and ToolBarStateOneWidget.
|
protectedvirtual |
Sets the association currently in use. This method is called in main press events handler just before calling the press event for associations handler. Default implementation is set the specified association, although this behaviour can be overridden in subclasses if needed.
association | The association to be set. |
|
protectedvirtual |
Sets the current association or widget. It sets the current element when a press event happened. The element will be used until the next release event. Default implementation first checks for associations, then message widgets and then any other widgets. It can be overridden in subclasses if needed.
Reimplemented in ToolBarStateMessages, ToolBarStateOther, and ToolBarStateOneWidget.
|
protectedvirtual |
Sets the widget currently in use. This method is called in main press events handler just before calling the press event for widgets handler. Default implementation is set the specified widget, although this behaviour can be overridden in subclasses if needed.
widget | The widget to be set. |
Reimplemented in ToolBarStateArrow.
|
protected |
Sets m_pMouseEvent as the equivalent of the received event after transforming it using the inverse world matrix in the UMLScene. This method is called at the beginning of the main event handler methods.
ome | The mouse event to transform. |
type | The type of the event. |
|
virtualslot |
An association was removed from the UMLScene. If the association removed was the current association, the current association is set to 0. It can be extended in subclasses if needed.
|
virtualslot |
|
private |
The association currently in use, if any.
|
private |
The widget currently in use, if any.
|
protected |
The mouse event currently in use.