Audacity  2.2.0
Scrubber Class Reference

#include <Scrubbing.h>

Inheritance diagram for Scrubber:

Classes

struct  Forwarder
 
class  ScrubPoller
 
class  ScrubPollerThread
 

Public Member Functions

 Scrubber (AudacityProject *project)
 
 ~Scrubber ()
 
void MarkScrubStart (wxCoord xx, bool smoothScrolling, bool seek)
 
bool MaybeStartScrubbing (wxCoord xx)
 
void ContinueScrubbingUI ()
 
void ContinueScrubbingPoll ()
 
void StopScrubbing ()
 
wxCoord GetScrubStartPosition () const
 
bool HasStartedScrubbing () const
 
bool IsScrubbing () const
 
bool IsScrollScrubbing () const
 
void SetScrollScrubbing (bool value)
 
bool ChoseSeeking () const
 
bool MayDragToSeek () const
 
bool TemporarilySeeks () const
 
bool Seeks () const
 
bool Scrubs () const
 
bool ShowsBar () const
 
void Cancel ()
 
bool ShouldDrawScrubSpeed ()
 
double FindScrubSpeed (bool seeking, double time) const
 
double GetMaxScrubSpeed () const
 
void HandleScrollWheel (int steps)
 
bool CanScrub () const
 
void AddMenuItems ()
 
void PopulatePopupMenu (wxMenu &menu)
 
void OnScrubOrSeek (bool seek)
 
void OnScrub (wxCommandEvent &)
 
void OnSeek (wxCommandEvent &)
 
void OnToggleScrubRuler (wxCommandEvent &)
 
const wxString & GetUntranslatedStateString () const
 
wxString StatusMessageForWave () const
 
void Pause (bool paused)
 
bool IsPaused () const
 
void CheckMenuItems ()
 
bool IsOneShotSeeking () const
 

Static Public Member Functions

static std::vector< wxString > GetAllUntranslatedStatusStrings ()
 

Public Attributes

bool mInOneShotMode
 

Private Member Functions

void DoScrub (bool seek)
 
void OnActivateOrDeactivateApp (wxActivateEvent &event)
 

Private Attributes

Forwarder mForwarder { *this }
 
int mScrubToken
 
bool mPaused
 
int mScrubSpeedDisplayCountdown
 
wxCoord mScrubStartPosition
 
wxCoord mLastScrubPosition {}
 
bool mScrubSeekPress {}
 
bool mSmoothScrollingScrub
 
bool mSeeking {}
 
bool mDragging {}
 
bool mCancelled {}
 
int mLogMaxScrubSpeed
 
AudacityProjectmProject
 
ScrubPollerThreadmpThread {}
 
std::unique_ptr< ScrubPollermPoller
 
ScrubbingOptions mOptions
 
double mMaxSpeed { 1.0 }
 

Constructor & Destructor Documentation

Scrubber::Scrubber ( AudacityProject project)
Scrubber::~Scrubber ( )

Member Function Documentation

void Scrubber::Cancel ( )
inline

References mCancelled.

bool Scrubber::ChoseSeeking ( ) const

References mDragging, and mSeeking.

Referenced by Scrubs(), and Seeks().

double Scrubber::FindScrubSpeed ( bool  seeking,
double  time 
) const
std::vector< wxString > Scrubber::GetAllUntranslatedStatusStrings ( )
static
double Scrubber::GetMaxScrubSpeed ( ) const
inline
wxCoord Scrubber::GetScrubStartPosition ( ) const
inline
const wxString & Scrubber::GetUntranslatedStateString ( ) const
bool Scrubber::IsOneShotSeeking ( ) const
inline
bool Scrubber::IsPaused ( ) const

References mPaused.

Referenced by AdornedRulerPanel::OnMouseEvents().

bool Scrubber::IsScrollScrubbing ( ) const
inline
bool Scrubber::MayDragToSeek ( ) const
void Scrubber::OnActivateOrDeactivateApp ( wxActivateEvent &  event)
private
void Scrubber::OnScrub ( wxCommandEvent &  )
void Scrubber::OnSeek ( wxCommandEvent &  )
void Scrubber::Pause ( bool  paused)
void Scrubber::PopulatePopupMenu ( wxMenu &  menu)
bool Scrubber::Scrubs ( ) const
void Scrubber::SetScrollScrubbing ( bool  value)
inline

References mSmoothScrollingScrub.

bool Scrubber::ShowsBar ( ) const
wxString Scrubber::StatusMessageForWave ( ) const

References _(), Scrubs(), and Seeks().

bool Scrubber::TemporarilySeeks ( ) const

Member Data Documentation

bool Scrubber::mCancelled {}
private
bool Scrubber::mDragging {}
private
Forwarder Scrubber::mForwarder { *this }
private
bool Scrubber::mInOneShotMode
wxCoord Scrubber::mLastScrubPosition {}
private
int Scrubber::mLogMaxScrubSpeed
private
double Scrubber::mMaxSpeed { 1.0 }
private
bool Scrubber::mPaused
private
std::unique_ptr<ScrubPoller> Scrubber::mPoller
private
ScrubPollerThread* Scrubber::mpThread {}
private
bool Scrubber::mScrubSeekPress {}
private
int Scrubber::mScrubSpeedDisplayCountdown
private
wxCoord Scrubber::mScrubStartPosition
private
int Scrubber::mScrubToken
private

Referenced by IsScrubbing(), and MaybeStartScrubbing().

bool Scrubber::mSeeking {}
private

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