PlaybackPrefs Class Reference

A PrefsPanel used to select playback options. More...

#include <PlaybackPrefs.h>

Inheritance diagram for PlaybackPrefs:

Collaboration diagram for PlaybackPrefs:

Public Member Functions
	PlaybackPrefs (wxWindow *parent, wxWindowID winid)
virtual	~PlaybackPrefs ()
ComponentInterfaceSymbol	GetSymbol () const override
TranslatableString	GetDescription () const override
bool	Commit () override
ManualPageID	HelpPageName () override
	If not empty string, the Help button is added below the panel. More...
void	PopulateOrExchange (ShuttleGui &S) override
Public Member Functions inherited from PrefsPanel
	PrefsPanel (wxWindow *parent, wxWindowID winid, const TranslatableString &title)
virtual	~PrefsPanel ()
virtual void	Preview ()
virtual bool	Commit ()=0
virtual PluginPath	GetPath () const override
virtual VendorSymbol	GetVendor () const override
virtual wxString	GetVersion () const override
virtual bool	ShowsPreviewButton ()
virtual void	PopulateOrExchange (ShuttleGui &WXUNUSED(S))
virtual ManualPageID	HelpPageName ()
	If not empty string, the Help button is added below the panel. More...
virtual void	Cancel ()
Public Member Functions inherited from wxPanelWrapper
	wxPanelWrapper ()
	wxPanelWrapper (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, const TranslatableString &name=XO("Panel"))
bool	Create (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, const TranslatableString &name=XO("Panel"))
void	SetLabel (const TranslatableString &label)
void	SetName (const TranslatableString &name)
void	SetToolTip (const TranslatableString &toolTip)
void	SetName ()
Public Member Functions inherited from wxTabTraversalWrapper< wxPanel >
	wxTabTraversalWrapper (Args &&... args)
	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete
wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Static Public Member Functions
static bool	GetUnpinnedScrubbingPreference ()
Static Public Member Functions inherited from PrefsPanel
static Factories &	DefaultFactories ()

Private Member Functions
void	Populate ()

Additional Inherited Members
Public Types inherited from PrefsPanel
using	Factories = std::vector< PrefsPanel::PrefsNode >
using	Factory = std::function< PrefsPanel *(wxWindow *parent, wxWindowID winid, AudacityProject *) >

Detailed Description

A PrefsPanel used to select playback options.

Presents interface for user to update the various playback options like previewing and seeking.

Definition at line 23 of file PlaybackPrefs.h.

Constructor & Destructor Documentation

PlaybackPrefs()

PlaybackPrefs::PlaybackPrefs	(	wxWindow *	parent,
		wxWindowID	winid
	)

Definition at line 30 of file PlaybackPrefs.cpp.

:  PrefsPanel(parent, winid, XO("Playback"))
{
   Populate();
}

References Populate().

Here is the call graph for this function:

~PlaybackPrefs()

PlaybackPrefs::~PlaybackPrefs ( )

virtual

Definition at line 36 of file PlaybackPrefs.cpp.

{
}

Member Function Documentation

Commit()

bool PlaybackPrefs::Commit ( )

overridevirtual

Implements PrefsPanel.

Definition at line 176 of file PlaybackPrefs.cpp.

{
   iPreferenceUnpinned = -1;
 
   ShuttleGui S(this, eIsSavingToPrefs);
   PopulateOrExchange(S);
 
   return true;
}

References eIsSavingToPrefs, anonymous_namespace{PlaybackPrefs.cpp}::iPreferenceUnpinned, PopulateOrExchange(), and S.

Here is the call graph for this function:

GetDescription()

TranslatableString PlaybackPrefs::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 45 of file PlaybackPrefs.cpp.

{
   return XO("Preferences for Playback");
}

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol PlaybackPrefs::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 40 of file PlaybackPrefs.cpp.

{
   return PLAYBACK_PREFS_PLUGIN_SYMBOL;
}

References PLAYBACK_PREFS_PLUGIN_SYMBOL.

GetUnpinnedScrubbingPreference()

bool PlaybackPrefs::GetUnpinnedScrubbingPreference ( )

static

Definition at line 165 of file PlaybackPrefs.cpp.

{
   if ( iPreferenceUnpinned >= 0 )
      return iPreferenceUnpinned == 1;
   bool bResult = gPrefs->ReadBool(
      UnpinnedScrubbingPreferenceKey(),
      UnpinnedScrubbingPreferenceDefault());
   iPreferenceUnpinned = bResult ? 1: 0;
   return bResult;
}

References gPrefs, anonymous_namespace{PlaybackPrefs.cpp}::iPreferenceUnpinned, audacity::BasicSettings::ReadBool(), anonymous_namespace{PlaybackPrefs.cpp}::UnpinnedScrubbingPreferenceDefault(), and anonymous_namespace{PlaybackPrefs.cpp}::UnpinnedScrubbingPreferenceKey().

Referenced by Scrubber::ShouldScrubPinned().

Here is the call graph for this function:

Here is the caller graph for this function:

HelpPageName()

ManualPageID PlaybackPrefs::HelpPageName ( )

overridevirtual

If not empty string, the Help button is added below the panel.

Default returns empty string.

Reimplemented from PrefsPanel.

Definition at line 50 of file PlaybackPrefs.cpp.

{
   return "Playback_Preferences";
}

Populate()

void PlaybackPrefs::Populate ( )

private

Definition at line 55 of file PlaybackPrefs.cpp.

{
   //------------------------- Main section --------------------
   // Now construct the GUI itself.
   // Use 'eIsCreatingFromPrefs' so that the GUI is
   // initialised with values from gPrefs.
   ShuttleGui S(this, eIsCreatingFromPrefs);
   PopulateOrExchange(S);
   // ----------------------- End of main section --------------
}

References eIsCreatingFromPrefs, PopulateOrExchange(), and S.

Referenced by PlaybackPrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

PopulateOrExchange()

void PlaybackPrefs::PopulateOrExchange ( ShuttleGui &  S )

override

Definition at line 78 of file PlaybackPrefs.cpp.

{
   const auto suffix = XO("seconds");
 
   S.StartScroller();
   S.SetBorder(2);
 
   S.StartStatic(XO("Effects Preview"));
   {
      S.StartThreeColumn();
      {
         S.NameSuffix(suffix)
            .TieNumericTextBox(XXO("&Length:"),
                                 {wxT("/AudioIO/EffectsPreviewLen"),
                                  6.0},
                                 9);
         S.AddUnits(XO("seconds"));
      }
      S.EndThreeColumn();
   }
   S.EndStatic();
 
   /* i18n-hint: (noun) this is a preview of the cut */
   S.StartStatic(XO("Cut Preview"));
   {
      S.StartThreeColumn();
      {
         S.NameSuffix(suffix)
            .TieNumericTextBox(XXO("&Before cut region:"),
                                 {wxT("/AudioIO/CutPreviewBeforeLen"),
                                  2.0},
                                 9);
         S.AddUnits(XO("seconds"));
 
         S.NameSuffix(suffix)
            .TieNumericTextBox(XXO("&After cut region:"),
                                 {wxT("/AudioIO/CutPreviewAfterLen"),
                                  1.0},
                                 9);
         S.AddUnits(XO("seconds"));
      }
      S.EndThreeColumn();
   }
   S.EndStatic();
 
   S.StartStatic(XO("Seek Time when playing"));
   {
      S.StartThreeColumn();
      {
         S.NameSuffix(suffix)
            .TieNumericTextBox(XXO("&Short period:"),
                                 {wxT("/AudioIO/SeekShortPeriod"),
                                  1.0},
                                 9);
         S.AddUnits(XO("seconds"));
 
         S.NameSuffix(suffix)
            .TieNumericTextBox(XXO("Lo&ng period:"),
                                 {wxT("/AudioIO/SeekLongPeriod"),
                                  15.0},
                                 9);
         S.AddUnits(XO("seconds"));
      }
      S.EndThreeColumn();
   }
   S.EndStatic();
 
   S.StartStatic(XO("Options"));
   {
      S.StartVerticalLay();
      {
         //Removing Vari-Speed Play from PlaybackPrefs
         //S.TieCheckBox(XXO("&Vari-Speed Play"), {"/AudioIO/VariSpeedPlay", true});
         S.TieCheckBox(XXO("&Micro-fades"), {"/AudioIO/Microfades", false});
         S.TieCheckBox(XXO("Always scrub un&pinned"),
            {UnpinnedScrubbingPreferenceKey(),
             UnpinnedScrubbingPreferenceDefault()});
      }
      S.EndVerticalLay();
   }
   S.EndStatic();
 
 
   S.EndScroller();
 
}

References S, anonymous_namespace{PlaybackPrefs.cpp}::UnpinnedScrubbingPreferenceDefault(), anonymous_namespace{PlaybackPrefs.cpp}::UnpinnedScrubbingPreferenceKey(), wxT(), XO(), and XXO().

Referenced by Commit(), and Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• PlaybackPrefs.h
• PlaybackPrefs.cpp