KDE 4.5 API Reference umbrello/umbrello
ToolBarState Class Reference
Base class for toolbar states. More...
#include <toolbarstate.h>
Detailed Description
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", "Wdiget" 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.
- Todo:
- Handle, for example, left press, right press, left release, right release and other similar strange combinations?
Definition at line 70 of file toolbarstate.h.
Constructor & Destructor Documentation
| ToolBarState::~ToolBarState | ( | ) | [virtual] |
| ToolBarState::ToolBarState | ( | UMLView * | umlView | ) | [protected] |
Creates a new ToolBarState.
UMLView 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.
- Parameters:
-
umlView The UMLView to use.
Definition at line 240 of file toolbarstate.cpp.
Member Function Documentation
| void ToolBarState::changeTool | ( | ) | [protected, virtual] |
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.
Definition at line 398 of file toolbarstate.cpp.
| void ToolBarState::cleanBeforeChange | ( | ) | [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.
Definition at line 57 of file toolbarstate.cpp.
| AssociationWidget * ToolBarState::getAssociationAt | ( | const QPoint & | pos | ) | [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.
- Parameters:
-
pos The position to get the association.
- Returns:
- The AssociationWidget at the specified position, or null if there is none.
- Todo:
- Better handling for associations at the same point
Definition at line 497 of file toolbarstate.cpp.
| AssociationWidget * ToolBarState::getCurrentAssociation | ( | ) | const [protected, virtual] |
Returns the association currently in use.
- Returns:
- The association currently in use.
Definition at line 434 of file toolbarstate.cpp.
| UMLWidget * ToolBarState::getCurrentWidget | ( | ) | const [protected, virtual] |
Returns the widget currently in use.
- Returns:
- The widget currently in use.
Definition at line 410 of file toolbarstate.cpp.
| FloatingDashLineWidget * ToolBarState::getFloatingLineAt | ( | const QPoint & | pos | ) | [protected] |
Returns the FloatingDashLineWidget at the specified position, or null if there is none.
The floatingdashline is only returned if it is visible.
- Parameters:
-
pos The position to get the floatingLine.
- Returns:
- The MessageWidget at the specified position, or null if there is none.
Definition at line 515 of file toolbarstate.cpp.
| MessageWidget * ToolBarState::getMessageAt | ( | const QPoint & | pos | ) | [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.
- Parameters:
-
pos The position to get the message.
- Returns:
- The MessageWidget at the specified position, or null if there is none.
- Todo:
- Better handling for messages at the same point
Definition at line 478 of file toolbarstate.cpp.
| void ToolBarState::init | ( | ) | [virtual] |
Goes back to the initial state.
Subclasses can extend, but not override, this method as needed.
Reimplemented in ToolBarStateArrow, ToolBarStateAssociation, ToolBarStateMessages, and ToolBarStateOneWidget.
Definition at line 39 of file toolbarstate.cpp.
| void ToolBarState::mouseDoubleClick | ( | QMouseEvent * | ome | ) | [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.
- Parameters:
-
ome The received event.
Definition at line 145 of file toolbarstate.cpp.
| void ToolBarState::mouseDoubleClickAssociation | ( | ) | [protected, virtual] |
Called when the double click event happened on an association.
Default implementation does nothing.
Reimplemented in ToolBarStateArrow.
Definition at line 346 of file toolbarstate.cpp.
| void ToolBarState::mouseDoubleClickEmpty | ( | ) | [protected, virtual] |
Called when the double click event happened on an empty space.
Default implementation cleans the selection.
Definition at line 362 of file toolbarstate.cpp.
| void ToolBarState::mouseDoubleClickWidget | ( | ) | [protected, virtual] |
Called when the double click event happened on a widget.
Default implementation does nothing.
Reimplemented in ToolBarStateArrow.
Definition at line 354 of file toolbarstate.cpp.
| void ToolBarState::mouseMove | ( | QMouseEvent * | ome | ) | [virtual] |
Handler for mouse double click 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 view 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.
- Parameters:
-
ome The received event.
Reimplemented in ToolBarStateAssociation, ToolBarStateMessages, and ToolBarStateOneWidget.
Definition at line 177 of file toolbarstate.cpp.
| void ToolBarState::mouseMoveAssociation | ( | ) | [protected, virtual] |
Called when the move event happened when an association is currently available.
Default implementation does nothing.
Reimplemented in ToolBarStateArrow.
Definition at line 372 of file toolbarstate.cpp.
| void ToolBarState::mouseMoveEmpty | ( | ) | [protected, virtual] |
Called when the move event happened when no association nor widget are currently available.
Default implementation does nothing.
Reimplemented in ToolBarStateArrow.
Definition at line 390 of file toolbarstate.cpp.
| void ToolBarState::mouseMoveWidget | ( | ) | [protected, virtual] |
Called when the move event happened when a widget is currently available.
Default implementation does nothing.
Reimplemented in ToolBarStateArrow.
Definition at line 381 of file toolbarstate.cpp.
| void ToolBarState::mousePress | ( | QMouseEvent * | ome | ) | [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.
- Parameters:
-
ome The received event.
- See also:
- setCurrentElement()
Definition at line 76 of file toolbarstate.cpp.
| void ToolBarState::mousePressAssociation | ( | ) | [protected, virtual] |
Called when the press event happened on an association.
Default implementation does nothing.
Reimplemented in ToolBarStateArrow.
Definition at line 297 of file toolbarstate.cpp.
| void ToolBarState::mousePressEmpty | ( | ) | [protected, virtual] |
Called when the press event happened on an empty space.
Default implementation cleans the selection.
Reimplemented in ToolBarStateArrow.
Definition at line 313 of file toolbarstate.cpp.
| void ToolBarState::mousePressWidget | ( | ) | [protected, virtual] |
Called when the press event happened on a widget.
Default implementation does nothing.
Reimplemented in ToolBarStateArrow.
Definition at line 305 of file toolbarstate.cpp.
| void ToolBarState::mouseRelease | ( | QMouseEvent * | ome | ) | [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.
- Parameters:
-
ome The received event.
Definition at line 112 of file toolbarstate.cpp.
| void ToolBarState::mouseReleaseAssociation | ( | ) | [protected, virtual] |
Called when the release event happened on an association.
Default implementation does nothing.
Reimplemented in ToolBarStateArrow, and ToolBarStateAssociation.
Definition at line 322 of file toolbarstate.cpp.
| void ToolBarState::mouseReleaseEmpty | ( | ) | [protected, virtual] |
Called when the release event happened on an empty space.
Default implementation does nothing.
Reimplemented in ToolBarStateArrow, ToolBarStateAssociation, ToolBarStateMessages, and ToolBarStateOneWidget.
Definition at line 338 of file toolbarstate.cpp.
| void ToolBarState::mouseReleaseWidget | ( | ) | [protected, virtual] |
Called when the release event happened on a widget.
Default implementation does nothing.
Reimplemented in ToolBarStateArrow, ToolBarStateAssociation, ToolBarStateMessages, and ToolBarStateOneWidget.
Definition at line 330 of file toolbarstate.cpp.
| void ToolBarState::setCurrentAssociation | ( | AssociationWidget * | currentAssociation | ) | [protected, virtual] |
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.
- Parameters:
-
currentAssociation The association to be set.
Definition at line 448 of file toolbarstate.cpp.
| void ToolBarState::setCurrentElement | ( | ) | [protected, virtual] |
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, and ToolBarStateOneWidget.
Definition at line 255 of file toolbarstate.cpp.
| void ToolBarState::setCurrentWidget | ( | UMLWidget * | currentWidget | ) | [protected, virtual] |
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.
- Parameters:
-
currentWidget The widget to be set.
Reimplemented in ToolBarStateArrow.
Definition at line 424 of file toolbarstate.cpp.
| void ToolBarState::setMouseEvent | ( | QMouseEvent * | ome, | |
| const QEvent::Type & | type | |||
| ) | [protected] |
Sets m_pMouseEvent as the equivalent of the received event after transforming it using the inverse world matrix in the UMLView.
This method is called at the beginning of the main event handler methods.
- Parameters:
-
ome The mouse event to transform. type The type of the event.
Definition at line 461 of file toolbarstate.cpp.
| void ToolBarState::slotAssociationRemoved | ( | AssociationWidget * | association | ) | [virtual, slot] |
An association was removed from the UMLView.
If the association removed was the current association, the current association is set to 0. It can be extended in subclasses if needed.
Definition at line 212 of file toolbarstate.cpp.
| void ToolBarState::slotWidgetRemoved | ( | UMLWidget * | widget | ) | [virtual, slot] |
A widget was removed from the UMLScene.
If the widget removed was the current widget, the current widget is set to 0. It can be extended in subclasses if needed.
Reimplemented in ToolBarStateAssociation, ToolBarStateMessages, and ToolBarStateOneWidget.
Definition at line 225 of file toolbarstate.cpp.
Member Data Documentation
QMouseEvent* ToolBarState::m_pMouseEvent [protected] |
The mouse event currently in use.
This event is the equivalent of the received event after transforming it using the inverse world matrix in the UMLView.
Definition at line 131 of file toolbarstate.h.
UMLView* ToolBarState::m_pUMLView [protected] |
The UMLView.
Definition at line 124 of file toolbarstate.h.
The documentation for this class was generated from the following files:
