TracksBehaviorsPrefs Class Reference

A PrefsPanel for Tracks Behaviors settings. More...

#include <TracksBehaviorsPrefs.h>

Inheritance diagram for TracksBehaviorsPrefs:

Collaboration diagram for TracksBehaviorsPrefs:

Public Member Functions
	TracksBehaviorsPrefs (wxWindow *parent, wxWindowID winid)
	~TracksBehaviorsPrefs ()
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

Private Member Functions
void	Populate ()
void	PopulateOrExchange (ShuttleGui &S) override

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

Detailed Description

A PrefsPanel for Tracks Behaviors settings.

Definition at line 24 of file TracksBehaviorsPrefs.h.

Constructor & Destructor Documentation

TracksBehaviorsPrefs()

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

Definition at line 30 of file TracksBehaviorsPrefs.cpp.

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

References Populate().

Here is the call graph for this function:

~TracksBehaviorsPrefs()

TracksBehaviorsPrefs::~TracksBehaviorsPrefs

(

)

Definition at line 37 of file TracksBehaviorsPrefs.cpp.

{
}

Member Function Documentation

Commit()

bool TracksBehaviorsPrefs::Commit ( )

overridevirtual

Implements PrefsPanel.

Definition at line 187 of file TracksBehaviorsPrefs.cpp.

{
   ShuttleGui S(this, eIsSavingToPrefs);
   PopulateOrExchange(S);
   EditClipsCanMove.Invalidate();
   ScrollingPreference.Invalidate();
 
   return true;
}

References EditClipsCanMove, eIsSavingToPrefs, Setting< T >::Invalidate(), PopulateOrExchange(), S, and ScrollingPreference.

Here is the call graph for this function:

GetDescription()

TranslatableString TracksBehaviorsPrefs::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 46 of file TracksBehaviorsPrefs.cpp.

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

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol TracksBehaviorsPrefs::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 41 of file TracksBehaviorsPrefs.cpp.

{
   return TRACKS_BEHAVIORS_PREFS_PLUGIN_SYMBOL;
}

References TRACKS_BEHAVIORS_PREFS_PLUGIN_SYMBOL.

HelpPageName()

ManualPageID TracksBehaviorsPrefs::HelpPageName ( )

overridevirtual

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

Default returns empty string.

Reimplemented from PrefsPanel.

Definition at line 51 of file TracksBehaviorsPrefs.cpp.

{
   return "Tracks_Behaviors_Preferences";
}

Populate()

void TracksBehaviorsPrefs::Populate ( )

private

Definition at line 56 of file TracksBehaviorsPrefs.cpp.

{
   //------------------------- Main section --------------------
   // Now construct the GUI itself.
   ShuttleGui S(this, eIsCreatingFromPrefs);
   PopulateOrExchange(S);
   // ----------------------- End of main section --------------
}

References eIsCreatingFromPrefs, PopulateOrExchange(), and S.

Referenced by TracksBehaviorsPrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

PopulateOrExchange()

void TracksBehaviorsPrefs::PopulateOrExchange ( ShuttleGui &  S )

overrideprivate

Definition at line 97 of file TracksBehaviorsPrefs.cpp.

{
   S.SetBorder(2);
   S.StartScroller();
 
   S.StartStatic(XO("Behaviors"));
   {
      S.TieCheckBox(XXO("&Select all audio, if selection required"),
                    {wxT("/GUI/SelectAllOnNone"),
                     false});
      /* i18n-hint: Cut-lines are lines that can expand to show the cut audio.*/
      S.TieCheckBox(XXO("Enable cut &lines"),
                    {wxT("/GUI/EnableCutLines"),
                     false});
      S.TieCheckBox(XXO("Enable &dragging selection edges"),
                    {wxT("/GUI/AdjustSelectionEdges"),
                     true});
      S
         .TieCheckBox(XXO("Editing a clip can &move other clips"),
            EditClipsCanMove);
      S.TieCheckBox(XXO("\"Move track focus\" c&ycles repeatedly through tracks"),
                    {wxT("/GUI/CircularTrackNavigation"),
                     false});
      S.TieCheckBox(XXO("&Type to create a label"),
                    {wxT("/GUI/TypeToCreateLabel"),
                     false});
      S.TieCheckBox(XXO("Use dialog for the &name of a new label"),
                    {wxT("/GUI/DialogForNameNewLabel"),
                     false});
#ifdef EXPERIMENTAL_SCROLLING_LIMITS
      S.TieCheckBox(XXO("Enable scrolling left of &zero"),
                    ScrollingPreference);
#endif
      S.TieCheckBox(XXO("Advanced &vertical zooming"),
                    {wxT("/GUI/VerticalZooming"),
                     false});
 
      S.AddSpace(10);
 
      S.StartMultiColumn(2);
      {
         S.TieChoice( XXO("Solo &Button:"), TracksBehaviorsSolo);
      }
      S.EndMultiColumn();
   }
   S.EndStatic();
   auto pastedAudioBox = S.StartStatic(XO("Pasted audio"));
   {
      const auto header = S.AddVariableText(XO("Paste audio from other Audacity project as"));
#if wxUSE_ACCESSIBILITY
      if(pastedAudioBox != nullptr)
      {
         pastedAudioBox->SetName(header->GetLabel());
         safenew WindowAccessible(pastedAudioBox);
      }
#endif
      S.StartRadioButtonGroup(TracksBehaviorsAudioTrackPastePolicy);
      for(int i = 0;
         i < TracksBehaviorsAudioTrackPastePolicy.GetSymbols().size();
         ++i)
      {
         S.StartHorizontalLay(wxALIGN_LEFT);
         {
            wxRadioButton* radioButton{};
            S.StartVerticalLay(0);
            {
               radioButton =
                  S.Name(audioPasteModeText[i]).TieRadioButton();
               S.AddSpace(0, 0, 1);
            }
            S.EndVerticalLay();
 
            S.AddVariableText(audioPasteModeText[i])->Bind(
               wxEVT_LEFT_UP, [=](auto)
               {
                  radioButton->SetValue(true);
               });
   #if wxUSE_ACCESSIBILITY
            safenew WindowAccessible(radioButton);
   #endif
         }
         S.EndHorizontalLay();
      }
      S.EndRadioButtonGroup();
   }
   S.EndStatic();
   
   S.EndScroller();
}

References anonymous_namespace{TracksBehaviorsPrefs.cpp}::audioPasteModeText, EditClipsCanMove, ChoiceSetting::GetSymbols(), S, safenew, ScrollingPreference, size, TracksBehaviorsAudioTrackPastePolicy, TracksBehaviorsSolo, 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:

• TracksBehaviorsPrefs.h
• TracksBehaviorsPrefs.cpp