Audacity  3.0.3
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
UIHandle Class Referenceabstract

Short-lived drawing and event-handling object associated with a TrackPanelCell. More...

#include <UIHandle.h>

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

Public Types

using Result = unsigned
 
using Cell = TrackPanelCell
 

Public Member Functions

virtual ~UIHandle ()=0
 
virtual void Enter (bool forward, AudacityProject *pProject)
 
virtual bool HasRotation () const
 
virtual bool Rotate (bool forward)
 
virtual bool HasEscape () const
 
virtual bool Escape (AudacityProject *pProject)
 
virtual Result Click (const TrackPanelMouseEvent &event, AudacityProject *pProject)=0
 
virtual Result Drag (const TrackPanelMouseEvent &event, AudacityProject *pProject)=0
 
virtual HitTestPreview Preview (const TrackPanelMouseState &state, AudacityProject *pProject)=0
 
virtual Result Release (const TrackPanelMouseEvent &event, AudacityProject *pProject, wxWindow *pParent)=0
 
virtual Result Cancel (AudacityProject *pProject)=0
 
virtual bool StopsOnKeystroke ()
 
virtual void OnProjectChange (AudacityProject *pProject)
 
Result GetChangeHighlight () const
 
void SetChangeHighlight (Result val)
 
- Public Member Functions inherited from TrackPanelDrawable
virtual ~TrackPanelDrawable ()=0
 
virtual void Draw (TrackPanelDrawingContext &context, const wxRect &rect, unsigned iPass)
 
virtual wxRect DrawingArea (TrackPanelDrawingContext &context, const wxRect &rect, const wxRect &panelRect, unsigned iPass)
 

Static Public Member Functions

static UIHandle::Result NeedChangeHighlight (const UIHandle &, const UIHandle &)
 
- Static Public Member Functions inherited from TrackPanelDrawable
static wxRect MaximizeWidth (const wxRect &rect, const wxRect &panelRect)
 
static wxRect MaximizeHeight (const wxRect &rect, const wxRect &panelRect)
 

Protected Attributes

Result mChangeHighlight { 0 }
 

Detailed Description

Short-lived drawing and event-handling object associated with a TrackPanelCell.

Definition at line 33 of file UIHandle.h.

Member Typedef Documentation

◆ Cell

Definition at line 40 of file UIHandle.h.

◆ Result

using UIHandle::Result = unsigned

Definition at line 37 of file UIHandle.h.

Constructor & Destructor Documentation

◆ ~UIHandle()

UIHandle::~UIHandle ( )
pure virtual

Definition at line 16 of file UIHandle.cpp.

17 {
18 }

Member Function Documentation

◆ Cancel()

virtual Result UIHandle::Cancel ( AudacityProject pProject)
pure virtual

◆ Click()

virtual Result UIHandle::Click ( const TrackPanelMouseEvent event,
AudacityProject pProject 
)
pure virtual

◆ Drag()

virtual Result UIHandle::Drag ( const TrackPanelMouseEvent event,
AudacityProject pProject 
)
pure virtual

◆ Enter()

void UIHandle::Enter ( bool  forward,
AudacityProject pProject 
)
virtual

◆ Escape()

bool UIHandle::Escape ( AudacityProject pProject)
virtual

Reimplemented in SelectHandle.

Definition at line 39 of file UIHandle.cpp.

40 {
41  return false;
42 }

◆ GetChangeHighlight()

Result UIHandle::GetChangeHighlight ( ) const
inline

Definition at line 116 of file UIHandle.h.

116 { return mChangeHighlight; }

◆ HasEscape()

bool UIHandle::HasEscape ( ) const
virtual

Reimplemented in SelectHandle.

Definition at line 34 of file UIHandle.cpp.

35 {
36  return false;
37 }

◆ HasRotation()

bool UIHandle::HasRotation ( ) const
virtual

Definition at line 24 of file UIHandle.cpp.

25 {
26  return false;
27 }

◆ NeedChangeHighlight()

static UIHandle::Result UIHandle::NeedChangeHighlight ( const UIHandle ,
const UIHandle  
)
inlinestatic

Definition at line 123 of file UIHandle.h.

125  {
126  return 0;
127  }

◆ OnProjectChange()

void UIHandle::OnProjectChange ( AudacityProject pProject)
virtual

Definition at line 49 of file UIHandle.cpp.

50 {
51 }

◆ Preview()

virtual HitTestPreview UIHandle::Preview ( const TrackPanelMouseState state,
AudacityProject pProject 
)
pure virtual

◆ Release()

virtual Result UIHandle::Release ( const TrackPanelMouseEvent event,
AudacityProject pProject,
wxWindow *  pParent 
)
pure virtual

◆ Rotate()

bool UIHandle::Rotate ( bool  forward)
virtual

Definition at line 29 of file UIHandle.cpp.

30 {
31  return false;
32 }

◆ SetChangeHighlight()

void UIHandle::SetChangeHighlight ( Result  val)
inline

Definition at line 117 of file UIHandle.h.

117 { mChangeHighlight = val; }

◆ StopsOnKeystroke()

bool UIHandle::StopsOnKeystroke ( )
virtual

Member Data Documentation

◆ mChangeHighlight

Result UIHandle::mChangeHighlight { 0 }
protected

The documentation for this class was generated from the following files:
UIHandle::mChangeHighlight
Result mChangeHighlight
Definition: UIHandle.h:133