ThemePrefs Class Reference

A PrefsPanel that configures dynamic loading of Theme icons and colours. More...

#include <ThemePrefs.h>

Inheritance diagram for ThemePrefs:

Collaboration diagram for ThemePrefs:

Public Member Functions
	ThemePrefs (wxWindow *parent, wxWindowID winid)
	~ThemePrefs (void)
ComponentInterfaceSymbol	GetSymbol () const override
TranslatableString	GetDescription () const override
bool	Commit () override
	Update the preferences stored on disk. More...
void	Cancel () 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 ()
	Creates the dialog and its contents. More...
void	PopulateOrExchange (ShuttleGui &S) override
	Create the dialog contents, or exchange data with it. More...
void	OnLoadThemeComponents (wxCommandEvent &e)
	Load Theme from multiple png files. More...
void	OnSaveThemeComponents (wxCommandEvent &e)
	Save Theme to multiple png files. More...
void	OnLoadThemeCache (wxCommandEvent &e)
	Load Theme from single png file. More...
void	OnSaveThemeCache (wxCommandEvent &e)
	Save Themes, each to a single png file. More...
void	OnReadThemeInternal (wxCommandEvent &e)
	Read Theme from internal storage. More...
void	OnSaveThemeAsCode (wxCommandEvent &e)
	Save Theme as C source code. More...

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 that configures dynamic loading of Theme icons and colours.

Provides:

• Button to save each theme as a single png image.
• Button to load current theme from a single png image.
• Button to save each theme to multiple png images.
• Button to load themes from multiple png images.
• (Optional) Button to save each theme as Cee data.
• Button to read theme from default values in program.
• CheckBox for loading custom themes at startup.

See also

Themability of Audacity

Definition at line 25 of file ThemePrefs.h.

Constructor & Destructor Documentation

ThemePrefs()

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

Definition at line 75 of file ThemePrefs.cpp.

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

References Populate().

Here is the call graph for this function:

~ThemePrefs()

ThemePrefs::~ThemePrefs

(

void

)

Definition at line 85 of file ThemePrefs.cpp.

{
}

Member Function Documentation

Cancel()

void ThemePrefs::Cancel ( )

overridevirtual

Reimplemented from PrefsPanel.

Definition at line 253 of file ThemePrefs.cpp.

{
   theTheme.LoadPreferredTheme();
   theTheme.DeleteUnusedThemes();
   AColor::ApplyUpdatedImages();
}

References AColor::ApplyUpdatedImages(), ThemeBase::DeleteUnusedThemes(), ThemeBase::LoadPreferredTheme(), and theTheme.

Here is the call graph for this function:

Commit()

bool ThemePrefs::Commit ( )

overridevirtual

Update the preferences stored on disk.

Implements PrefsPanel.

Definition at line 242 of file ThemePrefs.cpp.

{
   ShuttleGui S(this, eIsSavingToPrefs);
   PopulateOrExchange(S);
 
   theTheme.LoadPreferredTheme();
   theTheme.DeleteUnusedThemes();
   AColor::ApplyUpdatedImages();
   return true;
}

References AColor::ApplyUpdatedImages(), ThemeBase::DeleteUnusedThemes(), eIsSavingToPrefs, ThemeBase::LoadPreferredTheme(), PopulateOrExchange(), S, and theTheme.

Here is the call graph for this function:

GetDescription()

TranslatableString ThemePrefs::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 94 of file ThemePrefs.cpp.

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

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol ThemePrefs::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 89 of file ThemePrefs.cpp.

{
   return THEME_PREFS_PLUGIN_SYMBOL;
}

References THEME_PREFS_PLUGIN_SYMBOL.

HelpPageName()

ManualPageID ThemePrefs::HelpPageName ( )

overridevirtual

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

Default returns empty string.

Reimplemented from PrefsPanel.

Definition at line 99 of file ThemePrefs.cpp.

{
   return "Theme_Preferences";
}

OnLoadThemeCache()

void ThemePrefs::OnLoadThemeCache ( wxCommandEvent &  e )

private

Load Theme from single png file.

Definition at line 206 of file ThemePrefs.cpp.

{
   wxBusyCursor busy;
   theTheme.SwitchTheme({});
   AColor::ApplyUpdatedImages();
}

References AColor::ApplyUpdatedImages(), ThemeBase::SwitchTheme(), and theTheme.

Here is the call graph for this function:

OnLoadThemeComponents()

void ThemePrefs::OnLoadThemeComponents ( wxCommandEvent &  e )

private

Load Theme from multiple png files.

Definition at line 189 of file ThemePrefs.cpp.

{
   wxBusyCursor busy;
   theTheme.LoadThemeComponents();
   AColor::ApplyUpdatedImages();
}

References AColor::ApplyUpdatedImages(), ThemeBase::LoadThemeComponents(), and theTheme.

Here is the call graph for this function:

OnReadThemeInternal()

void ThemePrefs::OnReadThemeInternal ( wxCommandEvent &  e )

private

Read Theme from internal storage.

Definition at line 224 of file ThemePrefs.cpp.

{
   wxBusyCursor busy;
   theTheme.SwitchTheme( theTheme.GetFallbackThemeType() );
   AColor::ApplyUpdatedImages();
}

References AColor::ApplyUpdatedImages(), ThemeBase::GetFallbackThemeType(), ThemeBase::SwitchTheme(), and theTheme.

Here is the call graph for this function:

OnSaveThemeAsCode()

void ThemePrefs::OnSaveThemeAsCode ( wxCommandEvent &  e )

private

Save Theme as C source code.

Definition at line 232 of file ThemePrefs.cpp.

{
   if (!ConfirmSave())
      return;
   wxBusyCursor busy;
   theTheme.SaveThemeAsCode();
   theTheme.WriteImageDefs();// bonus - give them the Defs too.
}

References ConfirmSave(), ThemeBase::SaveThemeAsCode(), theTheme, and ThemeBase::WriteImageDefs().

Here is the call graph for this function:

OnSaveThemeCache()

void ThemePrefs::OnSaveThemeCache ( wxCommandEvent &  e )

private

Save Themes, each to a single png file.

Definition at line 214 of file ThemePrefs.cpp.

{
   if (!ConfirmSave())
      return;
   wxBusyCursor busy;
   theTheme.CreateImageCache();
   theTheme.WriteImageMap();// bonus - give them the html version.
}

References ConfirmSave(), ThemeBase::CreateImageCache(), theTheme, and ThemeBase::WriteImageMap().

Here is the call graph for this function:

OnSaveThemeComponents()

void ThemePrefs::OnSaveThemeComponents ( wxCommandEvent &  e )

private

Save Theme to multiple png files.

Definition at line 197 of file ThemePrefs.cpp.

{
   if (!ConfirmSave())
      return;
   wxBusyCursor busy;
   theTheme.SaveThemeComponents();
}

References ConfirmSave(), ThemeBase::SaveThemeComponents(), and theTheme.

Here is the call graph for this function:

Populate()

void ThemePrefs::Populate ( )

private

Creates the dialog and its contents.

Definition at line 105 of file ThemePrefs.cpp.

{
   // First any pre-processing for constructing the GUI.
 
   //------------------------- 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 ThemePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

PopulateOrExchange()

void ThemePrefs::PopulateOrExchange ( ShuttleGui &  S )

overrideprivate

Create the dialog contents, or exchange data with it.

Definition at line 119 of file ThemePrefs.cpp.

{
   S.SetBorder(2);
   S.StartScroller();
 
   S.StartStatic(XO("Info"));
   {
      S.AddFixedText(
         XO(
"Themability is an experimental feature.\n\nTo try it out, click \"Save Theme Cache\" then find and modify the images and colors in\nImageCacheVxx.png using an image editor such as the Gimp.\n\nClick \"Load Theme Cache\" to load the changed images and colors back into Audacity.")
         );
 
#ifdef _DEBUG
      S.AddFixedText(
         Verbatim(
"This is a debug version of Audacity, with an extra button, 'Output Sourcery'. This will save\nC versions of the image caches that can be compiled in as defaults.")
         );
#endif
 
      S.AddFixedText(
         XO(
"Saving and loading individual theme files uses a separate file for each image, but is\notherwise the same idea.")
         );
   }
   S.EndStatic();
 
   /* i18n-hint: && in here is an escape character to get a single & on screen,
    * so keep it as is */
   S.StartStatic(    XO("Theme Cache - Images && Color"));
   {
      S.StartHorizontalLay(wxALIGN_LEFT);
      {
         S.Id(idSaveThemeCache).AddButton(XXO("Save Theme Cache"));
         S.Id(idLoadThemeCache).AddButton(XXO("Load Theme Cache"));
 
         // This next button is only provided in Debug mode.
         // It is for developers who are compiling Audacity themselves
         // and who wish to generate NEW *ThemeAsCeeCode.h and compile them in.
#ifdef _DEBUG
         S.Id(idSaveThemeAsCode).AddButton(Verbatim("Output Sourcery"));
#endif
 
         S.Id(idReadThemeInternal).AddButton(XXO("&Defaults"));
      }
      S.EndHorizontalLay();
   }
   S.EndStatic();
 
   // JKC: 'Ergonomic' details:
   // Theme components are used much less frequently than
   // the ImageCache.  Yet it's easy to click them 'by mistake'.
   //
   // To reduce that risk, we use a separate box to separate them off.
   // And choose text on the buttons that is shorter, making the
   // buttons smaller and less tempting to click.
   S.StartStatic( XO("Individual Theme Files"),1);
   {
      S.StartHorizontalLay(wxALIGN_LEFT);
      {
         S.Id(idSaveThemeComponents).AddButton( XXO("Save Files"));
         S.Id(idLoadThemeComponents).AddButton( XXO("Load Files"));
      }
      S.EndHorizontalLay();
   }
   S.EndStatic();
   S.EndScroller();
 
}

References idLoadThemeCache, idLoadThemeComponents, idReadThemeInternal, idSaveThemeAsCode, idSaveThemeCache, idSaveThemeComponents, S, Verbatim(), 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:

• ThemePrefs.h
• ThemePrefs.cpp