A PrefsPanel for track display and behavior properties. More...

#include <TracksPrefs.h>

Inheritance diagram for TracksPrefs:

Collaboration diagram for TracksPrefs:

Public Member Functions
	TracksPrefs (wxWindow *parent, wxWindowID winid)

	~TracksPrefs ()

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...

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	GetPinnedHeadPreference ()

static void	SetPinnedHeadPreference (bool value, bool flush=false)

static double	GetPinnedHeadPositionPreference ()

static void	SetPinnedHeadPositionPreference (double value, bool flush=false)

static WaveChannelViewConstants::Display	ViewModeChoice ()

static WaveformSettings::ScaleTypeValues	WaveformScaleChoice ()

static WaveChannelViewConstants::SampleDisplay	SampleViewChoice ()

static WaveChannelViewConstants::ZoomPresets	Zoom1Choice ()

static WaveChannelViewConstants::ZoomPresets	Zoom2Choice ()

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

Private Member Functions
void	Populate ()

void	PopulateOrExchange (ShuttleGui &S) override

Static Private Attributes
static int	iPreferencePinned = -1

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 for track display and behavior properties.

Definition at line 27 of file TracksPrefs.h.

Constructor & Destructor Documentation

◆ TracksPrefs()

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

Definition at line 272 of file TracksPrefs.cpp.

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

References Populate().

Here is the call graph for this function:

◆ ~TracksPrefs()

TracksPrefs::~TracksPrefs ( )

Definition at line 281 of file TracksPrefs.cpp.

282{

283}

Member Function Documentation

◆ Commit()

bool TracksPrefs::Commit ( )

overridevirtual

Implements PrefsPanel.

Definition at line 427 of file TracksPrefs.cpp.

{
   // Bug 1583: Clear the caching of the preference pinned state.
   iPreferencePinned = -1;
   ShuttleGui S(this, eIsSavingToPrefs);
   PopulateOrExchange(S);
 
   // Bug 1661: Don't store the name for new tracks if the name is the
   // default in that language.
   if (WaveTrack::GetDefaultAudioTrackNamePreference() ==
       AudioTrackNameSetting.GetDefault()) {
      AudioTrackNameSetting.Delete();
      gPrefs->Flush();
   }
 
   AudioTrackNameSetting.Invalidate();
   return true;
}

References AudioTrackNameSetting, SettingBase::Delete(), eIsSavingToPrefs, audacity::BasicSettings::Flush(), Setting< T >::GetDefault(), WaveTrack::GetDefaultAudioTrackNamePreference(), gPrefs, Setting< T >::Invalidate(), iPreferencePinned, PopulateOrExchange(), and S.

Here is the call graph for this function:

◆ GetDescription()

TranslatableString TracksPrefs::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 290 of file TracksPrefs.cpp.

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

References XO().

Here is the call graph for this function:

◆ GetPinnedHeadPositionPreference()

double TracksPrefs::GetPinnedHeadPositionPreference ( )

static

Definition at line 411 of file TracksPrefs.cpp.

{
   auto value = gPrefs->ReadDouble(
      PinnedHeadPositionPreferenceKey(),
      PinnedHeadPositionPreferenceDefault());
   return std::max(0.0, std::min(1.0, value));
}

References gPrefs, min(), anonymous_namespace{TracksPrefs.cpp}::PinnedHeadPositionPreferenceDefault(), anonymous_namespace{TracksPrefs.cpp}::PinnedHeadPositionPreferenceKey(), and audacity::BasicSettings::ReadDouble().

Referenced by anonymous_namespace{AdornedRulerPanel.cpp}::PlayheadHandle::Click(), anonymous_namespace{Scrubbing.cpp}::FindScrubbingSpeed(), anonymous_namespace{Scrubbing.cpp}::FindSeekSpeed(), anonymous_namespace{AdornedRulerPanel.cpp}::GetPlayHeadX(), and ProjectWindow::PlaybackScroller::OnTimer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPinnedHeadPreference()

bool TracksPrefs::GetPinnedHeadPreference ( )

static

Definition at line 392 of file TracksPrefs.cpp.

{
   // JKC: Cache this setting as it is read many times during drawing, and otherwise causes screen flicker.
   // Correct solution would be to re-write wxFileConfig to be efficient.
   if( iPreferencePinned >= 0 )
      return iPreferencePinned == 1;
   bool bResult = gPrefs->ReadBool(PinnedHeadPreferenceKey(), PinnedHeadPreferenceDefault());
   iPreferencePinned = bResult ? 1: 0;
   return bResult;
}

References gPrefs, iPreferencePinned, anonymous_namespace{TracksPrefs.cpp}::PinnedHeadPreferenceDefault(), anonymous_namespace{TracksPrefs.cpp}::PinnedHeadPreferenceKey(), and audacity::BasicSettings::ReadBool().

Referenced by Scrubber::ShouldScrubPinned(), AdornedRulerPanel::ShowMenu(), AdornedRulerPanel::TogglePinnedHead(), and AdornedRulerPanel::UpdateButtonStates().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol TracksPrefs::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 285 of file TracksPrefs.cpp.

{
   return TRACKS_PREFS_PLUGIN_SYMBOL;
}

References TRACKS_PREFS_PLUGIN_SYMBOL.

◆ HelpPageName()

ManualPageID TracksPrefs::HelpPageName ( )

overridevirtual

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

Default returns empty string.

Reimplemented from PrefsPanel.

Definition at line 295 of file TracksPrefs.cpp.

{
   return "Tracks_Preferences";
}

◆ Populate()

void TracksPrefs::Populate ( )

private

Definition at line 300 of file TracksPrefs.cpp.

{
   // Keep view choices and codes in proper correspondence --
   // we don't display them by increasing integer values.
 
 
   // How samples are displayed when zoomed in:
 
 
   //------------------------- 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 TracksPrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PopulateOrExchange()

void TracksPrefs::PopulateOrExchange ( ShuttleGui & S )

overrideprivate

Definition at line 318 of file TracksPrefs.cpp.

{
   auto viewModeSetting = ViewModeSetting();
 
   S.SetBorder(2);
   S.StartScroller();
 
   S.StartStatic(XO("Display"));
   {
      S.TieCheckBox(XXO("Auto-&fit track height"),
                    {wxT("/GUI/TracksFitVerticallyZoomed"),
                     false});
      S.TieCheckBox(XXO("Sho&w track name as overlay"),
                  {wxT("/GUI/ShowTrackNameInWaveform"),
                   false});
#ifdef EXPERIMENTAL_HALF_WAVE
      S.TieCheckBox(XXO("Use &half-wave display when collapsed"),
                  {wxT("/GUI/CollapseToHalfWave"),
                   false});
#endif
#ifdef SHOW_PINNED_UNPINNED_IN_PREFS
      S.TieCheckBox(XXO("&Pinned Recording/Playback head"),
         {PinnedHeadPreferenceKey(),
          PinnedHeadPreferenceDefault()});
#endif
      S.TieCheckBox(XXO("A&uto-scroll if head unpinned"),
         {wxT("/GUI/AutoScroll"),
          true});
 
      S.AddSpace(10);
 
      S.StartMultiColumn(2);
      {
#ifdef SHOW_PINNED_POSITION_IN_PREFS
         S.TieNumericTextBox(
            XXO("Pinned &head position"),
            {PinnedHeadPositionPreferenceKey(),
             PinnedHeadPositionPreferenceDefault()},
            30
         );
#endif
 
         S.TieChoice(XXO("Default &view mode:"),
                     viewModeSetting );
 
         S.TieChoice(XXO("Default Waveform scale:"),
                     waveformScaleSetting );
 
         S.TieChoice(XXO("Display &samples:"),
                     sampleDisplaySetting );
 
         S.TieTextBox(XXO("Default audio track &name:"),
                      AudioTrackNameSetting,
                      30);
      }
      S.EndMultiColumn();
   }
   S.EndStatic();
 
   S.StartStatic(XO("Zoom Toggle"));
   {
      S.StartMultiColumn(4);
      {
         S.TieChoice(XXO("Preset 1:"),
                     zoom1Setting );
 
         S.TieChoice(XXO("Preset 2:"),
                     zoom2Setting );
      }
   }
   S.EndStatic();
   S.EndScroller();
}

References AudioTrackNameSetting, anonymous_namespace{TracksPrefs.cpp}::PinnedHeadPositionPreferenceDefault(), anonymous_namespace{TracksPrefs.cpp}::PinnedHeadPositionPreferenceKey(), anonymous_namespace{TracksPrefs.cpp}::PinnedHeadPreferenceDefault(), anonymous_namespace{TracksPrefs.cpp}::PinnedHeadPreferenceKey(), S, sampleDisplaySetting, ViewModeSetting(), waveformScaleSetting, wxT(), XO(), XXO(), zoom1Setting, and zoom2Setting.

Referenced by Commit(), and Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SampleViewChoice()

WaveChannelViewConstants::SampleDisplay TracksPrefs::SampleViewChoice ( )

static

Definition at line 200 of file TracksPrefs.cpp.

{
   return sampleDisplaySetting.ReadEnum();
}

References sampleDisplaySetting.

Referenced by TrackArtist::UpdatePrefs().

Here is the caller graph for this function:

◆ SetPinnedHeadPositionPreference()

void TracksPrefs::SetPinnedHeadPositionPreference	(	double	value,
		bool	flush = `false`
	)

static

Definition at line 419 of file TracksPrefs.cpp.

{
   value = std::max(0.0, std::min(1.0, value));
   gPrefs->Write(PinnedHeadPositionPreferenceKey(), value);
   if(flush)
      gPrefs->Flush();
}

References audacity::BasicSettings::Flush(), gPrefs, min(), anonymous_namespace{TracksPrefs.cpp}::PinnedHeadPositionPreferenceKey(), and audacity::BasicSettings::Write().

Referenced by anonymous_namespace{AdornedRulerPanel.cpp}::PlayheadHandle::Cancel(), anonymous_namespace{AdornedRulerPanel.cpp}::PlayheadHandle::Click(), anonymous_namespace{AdornedRulerPanel.cpp}::PlayheadHandle::Drag(), and anonymous_namespace{AdornedRulerPanel.cpp}::PlayheadHandle::Release().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetPinnedHeadPreference()

void TracksPrefs::SetPinnedHeadPreference	(	bool	value,
		bool	flush = `false`
	)

static

Definition at line 403 of file TracksPrefs.cpp.

{
   iPreferencePinned = value ? 1 :0;
   gPrefs->Write(PinnedHeadPreferenceKey(), value);
   if(flush)
      gPrefs->Flush();
}

References audacity::BasicSettings::Flush(), gPrefs, iPreferencePinned, anonymous_namespace{TracksPrefs.cpp}::PinnedHeadPreferenceKey(), and audacity::BasicSettings::Write().

Referenced by AdornedRulerPanel::TogglePinnedHead().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ViewModeChoice()

WaveChannelViewConstants::Display TracksPrefs::ViewModeChoice ( )

static

Definition at line 172 of file TracksPrefs.cpp.

{
   return ViewModeSetting().ReadEnum();
}

References EnumSetting< Enum >::ReadEnum(), and ViewModeSetting().

Referenced by WaveChannelView::BuildSubViews().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WaveformScaleChoice()

WaveformSettings::ScaleTypeValues TracksPrefs::WaveformScaleChoice ( )

static

Definition at line 177 of file TracksPrefs.cpp.

{
   return waveformScaleSetting.ReadEnum();
}

References waveformScaleSetting.

Referenced by WaveformSettings::LoadPrefs(), and WaveformSettings::UpdatePrefs().

Here is the caller graph for this function:

◆ Zoom1Choice()

WaveChannelViewConstants::ZoomPresets TracksPrefs::Zoom1Choice ( )

static

Definition at line 261 of file TracksPrefs.cpp.

{
   return zoom1Setting.ReadEnum();
}

References zoom1Setting.

Referenced by ViewActions::Handler::OnZoomToggle().

Here is the caller graph for this function:

◆ Zoom2Choice()

WaveChannelViewConstants::ZoomPresets TracksPrefs::Zoom2Choice ( )

static

Definition at line 266 of file TracksPrefs.cpp.

{
   return zoom2Setting.ReadEnum();
}

References zoom2Setting.

Referenced by ViewActions::Handler::OnZoomToggle().

Here is the caller graph for this function:

Member Data Documentation

◆ iPreferencePinned

int TracksPrefs::iPreferencePinned = -1

staticprivate

Definition at line 54 of file TracksPrefs.h.

Referenced by Commit(), GetPinnedHeadPreference(), and SetPinnedHeadPreference().

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TracksPrefs()

◆ ~TracksPrefs()

Member Function Documentation

◆ Commit()

◆ GetDescription()

◆ GetPinnedHeadPositionPreference()

◆ GetPinnedHeadPreference()

◆ GetSymbol()

◆ HelpPageName()

◆ Populate()

◆ PopulateOrExchange()

◆ SampleViewChoice()

◆ SetPinnedHeadPositionPreference()

◆ SetPinnedHeadPreference()

◆ ViewModeChoice()

◆ WaveformScaleChoice()

◆ Zoom1Choice()

◆ Zoom2Choice()

Member Data Documentation

◆ iPreferencePinned