Audacity 3.2.0
Public Member Functions | Protected Attributes | List of all members
GrabberEvent Class Referencefinal

Grabber Class. More...

#include <Grabber.h>

Inheritance diagram for GrabberEvent:
[legend]
Collaboration diagram for GrabberEvent:
[legend]

Public Member Functions

 GrabberEvent (wxEventType type=wxEVT_NULL, Identifier barId={}, const wxPoint &pt=wxDefaultPosition, bool escaping=false)
 
 GrabberEvent (const GrabberEvent &event)=default
 
const wxPoint & GetPosition () const
 
void SetPosition (const wxPoint &pos)
 
bool IsEscaping () const
 
Identifier BarId () const
 
wxEvent * Clone () const override
 

Protected Attributes

const Identifier mBarId
 
wxPoint mPos
 
bool mEscaping {}
 

Detailed Description

Grabber Class.

Definition at line 47 of file Grabber.h.

Constructor & Destructor Documentation

◆ GrabberEvent() [1/2]

GrabberEvent::GrabberEvent ( wxEventType  type = wxEVT_NULL,
Identifier  barId = {},
const wxPoint &  pt = wxDefaultPosition,
bool  escaping = false 
)
inline

Definition at line 51 of file Grabber.h.

52 {},
53 const wxPoint& pt = wxDefaultPosition,
54 bool escaping = false)
55 : wxCommandEvent(type)
56 , mBarId{ barId }
57 {
58 mPos = pt;
59 mEscaping = escaping;
60 }
bool mEscaping
Definition: Grabber.h:89
wxPoint mPos
Definition: Grabber.h:88
const Identifier mBarId
Definition: Grabber.h:87

◆ GrabberEvent() [2/2]

GrabberEvent::GrabberEvent ( const GrabberEvent event)
default

Member Function Documentation

◆ BarId()

Identifier GrabberEvent::BarId ( ) const
inline

Definition at line 77 of file Grabber.h.

77{ return mBarId; }

Referenced by ToolManager::OnGrabber().

Here is the caller graph for this function:

◆ Clone()

wxEvent * GrabberEvent::Clone ( ) const
inlineoverride

Definition at line 80 of file Grabber.h.

81 {
82 return safenew GrabberEvent(*this);
83 }
#define safenew
Definition: MemoryX.h:10
GrabberEvent(wxEventType type=wxEVT_NULL, Identifier barId={}, const wxPoint &pt=wxDefaultPosition, bool escaping=false)
Definition: Grabber.h:51

References safenew.

◆ GetPosition()

const wxPoint & GrabberEvent::GetPosition ( ) const
inline

Definition at line 65 of file Grabber.h.

66 {
67 return mPos;
68 }

◆ IsEscaping()

bool GrabberEvent::IsEscaping ( ) const
inline

Definition at line 75 of file Grabber.h.

75{ return mEscaping; }

Referenced by ToolDock::OnGrabber(), and ToolManager::OnGrabber().

Here is the caller graph for this function:

◆ SetPosition()

void GrabberEvent::SetPosition ( const wxPoint &  pos)
inline

Definition at line 70 of file Grabber.h.

71 {
72 mPos = pos;
73 }

Member Data Documentation

◆ mBarId

const Identifier GrabberEvent::mBarId
protected

Definition at line 87 of file Grabber.h.

◆ mEscaping

bool GrabberEvent::mEscaping {}
protected

Definition at line 89 of file Grabber.h.

◆ mPos

wxPoint GrabberEvent::mPos
protected

Definition at line 88 of file Grabber.h.


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