Theme.h File Reference

#include <map>
#include <unordered_set>
#include <vector>
#include <optional>
#include <wx/arrstr.h>
#include <wx/defs.h>
#include <wx/gdicmn.h>
#include "ComponentInterfaceSymbol.h"
#include "Observer.h"
#include "Prefs.h"

Include dependency graph for Theme.h:

Go to the source code of this file.

Classes
class	FlowPacker
	A cursor for iterating the theme bitmap. More...
struct	ThemeSet
struct	ThemeChangeMessage
class	ThemeBase
	Theme management - Image loading and saving. More...
struct	ThemeBase::RegisteredTheme
class	Theme
	Based on ThemeBase, Theme manages image and icon resources. More...

Typedefs
using	teThemeType = Identifier
	A choice of theme such as "Light", "Dark", ... More...
using	teBmps = int

Enumerations
enum class	PreferredSystemAppearance { Light , Dark , HighContrastDark }
	A system theme, that matches selected theme best (only works on macOS with builtin themes). More...
enum	teResourceType { resTypeColour , resTypeBitmap , resTypeImage = resTypeBitmap }
	The index of a bitmap resource in Theme Resources. More...
enum	teResourceFlags {   resFlagNone =0x00 , resFlagPaired =0x01 , resFlagCursor =0x02 , resFlagNewLine = 0x04 ,   resFlagInternal = 0x08 , resFlagSkip = 0x10 }

Functions
THEME_API ChoiceSetting &	GUITheme ()

Variables
THEME_API Theme	theTheme

Typedef Documentation

teBmps

using teBmps = int

Definition at line 49 of file Theme.h.

teThemeType

using teThemeType = Identifier

A choice of theme such as "Light", "Dark", ...

Definition at line 30 of file Theme.h.

Enumeration Type Documentation

PreferredSystemAppearance

enum class PreferredSystemAppearance

strong

A system theme, that matches selected theme best (only works on macOS with builtin themes).

Enumerator
Light
Dark
HighContrastDark

Definition at line 33 of file Theme.h.

{
    Light,
    Dark,
    HighContrastDark
};

teResourceFlags

enum teResourceFlags

Enumerator
resFlagNone
resFlagPaired
resFlagCursor
resFlagNewLine
resFlagInternal
resFlagSkip

Definition at line 58 of file Theme.h.

{
   resFlagNone   =0x00,
   resFlagPaired =0x01,
   resFlagCursor =0x02,
   resFlagNewLine = 0x04,
   resFlagInternal = 0x08,  // For image manipulation.  Don't save or load.
   resFlagSkip = 0x10
};

teResourceType

enum teResourceType

The index of a bitmap resource in Theme Resources.

Enumerator
resTypeColour
resTypeBitmap
resTypeImage

Definition at line 51 of file Theme.h.

{
   resTypeColour,
   resTypeBitmap,
   resTypeImage = resTypeBitmap,
};

Function Documentation

GUITheme()

THEME_API ChoiceSetting & GUITheme

(

)

Referenced by ThemeBase::LoadPreferredTheme(), GUIPrefs::PopulateOrExchange(), ThemeBase::ReadImageCache(), and ThemeBase::SwitchTheme().

Here is the caller graph for this function:

Variable Documentation

theTheme

THEME_API Theme theTheme

extern

Definition at line 82 of file Theme.cpp.

Referenced by AboutDialog::AboutDialog(), TranscriptionToolBar::AddButton(), anonymous_namespace{HelpMenus.cpp}::QuickFixDialog::AddStuck(), SelectionBar::AddTitle(), TimeSignatureToolBar::AddTitle(), AdornedRulerPanel::AdornedRulerPanel(), AlphaBlend(), AColor::ApplyUpdatedImages(), ProjectWindow::ApplyUpdatedTheme(), ASlider::ASlider(), auStaticText::auStaticText(), AColor::Bevel2(), AColor::BevelTrackInfo(), EffectUIHost::BuildTopBar(), AColor::ButtonStretch(), ThemePrefs::Cancel(), CommonTrackInfo::CloseTitleDrawFunction(), GUIPrefs::Commit(), ThemePrefs::Commit(), anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::Create(), ToolBarButtons::CreateButton(), CreateStdButtonSizer(), CursorColour(), WaveChannelVRulerControls::DoDraw(), AdornedRulerPanel::DoDrawMarks(), AdornedRulerPanel::DoDrawPlayRegion(), AdornedRulerPanel::DoDrawPlayRegionLimits(), LabelTrackView::Draw(), NoteTrackAffordanceControls::Draw(), WaveTrackAffordanceControls::Draw(), TimeTrackVRulerControls::Draw(), RulerUpdater::Label::Draw(), CommonTrackInfo::DrawCloseButton(), anonymous_namespace{TimeTrackView.cpp}::DrawHorzRulerAndCurve(), CommonTrackInfo::DrawItems(), anonymous_namespace{NoteTrackControls.cpp}::DrawLabelControls(), anonymous_namespace{NoteTrackView.cpp}::DrawNoteTrack(), ClipButtonSpecializations< ClipButtonId::Pitch >::DrawOnClip(), ClipButtonSpecializations< ClipButtonId::Speed >::DrawOnClip(), FrequencyPlotDialog::DrawPlot(), TrackArt::DrawSyncLockTiles(), LWSlider::DrawToBitmap(), anonymous_namespace{TrackPanel.cpp}::DrawTrackName(), ErrorReportDialog::ErrorReportDialog(), WaveTrackControls::GainSlider(), LabelTrackView::GetGlyph(), anonymous_namespace{PlayIndicatorOverlay.cpp}::GetIndicatorBitmap(), HighlitClipButtonHandle::Highlight(), HtmlColourOfIndex(), AColor::Init(), InitProjectWindow(), NumericTextCtrl::Layout(), ThemeBase::LoadPreferredTheme(), main(), ControlToolBar::MakeAlternateImages(), ToolBar::MakeAlternateImages(), TranscriptionToolBar::MakeAlternateImages(), AudioSetupToolBar::MakeAudioSetupButton(), ToolBar::MakeButton(), MixerBoard::MakeButtonBitmap(), ToolBar::MakeMacRecoloredImage(), ToolBar::MakeMacRecoloredImageSize(), ToolBar::MakeRecoloredImageSize(), SelectionBar::MakeSetupButton(), audacity::cloud::ShareAudioToolbar::MakeShareAudioButton(), WaveTrackAffordanceControls::MakeTextEditHelper(), ToolsToolBar::MakeTool(), anonymous_namespace{SplashDialog.cpp}::MakeWhatsNewText(), CommonTrackInfo::MinimizeSyncLockDrawFunction(), MixerBoard::MixerBoard(), MultiDialog::MultiDialog(), ToolManager::OnIndicatorPaint(), App::OnInit(), AudacityApp::OnInit(), ThemePrefs::OnLoadThemeCache(), ThemePrefs::OnLoadThemeComponents(), 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(), ThemePrefs::OnReadThemeInternal(), ThemePrefs::OnSaveThemeAsCode(), ThemePrefs::OnSaveThemeCache(), ThemePrefs::OnSaveThemeComponents(), ThemedWindowWrapper< WindowBase >::OnThemeChange(), ThemedButtonWrapper< ButtonBase >::OnThemeChange(), ThemedAButtonWrapper< AButtonBase >::OnThemeChange(), OverlayImage(), WaveTrackControls::PanSlider(), FrequencyPlotDialog::Populate(), audacity::cloud::ShareAudioToolbar::Populate(), AudioSetupToolBar::Populate(), ControlToolBar::Populate(), CutCopyPasteToolBar::Populate(), DeviceToolBar::Populate(), EditToolBar::Populate(), MeterToolBar::Populate(), SelectionBar::Populate(), SnappingToolBar::Populate(), SpectralSelectionBar::Populate(), TimeSignatureToolBar::Populate(), ToolsToolBar::Populate(), TranscriptionToolBar::Populate(), DevicePrefs::PopulateOrExchange(), AColor::PreComputeGradient(), ProjectWindow::ProjectWindow(), AdornedRulerPanel::ReCreateButtons(), Ruler::Ruler(), audacity::cloud::audiocom::UserPanel::SetAnonymousState(), ThemedWindowWrapper< WindowBase >::SetBackgroundColorIndex(), ThemedButtonWrapper< ButtonBase >::SetBackgroundColorIndex(), ThemedAButtonWrapper< AButtonBase >::SetBackgroundColorIndex(), ThemedButtonWrapper< ButtonBase >::SetBitmapCurrentIndex(), ThemedButtonWrapper< ButtonBase >::SetBitmapFocusIndex(), ThemedButtonWrapper< ButtonBase >::SetBitmapIndex(), ThemedButtonWrapper< ButtonBase >::SetBitmapLabelIndex(), ThemedButtonWrapper< ButtonBase >::SetBitmapPressedIndex(), TrackArtist::SetColours(), ThemedWindowWrapper< WindowBase >::SetForegroundColorIndex(), ThemedAButtonWrapper< AButtonBase >::SetForegroundColorIndex(), ThemedAButtonWrapper< AButtonBase >::SetImageIndices(), LogWindow::Show(), HelpSystem::ShowHtmlText(), ThemedAButtonWrapper< AButtonBase >::ThemedAButtonWrapper(), ThemedButtonWrapper< ButtonBase >::ThemedButtonWrapper(), ThemedWindowWrapper< WindowBase >::ThemedWindowWrapper(), ToolBarGrabber::ToolBarGrabber(), ToolDock::ToolDock(), audacity::cloud::audiocom::sync::CloudSyncStatusField::StatusWidget::UpdatePrefs(), MixerBoard::UpdatePrefs(), audacity::cloud::audiocom::UserPanel::UpdateUserData(), AColor::UseThemeColour(), and NoteTrackControls::VelocitySlider().