Audacity  2.2.0
UIHandle Class Referenceabstract

#include <UIHandle.h>

Inheritance diagram for UIHandle:
BackgroundHandle ButtonHandle CutlineHandle EnvelopeHandle LabelDefaultClickHandle NoteTrackButtonHandle NoteTrackVZoomHandle SampleHandle SelectHandle SliderHandle StretchHandle TimeShiftHandle TrackPanelResizeHandle TrackSelectHandle WaveTrackVZoomHandle ZoomHandle

Public Types

enum  DrawingPass { Cells, Panel }
 
using Result = unsigned
 
using Cell = TrackPanelCell
 

Public Member Functions

virtual ~UIHandle ()=0
 
virtual void Enter (bool forward)
 
virtual bool HasRotation () const
 
virtual bool Rotate (bool forward)
 
virtual bool HasEscape () const
 
virtual bool Escape ()
 
virtual Result Click (const TrackPanelMouseEvent &event, AudacityProject *pProject)=0
 
virtual Result Drag (const TrackPanelMouseEvent &event, AudacityProject *pProject)=0
 
virtual HitTestPreview Preview (const TrackPanelMouseState &state, const AudacityProject *pProject)=0
 
virtual Result Release (const TrackPanelMouseEvent &event, AudacityProject *pProject, wxWindow *pParent)=0
 
virtual Result Cancel (AudacityProject *pProject)=0
 
virtual void DrawExtras (DrawingPass pass, wxDC *dc, const wxRegion &updateRegion, const wxRect &panelRect)
 
virtual bool StopsOnKeystroke ()
 
virtual void OnProjectChange (AudacityProject *pProject)
 
Result GetChangeHighlight () const
 
void SetChangeHighlight (Result val)
 

Static Public Member Functions

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

Protected Attributes

Result mChangeHighlight { 0 }
 

Member Typedef Documentation

using UIHandle::Result = unsigned

Member Enumeration Documentation

Enumerator
Cells 
Panel 

Constructor & Destructor Documentation

UIHandle::~UIHandle ( )
pure virtual

Member Function Documentation

void UIHandle::DrawExtras ( DrawingPass  pass,
wxDC *  dc,
const wxRegion &  updateRegion,
const wxRect &  panelRect 
)
virtual
bool UIHandle::Escape ( )
virtual

Reimplemented in SelectHandle.

Result UIHandle::GetChangeHighlight ( ) const
inline

References mChangeHighlight.

bool UIHandle::HasEscape ( ) const
virtual

Reimplemented in SelectHandle.

bool UIHandle::HasRotation ( ) const
virtual
static UIHandle::Result UIHandle::NeedChangeHighlight ( const UIHandle ,
const UIHandle  
)
inlinestatic
void UIHandle::OnProjectChange ( AudacityProject pProject)
virtual
bool UIHandle::Rotate ( bool  forward)
virtual
void UIHandle::SetChangeHighlight ( Result  val)
inline

References mChangeHighlight.

Member Data Documentation


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