ThemeBase Class Reference

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

#include <Theme.h>

Inheritance diagram for ThemeBase:

Collaboration diagram for ThemeBase:

Public Member Functions
	ThemeBase (void)
	ThemeBase (const ThemeBase &)=delete
ThemeBase &	operator= (const ThemeBase &)=delete
virtual	~ThemeBase (void)
virtual void	EnsureInitialised ()=0
void	LoadTheme (teThemeType Theme)
void	RegisterImage (int &iIndex, char const **pXpm, const wxString &Name)
void	RegisterImage (int &iIndex, const wxImage &Image, const wxString &Name)
void	RegisterColour (int &iIndex, const wxColour &Clr, const wxString &Name)
teThemeType	GetFallbackThemeType ()
teThemeType	ThemeTypeOfTypeName (const wxString &Name)
void	CreateImageCache (bool bBinarySave=true)
bool	ReadImageCache (teThemeType type=themeFromFile, bool bOkIfNotFound=false)
void	LoadComponents (bool bOkIfNotFound=false)
void	SaveComponents ()
void	SaveThemeAsCode ()
void	WriteImageDefs ()
	Writes a series of Macro definitions that can be used in the include file. More...
void	WriteImageMap ()
bool	IsUsingSystemTextColour ()
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)
wxCursor &	Cursor (int iIndex)
wxFont &	Font (int iIndex)
wxSize	ImageSize (int iIndex)
void	ReplaceImage (int iIndex, wxImage *pImage)
	Replaces both the image and the bitmap. More...
void	RotateImageInto (int iTo, int iFrom, bool bClockwise)
void	SetBrushColour (wxBrush &Brush, int iIndex)
void	SetPenColour (wxPen &Pen, int iIndex)
void	SetFlags (int flags)
wxImage	MaskedImage (char const **pXpm, char const **pMask)
wxImage	MakeImageWithAlpha (wxBitmap &Bmp)

Static Public Member Functions
static bool	LoadPreferredTheme ()

Public Attributes
bool	bRecolourOnLoad
bool	bIsUsingSystemTextColour

Protected Attributes
std::vector< wxImage >	mImages
std::vector< wxBitmap >	mBitmaps
wxArrayString	mBitmapNames
std::vector< int >	mBitmapFlags
std::vector< wxColour >	mColours
wxArrayString	mColourNames
FlowPacker	mFlow

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 98 of file Theme.h.

Constructor & Destructor Documentation

ThemeBase() [1/2]

ThemeBase::ThemeBase

(

void

)

Definition at line 259 of file Theme.cpp.

{
   bRecolourOnLoad = false;
   bIsUsingSystemTextColour = false;
}

References bIsUsingSystemTextColour, and bRecolourOnLoad.

ThemeBase() [2/2]

ThemeBase::ThemeBase ( const ThemeBase &  )

delete

~ThemeBase()

ThemeBase::~ThemeBase ( void  )

virtual

Definition at line 265 of file Theme.cpp.

{
}

Member Function Documentation

Bitmap()

wxBitmap & ThemeBase::Bitmap

(

int

iIndex

)

Definition at line 1216 of file Theme.cpp.

{
   wxASSERT( iIndex >= 0 );
   EnsureInitialised();
   return mBitmaps[iIndex];
}

References EnsureInitialised(), and mBitmaps.

Referenced by anonymous_namespace{HelpMenus.cpp}::QuickFixDialog::AddStuck(), AColor::Bevel2(), CreateStdButtonSizer(), Exporter::CreateUserPane(), LWSlider::DrawToBitmap(), ErrorReportDialog::ErrorReportDialog(), LabelTrackView::GetGlyph(), AdornedRulerPanel::GetIndicatorBitmap(), InitProjectWindow(), MultiDialog::MultiDialog(), MeterPanel::OnPaint(), DeviceToolBar::Populate(), MixerToolBar::Populate(), RecolourBitmap(), ReplaceImage(), RotateImageInto(), LogWindow::Show(), and HelpSystem::ShowHtmlText().

Here is the call graph for this function:

Here is the caller graph for this function:

Colour()

wxColour & ThemeBase::Colour

(

int

iIndex

)

Definition at line 1197 of file Theme.cpp.

{
   wxASSERT( iIndex >= 0 );
   EnsureInitialised();
   return mColours[iIndex];
}

References EnsureInitialised(), and mColours.

Referenced by SelectionBar::AddTitle(), ProjectWindow::ApplyUpdatedTheme(), ASlider::ASlider(), auStaticText::auStaticText(), AColor::BevelTrackInfo(), TrackInfo::CloseTitleDrawFunction(), CursorColour(), WaveTrackVRulerControls::DoDraw(), AdornedRulerPanel::DoDrawMarks(), AdornedRulerPanel::DoDrawSelection(), 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(), EqualizationPanel::OnPaint(), ToolBarResizer::OnPaint(), ToolBar::OnPaint(), ToolDock::OnPaint(), NumericTextCtrl::OnPaint(), EffectAutoDuckPanel::OnPaint(), EffectCompressorPanel::OnPaint(), EffectScienFilterPanel::OnPaint(), MixerTrackCluster::OnPaint(), MeterPanel::OnPaint(), ToolFrame::OnPaint(), OverlayImage(), FrequencyPlotDialog::Populate(), ControlToolBar::Populate(), DeviceToolBar::Populate(), EditToolBar::Populate(), MeterToolBar::Populate(), MixerToolBar::Populate(), ScrubbingToolBar::Populate(), SelectionBar::Populate(), ToolsToolBar::Populate(), TranscriptionToolBar::Populate(), AColor::PreComputeGradient(), RecolourTheme(), AdornedRulerPanel::ReCreateButtons(), Ruler::Ruler(), SetBrushColour(), SetPenColour(), ToolDock::ToolDock(), MixerBoard::UpdatePrefs(), and AColor::UseThemeColour().

Here is the call graph for this function:

ColourDistance()

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

Definition at line 339 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

(

bool

bBinarySave = true

)

Definition at line 633 of file Theme.cpp.

{
   EnsureInitialised();
   wxBusyCursor busy;
 
   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();
   }
 
   int i;
 
   mFlow.Init( ImageCacheWidth );
   mFlow.mBorderWidth =1;
 
//#define IMAGE_MAP
#ifdef IMAGE_MAP
   wxLogDebug( wxT("<img src=\"ImageCache.png\" usemap=\"#map1\">" ));
   wxLogDebug( wxT("<map name=\"map1\">") );
#endif
 
   // Save the bitmaps
   for(i = 0;i < (int)mImages.size();i++)
   {
      wxImage &SrcImage = mImages[i];
      mFlow.mFlags = mBitmapFlags[i];
      if( (mBitmapFlags[i] & resFlagInternal)==0)
      {
         mFlow.GetNextPosition( SrcImage.GetWidth(), SrcImage.GetHeight());
         ImageCache.SetRGB( mFlow.Rect(), 0xf2, 0xb0, 0x27 );
         if( (mFlow.mFlags & resFlagSkip) == 0 )
            PasteSubImage( &ImageCache, &SrcImage, 
               mFlow.mxPos + mFlow.mBorderWidth, 
               mFlow.myPos + mFlow.mBorderWidth);
         else
            ImageCache.SetRGB( mFlow.RectInner(), 1,1,1);
#ifdef IMAGE_MAP
         // No href in html.  Uses title not alt.
         wxRect R( mFlow.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;
 
   mFlow.SetColourGroup();
   const int iColSize = 10;
   for(i = 0; i < (int)mColours.size(); i++)
   {
      mFlow.GetNextPosition( iColSize, iColSize );
      wxColour c = mColours[i];
      ImageCache.SetRGB( mFlow.Rect() , 0xf2, 0xb0, 0x27 );
      ImageCache.SetRGB( mFlow.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( mFlow.mxPos + x, mFlow.myPos+y, 255);
         }
      }
#ifdef IMAGE_MAP
      // No href in html.  Uses title not alt.
      wxRect R( mFlow.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
   int j;
   for(i=0;i<ImageCacheWidth;i++)
      for(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
 
   // IF bBinarySave, THEN saving to a normal PNG file.
   if( bBinarySave )
   {
      const auto &FileName = FileNames::ThemeCachePng();
 
      // 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 };
         AudacityMessageBox( message );
         return;
      }
#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 ))
      {
         AudacityMessageBox(
            XO("Audacity could not write file:\n  %s.")
               .Format( FileName ));
         return;
      }
      AudacityMessageBox(
/* 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("Theme written to:\n  %s.")
            .Format( FileName ));
   }
   // ELSE saving to a C code textual version.
   else
   {
      SourceOutputStream OutStream;
      const auto &FileName = FileNames::ThemeCacheAsCee( );
      if( !OutStream.OpenFile( FileName ))
      {
         AudacityMessageBox(
            XO("Audacity could not open file:\n  %s\nfor writing.")
               .Format( FileName ));
         return;
      }
      if( !ImageCache.SaveFile(OutStream, wxBITMAP_TYPE_PNG ) )
      {
         AudacityMessageBox(
            XO("Audacity could not write images to file:\n  %s.")
               .Format( FileName ));
         return;
      }
      AudacityMessageBox(
         /* i18n-hint "Cee" means the C computer programming language */
         XO("Theme as Cee code written to:\n  %s.")
            .Format( FileName ));
   }
}

References AudacityMessageBox(), EnsureInitialised(), FlowPacker::GetNextPosition(), ImageCacheHeight, ImageCacheWidth, FlowPacker::Init(), mBitmapFlags, mBitmapNames, FlowPacker::mBorderWidth, mColourNames, mColours, FlowPacker::mFlags, mFlow, mImages, FlowPacker::mxPos, FlowPacker::myPos, SourceOutputStream::OpenFile(), PasteSubImage(), FlowPacker::Rect(), FlowPacker::RectInner(), resFlagInternal, resFlagSkip, FlowPacker::SetColourGroup(), FileNames::ThemeCacheAsCee(), FileNames::ThemeCachePng(), and XO.

Referenced by LoadTheme(), ThemePrefs::OnSaveThemeCache(), and SaveThemeAsCode().

Here is the call graph for this function:

Here is the caller graph for this function:

Cursor()

wxCursor& ThemeBase::Cursor

(

int

iIndex

)

EnsureInitialised()

virtual void ThemeBase::EnsureInitialised ( )

pure virtual

Implemented in Theme.

Referenced by Bitmap(), Colour(), CreateImageCache(), Image(), ImageSize(), LoadTheme(), ReadImageCache(), WriteImageDefs(), and WriteImageMap().

Here is the caller graph for this function:

Font()

wxFont& ThemeBase::Font

(

int

iIndex

)

GetFallbackThemeType()

teThemeType ThemeBase::GetFallbackThemeType

(

)

Definition at line 891 of file Theme.cpp.

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

References themeDark, and themeLight.

Referenced by LoadTheme(), ThemePrefs::OnReadThemeInternal(), and ThemeTypeOfTypeName().

Here is the caller graph for this function:

Image()

wxImage & ThemeBase::Image

(

int

iIndex

)

Definition at line 1223 of file Theme.cpp.

{
   wxASSERT( iIndex >= 0 );
   EnsureInitialised();
   return mImages[iIndex];
}

References EnsureInitialised(), and mImages.

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

Here is the call graph for this function:

Here is the caller graph for this function:

ImageSize()

wxSize ThemeBase::ImageSize

(

int

iIndex

)

Definition at line 1229 of file Theme.cpp.

{
   wxASSERT( iIndex >= 0 );
   EnsureInitialised();
   wxImage & Image = mImages[iIndex];
   return wxSize( Image.GetWidth(), Image.GetHeight());
}

References EnsureInitialised(), Image(), and mImages.

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

Here is the call graph for this function:

Here is the caller graph for this function:

IsUsingSystemTextColour()

bool ThemeBase::IsUsingSystemTextColour ( )

inline

Definition at line 124 of file Theme.h.

{ return bIsUsingSystemTextColour;};

LoadComponents()

void ThemeBase::LoadComponents

(

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 1055 of file Theme.cpp.

{
   // IF directory doesn't exist THEN return early.
   if( !wxDirExists( FileNames::ThemeComponentsDir() ))
      return;
 
   wxBusyCursor busy;
   int i;
   int n=0;
   FilePath FileName;
   for(i = 0; i < (int)mImages.size(); i++)
   {
 
      if( (mBitmapFlags[i] & resFlagInternal)==0)
      {
         FileName = FileNames::ThemeComponent( mBitmapNames[i] );
         if( wxFileExists( FileName ))
         {
            if( !mImages[i].LoadFile( FileName, wxBITMAP_TYPE_PNG ))
            {
               AudacityMessageBox(
                  XO(
               /* i18n-hint: Do not translate png.  It is the name of a file format.*/
"Audacity could not load file:\n  %s.\nBad png format perhaps?")
                     .Format( FileName ));
               return;
            }
            if( ! mImages[i].HasAlpha() )
            {
               // wxLogDebug( wxT("File %s lacked alpha"), mBitmapNames[i] );
               mImages[i].InitAlpha();
            }
            mBitmaps[i] = wxBitmap( mImages[i] );
            n++;
         }
      }
   }
   if( n==0 )
   {
      if( bOkIfNotFound )
         return;
      AudacityMessageBox(
         XO(
"None of the expected theme component files\n were found in:\n  %s.")
            .Format( FileNames::ThemeComponentsDir() ));
   }
}

References AudacityMessageBox(), mBitmapFlags, mBitmapNames, mBitmaps, mImages, resFlagInternal, FileNames::ThemeComponent(), FileNames::ThemeComponentsDir(), and XO.

Referenced by LoadTheme(), and ThemePrefs::OnLoadThemeComponents().

Here is the call graph for this function:

Here is the caller graph for this function:

LoadPreferredTheme()

bool ThemeBase::LoadPreferredTheme ( )

static

Definition at line 231 of file Theme.cpp.

{
// DA: Default themes differ.
   auto theme = GUITheme.Read();
 
   theTheme.LoadTheme( theTheme.ThemeTypeOfTypeName( theme ) );
   return true;
}

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

Referenced by GUIPrefs::Commit(), and Theme::EnsureInitialised().

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 271 of file Theme.cpp.

{
   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
   }
 
   RotateImageInto( bmpRecordBeside, bmpRecordBelow, false );
   RotateImageInto( bmpRecordBesideDisabled, bmpRecordBelowDisabled, false );
 
   if( bRecolourOnLoad )
      RecolourTheme();
 
   wxColor Back        = theTheme.Colour( clrTrackInfo );
   wxColor CurrentText = theTheme.Colour( clrTrackPanelText );
   wxColor DesiredText = wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOWTEXT );
 
   int TextColourDifference =  ColourDistance( CurrentText, DesiredText );
 
   bIsUsingSystemTextColour = ( TextColourDifference == 0 );
   // 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( !bIsUsingSystemTextColour ){
      int ContrastLevel        =  ColourDistance( Back, DesiredText );
      bIsUsingSystemTextColour = bRecolourOnLoad && (ContrastLevel > 250);
      if( bIsUsingSystemTextColour )
         Colour( clrTrackPanelText ) = DesiredText;
   }
   bRecolourOnLoad = false;
 
   // Next line is not required as we haven't yet built the GUI
   // when this function is (or should be) called.
   // ApplyUpdatedImages();
}

References bIsUsingSystemTextColour, bRecolourOnLoad, Colour(), ColourDistance(), CreateImageCache(), EnsureInitialised(), GetFallbackThemeType(), LoadComponents(), ReadImageCache(), RecolourTheme(), RotateImageInto(), and theTheme.

Referenced by LoadPreferredTheme().

Here is the call graph for this function:

Here is the caller graph for this function:

MakeImageWithAlpha()

wxImage ThemeBase::MakeImageWithAlpha

(

wxBitmap &

Bmp

)

Definition at line 1190 of file Theme.cpp.

{
   // BUG in wxWidgets.  Conversion from BMP to image does not preserve alpha.
   wxImage image( Bmp.ConvertToImage() );
   return image;
}

MaskedImage()

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

Definition at line 382 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 = themeFromFile,
		bool	bOkIfNotFound = false
	)

Reads an image cache including images, cursors and colours.

Parameters

bBinaryRead	if true means read from an external binary file. otherwise the data is taken from a compiled in 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 923 of file Theme.cpp.

{
   EnsureInitialised();
   wxImage ImageCache;
   wxBusyCursor busy;
 
   // Ensure we have an alpha channel...
//   if( !ImageCache.HasAlpha() )
//   {
//      ImageCache.InitAlpha();
//   }
 
   gPrefs->Read(wxT("/GUI/BlendThemes"), &bRecolourOnLoad, true);
 
   if(  type == themeFromFile )
   {
      const auto &FileName = FileNames::ThemeCachePng();
      if( !wxFileExists( FileName ))
      {
         if( bOkIfNotFound )
            return false; // did not load the images, so return false.
         AudacityMessageBox(
            XO("Audacity could not find file:\n  %s.\nTheme not loaded.")
               .Format( FileName ));
         return false;
      }
      if( !ImageCache.LoadFile( FileName, wxBITMAP_TYPE_PNG ))
      {
         AudacityMessageBox(
            /* 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;
      switch( type ){
         default: 
         case themeClassic : 
            ImageSize = sizeof(ClassicImageCacheAsData);
            pImage = ClassicImageCacheAsData;
            break;
         case themeLight : 
            ImageSize = sizeof(LightImageCacheAsData);
            pImage = LightImageCacheAsData;
            break;
         case themeDark : 
            ImageSize = sizeof(DarkImageCacheAsData);
            pImage = DarkImageCacheAsData;
            break;
         case themeHiContrast : 
            ImageSize = sizeof(HiContrastImageCacheAsData);
            pImage = HiContrastImageCacheAsData;
            break;
      }
      //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.
         AudacityMessageBox(
            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 );
   }
   int i;
   mFlow.Init(ImageCacheWidth);
   mFlow.mBorderWidth = 1;
   // Load the bitmaps
   for(i = 0; i < (int)mImages.size(); i++)
   {
      wxImage &Image = mImages[i];
      mFlow.mFlags = mBitmapFlags[i];
      if( (mBitmapFlags[i] & resFlagInternal)==0)
      {
         mFlow.GetNextPosition( Image.GetWidth(),Image.GetHeight() );
         wxRect R = mFlow.RectInner();
         //wxLogDebug( "[%i, %i, %i, %i, \"%s\"], ", R.x, R.y, R.width, R.height, mBitmapNames[i].c_str() );
         Image = GetSubImageWithAlpha( ImageCache, mFlow.RectInner() );
         mBitmaps[i] = wxBitmap(Image);
      }
   }
   if( !ImageCache.HasAlpha() )
      ImageCache.InitAlpha();
 
//   return true; //To not load colours..
   // Now load the colours.
   int x,y;
   mFlow.SetColourGroup();
   wxColour TempColour;
   const int iColSize=10;
   for(i = 0; i < (int)mColours.size(); i++)
   {
      mFlow.GetNextPosition( iColSize, iColSize );
      mFlow.RectMid( x, y );
      wxRect R = mFlow.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) )
            mColours[i] = TempColour;
      }
   }
   return true;
}

References AudacityMessageBox(), bRecolourOnLoad, ClassicImageCacheAsData, DarkImageCacheAsData, EnsureInitialised(), FlowPacker::GetNextPosition(), GetSubImageWithAlpha(), gPrefs, HiContrastImageCacheAsData, Image(), ImageCacheWidth, ImageSize(), FlowPacker::Init(), LightImageCacheAsData, mBitmapFlags, mBitmaps, FlowPacker::mBorderWidth, mColours, FlowPacker::mFlags, mFlow, mImages, FlowPacker::RectInner(), FlowPacker::RectMid(), resFlagInternal, FlowPacker::SetColourGroup(), FileNames::ThemeCachePng(), themeClassic, themeDark, themeFromFile, themeHiContrast, themeLight, and XO.

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

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 330 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 349 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	(	int &	iIndex,
		const wxColour &	Clr,
		const wxString &	Name
	)

Definition at line 468 of file Theme.cpp.

{
   wxASSERT( iIndex == -1 ); // Don't initialise same colour twice!
   mColours.push_back( Clr );
   mColourNames.push_back( Name );
   iIndex = mColours.size() - 1;
}

References mColourNames, and mColours.

RegisterImage() [1/2]

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

Definition at line 428 of file Theme.cpp.

{
   wxASSERT( iIndex == -1 ); // Don't initialise same bitmap twice!
   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( iIndex, Img, Name );
}

RegisterImage() [2/2]

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

Definition at line 444 of file Theme.cpp.

{
   wxASSERT( iIndex == -1 ); // Don't initialise same bitmap twice!
   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();
   mBitmaps.push_back( wxBitmap( TempImage ) );
#else
   mBitmaps.push_back( wxBitmap( Image ) );
#endif
 
   mBitmapNames.push_back( Name );
   mBitmapFlags.push_back( mFlow.mFlags );
   mFlow.mFlags &= ~resFlagSkip;
   iIndex = mBitmaps.size() - 1;
}

References Image(), mBitmapFlags, mBitmapNames, mBitmaps, FlowPacker::mFlags, mFlow, mImages, and resFlagSkip.

Here is the call graph for this function:

ReplaceImage()

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

Replaces both the image and the bitmap.

Definition at line 1259 of file Theme.cpp.

{
   Image( iIndex ) = *pImage;
   Bitmap( iIndex ) = wxBitmap( *pImage );
}

References Bitmap(), and Image().

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

Here is the call graph for this function:

Here is the caller graph for this function:

RotateImageInto()

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

Definition at line 1265 of file Theme.cpp.

{
   wxImage img(theTheme.Bitmap( iFrom ).ConvertToImage() );
   wxImage img2 = img.Rotate90( bClockwise );
   ReplaceImage( iTo, &img2 );
}

References Bitmap(), ReplaceImage(), and theTheme.

Referenced by LoadTheme().

Here is the call graph for this function:

Here is the caller graph for this function:

SaveComponents()

void ThemeBase::SaveComponents

(

)

Bug:

1 in wxWidgets documentation; wxMkDir returns false if directory didn't exist, even if it successfully creates it. so we create and then test if it exists instead.

Bug:

2 in wxWidgets documentation; wxMkDir has only one argument under MSW

Definition at line 1107 of file Theme.cpp.

{
   // IF directory doesn't exist THEN create it
   if( !wxDirExists( FileNames::ThemeComponentsDir() ))
   {
#ifdef __WXMSW__
      wxMkDir( FileNames::ThemeComponentsDir().fn_str() );
#else
      wxMkDir( FileNames::ThemeComponentsDir().fn_str(), 0700 );
#endif
      if( !wxDirExists( FileNames::ThemeComponentsDir() ))
      {
         AudacityMessageBox(
            XO("Could not create directory:\n  %s")
               .Format( FileNames::ThemeComponentsDir() ) );
         return;
      }
   }
 
   wxBusyCursor busy;
   int i;
   int n=0;
   FilePath FileName;
   for(i = 0; i < (int)mImages.size(); i++)
   {
      if( (mBitmapFlags[i] & resFlagInternal)==0)
      {
         FileName = FileNames::ThemeComponent( mBitmapNames[i] );
         if( wxFileExists( FileName ))
         {
            ++n;
            break;
         }
      }
   }
 
   using namespace BasicUI;
 
   if (n > 0)
   {
      auto result =
         ShowMessageBox(
            XO(
"Some required files in:\n  %s\nwere already present. Overwrite?")
               .Format( FileNames::ThemeComponentsDir() ),
            MessageBoxOptions{}
               .ButtonStyle(Button::YesNo)
               .DefaultIsNo());
      if (result == MessageBoxResult::No)
         return;
   }
 
   for(i = 0; i < (int)mImages.size(); i++)
   {
      if( (mBitmapFlags[i] & resFlagInternal)==0)
      {
         FileName = FileNames::ThemeComponent( mBitmapNames[i] );
         if( !mImages[i].SaveFile( FileName, wxBITMAP_TYPE_PNG ))
         {
            AudacityMessageBox(
               XO("Audacity could not save file:\n  %s")
                  .Format( FileName ));
            return;
         }
      }
   }
   AudacityMessageBox(
      XO("Theme written to:\n  %s.")
         .Format( FileNames::ThemeComponentsDir() ) );
}

References AudacityMessageBox(), BasicUI::MessageBoxOptions::ButtonStyle(), mBitmapFlags, mBitmapNames, mImages, resFlagInternal, BasicUI::ShowMessageBox(), FileNames::ThemeComponent(), FileNames::ThemeComponentsDir(), and XO.

Referenced by ThemePrefs::OnSaveThemeComponents().

Here is the call graph for this function:

Here is the caller graph for this function:

SaveThemeAsCode()

void ThemeBase::SaveThemeAsCode

(

)

Definition at line 1184 of file Theme.cpp.

{
   // false indicates not using standard binary method.
   CreateImageCache( false );
}

References CreateImageCache().

Referenced by ThemePrefs::OnSaveThemeAsCode().

Here is the call graph for this function:

Here is the caller graph for this function:

SetBrushColour()

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

Definition at line 1204 of file Theme.cpp.

{
   wxASSERT( iIndex >= 0 );
   Brush.SetColour( Colour( iIndex ));
}

References Colour().

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

Here is the call graph for this function:

Here is the caller graph for this function:

SetFlags()

void ThemeBase::SetFlags ( int  flags )

inline

Definition at line 143 of file Theme.h.

{ mFlow.mFlags = flags;};

SetPenColour()

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

Definition at line 1210 of file Theme.cpp.

{
   wxASSERT( iIndex >= 0 );
   Pen.SetColour( Colour( iIndex ));
}

References Colour().

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

Here is the call graph for this function:

Here is the caller graph for this function:

ThemeTypeOfTypeName()

teThemeType ThemeBase::ThemeTypeOfTypeName

(

const wxString &

Name

)

Definition at line 901 of file Theme.cpp.

{
   static const wxArrayStringEx aThemes{
      "classic" ,
      "dark" ,
      "light" ,
      "high-contrast" ,
      "custom" ,
   };
   int themeIx = make_iterator_range( aThemes ).index( Name );
   if( themeIx < 0 )
      return GetFallbackThemeType();
   return (teThemeType)themeIx;
}

References GetFallbackThemeType(), and make_iterator_range().

Referenced by LoadPreferredTheme().

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 851 of file Theme.cpp.

{
   EnsureInitialised();
   wxBusyCursor busy;
 
   int i;
   wxFFile File( FileNames::ThemeImageDefsAsCee(), wxT("wb") );
   if( !File.IsOpened() )
      return;
   teResourceFlags PrevFlags = (teResourceFlags)-1;
   for(i = 0; i < (int)mImages.size(); i++)
   {
      wxImage &SrcImage = 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(), mBitmapFlags, mBitmapNames, mImages, resFlagCursor, resFlagInternal, resFlagNewLine, resFlagPaired, and FileNames::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

(

)

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

Definition at line 798 of file Theme.cpp.

{
   EnsureInitialised();
   wxBusyCursor busy;
 
   int i;
   mFlow.Init( ImageCacheWidth );
   mFlow.mBorderWidth = 1;
 
   wxFFile File( FileNames::ThemeCacheHtm(), 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(i = 0; i < (int)mImages.size(); i++)
   {
      wxImage &SrcImage = mImages[i];
      mFlow.mFlags = mBitmapFlags[i];
      if( (mBitmapFlags[i] & resFlagInternal)==0)
      {
         mFlow.GetNextPosition( SrcImage.GetWidth(), SrcImage.GetHeight());
         // No href in html.  Uses title not alt.
         wxRect R( mFlow.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.
   mFlow.SetColourGroup();
   const int iColSize = 10;
   for(i = 0; i < (int)mColours.size(); i++)
   {
      mFlow.GetNextPosition( iColSize, iColSize );
      // No href in html.  Uses title not alt.
      wxRect R( mFlow.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 EnsureInitialised(), FlowPacker::GetNextPosition(), ImageCacheWidth, FlowPacker::Init(), mBitmapFlags, mBitmapNames, FlowPacker::mBorderWidth, mColourNames, mColours, FlowPacker::mFlags, mFlow, mImages, FlowPacker::RectInner(), resFlagInternal, FlowPacker::SetColourGroup(), and FileNames::ThemeCacheHtm().

Referenced by ThemePrefs::OnSaveThemeCache().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

bIsUsingSystemTextColour

bool ThemeBase::bIsUsingSystemTextColour

Definition at line 136 of file Theme.h.

Referenced by LoadTheme(), and ThemeBase().

bRecolourOnLoad

bool ThemeBase::bRecolourOnLoad

Definition at line 135 of file Theme.h.

Referenced by LoadTheme(), ReadImageCache(), and ThemeBase().

mBitmapFlags

std::vector<int> ThemeBase::mBitmapFlags

protected

Definition at line 155 of file Theme.h.

Referenced by CreateImageCache(), LoadComponents(), ReadImageCache(), RegisterImage(), SaveComponents(), WriteImageDefs(), and WriteImageMap().

mBitmapNames

wxArrayString ThemeBase::mBitmapNames

protected

Definition at line 154 of file Theme.h.

Referenced by CreateImageCache(), LoadComponents(), RegisterImage(), SaveComponents(), WriteImageDefs(), and WriteImageMap().

mBitmaps

std::vector<wxBitmap> ThemeBase::mBitmaps

protected

Definition at line 153 of file Theme.h.

Referenced by Bitmap(), LoadComponents(), ReadImageCache(), and RegisterImage().

mColourNames

wxArrayString ThemeBase::mColourNames

protected

Definition at line 158 of file Theme.h.

Referenced by CreateImageCache(), RegisterColour(), and WriteImageMap().

mColours

std::vector<wxColour> ThemeBase::mColours

protected

Definition at line 157 of file Theme.h.

Referenced by Colour(), CreateImageCache(), ReadImageCache(), RegisterColour(), and WriteImageMap().

mFlow

FlowPacker ThemeBase::mFlow

protected

Definition at line 159 of file Theme.h.

Referenced by CreateImageCache(), ReadImageCache(), RegisterImage(), and WriteImageMap().

mImages

std::vector<wxImage> ThemeBase::mImages

protected

Definition at line 152 of file Theme.h.

Referenced by CreateImageCache(), Image(), ImageSize(), LoadComponents(), ReadImageCache(), RegisterImage(), SaveComponents(), WriteImageDefs(), and WriteImageMap().

---

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

• Theme.h
• Theme.cpp