Audacity  3.0.3
Public Member Functions | Private Member Functions | List of all members
TracksBehaviorsPrefs Class Referencefinal

A PrefsPanel for Tracks Behaviors settings. More...

#include <TracksBehaviorsPrefs.h>

Inheritance diagram for TracksBehaviorsPrefs:
[legend]
Collaboration diagram for TracksBehaviorsPrefs:
[legend]

Public Member Functions

 TracksBehaviorsPrefs (wxWindow *parent, wxWindowID winid)
 
 ~TracksBehaviorsPrefs ()
 
ComponentInterfaceSymbol GetSymbol () override
 
TranslatableString GetDescription () 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 PluginPath GetPath ()
 
virtual VendorSymbol GetVendor ()
 
virtual wxString GetVersion ()
 
virtual bool ShowsPreviewButton ()
 
virtual void PopulateOrExchange (ShuttleGui &WXUNUSED(S))
 
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
 
wxTabTraversalWrapperoperator= (const wxTabTraversalWrapper &)=delete
 
wxTabTraversalWrapperoperator= (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 FactoriesDefaultFactories ()
 

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 24 of file TracksBehaviorsPrefs.cpp.

26 : PrefsPanel(parent, winid, XO("Tracks Behaviors"))
27 {
28  Populate();
29 }

References Populate().

Here is the call graph for this function:

◆ ~TracksBehaviorsPrefs()

TracksBehaviorsPrefs::~TracksBehaviorsPrefs ( )

Definition at line 31 of file TracksBehaviorsPrefs.cpp.

32 {
33 }

Member Function Documentation

◆ Commit()

bool TracksBehaviorsPrefs::Commit ( )
overridevirtual

Implements PrefsPanel.

Definition at line 118 of file TracksBehaviorsPrefs.cpp.

119 {
120  ShuttleGui S(this, eIsSavingToPrefs);
122 
123  return true;
124 }

References eIsSavingToPrefs, and PopulateOrExchange().

Here is the call graph for this function:

◆ GetDescription()

TranslatableString TracksBehaviorsPrefs::GetDescription ( )
overridevirtual

Implements ComponentInterface.

Definition at line 40 of file TracksBehaviorsPrefs.cpp.

41 {
42  return XO("Preferences for TracksBehaviors");
43 }

References XO.

◆ GetSymbol()

ComponentInterfaceSymbol TracksBehaviorsPrefs::GetSymbol ( )
overridevirtual

Implements ComponentInterface.

Definition at line 35 of file TracksBehaviorsPrefs.cpp.

36 {
38 }

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 45 of file TracksBehaviorsPrefs.cpp.

46 {
47  return "Tracks_Behaviors_Preferences";
48 }

◆ Populate()

void TracksBehaviorsPrefs::Populate ( )
private

Definition at line 50 of file TracksBehaviorsPrefs.cpp.

51 {
52  //------------------------- Main section --------------------
53  // Now construct the GUI itself.
56  // ----------------------- End of main section --------------
57 }

References eIsCreatingFromPrefs, and PopulateOrExchange().

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 69 of file TracksBehaviorsPrefs.cpp.

70 {
71  S.SetBorder(2);
72  S.StartScroller();
73 
74  S.StartStatic(XO("Behaviors"));
75  {
76  S.TieCheckBox(XXO("&Select all audio, if selection required"),
77  {wxT("/GUI/SelectAllOnNone"),
78  false});
79  /* i18n-hint: Cut-lines are lines that can expand to show the cut audio.*/
80  S.TieCheckBox(XXO("Enable cut &lines"),
81  {wxT("/GUI/EnableCutLines"),
82  false});
83  S.TieCheckBox(XXO("Enable &dragging selection edges"),
84  {wxT("/GUI/AdjustSelectionEdges"),
85  true});
86  S.TieCheckBox(XXO("Editing a clip can &move other clips"),
87  {wxT("/GUI/EditClipCanMove"),
88  false});
89  S.TieCheckBox(XXO("\"Move track focus\" c&ycles repeatedly through tracks"),
90  {wxT("/GUI/CircularTrackNavigation"),
91  false});
92  S.TieCheckBox(XXO("&Type to create a label"),
93  {wxT("/GUI/TypeToCreateLabel"),
94  false});
95  S.TieCheckBox(XXO("Use dialog for the &name of a new label"),
96  {wxT("/GUI/DialogForNameNewLabel"),
97  false});
98 #ifdef EXPERIMENTAL_SCROLLING_LIMITS
99  S.TieCheckBox(XXO("Enable scrolling left of &zero"),
101 #endif
102  S.TieCheckBox(XXO("Advanced &vertical zooming"),
103  {wxT("/GUI/VerticalZooming"),
104  false});
105 
106  S.AddSpace(10);
107 
108  S.StartMultiColumn(2);
109  {
110  S.TieChoice( XXO("Solo &Button:"), TracksBehaviorsSolo);
111  }
112  S.EndMultiColumn();
113  }
114  S.EndStatic();
115  S.EndScroller();
116 }

References ShuttleGui::AddSpace(), ShuttleGuiBase::EndMultiColumn(), ShuttleGuiBase::EndScroller(), ShuttleGuiBase::EndStatic(), ScrollingPreference, ShuttleGuiBase::SetBorder(), ShuttleGuiBase::StartMultiColumn(), ShuttleGuiBase::StartScroller(), ShuttleGuiBase::StartStatic(), ShuttleGuiBase::TieCheckBox(), ShuttleGuiBase::TieChoice(), TracksBehaviorsSolo, 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:
TracksBehaviorsSolo
ChoiceSetting TracksBehaviorsSolo
Definition: TracksBehaviorsPrefs.cpp:59
ShuttleGuiBase::TieCheckBox
wxCheckBox * TieCheckBox(const TranslatableString &Prompt, bool &Var)
Definition: ShuttleGui.cpp:1629
ShuttleGui::AddSpace
wxSizerItem * AddSpace(int width, int height, int prop=0)
Definition: ShuttleGui.cpp:2459
XO
#define XO(s)
Definition: Internat.h:31
ShuttleGuiBase::EndMultiColumn
void EndMultiColumn()
Definition: ShuttleGui.cpp:1238
ScrollingPreference
BoolSetting ScrollingPreference
Definition: ViewInfo.cpp:266
ShuttleGuiBase::EndScroller
void EndScroller()
Definition: ShuttleGui.cpp:971
XXO
#define XXO(s)
Definition: Internat.h:44
ShuttleGuiBase::StartScroller
wxScrolledWindow * StartScroller(int iStyle=0)
Definition: ShuttleGui.cpp:938
ShuttleGuiBase::StartMultiColumn
void StartMultiColumn(int nCols, int PositionFlags=wxALIGN_LEFT)
Definition: ShuttleGui.cpp:1229
ShuttleGuiBase::StartStatic
wxStaticBox * StartStatic(const TranslatableString &Str, int iProp=0)
Definition: ShuttleGui.cpp:893
eIsSavingToPrefs
@ eIsSavingToPrefs
Definition: ShuttleGui.h:48
TracksBehaviorsPrefs::PopulateOrExchange
void PopulateOrExchange(ShuttleGui &S) override
Definition: TracksBehaviorsPrefs.cpp:69
TracksBehaviorsPrefs::Populate
void Populate()
Definition: TracksBehaviorsPrefs.cpp:50
TRACKS_BEHAVIORS_PREFS_PLUGIN_SYMBOL
#define TRACKS_BEHAVIORS_PREFS_PLUGIN_SYMBOL
Definition: TracksBehaviorsPrefs.h:22
ShuttleGuiBase::SetBorder
void SetBorder(int Border)
Definition: ShuttleGui.h:489
eIsCreatingFromPrefs
@ eIsCreatingFromPrefs
Definition: ShuttleGui.h:47
ShuttleGuiBase::EndStatic
void EndStatic()
Definition: ShuttleGui.cpp:922
ShuttleGuiBase::TieChoice
wxChoice * TieChoice(const TranslatableString &Prompt, TranslatableString &Selected, const TranslatableStrings &choices)
Definition: ShuttleGui.cpp:1727
ShuttleGui
Derived from ShuttleGuiBase, an Audacity specific class for shuttling data to and from GUI.
Definition: ShuttleGui.h:631
PrefsPanel::PrefsPanel
PrefsPanel(wxWindow *parent, wxWindowID winid, const TranslatableString &title)
Definition: PrefsPanel.h:90