ThemePrefs.cpp

Go to the documentation of this file.

/**********************************************************************
 
  Audacity: A Digital Audio Editor
 
  ThemePrefs.cpp
 
  James Crook
 
  Audacity is free software.
  This file is licensed under the wxWidgets license, see License.txt
 
********************************************************************//********************************************************************/
 
 
#include "ThemePrefs.h"
 
#include <wx/app.h>
#include <wx/wxprec.h>
#include "Prefs.h"
#include "Theme.h"
#include "ShuttleGui.h"
#include "AColor.h"
#include "BasicUI.h"
 
enum eThemePrefsIds {
   idLoadThemeCache=7000,
   idSaveThemeCache,
   idLoadThemeComponents,
   idSaveThemeComponents,
   idReadThemeInternal,
   idSaveThemeAsCode
};
 
BEGIN_EVENT_TABLE(ThemePrefs, PrefsPanel)
   EVT_BUTTON(idLoadThemeCache,      ThemePrefs::OnLoadThemeCache)
   EVT_BUTTON(idSaveThemeCache,      ThemePrefs::OnSaveThemeCache)
   EVT_BUTTON(idLoadThemeComponents, ThemePrefs::OnLoadThemeComponents)
   EVT_BUTTON(idSaveThemeComponents, ThemePrefs::OnSaveThemeComponents)
   EVT_BUTTON(idReadThemeInternal,   ThemePrefs::OnReadThemeInternal)
   EVT_BUTTON(idSaveThemeAsCode,     ThemePrefs::OnSaveThemeAsCode)
END_EVENT_TABLE()
 
static bool ConfirmSave()
{
   if (!GUIBlendThemes.Read())
      return true;
 
   using namespace BasicUI;
   const auto message = Verbatim(
"\"Blend system and Audacity theme\" in Interface Preferences was on.\n"
"This may cause images to to be re-saved with slight changes of color."
   );
 
   return MessageBoxResult::Cancel != ShowMessageBox(message,
      MessageBoxOptions{}.CancelButton().IconStyle(Icon::Warning));
}
 
ThemePrefs::ThemePrefs(wxWindow * parent, wxWindowID winid)
/* i18n-hint: A theme is a consistent visual style across an application's
 graphical user interface, including choices of colors, and similarity of images
 such as those on button controls.  Audacity can load and save alternative
 themes. */
:  PrefsPanel(parent, winid, XO("Theme"))
{
   Populate();
}
 
ThemePrefs::~ThemePrefs(void)
{
}
 
ComponentInterfaceSymbol ThemePrefs::GetSymbol() const
{
   return THEME_PREFS_PLUGIN_SYMBOL;
}
 
TranslatableString ThemePrefs::GetDescription() const
{
   return XO("Preferences for Theme");
}
 
ManualPageID ThemePrefs::HelpPageName()
{
   return "Theme_Preferences";
}
 
void ThemePrefs::Populate()
{
   // 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 --------------
}
 
void ThemePrefs::PopulateOrExchange(ShuttleGui & S)
{
   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();
 
}
 
void ThemePrefs::OnLoadThemeComponents(wxCommandEvent & WXUNUSED(event))
{
   wxBusyCursor busy;
   theTheme.LoadThemeComponents();
   AColor::ApplyUpdatedImages();
}
 
void ThemePrefs::OnSaveThemeComponents(wxCommandEvent & WXUNUSED(event))
{
   if (!ConfirmSave())
      return;
   wxBusyCursor busy;
   theTheme.SaveThemeComponents();
}
 
void ThemePrefs::OnLoadThemeCache(wxCommandEvent & WXUNUSED(event))
{
   wxBusyCursor busy;
   theTheme.SwitchTheme({});
   AColor::ApplyUpdatedImages();
}
 
void ThemePrefs::OnSaveThemeCache(wxCommandEvent & WXUNUSED(event))
{
   if (!ConfirmSave())
      return;
   wxBusyCursor busy;
   theTheme.CreateImageCache();
   theTheme.WriteImageMap();// bonus - give them the html version.
}
 
void ThemePrefs::OnReadThemeInternal(wxCommandEvent & WXUNUSED(event))
{
   wxBusyCursor busy;
   theTheme.SwitchTheme( theTheme.GetFallbackThemeType() );
   AColor::ApplyUpdatedImages();
}
 
void ThemePrefs::OnSaveThemeAsCode(wxCommandEvent & WXUNUSED(event))
{
   if (!ConfirmSave())
      return;
   wxBusyCursor busy;
   theTheme.SaveThemeAsCode();
   theTheme.WriteImageDefs();// bonus - give them the Defs too.
}
 
bool ThemePrefs::Commit()
{
   ShuttleGui S(this, eIsSavingToPrefs);
   PopulateOrExchange(S);
 
   theTheme.LoadPreferredTheme();
   theTheme.DeleteUnusedThemes();
   AColor::ApplyUpdatedImages();
   return true;
}
 
void ThemePrefs::Cancel()
{
   theTheme.LoadPreferredTheme();
   theTheme.DeleteUnusedThemes();
   AColor::ApplyUpdatedImages();
}
 
#ifdef EXPERIMENTAL_THEME_PREFS
namespace{
PrefsPanel::Registration sAttachment{ "Theme",
   [](wxWindow *parent, wxWindowID winid, AudacityProject *)
   {
      wxASSERT(parent); // to justify safenew
      return safenew ThemePrefs(parent, winid);
   },
   false,
   // Register with an explicit ordering hint because this one is
   // only conditionally compiled
   { "", { Registry::OrderingHint::After, "Effects" } }
};
}
#endif