Workspace 6.21.5
Public Member Functions | List of all members
MoveNoteItemEvent Class Reference

Event emitted when a WorkspaceNoteItem has been moved.

#include <Workspace/Presentation/workspacenoteitemevents.h>

Inheritance diagram for MoveNoteItemEvent:
[legend]

Public Member Functions

 MoveNoteItemEvent (const QUuid &noteItemId, const QPointF &delta, bool allowSnapToGrid=true)
 
bool getAllowSnapToGrid () const
 
const QPointF & getDelta () const
 
const QUuid & getNoteItemId () const
 
- Public Member Functions inherited from ObservableEventType< MoveNoteItemEvent >
CSIRO_WORKSPACE_API const EventIDSingleton< CSIRO::DataExecution::AllObservableEvents > & eventID ()
 
CSIRO_WORKSPACE_API const EventIDSingleton< CSIRO::DataExecution::ProgressEvent > & eventID ()
 
const EventIDSingleton< MoveNoteItemEvent > & getEventID () const override
 
- Public Member Functions inherited from ObservableEvent
virtual ~ObservableEvent ()=default
 
virtual const EventIDgetEventID () const =0
 

Additional Inherited Members

- Static Public Member Functions inherited from ObservableEventType< MoveNoteItemEvent >
static const EventIDSingleton< MoveNoteItemEvent > & eventID ()
 
- Protected Member Functions inherited from ObservableEventType< MoveNoteItemEvent >
 ObservableEventType ()=default
 

Constructor & Destructor Documentation

◆ MoveNoteItemEvent()

MoveNoteItemEvent ( const QUuid &  noteItemId,
const QPointF &  delta,
bool  allowSnapToGrid = true 
)
inline
Parameters
noteItemIdThe id of the note item to move.
deltaThe amount to move the specified note item relative to its current position.
allowSnapToGridIf true, the note item will be forced to the nearest grid point after shifting it by delta. Set this to false in situations where the exact delta must be applied, such as when undoing a move event.

Member Function Documentation

◆ getAllowSnapToGrid()

bool getAllowSnapToGrid ( ) const
inline

◆ getDelta()

const QPointF & getDelta ( ) const
inline

◆ getNoteItemId()

const QUuid & getNoteItemId ( ) const
inline