A QgsLayoutViewMouseEvent is the result of a user interaction with the mouse on a QgsLayoutView. More...

#include <qgslayoutviewmouseevent.h>

Inheritance diagram for QgsLayoutViewMouseEvent:

Public Member Functions
	QgsLayoutViewMouseEvent (QgsLayoutView view, QMouseEvent event, bool snap=false)
	Constructor for QgsLayoutViewMouseEvent.

bool	isSnapped () const
	Returns `true` if point was snapped, e.g.

QPointF	layoutPoint () const
	Returns the event point location in layout coordinates.

QPointF	snappedPoint () const
	Returns the snapped event point location in layout coordinates.

void	snapPoint (QGraphicsLineItem horizontalSnapLine=nullptr, QGraphicsLineItem verticalSnapLine=nullptr, const QList< QgsLayoutItem * > &ignoreItems=QList< QgsLayoutItem * >())
	Manually triggers a snap for the mouse event position using the layout's snapper.

Detailed Description

A QgsLayoutViewMouseEvent is the result of a user interaction with the mouse on a QgsLayoutView.

It is sent whenever the user moves, clicks, releases or double clicks the mouse. In addition to the coordinates in pixel space it also knows the coordinates the layout space.

Definition at line 34 of file qgslayoutviewmouseevent.h.

Constructor & Destructor Documentation

◆ QgsLayoutViewMouseEvent()

QgsLayoutViewMouseEvent::QgsLayoutViewMouseEvent	(	QgsLayoutView *	view,
		QMouseEvent *	event,
		bool	snap = `false`
	)

Constructor for QgsLayoutViewMouseEvent.

Should only be required to be called from the QgsLayoutView.

Parameters

view	The view in which the event occurred.
event	The original mouse event
snap	set to `true` to snap the point using the layout's snapping settings

Definition at line 21 of file qgslayoutviewmouseevent.cpp.

Member Function Documentation

◆ isSnapped()

bool QgsLayoutViewMouseEvent::isSnapped ( ) const

inline

Returns true if point was snapped, e.g.

to grid or guide lines.

See also: snappedPoint()

Definition at line 83 of file qgslayoutviewmouseevent.h.

◆ layoutPoint()

QPointF QgsLayoutViewMouseEvent::layoutPoint ( ) const

Returns the event point location in layout coordinates.

Definition at line 44 of file qgslayoutviewmouseevent.cpp.

◆ snappedPoint()

QPointF QgsLayoutViewMouseEvent::snappedPoint ( ) const

inline

Returns the snapped event point location in layout coordinates.

The snapped point will consider all possible snapping methods, such as snapping to grid or guide lines.

See also: isSnapped()

Definition at line 77 of file qgslayoutviewmouseevent.h.

◆ snapPoint()

void QgsLayoutViewMouseEvent::snapPoint	(	QGraphicsLineItem *	horizontalSnapLine = `nullptr`,
		QGraphicsLineItem *	verticalSnapLine = `nullptr`,
		const QList< QgsLayoutItem * > &	ignoreItems = `QList< QgsLayoutItem * >()`
	)

Manually triggers a snap for the mouse event position using the layout's snapper.

If the horizontalSnapLine and verticalSnapLine arguments are specified, then the snapper will automatically display and position these lines to indicate snapping positions to item bounds.

The ignoreItems argument can be used to specify a list of items to avoid snapping to.

Definition at line 36 of file qgslayoutviewmouseevent.cpp.

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

/build/qgis-3.36.0+99sid/src/gui/layout/qgslayoutviewmouseevent.h
/build/qgis-3.36.0+99sid/src/gui/layout/qgslayoutviewmouseevent.cpp

Public Member Functions