ThemeBase Class Reference

Theme management - Image loading and saving. More...

#include <Theme.h>

Inheritance diagram for ThemeBase:

Collaboration diagram for ThemeBase:

Classes
struct	RegisteredTheme

Public Types
using	NameSet = std::unordered_set< wxString >
Public Types inherited from Observer::Publisher< ThemeChangeMessage >
using	message_type = ThemeChangeMessage
using	CallbackReturn = std::conditional_t< true, void, bool >
using	Callback = std::function< CallbackReturn(const ThemeChangeMessage &) >
	Type of functions that can be connected to the Publisher. More...

Public Member Functions
	ThemeBase (void)
	ThemeBase (const ThemeBase &)=delete
ThemeBase &	operator= (const ThemeBase &)=delete
virtual	~ThemeBase (void)
virtual void	EnsureInitialised ()=0
FilePath	GetFilePath ()
void	SetFilePath (const FilePath &path)
void	SwitchTheme (teThemeType Theme)
void	LoadTheme (teThemeType Theme)
void	RegisterImage (NameSet &allNames, int &flags, int &iIndex, char const **pXpm, const wxString &Name)
void	RegisterImage (NameSet &allNames, int &flags, int &iIndex, const wxImage &Image, const wxString &Name)
void	RegisterColour (NameSet &allNames, int &iIndex, const wxColour &Clr, const wxString &Name)
teThemeType	GetFallbackThemeType ()
void	CreateImageCache ()
bool	CreateOneImageCache (teThemeType id, bool bBinarySave)
bool	ReadImageCache (teThemeType type={}, bool bOkIfNotFound=false)
void	LoadThemeComponents (bool bOkIfNotFound=false)
void	LoadOneThemeComponents (teThemeType id, bool bOkIfNotFound=false)
void	SaveThemeComponents ()
bool	SaveOneThemeComponents (teThemeType id)
void	SaveThemeAsCode ()
void	WriteImageDefs ()
	Writes a series of Macro definitions that can be used in the include file. More...
void	WriteImageMap ()
void	WriteOneImageMap (teThemeType id)
void	RecolourBitmap (int iIndex, wxColour From, wxColour To)
void	RecolourTheme ()
int	ColourDistance (wxColour &From, wxColour &To)
wxColour &	Colour (int iIndex)
wxBitmap &	Bitmap (int iIndex)
wxImage &	Image (int iIndex)
wxSize	ImageSize (int iIndex)
void	ReplaceImage (int iIndex, wxImage *pImage)
void	RotateImageInto (int iTo, int iFrom, bool bClockwise)
void	SetBrushColour (wxBrush &Brush, int iIndex)
void	SetPenColour (wxPen &Pen, int iIndex)
wxImage	MaskedImage (char const **pXpm, char const **pMask)
wxImage	MakeImageWithAlpha (wxBitmap &Bmp)
void	DeleteUnusedThemes ()
Public Member Functions inherited from Observer::Publisher< ThemeChangeMessage >
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...
	Publisher (Publisher &&)=default
Publisher &	operator= (Publisher &&)=default
Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...
Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...

Static Public Member Functions
static bool	LoadPreferredTheme ()

Protected Attributes
FilePath	mThemeDir
wxArrayString	mBitmapNames
std::vector< int >	mBitmapFlags
wxArrayString	mColourNames
PreferredSystemAppearance	mPreferredSystemAppearance { PreferredSystemAppearance::Light }
std::map< Identifier, ThemeSet >	mSets
ThemeSet *	mpSet = nullptr

Additional Inherited Members
Static Public Attributes inherited from Observer::Publisher< ThemeChangeMessage >
static constexpr bool	notifies_all
Protected Member Functions inherited from Observer::Publisher< ThemeChangeMessage >
CallbackReturn	Publish (const ThemeChangeMessage &message)
	Send a message to connected callbacks. More...

Detailed Description

Theme management - Image loading and saving.

Base for the Theme class. ThemeBase is a generic non-Audacity specific class.

See also

Themability of Audacity

Definition at line 117 of file Theme.h.

Member Typedef Documentation

NameSet

using ThemeBase::NameSet = std::unordered_set<wxString>

Definition at line 152 of file Theme.h.

Constructor & Destructor Documentation

ThemeBase() [1/2]

ThemeBase::ThemeBase

(

void

)

Definition at line 185 of file Theme.cpp.

{
}

ThemeBase() [2/2]

ThemeBase::ThemeBase ( const ThemeBase &  )

delete

~ThemeBase()

ThemeBase::~ThemeBase ( void  )

virtual

Definition at line 189 of file Theme.cpp.

{
}

Member Function Documentation

Bitmap()

wxBitmap & ThemeBase::Bitmap

(

int

iIndex

)

Referenced by anonymous_namespace{HelpMenus.cpp}::QuickFixDialog::AddStuck(), AColor::Bevel2(), AColor::ButtonStretch(), CreateStdButtonSizer(), Exporter::CreateUserPane(), LWSlider::DrawToBitmap(), ErrorReportDialog::ErrorReportDialog(), LabelTrackView::GetGlyph(), anonymous_namespace{PlayIndicatorOverlay.cpp}::GetIndicatorBitmap(), InitProjectWindow(), MultiDialog::MultiDialog(), MeterPanel::OnPaint(), ThemedButtonWrapper< ButtonBase >::OnThemeChange(), DeviceToolBar::Populate(), MixerToolBar::Populate(), anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::RealtimeEffectControl(), RecolourBitmap(), ThemedButtonWrapper< ButtonBase >::SetBitmapCurrentIndex(), ThemedButtonWrapper< ButtonBase >::SetBitmapLabelIndex(), ThemedButtonWrapper< ButtonBase >::SetBitmapPressedIndex(), LogWindow::Show(), and HelpSystem::ShowHtmlText().

Here is the caller graph for this function:

Colour()

wxColour & ThemeBase::Colour

(

int

iIndex

)

Referenced by AboutDialog::AboutDialog(), SelectionBar::AddTitle(), AlphaBlend(), ProjectWindow::ApplyUpdatedTheme(), ASlider::ASlider(), auStaticText::auStaticText(), AColor::BevelTrackInfo(), TrackInfo::CloseTitleDrawFunction(), CursorColour(), WaveTrackVRulerControls::DoDraw(), AdornedRulerPanel::DoDrawMarks(), AdornedRulerPanel::DoDrawPlayRegion(), AdornedRulerPanel::DoDrawPlayRegionLimits(), LabelTrackView::Draw(), NoteTrackAffordanceControls::Draw(), WaveTrackAffordanceControls::Draw(), TimeTrackVRulerControls::Draw(), Ruler::Label::Draw(), TrackInfo::DrawCloseButton(), anonymous_namespace{TimeTrackView.cpp}::DrawHorzRulerAndCurve(), TrackInfo::DrawItems(), NoteTrack::DrawLabelControls(), anonymous_namespace{NoteTrackView.cpp}::DrawNoteTrack(), FrequencyPlotDialog::DrawPlot(), LWSlider::DrawToBitmap(), anonymous_namespace{TrackPanel.cpp}::DrawTrackName(), Grabber::Grabber(), HtmlColourOfIndex(), AColor::Init(), InitProjectWindow(), NumericTextCtrl::Layout(), LoadTheme(), MixerBoard::MakeButtonBitmap(), WaveTrackAffordanceControls::MakeTextEditHelper(), TrackInfo::MinimizeSyncLockDrawFunction(), MixerBoard::MixerBoard(), ToolManager::OnIndicatorPaint(), anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::OnPaint(), EqualizationPanel::OnPaint(), ToolBarResizer::OnPaint(), ToolBar::OnPaint(), ToolDock::OnPaint(), NumericTextCtrl::OnPaint(), EffectAutoDuck::Panel::OnPaint(), EffectCompressorPanel::OnPaint(), EffectScienFilterPanel::OnPaint(), MixerTrackCluster::OnPaint(), MeterPanel::OnPaint(), ToolFrame::OnPaint(), ThemedWindowWrapper< WindowBase >::OnThemeChange(), ThemedButtonWrapper< ButtonBase >::OnThemeChange(), OverlayImage(), FrequencyPlotDialog::Populate(), ControlToolBar::Populate(), DeviceToolBar::Populate(), EditToolBar::Populate(), MeterToolBar::Populate(), MixerToolBar::Populate(), ScrubbingToolBar::Populate(), SelectionBar::Populate(), ToolsToolBar::Populate(), TranscriptionToolBar::Populate(), AColor::PreComputeGradient(), ProjectWindow::ProjectWindow(), RecolourTheme(), AdornedRulerPanel::ReCreateButtons(), Ruler::Ruler(), ThemedWindowWrapper< WindowBase >::SetBackgroundColorIndex(), ThemedButtonWrapper< ButtonBase >::SetBackgroundColorIndex(), ThemedWindowWrapper< WindowBase >::SetForegroundColorIndex(), ToolDock::ToolDock(), MixerBoard::UpdatePrefs(), and AColor::UseThemeColour().

ColourDistance()

int ThemeBase::ColourDistance	(	wxColour &	From,
		wxColour &	To
	)

Definition at line 307 of file Theme.cpp.

                                                             {
   return 
      abs( From.Red() - To.Red() )
      + abs( From.Green() - To.Green() )
      + abs( From.Blue() - To.Blue() );
}

Referenced by CursorColour(), LoadTheme(), MeterPanel::OnPaint(), and RecolourTheme().

Here is the caller graph for this function:

CreateImageCache()

void ThemeBase::CreateImageCache

(

)

Definition at line 614 of file Theme.cpp.

{
   ValueRestorer cleanup{ mpSet };
   for (auto &[key, data] : GetThemeCacheLookup())
      if (!CreateOneImageCache(key.Internal(), true))
         // Some file failed to save, message was given
         return;
   BasicUI::ShowMessageBox(
/* 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. */
      XO("Themes written to:\n  %s/*/%s.")
         .Format( GetFilePath(), ImageCacheFileName ));
}

References CreateOneImageCache(), GetFilePath(), GetThemeCacheLookup(), anonymous_namespace{Theme.cpp}::ImageCacheFileName, key, mpSet, BasicUI::ShowMessageBox(), and XO.

Referenced by ThemePrefs::OnSaveThemeCache(), and SwitchTheme().

Here is the call graph for this function:

Here is the caller graph for this function:

CreateOneImageCache()

bool ThemeBase::CreateOneImageCache	(	teThemeType	id,
		bool	bBinarySave
	)

Definition at line 630 of file Theme.cpp.

{
   SwitchTheme( id );
   auto &resources = *mpSet;
 
   wxImage ImageCache( ImageCacheWidth, ImageCacheHeight );
   ImageCache.SetRGB( wxRect( 0,0,ImageCacheWidth, ImageCacheHeight), 1,1,1);//Not-quite black.
 
   // Ensure we have an alpha channel...
   if( !ImageCache.HasAlpha() )
   {
      ImageCache.InitAlpha();
   }
 
   FlowPacker context{ ImageCacheWidth };
 
//#define IMAGE_MAP
#ifdef IMAGE_MAP
   wxLogDebug( wxT("<img src=\"ImageCache.png\" usemap=\"#map1\">" ));
   wxLogDebug( wxT("<map name=\"map1\">") );
#endif
 
   // Save the bitmaps
   for (size_t i = 0; i < resources.mImages.size() ; ++i)
   {
      wxImage &SrcImage = resources.mImages[i];
      context.mFlags = mBitmapFlags[i];
      if( !(mBitmapFlags[i] & resFlagInternal) )
      {
         context.GetNextPosition( SrcImage.GetWidth(), SrcImage.GetHeight());
         ImageCache.SetRGB( context.Rect(), 0xf2, 0xb0, 0x27 );
         if( !(context.mFlags & resFlagSkip) )
            PasteSubImage( &ImageCache, &SrcImage, 
               context.mxPos + context.mBorderWidth,
               context.myPos + context.mBorderWidth);
         else
            ImageCache.SetRGB( context.RectInner(), 1,1,1);
#ifdef IMAGE_MAP
         // No href in html.  Uses title not alt.
         wxRect R( context.Rect() );
         wxLogDebug( wxT("<area title=\"Bitmap:%s\" shape=rect coords=\"%i,%i,%i,%i\">"),
            mBitmapNames[i],
            R.GetLeft(), R.GetTop(), R.GetRight(), R.GetBottom() );
#endif
      }
   }
 
   // Now save the colours.
   int x,y;
 
   context.SetColourGroup();
   for (size_t i = 0; i < resources.mColours.size(); ++i)
   {
      context.GetNextPosition( iColSize, iColSize );
      wxColour c = resources.mColours[i];
      ImageCache.SetRGB( context.Rect() , 0xf2, 0xb0, 0x27 );
      ImageCache.SetRGB( context.RectInner() , c.Red(), c.Green(), c.Blue() );
 
      // YUCK!  No function in wxWidgets to set a rectangle of alpha...
      for(x=0;x<iColSize;x++)
      {
         for(y=0;y<iColSize;y++)
         {
            ImageCache.SetAlpha( context.mxPos + x, context.myPos+y, 255);
         }
      }
#ifdef IMAGE_MAP
      // No href in html.  Uses title not alt.
      wxRect R( context.Rect() );
      wxLogDebug( wxT("<area title=\"Colour:%s\" shape=rect coords=\"%i,%i,%i,%i\">"),
         mColourNames[i],
         R.GetLeft(), R.GetTop(), R.GetRight(), R.GetBottom() );
#endif
   }
#if TEST_CARD
   for ( unsigned i = 0; i < ImageCacheWidth; ++i)
      for ( unsigned j = 0; j < ImageCacheHeight; ++j) {
         int r = j &0xff;
         int g = i &0xff;
         int b = (j >> 8) | ((i>>4)&0xf0);
         wxRect R( i,j, 1, 1);
         ImageCache.SetRGB( R, r, g, b );
         ImageCache.SetAlpha( i,j, 255);
   }
#endif
 
#ifdef IMAGE_MAP
   wxLogDebug( "</map>" );
#endif
 
   using namespace BasicUI;
 
   // IF bBinarySave, THEN saving to a normal PNG file.
   if( bBinarySave )
   {
      auto dir = ThemeSubdir(GetFilePath(), id);
      auto FileName = wxFileName{ dir, ImageCacheFileName }.GetFullPath();
 
      // Perhaps we should prompt the user if they are overwriting
      // an existing theme cache?
#if 0
      if( wxFileExists( FileName ))
      {
         auto message =
//          XO(
//"Theme cache file:\n  %s\nalready exists.\nAre you sure you want to replace it?")
//             .Format( FileName );
            TranslatableString{ FileName };
         ShowMessageBox( message );
         return false;
      }
#endif
#if 0
      // Deliberate policy to use the fast/cheap blocky pixel-multiplication
      // algorithm, as this introduces no artifacts on repeated scale up/down.
      ImageCache.Rescale( 
         ImageCache.GetWidth()*4,
         ImageCache.GetHeight()*4,
         wxIMAGE_QUALITY_NEAREST );
#endif
      if( !ImageCache.SaveFile( FileName, wxBITMAP_TYPE_PNG ))
      {
         ShowMessageBox(
            XO("Audacity could not write file:\n  %s.")
               .Format( FileName ));
         return false;
      }
   }
   // ELSE saving to a C code textual version.
   else
   {
      // Generated header file is not put in the sub-directory for
      // the theme, but is instead distinguished by a prefix on the file name.
      // So the header can simply be copied into the source code tree.
      auto dir = GetFilePath();
      SourceOutputStream OutStream;
      auto name = ThemeFilePrefix(id) + ThemeCacheFileName;
      auto FileName = wxFileName{ dir, name }.GetFullPath();
      if( !OutStream.OpenFile( FileName ))
      {
         ShowMessageBox(
            XO("Audacity could not open file:\n  %s\nfor writing.")
               .Format( FileName ));
         return false;
      }
      if( !ImageCache.SaveFile(OutStream, wxBITMAP_TYPE_PNG ) )
      {
         ShowMessageBox(
            XO("Audacity could not write images to file:\n  %s.")
               .Format( FileName ));
         return false;
      }
   }
   return true;
}

References GetFilePath(), anonymous_namespace{Theme.cpp}::iColSize, anonymous_namespace{Theme.cpp}::ImageCacheFileName, ImageCacheHeight, ImageCacheWidth, mBitmapFlags, mBitmapNames, mColourNames, mpSet, name, SourceOutputStream::OpenFile(), PasteSubImage(), resFlagInternal, resFlagSkip, BasicUI::ShowMessageBox(), SwitchTheme(), anonymous_namespace{Theme.cpp}::ThemeCacheFileName, anonymous_namespace{Theme.cpp}::ThemeFilePrefix(), anonymous_namespace{Theme.cpp}::ThemeSubdir(), and XO.

Referenced by CreateImageCache().

Here is the call graph for this function:

Here is the caller graph for this function:

DeleteUnusedThemes()

void ThemeBase::DeleteUnusedThemes

(

)

Referenced by ThemePrefs::Cancel(), GUIPrefs::Commit(), and ThemePrefs::Commit().

Here is the caller graph for this function:

EnsureInitialised()

virtual void ThemeBase::EnsureInitialised ( )

pure virtual

Implemented in Theme.

Referenced by ReadImageCache(), SwitchTheme(), and WriteImageDefs().

Here is the caller graph for this function:

GetFallbackThemeType()

teThemeType ThemeBase::GetFallbackThemeType

(

)

Definition at line 889 of file Theme.cpp.

                                           {
// Fallback must be an internally supported type,
// to guarantee it is found.
#ifdef EXPERIMENTAL_DA
   return "dark";
#else
   return "light";
#endif
}

Referenced by ThemePrefs::OnReadThemeInternal(), and SwitchTheme().

Here is the caller graph for this function:

GetFilePath()

FilePath ThemeBase::GetFilePath

(

)

Definition at line 149 of file Theme.cpp.

{
   if (mThemeDir.empty())
      SetFilePath(
         wxFileName(FileNames::DataDir(), wxT("Theme")).GetFullPath());
   return mThemeDir;
}

References FileNames::DataDir(), mThemeDir, and SetFilePath().

Referenced by CreateImageCache(), CreateOneImageCache(), LoadOneThemeComponents(), ReadImageCache(), WriteImageDefs(), and WriteOneImageMap().

Here is the call graph for this function:

Here is the caller graph for this function:

Image()

wxImage & ThemeBase::Image

(

int

iIndex

)

Referenced by TrackArt::DrawSyncLockTiles(), ToolBar::MakeAlternateImages(), ToolBar::MakeButton(), ToolBar::MakeMacRecoloredImage(), TrackInfo::MinimizeSyncLockDrawFunction(), OverlayImage(), ReadImageCache(), RecolourBitmap(), RegisterImage(), and ToolBarGrabber::ToolBarGrabber().

Here is the caller graph for this function:

ImageSize()

wxSize ThemeBase::ImageSize

(

int

iIndex

)

Referenced by EditToolBar::AddButton(), ScrubbingToolBar::AddButton(), TranscriptionToolBar::AddButton(), ControlToolBar::MakeAlternateImages(), TranscriptionToolBar::MakeAlternateImages(), ControlToolBar::MakeButton(), ToolsToolBar::MakeTool(), ReadImageCache(), and AdornedRulerPanel::ReCreateButtons().

Here is the caller graph for this function:

LoadOneThemeComponents()

void ThemeBase::LoadOneThemeComponents	(	teThemeType	id,
		bool	bOkIfNotFound = false
	)

JKC:

Bug:

(wxWidgets) A png may have been saved with alpha, but when you load it, it comes back with a mask instead! (well I guess it is more efficient). Anyway, we want alpha and not a mask, so we call InitAlpha, and that transfers the mask into the alpha channel, and we're done.

Definition at line 1043 of file Theme.cpp.

References PackedArray::begin(), anonymous_namespace{Theme.cpp}::ColorFileName, PackedArray::end(), TranslatableString::Format(), GetFilePath(), mBitmapFlags, mBitmapNames, mColourNames, mpSet, name, names, resFlagInternal, BasicUI::ShowMessageBox(), str, SwitchTheme(), anonymous_namespace{Theme.cpp}::ThemeComponent(), anonymous_namespace{Theme.cpp}::ThemeComponentsDir(), Verbatim(), and XO.

Referenced by LoadThemeComponents().

Here is the call graph for this function:

Here is the caller graph for this function:

LoadPreferredTheme()

bool ThemeBase::LoadPreferredTheme ( )

static

Definition at line 162 of file Theme.cpp.

{
   Identifier theme = GUITheme().Read();
   theTheme.LoadTheme( theme );
   return true;
}

References GUITheme(), LoadTheme(), ChoiceSetting::Read(), theme, and theTheme.

Referenced by ThemePrefs::Cancel(), GUIPrefs::Commit(), ThemePrefs::Commit(), and AudacityApp::OnInit().

Here is the call graph for this function:

Here is the caller graph for this function:

LoadTheme()

void ThemeBase::LoadTheme

(

teThemeType

Theme

)

This function is called to load the initial Theme images. It does not though cause the GUI to refresh.

Definition at line 255 of file Theme.cpp.

{
   SwitchTheme( Theme );
 
   // Post-processing steps after loading of the cache
 
   // Two always overwritten images
   RotateImageInto( bmpRecordBeside, bmpRecordBelow, false );
   RotateImageInto( bmpRecordBesideDisabled, bmpRecordBelowDisabled, false );
 
   // Other modifications of images happening only when the setting
   // GUIBlendThemes is true
   if ( mpSet->bRecolourOnLoad ) {
      RecolourTheme();
 
      wxColor Back        = theTheme.Colour( clrTrackInfo );
      wxColor CurrentText = theTheme.Colour( clrTrackPanelText );
      wxColor DesiredText = wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOWTEXT );
 
      int TextColourDifference =  ColourDistance( CurrentText, DesiredText );
 
      // Theming is very accepting of alternative text colours.  They just need to
      // have decent contrast to the background colour, if we're blending themes.
      if ( TextColourDifference != 0 ) {
         int ContrastLevel        =  ColourDistance( Back, DesiredText );
         if ( ContrastLevel > 250 )
            Colour( clrTrackPanelText ) = DesiredText;
      }
      mpSet->bRecolourOnLoad = false;
   }
 
 
   // Next line is not required as we haven't yet built the GUI
   // when this function is (or should be) called.
   // AColor::ApplyUpdatedImages();
 
   // The next step doesn't post-process the theme data.  It only modifies
   // system settings.  So it is not necessary to make it conditional on
   // preferences, for avoidance of errors in the use of Theme preferences.
   // (See commit 2020217)
   Publish({ mPreferredSystemAppearance });
}

References ThemeSet::bRecolourOnLoad, Colour(), ColourDistance(), mPreferredSystemAppearance, mpSet, Observer::Publisher< ThemeChangeMessage >::Publish(), RecolourTheme(), RotateImageInto(), SwitchTheme(), and theTheme.

Referenced by LoadPreferredTheme().

Here is the call graph for this function:

Here is the caller graph for this function:

LoadThemeComponents()

void ThemeBase::LoadThemeComponents

(

bool

bOkIfNotFound = false

)

Definition at line 1036 of file Theme.cpp.

{
   ValueRestorer cleanup{ mpSet };
   for (auto &[key, data] : GetThemeCacheLookup())
      LoadOneThemeComponents( key.Internal(), bOkIfNotFound );
}

References GetThemeCacheLookup(), key, LoadOneThemeComponents(), and mpSet.

Referenced by App::OnInit(), and ThemePrefs::OnLoadThemeComponents().

Here is the call graph for this function:

Here is the caller graph for this function:

MakeImageWithAlpha()

wxImage ThemeBase::MakeImageWithAlpha

(

wxBitmap &

Bmp

)

MaskedImage()

wxImage ThemeBase::MaskedImage	(	char const **	pXpm,
		char const **	pMask
	)

Definition at line 350 of file Theme.cpp.

{
   wxBitmap Bmp1( pXpm );
   wxBitmap Bmp2( pMask );
 
//   wxLogDebug( wxT("Image 1: %i Image 2: %i"),
//      Bmp1.GetDepth(), Bmp2.GetDepth() );
 
   // We want a 24-bit-depth bitmap if all is working, but on some
   // platforms it might just return -1 (which means best available
   // or not relevant).
   // JKC: \todo check that we're not relying on 24 bit elsewhere.
   wxASSERT( Bmp1.GetDepth()==-1 || Bmp1.GetDepth()==24);
   wxASSERT( Bmp1.GetDepth()==-1 || Bmp2.GetDepth()==24);
 
   int i,nBytes;
   nBytes = Bmp1.GetWidth() * Bmp1.GetHeight();
   wxImage Img1( Bmp1.ConvertToImage());
   wxImage Img2( Bmp2.ConvertToImage());
 
//   unsigned char *src = Img1.GetData();
   unsigned char *mk = Img2.GetData();
   //wxImage::setAlpha requires memory allocated with malloc, not NEW
   MallocString<unsigned char> alpha{
      static_cast<unsigned char*>(malloc( nBytes )) };
 
   // Extract alpha channel from second XPM.
   for(i=0;i<nBytes;i++)
   {
      alpha[i] = mk[0];
      mk+=3;
   }
 
   Img1.SetAlpha( alpha.release() );
 
   //dmazzoni: the top line does not work on wxGTK
   //wxBitmap Result( Img1, 32 );
   //wxBitmap Result( Img1 );
 
   return Img1;
}

operator=()

ThemeBase & ThemeBase::operator= ( const ThemeBase &  )

delete

ReadImageCache()

bool ThemeBase::ReadImageCache	(	teThemeType	type = {},
		bool	bOkIfNotFound = false
	)

Reads an image cache including images, cursors and colours.

Parameters

type	if empty means read from an external binary file. otherwise the data is taken from a block of memory.
bOkIfNotFound	if true means do not report absent file.

Returns

true iff we loaded the images.

Todo:

revisit this hack which makes adding NEW colours easier but which prevents a colour of (1,1,1) from being added. find an alternative way to make adding NEW colours easier. e.g. initialise the background to translucent, perhaps.

Definition at line 904 of file Theme.cpp.

{
   auto &resources = *mpSet;
   EnsureInitialised();
   wxImage ImageCache;
 
   // Ensure we have an alpha channel...
//   if( !ImageCache.HasAlpha() )
//   {
//      ImageCache.InitAlpha();
//   }
 
   mpSet->bRecolourOnLoad = GUIBlendThemes.Read();
 
   using namespace BasicUI;
 
   if( type.empty() || type == "custom" )
   {
      mPreferredSystemAppearance = PreferredSystemAppearance::Light;
 
      // Take the image cache file for the theme chosen in preferences
      auto dir = ThemeSubdir(GetFilePath(), GUITheme().Read());
      const auto &FileName =
         wxFileName{ dir, ImageCacheFileName }.GetFullPath();
      if( !wxFileExists( FileName ))
      {
         if( bOkIfNotFound )
            return false; // did not load the images, so return false.
         ShowMessageBox(
            XO("Audacity could not find file:\n  %s.\nTheme not loaded.")
               .Format( FileName ));
         return false;
      }
      if( !ImageCache.LoadFile( FileName, wxBITMAP_TYPE_PNG ))
      {
         ShowMessageBox(
            /* i18n-hint: Do not translate png.  It is the name of a file format.*/
            XO("Audacity could not load file:\n  %s.\nBad png format perhaps?")
               .Format( FileName ));
         return false;
      }
   }
   // ELSE we are reading from internal storage.
   else
   {
      size_t ImageSize = 0;
      const unsigned char * pImage = nullptr;
      auto &lookup = GetThemeCacheLookup();
      auto iter = lookup.find({type, {}});
      if (const auto end = lookup.end(); iter == end) {
         iter = lookup.find({"classic", {}});
         wxASSERT(iter != end);
      }
 
      mPreferredSystemAppearance = iter->second.preferredSystemAppearance;
 
      ImageSize = iter->second.data.size();
      if (ImageSize == 0)
         // This must be the image compiler
         return true;
 
      pImage = iter->second.data.data();
      //wxLogDebug("Reading ImageCache %p size %i", pImage, ImageSize );
      wxMemoryInputStream InternalStream( pImage, ImageSize );
 
      if( !ImageCache.LoadFile( InternalStream, wxBITMAP_TYPE_PNG ))
      {
         // If we get this message, it means that the data in file
         // was not a valid png image.
         // Most likely someone edited it by mistake,
         // Or some experiment is being tried with NEW formats for it.
         ShowMessageBox(
            XO(
"Audacity could not read its default theme.\nPlease report the problem."));
         return false;
      }
      //wxLogDebug("Read %i by %i", ImageCache.GetWidth(), ImageCache.GetHeight() );
   }
 
   // Resize a large image down.
   if( ImageCache.GetWidth() > ImageCacheWidth ){
      int h = ImageCache.GetHeight() * ((1.0*ImageCacheWidth)/ImageCache.GetWidth());
      ImageCache.Rescale(  ImageCacheWidth, h );
   }
   FlowPacker context{ ImageCacheWidth };
   // Load the bitmaps
   for (size_t i = 0; i < resources.mImages.size(); ++i)
   {
      wxImage &Image = resources.mImages[i];
      context.mFlags = mBitmapFlags[i];
      if( !(mBitmapFlags[i] & resFlagInternal) )
      {
         context.GetNextPosition( Image.GetWidth(),Image.GetHeight() );
         wxRect R = context.RectInner();
         //wxLogDebug( "[%i, %i, %i, %i, \"%s\"], ", R.x, R.y, R.width, R.height, mBitmapNames[i].c_str() );
         Image = GetSubImageWithAlpha( ImageCache, context.RectInner() );
         resources.mBitmaps[i] = wxBitmap(Image);
      }
   }
   if( !ImageCache.HasAlpha() )
      ImageCache.InitAlpha();
 
//   return true; //To not load colours..
   // Now load the colours.
   int x,y;
   context.SetColourGroup();
   wxColour TempColour;
   for (size_t i = 0; i < resources.mColours.size(); ++i)
   {
      context.GetNextPosition( iColSize, iColSize );
      context.RectMid( x, y );
      wxRect R = context.RectInner();
      //wxLogDebug( "[%i, %i, %i, %i, \"%s\"], ", R.x, R.y, R.width, R.height, mColourNames[i].c_str() );
      // Only change the colour if the alpha is opaque.
      // This allows us to add NEW colours more easily.
      if( ImageCache.GetAlpha(x,y ) > 128 )
      {
         TempColour = wxColour(
            ImageCache.GetRed( x,y),
            ImageCache.GetGreen( x,y),
            ImageCache.GetBlue(x,y));
         if( TempColour != wxColour(1,1,1) )
            resources.mColours[i] = TempColour;
      }
   }
   return true;
}

References ThemeSet::bRecolourOnLoad, Identifier::empty(), PackedArray::end(), EnsureInitialised(), GetFilePath(), GetSubImageWithAlpha(), GetThemeCacheLookup(), GUIBlendThemes, GUITheme(), anonymous_namespace{Theme.cpp}::iColSize, Image(), anonymous_namespace{Theme.cpp}::ImageCacheFileName, ImageCacheWidth, ImageSize(), Light, mBitmapFlags, mPreferredSystemAppearance, mpSet, Setting< T >::Read(), Read(), resFlagInternal, BasicUI::ShowMessageBox(), anonymous_namespace{Theme.cpp}::ThemeSubdir(), and XO.

Referenced by SwitchTheme().

Here is the call graph for this function:

Here is the caller graph for this function:

RecolourBitmap()

void ThemeBase::RecolourBitmap	(	int	iIndex,
		wxColour	From,
		wxColour	To
	)

Definition at line 298 of file Theme.cpp.

{
   wxImage Image( Bitmap( iIndex ).ConvertToImage() );
 
   std::unique_ptr<wxImage> pResult = ChangeImageColour(
      &Image, From, To );
   ReplaceImage( iIndex, pResult.get() );
}

References Bitmap(), ChangeImageColour(), Image(), and ReplaceImage().

Referenced by RecolourTheme().

Here is the call graph for this function:

Here is the caller graph for this function:

RecolourTheme()

void ThemeBase::RecolourTheme

(

)

Definition at line 317 of file Theme.cpp.

{
   wxColour From = Colour( clrMedium );
#if defined( __WXGTK__ )
   wxColour To = wxSystemSettings::GetColour( wxSYS_COLOUR_BACKGROUND );
#else
   wxColour To = wxSystemSettings::GetColour( wxSYS_COLOUR_3DFACE );
#endif
   // only recolour if recolouring is slight.
   int d = ColourDistance( From, To );
 
   // Don't recolour if difference is too big.
   if( d  > 120 )
      return;
 
   // A minor tint difference from standard does not need 
   // to be recouloured either.  Includes case of d==0 which is nothing
   // needs to be done.
   if( d < 40 )
      return;
 
   Colour( clrMedium ) = To;
   RecolourBitmap( bmpUpButtonLarge, From, To );
   RecolourBitmap( bmpDownButtonLarge, From, To );
   RecolourBitmap( bmpHiliteButtonLarge, From, To );
   RecolourBitmap( bmpUpButtonSmall, From, To );
   RecolourBitmap( bmpDownButtonSmall, From, To );
   RecolourBitmap( bmpHiliteButtonSmall, From, To );
 
   Colour( clrTrackInfo ) = To;
   RecolourBitmap( bmpUpButtonExpand, From, To );
}

References Colour(), ColourDistance(), and RecolourBitmap().

Referenced by LoadTheme().

Here is the call graph for this function:

Here is the caller graph for this function:

RegisterColour()

void ThemeBase::RegisterColour	(	NameSet &	allNames,
		int &	iIndex,
		const wxColour &	Clr,
		const wxString &	Name
	)

Definition at line 449 of file Theme.cpp.

{
   auto &resources = *mpSet;
   resources.mColours.push_back( Clr );
   auto index = resources.mColours.size() - 1;
   if (iIndex == -1) {
      // First time assignment of global variable identifying a colour
      iIndex = index;
      mColourNames.push_back( Name );
      wxASSERT(allNames.insert(Name).second);
   }
   else {
      // If revisiting for another theme set,
      // colours should be re-done in the same sequence
      wxASSERT(iIndex == index);
      wxASSERT(mColourNames[index] == Name);
   }
}

References mColourNames, ThemeSet::mColours, and mpSet.

RegisterImage() [1/2]

void ThemeBase::RegisterImage	(	NameSet &	allNames,
		int &	flags,
		int &	iIndex,
		char const **	pXpm,
		const wxString &	Name
	)

Definition at line 396 of file Theme.cpp.

{
   wxBitmap Bmp( pXpm );
   wxImage Img( Bmp.ConvertToImage() );
   // The next line recommended by http://forum.audacityteam.org/viewtopic.php?f=50&t=96765
   Img.SetMaskColour(0xDE, 0xDE, 0xDE);
   Img.InitAlpha();
 
   //dmazzoni: the top line does not work on wxGTK
   //wxBitmap Bmp2( Img, 32 );
   //wxBitmap Bmp2( Img );
 
   RegisterImage( allNames, flags, iIndex, Img, Name );
}

References RegisterImage().

Referenced by RegisterImage().

Here is the call graph for this function:

Here is the caller graph for this function:

RegisterImage() [2/2]

void ThemeBase::RegisterImage	(	NameSet &	allNames,
		int &	flags,
		int &	iIndex,
		const wxImage &	Image,
		const wxString &	Name
	)

Definition at line 412 of file Theme.cpp.

{
   auto &resources = *mpSet;
   resources.mImages.push_back( Image );
 
#ifdef __APPLE__
   // On Mac, bitmaps with alpha don't work.
   // So we convert to a mask and use that.
   // It isn't quite as good, as alpha gives smoother edges.
   //[Does not affect the large control buttons, as for those we do
   // the blending ourselves anyway.]
   wxImage TempImage( Image );
   TempImage.ConvertAlphaToMask();
   resources.mBitmaps.push_back( wxBitmap( TempImage ) );
#else
   resources.mBitmaps.push_back( wxBitmap( Image ) );
#endif
 
   flags &= ~resFlagSkip;
   auto index = resources.mBitmaps.size() - 1;
   if (iIndex == -1) {
      // First time assignment of global variable identifying an image
      iIndex = index;
      mBitmapNames.push_back( Name );
      mBitmapFlags.push_back( flags );
      wxASSERT(allNames.insert(Name).second);
   }
   else {
      // If revisiting for another theme set,
      // images should be re-done in the same sequence
      wxASSERT(iIndex == index);
      wxASSERT(mBitmapNames[index] == Name);
      wxASSERT(mBitmapFlags[index] == flags);
   }
}

References Image(), mBitmapFlags, mBitmapNames, ThemeSet::mImages, and mpSet.

Here is the call graph for this function:

ReplaceImage()

void ThemeBase::ReplaceImage	(	int	iIndex,
		wxImage *	pImage
	)

Referenced by ToolBar::MakeMacRecoloredImage(), and RecolourBitmap().

Here is the caller graph for this function:

RotateImageInto()

void ThemeBase::RotateImageInto	(	int	iTo,
		int	iFrom,
		bool	bClockwise
	)

Referenced by LoadTheme().

Here is the caller graph for this function:

SaveOneThemeComponents()

bool ThemeBase::SaveOneThemeComponents

(

teThemeType

id

)

SaveThemeAsCode()

void ThemeBase::SaveThemeAsCode

(

)

Referenced by App::OnInit(), and ThemePrefs::OnSaveThemeAsCode().

Here is the caller graph for this function:

SaveThemeComponents()

void ThemeBase::SaveThemeComponents

(

)

Referenced by ThemePrefs::OnSaveThemeComponents().

Here is the caller graph for this function:

SetBrushColour()

void ThemeBase::SetBrushColour	(	wxBrush &	Brush,
		int	iIndex
	)

Referenced by AColor::Init(), NumericTextCtrl::Layout(), NumericTextCtrl::OnPaint(), and TrackArtist::SetColours().

Here is the caller graph for this function:

SetFilePath()

void ThemeBase::SetFilePath

(

const FilePath &

path

)

Definition at line 157 of file Theme.cpp.

{
   mThemeDir = path;
}

References mThemeDir.

Referenced by GetFilePath(), and main().

Here is the caller graph for this function:

SetPenColour()

void ThemeBase::SetPenColour	(	wxPen &	Pen,
		int	iIndex
	)

Referenced by AColor::Init(), NumericTextCtrl::OnPaint(), and TrackArtist::SetColours().

Here is the caller graph for this function:

SwitchTheme()

void ThemeBase::SwitchTheme

(

teThemeType

Theme

)

Definition at line 217 of file Theme.cpp.

{
   // Switch the active theme set
   mpSet = &mSets[Theme.empty() ? GUITheme().Read() : Theme];
   auto &resources = *mpSet;
   EnsureInitialised();
 
   const bool cbOkIfNotFound = true;
 
   if( !ReadImageCache( Theme, cbOkIfNotFound ) )
   {
      // THEN get the default set.
      ReadImageCache( GetFallbackThemeType(), !cbOkIfNotFound );
 
      // JKC: Now we could go on and load the individual images
      // on top of the default images using the commented out
      // code that follows...
      //
      // However, I think it is better to get the user to
      // build a NEW image cache, which they can do easily
      // from the Theme preferences tab.
#if 0
      // and now add any available component images.
      LoadComponents( cbOkIfNotFound );
 
      // JKC: I'm usure about doing this next step automatically.
      // Suppose the disk is write protected?
      // Is having the image cache created automatically
      // going to confuse users?  Do we need version specific names?
      // and now save the combined image as a cache for later use.
      // We should load the images a little faster in future as a result.
      CreateImageCache();
#endif
   }
}

References CreateImageCache(), EnsureInitialised(), GetFallbackThemeType(), GUITheme(), mpSet, mSets, ChoiceSetting::Read(), and ReadImageCache().

Referenced by CreateOneImageCache(), LoadOneThemeComponents(), LoadTheme(), ThemePrefs::OnLoadThemeCache(), ThemePrefs::OnReadThemeInternal(), and WriteOneImageMap().

Here is the call graph for this function:

Here is the caller graph for this function:

WriteImageDefs()

void ThemeBase::WriteImageDefs

(

)

Writes a series of Macro definitions that can be used in the include file.

Definition at line 847 of file Theme.cpp.

{
   // The generated image defs macro calls depend only on sizes of images,
   // not contents, and so there is only one file good across all themes.
 
   auto &resources = *mpSet;
   EnsureInitialised();
 
   wxFFile File( ThemeImageDefsAsCee(GetFilePath()), wxT("wb") );
   if( !File.IsOpened() )
      return;
   teResourceFlags PrevFlags = (teResourceFlags)-1;
   for (size_t i = 0; i < resources.mImages.size(); ++i)
   {
      wxImage &SrcImage = resources.mImages[i];
      // No href in html.  Uses title not alt.
      if( PrevFlags != mBitmapFlags[i] )
      {
         PrevFlags = (teResourceFlags)mBitmapFlags[i];
         int t = (int)PrevFlags;
         wxString Temp;
         if( t==0 ) Temp = wxT(" resFlagNone ");
         if( t & resFlagPaired )   Temp += wxT(" resFlagPaired ");
         if( t & resFlagCursor )   Temp += wxT(" resFlagCursor ");
         if( t & resFlagNewLine )  Temp += wxT(" resFlagNewLine ");
         if( t & resFlagInternal ) Temp += wxT(" resFlagInternal ");
         Temp.Replace( wxT("  "), wxT(" | ") );
 
         File.Write( wxString::Format( wxT("\r\n   SET_THEME_FLAGS( %s );\r\n"),
            Temp ));
      }
      File.Write( wxString::Format(
         wxT("   DEFINE_IMAGE( bmp%s, wxImage( %i, %i ), wxT(\"%s\"));\r\n"),
         mBitmapNames[i],
         SrcImage.GetWidth(),
         SrcImage.GetHeight(),
         mBitmapNames[i]
         ));
   }
}

References EnsureInitialised(), GetFilePath(), mBitmapFlags, mBitmapNames, mpSet, resFlagCursor, resFlagInternal, resFlagNewLine, resFlagPaired, and anonymous_namespace{Theme.cpp}::ThemeImageDefsAsCee().

Referenced by ThemePrefs::OnSaveThemeAsCode().

Here is the call graph for this function:

Here is the caller graph for this function:

WriteImageMap()

void ThemeBase::WriteImageMap

(

)

Definition at line 786 of file Theme.cpp.

{
   ValueRestorer cleanup{ mpSet };
   for (auto &[key, data] : GetThemeCacheLookup())
      WriteOneImageMap(key.Internal());
}

References GetThemeCacheLookup(), key, mpSet, and WriteOneImageMap().

Referenced by ThemePrefs::OnSaveThemeCache().

Here is the call graph for this function:

Here is the caller graph for this function:

WriteOneImageMap()

void ThemeBase::WriteOneImageMap

(

teThemeType

id

)

Writes an html file with an image map of the ImageCache Very handy for seeing what each part is for.

Definition at line 795 of file Theme.cpp.

{
   SwitchTheme( id );
   auto &resources = *mpSet;
 
   FlowPacker context{ ImageCacheWidth };
   
   auto dir = ThemeSubdir(GetFilePath(), id);
   auto FileName = wxFileName{ dir, ImageMapFileName }.GetFullPath();
   wxFFile File( FileName, wxT("wb") );// I'll put in NEW lines explicitly.
   if( !File.IsOpened() )
      return;
 
   File.Write( wxT("<html>\r\n"));
   File.Write( wxT("<body bgcolor=\"303030\">\r\n"));
   wxString Temp = wxString::Format( wxT("<img src=\"ImageCache.png\" width=\"%i\" usemap=\"#map1\">\r\n" ), ImageCacheWidth );
   File.Write( Temp );
   File.Write( wxT("<map name=\"map1\">\r\n") );
 
   for (size_t i = 0; i < resources.mImages.size(); ++i)
   {
      wxImage &SrcImage = resources.mImages[i];
      context.mFlags = mBitmapFlags[i];
      if( !(mBitmapFlags[i] & resFlagInternal) )
      {
         context.GetNextPosition( SrcImage.GetWidth(), SrcImage.GetHeight());
         // No href in html.  Uses title not alt.
         wxRect R( context.RectInner() );
         File.Write( wxString::Format(
            wxT("<area title=\"Bitmap:%s\" shape=rect coords=\"%i,%i,%i,%i\">\r\n"),
            mBitmapNames[i],
            R.GetLeft(), R.GetTop(), R.GetRight(), R.GetBottom()) );
      }
   }
   // Now save the colours.
   context.SetColourGroup();
   for (size_t i = 0; i < resources.mColours.size(); ++i)
   {
      context.GetNextPosition( iColSize, iColSize );
      // No href in html.  Uses title not alt.
      wxRect R( context.RectInner() );
      File.Write( wxString::Format( wxT("<area title=\"Colour:%s\" shape=rect coords=\"%i,%i,%i,%i\">\r\n"),
         mColourNames[i],
         R.GetLeft(), R.GetTop(), R.GetRight(), R.GetBottom()) );
   }
   File.Write( wxT("</map>\r\n") );
   File.Write( wxT("</body>\r\n"));
   File.Write( wxT("</html>\r\n"));
   // File will be closed automatically.
}

References GetFilePath(), anonymous_namespace{Theme.cpp}::iColSize, ImageCacheWidth, anonymous_namespace{Theme.cpp}::ImageMapFileName, mBitmapFlags, mBitmapNames, mColourNames, mpSet, resFlagInternal, SwitchTheme(), and anonymous_namespace{Theme.cpp}::ThemeSubdir().

Referenced by WriteImageMap().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mBitmapFlags

std::vector<int> ThemeBase::mBitmapFlags

protected

Definition at line 201 of file Theme.h.

Referenced by CreateOneImageCache(), LoadOneThemeComponents(), ReadImageCache(), RegisterImage(), WriteImageDefs(), and WriteOneImageMap().

mBitmapNames

wxArrayString ThemeBase::mBitmapNames

protected

Definition at line 200 of file Theme.h.

Referenced by CreateOneImageCache(), LoadOneThemeComponents(), RegisterImage(), WriteImageDefs(), and WriteOneImageMap().

mColourNames

wxArrayString ThemeBase::mColourNames

protected

Definition at line 202 of file Theme.h.

Referenced by CreateOneImageCache(), LoadOneThemeComponents(), RegisterColour(), and WriteOneImageMap().

mPreferredSystemAppearance

PreferredSystemAppearance ThemeBase::mPreferredSystemAppearance { PreferredSystemAppearance::Light }

protected

Definition at line 204 of file Theme.h.

Referenced by LoadTheme(), and ReadImageCache().

mpSet

ThemeSet* ThemeBase::mpSet = nullptr

protected

Definition at line 207 of file Theme.h.

Referenced by CreateImageCache(), CreateOneImageCache(), Theme::EnsureInitialised(), LoadOneThemeComponents(), LoadTheme(), LoadThemeComponents(), ReadImageCache(), RegisterColour(), RegisterImage(), Theme::RegisterImagesAndColours(), SwitchTheme(), WriteImageDefs(), WriteImageMap(), and WriteOneImageMap().

mSets

std::map<Identifier, ThemeSet> ThemeBase::mSets

protected

Definition at line 206 of file Theme.h.

Referenced by SwitchTheme().

mThemeDir

FilePath ThemeBase::mThemeDir

protected

Definition at line 198 of file Theme.h.

Referenced by GetFilePath(), and SetFilePath().

---

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

• Theme.h
• Theme.cpp