Audacity  2.2.2
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
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 }
 

Detailed Description

Definition at line 33 of file UIHandle.h.

Member Typedef Documentation

Definition at line 40 of file UIHandle.h.

using UIHandle::Result = unsigned

Definition at line 37 of file UIHandle.h.

Member Enumeration Documentation

Enumerator
Cells 
Panel 

Definition at line 43 of file UIHandle.h.

43  {
44  Cells,
45  Panel,
46  };

Constructor & Destructor Documentation

UIHandle::~UIHandle ( )
pure virtual

Definition at line 15 of file UIHandle.cpp.

16 {
17 }

Member Function Documentation

virtual Result UIHandle::Cancel ( AudacityProject pProject)
pure virtual
virtual Result UIHandle::Click ( const TrackPanelMouseEvent event,
AudacityProject pProject 
)
pure virtual
virtual Result UIHandle::Drag ( const TrackPanelMouseEvent event,
AudacityProject pProject 
)
pure virtual
void UIHandle::DrawExtras ( DrawingPass  pass,
wxDC *  dc,
const wxRegion &  updateRegion,
const wxRect &  panelRect 
)
virtual

Reimplemented in TimeShiftHandle, SelectHandle, WaveTrackVZoomHandle, NoteTrackVZoomHandle, and ZoomHandle.

Definition at line 44 of file UIHandle.cpp.

45 {
46 }
void UIHandle::Enter ( bool  forward)
virtual
bool UIHandle::Escape ( )
virtual

Reimplemented in SelectHandle.

Definition at line 38 of file UIHandle.cpp.

39 {
40  return false;
41 }
Result UIHandle::GetChangeHighlight ( ) const
inline

Definition at line 133 of file UIHandle.h.

References mChangeHighlight.

133 { return mChangeHighlight; }
Result mChangeHighlight
Definition: UIHandle.h:150
bool UIHandle::HasEscape ( ) const
virtual

Reimplemented in SelectHandle.

Definition at line 33 of file UIHandle.cpp.

34 {
35  return false;
36 }
bool UIHandle::HasRotation ( ) const
virtual

Definition at line 23 of file UIHandle.cpp.

24 {
25  return false;
26 }
static UIHandle::Result UIHandle::NeedChangeHighlight ( const UIHandle ,
const UIHandle  
)
inlinestatic

Definition at line 141 of file UIHandle.h.

142  {
143  return 0;
144  }
void UIHandle::OnProjectChange ( AudacityProject pProject)
virtual

Definition at line 53 of file UIHandle.cpp.

54 {
55 }
virtual HitTestPreview UIHandle::Preview ( const TrackPanelMouseState state,
const AudacityProject pProject 
)
pure virtual
virtual Result UIHandle::Release ( const TrackPanelMouseEvent event,
AudacityProject pProject,
wxWindow *  pParent 
)
pure virtual
bool UIHandle::Rotate ( bool  forward)
virtual

Definition at line 28 of file UIHandle.cpp.

29 {
30  return false;
31 }
void UIHandle::SetChangeHighlight ( Result  val)
inline

Definition at line 134 of file UIHandle.h.

References mChangeHighlight.

134 { mChangeHighlight = val; }
Result mChangeHighlight
Definition: UIHandle.h:150
bool UIHandle::StopsOnKeystroke ( )
virtual

Member Data Documentation

Result UIHandle::mChangeHighlight { 0 }
protected

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