Mapper  0.9.0
API documentation
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
OpenOrienteering::TemplateAdjustAddTool Class Reference

Tool to add a new pass point. More...

#include <template_adjust.h>

Inheritance diagram for OpenOrienteering::TemplateAdjustAddTool:
Inheritance graph
[legend]
Collaboration diagram for OpenOrienteering::TemplateAdjustAddTool:
Collaboration graph
[legend]

Public Member Functions

 TemplateAdjustAddTool (MapEditorController *editor, QAction *tool_action, TemplateAdjustWidget *widget)
 
void init () override
 Performs initialization when the tool becomes active. More...
 
const QCursorgetCursor () const override
 Returns the cursor which should be used for the tool in the editor windows. More...
 
bool mousePressEvent (QMouseEvent *event, const MapCoordF &map_coord, MapWidget *widget) override
 
bool mouseMoveEvent (QMouseEvent *event, const MapCoordF &map_coord, MapWidget *widget) override
 
bool keyPressEvent (QKeyEvent *event) override
 
void draw (QPainter *painter, MapWidget *widget) override
 Draws the tool's visualisation for a map widget. More...
 
- Public Member Functions inherited from OpenOrienteering::MapEditorTool
 MapEditorTool (MapEditorController *editor, Type type, QAction *tool_action=nullptr)
 Constructs a new MapEditorTool. More...
 
 ~MapEditorTool () override
 Destructs the MapEditorTool. More...
 
virtual void deactivate ()
 Makes this tool inactive in the editor. More...
 
virtual void switchToDefaultDrawTool (const Symbol *symbol) const
 Switch to a default draw tool for the given symbol. More...
 
virtual bool mouseReleaseEvent (QMouseEvent *event, const MapCoordF &map_coord, MapWidget *widget)
 
virtual bool mouseDoubleClickEvent (QMouseEvent *event, const MapCoordF &map_coord, MapWidget *widget)
 
virtual void leaveEvent (QEvent *event)
 
virtual bool keyReleaseEvent (QKeyEvent *event)
 
virtual void focusOutEvent (QFocusEvent *event)
 
virtual bool inputMethodEvent (QInputMethodEvent *event)
 
virtual QVariant inputMethodQuery (Qt::InputMethodQuery property, const QVariant &argument) const
 
virtual bool gestureEvent (QGestureEvent *event, MapWidget *widget)
 
virtual void gestureStarted ()
 This is called to signal the start of a gesture. More...
 
Type toolType () const
 Returns the type of this tool. More...
 
QActiontoolAction () const
 Returns the action which represents this tool. More...
 
bool usesTouchCursor () const
 Returns whether to use the touch helper cursor for this tool. More...
 
Mapmap () const
 Returns the map being edited. More...
 
MapWidgetmapWidget () const
 Returns the map widget being operated on. More...
 
MainWindowmainWindow () const
 Returns the main window the controller is attached to. More...
 
QWidgetwindow () const
 Returns the main window the controller is attached to as a QWidget. More...
 
bool drawOnRightClickEnabled () const
 Returns true if Mapper is configured to finish drawing on right click. More...
 
bool editingInProgress () const
 Returns whether an editing operation is currently in progress. More...
 
virtual void finishEditing ()
 Finishes editing if it is currently in progress. More...
 
bool isDrawTool () const
 Returns true if the given tool is for drawing new objects. More...
 
const PointHandlespointHandles () const
 Returns the point handles utility for this tool. More...
 
unsigned int scaleFactor () const
 The factor by which all drawing shall be scaled. More...
 
qreal clickTolerance () const
 A value representing how close the user must click or hover to select a point. More...
 
int startDragDistance () const
 The number of pixels the mouse has to be moved to start dragging. More...
 
- Public Member Functions inherited from QObject
virtual const QMetaObjectmetaObject () const const
 
 QObject (QObject *parent)
 
virtual ~QObject ()
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
QString objectName () const const
 
void setObjectName (const QString &name)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
bool signalsBlocked () const const
 
bool blockSignals (bool block)
 
QThreadthread () const const
 
void moveToThread (QThread *targetThread)
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
void killTimer (int id)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
const QObjectListchildren () const const
 
void setParent (QObject *parent)
 
void installEventFilter (QObject *filterObj)
 
void removeEventFilter (QObject *obj)
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectTree ()
 
void dumpObjectInfo ()
 
void dumpObjectTree () const const
 
void dumpObjectInfo () const const
 
bool setProperty (const char *name, const QVariant &value)
 
QVariant property (const char *name) const const
 
QList< QByteArraydynamicPropertyNames () const const
 
void destroyed (QObject *obj)
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
bool inherits (const char *className) const const
 
void deleteLater ()
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
 Q_CLASSINFO (Name, Value)
 
 Q_INTERFACES (...)
 
 Q_PROPERTY (...)
 
 Q_ENUMS (...)
 
 Q_FLAGS (...)
 
 Q_ENUM (...)
 
 Q_FLAG (...)
 
 Q_ENUM_NS (...)
 
 Q_FLAG_NS (...)
 
 Q_OBJECT Q_OBJECT
 
 Q_GADGET Q_GADGET
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SLOTS Q_SLOTS
 
 Q_SLOT Q_SLOT
 
 Q_EMIT Q_EMIT
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 

Protected Member Functions

void setDirtyRect (const MapCoordF &mouse_pos)
 
- Protected Member Functions inherited from OpenOrienteering::MapEditorTool
void useTouchCursor (bool enabled)
 Sets the flag which indicates whether the touch cursor shall be used. More...
 
void setEditingInProgress (bool state)
 Sets a flag which indicates an active editing operation. More...
 
void setStatusBarText (const QString &text)
 Sends text to the window's status bar. More...
 
void drawSelectionBox (QPainter *painter, MapWidget *widget, const MapCoordF &corner1, const MapCoordF &corner2) const
 Draws a selection box for the given corner points. More...
 
MapCoordVector::size_type findHoverPoint (const QPointF &cursor, const MapWidget *widget, const Object *object, bool include_curve_handles, MapCoordF *out_handle_pos=nullptr) const
 Finds and returns the point of the given object over which the cursor hovers. More...
 
bool containsDrawingButtons (Qt::MouseButtons buttons) const
 Checks if the given buttons contain one which controls drawing. More...
 
bool isDrawingButton (Qt::MouseButton button) const
 Checks if the given event was triggered by press or release of a mouse button for drawing. More...
 
- Protected Member Functions inherited from QObject
QObjectsender () const const
 
int senderSignalIndex () const const
 
int receivers (const char *signal) const const
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
virtual void timerEvent (QTimerEvent *event)
 
virtual void childEvent (QChildEvent *event)
 
virtual void customEvent (QEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 

Protected Attributes

bool first_point_set
 
MapCoordF first_point
 
MapCoordF mouse_pos
 
TemplateAdjustWidgetwidget
 
- Protected Attributes inherited from OpenOrienteering::MapEditorTool
MapEditorController *const editor
 The map editor which uses this tool. More...
 

Additional Inherited Members

- Public Types inherited from OpenOrienteering::MapEditorTool
enum  Type {
  EditPoint = 1, EditLine = 2, DrawPoint = 3, DrawPath = 4,
  DrawCircle = 5, DrawRectangle = 6, DrawText = 7, DrawFreehand = 8,
  Pan = 9, Scribble = 10, Other = 0
}
 Types of tool. More...
 
- Static Public Member Functions inherited from QObject
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Static Public Attributes inherited from OpenOrienteering::MapEditorTool
static const QRgb inactive_color = qRgb(0, 0, 255)
 Color for normal (not active) elements. More...
 
static const QRgb active_color = qRgb(255, 150, 0)
 Color for active elements (which are hovered over by the cursor) More...
 
static const QRgb selection_color = qRgb(210, 0, 229)
 Color for selected elements. More...
 
- Static Protected Member Functions inherited from OpenOrienteering::MapEditorTool
static QCursor scaledToScreen (const QCursor &unscaled_cursor)
 Returns a cursor which is scaled to the screen's resolution. More...
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Tool to add a new pass point.

Constructor & Destructor Documentation

◆ TemplateAdjustAddTool()

OpenOrienteering::TemplateAdjustAddTool::TemplateAdjustAddTool ( MapEditorController editor,
QAction tool_action,
TemplateAdjustWidget widget 
)

Member Function Documentation

◆ draw()

void OpenOrienteering::TemplateAdjustAddTool::draw ( QPainter painter,
MapWidget widget 
)
overridevirtual

Draws the tool's visualisation for a map widget.

All dynamic drawing must be done here using the given painter. Drawing is only possible in the area specified by calling map->setDrawingBoundingBox().

Reimplemented from OpenOrienteering::MapEditorTool.

◆ getCursor()

const QCursor & OpenOrienteering::TemplateAdjustAddTool::getCursor ( ) const
overridevirtual

Returns the cursor which should be used for the tool in the editor windows.

Todo:
How to change the cursor for all map widgets while a tool is active?

Implements OpenOrienteering::MapEditorTool.

◆ init()

void OpenOrienteering::TemplateAdjustAddTool::init ( )
overridevirtual

Performs initialization when the tool becomes active.

This method is called by the map editor when the tool shall become active. Reimplementations may make changes to the map editor or window (e.g. set status bar text) which are not allowed in the constructor.

Note that this method by call several times, without any deinitialization in between.

Reimplementations shall call parent implementations.

The implementation in this class marks the tool's action as checked.

Reimplemented from OpenOrienteering::MapEditorTool.

◆ keyPressEvent()

bool OpenOrienteering::TemplateAdjustAddTool::keyPressEvent ( QKeyEvent event)
overridevirtual

Reimplemented from OpenOrienteering::MapEditorTool.

◆ mouseMoveEvent()

bool OpenOrienteering::TemplateAdjustAddTool::mouseMoveEvent ( QMouseEvent event,
const MapCoordF map_coord,
MapWidget widget 
)
overridevirtual

Reimplemented from OpenOrienteering::MapEditorTool.

◆ mousePressEvent()

bool OpenOrienteering::TemplateAdjustAddTool::mousePressEvent ( QMouseEvent event,
const MapCoordF map_coord,
MapWidget widget 
)
overridevirtual

Reimplemented from OpenOrienteering::MapEditorTool.

◆ setDirtyRect()

void OpenOrienteering::TemplateAdjustAddTool::setDirtyRect ( const MapCoordF mouse_pos)
protected

Member Data Documentation

◆ first_point

MapCoordF OpenOrienteering::TemplateAdjustAddTool::first_point
protected

◆ first_point_set

bool OpenOrienteering::TemplateAdjustAddTool::first_point_set
protected

◆ mouse_pos

MapCoordF OpenOrienteering::TemplateAdjustAddTool::mouse_pos
protected

◆ widget

TemplateAdjustWidget* OpenOrienteering::TemplateAdjustAddTool::widget
protected

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