mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-31 00:06:02 -04:00
84 lines
3.0 KiB
Plaintext
84 lines
3.0 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/layout/qgslayoutviewmouseevent.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
class QgsLayoutViewMouseEvent : QMouseEvent
|
|
{
|
|
%Docstring
|
|
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.
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgslayoutviewmouseevent.h"
|
|
%End
|
|
%ConvertToSubClassCode
|
|
if ( dynamic_cast<QgsLayoutViewMouseEvent *>( sipCpp ) )
|
|
sipType = sipType_QgsLayoutViewMouseEvent;
|
|
else
|
|
sipType = 0;
|
|
%End
|
|
public:
|
|
|
|
QgsLayoutViewMouseEvent( QgsLayoutView *view, QMouseEvent *event, bool snap = false );
|
|
%Docstring
|
|
Constructor for QgsLayoutViewMouseEvent. Should only be required to be called from the QgsLayoutView.
|
|
|
|
:param view: The view in which the event occurred.
|
|
:param event: The original mouse event
|
|
:param snap: set to ``True`` to snap the point using the layout's snapping settings
|
|
%End
|
|
|
|
void snapPoint( QGraphicsLineItem *horizontalSnapLine = 0, QGraphicsLineItem *verticalSnapLine = 0,
|
|
const QList<QgsLayoutItem *> &ignoreItems = QList< QgsLayoutItem * >() );
|
|
%Docstring
|
|
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.
|
|
%End
|
|
|
|
QPointF layoutPoint() const;
|
|
%Docstring
|
|
Returns the event point location in layout coordinates.
|
|
%End
|
|
|
|
QPointF snappedPoint() const;
|
|
%Docstring
|
|
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.
|
|
|
|
.. seealso:: :py:func:`isSnapped`
|
|
%End
|
|
|
|
bool isSnapped() const;
|
|
%Docstring
|
|
Returns ``True`` if point was snapped, e.g. to grid or guide lines.
|
|
|
|
.. seealso:: :py:func:`snappedPoint`
|
|
%End
|
|
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/layout/qgslayoutviewmouseevent.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|