Audacity  2.2.0
PrefsPanel Class Referenceabstract

Used within the PrefsDialog, classes derived from this class include AudioIOPrefs, BatchPrefs, DirectoriesPrefs, FileFormatPrefs, GUIPrefs, KeyConfigPrefs, MousePrefs, QualityPrefs, SpectrumPrefs and ThemePrefs. More...

#include <PrefsPanel.h>

Inheritance diagram for PrefsPanel:
wxTabTraversalWrapper< Base > BatchPrefs DevicePrefs DirectoriesPrefs EffectsPrefs ExtImportPrefs GUIPrefs ImportExportPrefs KeyConfigPrefs LibraryPrefs ModulePrefs MousePrefs PlaybackPrefs ProjectsPrefs QualityPrefs RecordingPrefs SpectrumPrefs ThemePrefs TracksBehaviorsPrefs TracksPrefs WarningsPrefs WaveformPrefs

Public Member Functions

 PrefsPanel (wxWindow *parent, const wxString &title)
 
virtual ~PrefsPanel ()
 
virtual void Preview ()
 
virtual bool Commit ()=0
 
virtual bool ShowsPreviewButton ()
 
virtual wxString HelpPageName ()
 
virtual void Cancel ()
 
- Public Member Functions inherited from wxTabTraversalWrapper< Base >
template<typename... Args>
 wxTabTraversalWrapper (Args &&...args)
 
 ~wxTabTraversalWrapper ()
 

Detailed Description

Used within the PrefsDialog, classes derived from this class include AudioIOPrefs, BatchPrefs, DirectoriesPrefs, FileFormatPrefs, GUIPrefs, KeyConfigPrefs, MousePrefs, QualityPrefs, SpectrumPrefs and ThemePrefs.

The interface works like this: Each panel in the preferences dialog must derive from PrefsPanel. You must override Apply() with code to validate fields (returning false if any are bad), updating the global preferences object gPrefs, and instructing the applicable parts of the program to re-read the preference options.

To actually add a the NEW panel, edit the PrefsDialog constructor to append the panel to its list of panels.

Constructor & Destructor Documentation

PrefsPanel::PrefsPanel ( wxWindow *  parent,
const wxString &  title 
)
inline
PrefsPanel::~PrefsPanel ( )
virtual

Member Function Documentation

void PrefsPanel::Cancel ( )
virtual

Reimplemented in KeyConfigPrefs.

Referenced by PrefsDialog::OnCancel().

virtual void PrefsPanel::Preview ( )
inlinevirtual

Reimplemented in SpectrumPrefs.

Referenced by PrefsDialog::OnOK(), and PrefsDialog::OnPreview().

bool PrefsPanel::ShowsPreviewButton ( )
virtual

Reimplemented in SpectrumPrefs, and WaveformPrefs.

Referenced by SetSelection().


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