ThemedAButtonWrapper< AButtonBase > Class Template Reference

#include <ThemedWrappers.h>

Inheritance diagram for ThemedAButtonWrapper< AButtonBase >:

Collaboration diagram for ThemedAButtonWrapper< AButtonBase >:

Public Member Functions
template<typename... Args>
	ThemedAButtonWrapper (Args &&... args)
void	SetImageIndices (int setIndex, int up, int over, int down, int overDown, int disabled)
void	SetBackgroundColorIndex (int index)
void	SetForegroundColorIndex (int index)
void	SetTranslatableLabel (TranslatableString label)
void	UpdatePrefs () override
Public Member Functions inherited from PrefsListener
	PrefsListener ()
virtual	~PrefsListener ()
virtual void	UpdatePrefs ()=0

Private Member Functions
void	OnThemeChange (ThemeChangeMessage message)

Private Attributes
Observer::Subscription	mThemeChangeSubscription
std::map< int, std::array< int, AButton::AButtonStateCount > >	mSets
int	mBackgroundColorIndex {-1}
int	mForegroundColorIndex {-1}
std::optional< TranslatableString >	mTranslatableLabel

Additional Inherited Members
Static Public Member Functions inherited from PrefsListener
static void	Broadcast (int id=0)
	Call this static function to notify all PrefsListener objects. More...
Protected Member Functions inherited from PrefsListener
virtual void	UpdateSelectedPrefs (int id)

Detailed Description

template<typename AButtonBase>
class ThemedAButtonWrapper< AButtonBase >

Definition at line 191 of file ThemedWrappers.h.

Constructor & Destructor Documentation

ThemedAButtonWrapper()

template<typename AButtonBase >

template<typename... Args>

ThemedAButtonWrapper< AButtonBase >::ThemedAButtonWrapper ( Args &&...  args )

inline

Definition at line 204 of file ThemedWrappers.h.

                                        : AButtonBase( std::forward<Args>(args)... )
   {
      mThemeChangeSubscription =
         theTheme.Subscribe(*this, &ThemedAButtonWrapper::OnThemeChange);
   }

References ThemedAButtonWrapper< AButtonBase >::mThemeChangeSubscription, ThemedAButtonWrapper< AButtonBase >::OnThemeChange(), Observer::Publisher< Message, NotifyAll >::Subscribe(), and theTheme.

Here is the call graph for this function:

Member Function Documentation

OnThemeChange()

template<typename AButtonBase >

void ThemedAButtonWrapper< AButtonBase >::OnThemeChange ( ThemeChangeMessage  message )

inlineprivate

Definition at line 255 of file ThemedWrappers.h.

   {
      if (message.appearance)
      {
         for(const auto& p : mSets)
            AButtonBase::SetAlternateImages(
               p.first,
               theTheme.Image(p.second[AButton::AButtonUp]),
               theTheme.Image(p.second[AButton::AButtonOver]),
               theTheme.Image(p.second[AButton::AButtonDown]),
               theTheme.Image(p.second[AButton::AButtonOverDown]),
               theTheme.Image(p.second[AButton::AButtonDis])
            );
 
         if(mBackgroundColorIndex != -1)
            AButtonBase::SetBackgroundColour(theTheme.Colour(mBackgroundColorIndex));
 
         if(mForegroundColorIndex != -1)
            AButtonBase::SetForegroundColour(theTheme.Colour(mForegroundColorIndex));
 
         AButtonBase::Refresh(false);
      }
   }

References AButton::AButtonDis, AButton::AButtonDown, AButton::AButtonOver, AButton::AButtonOverDown, AButton::AButtonUp, ThemeChangeMessage::appearance, ThemeBase::Colour(), ThemeBase::Image(), ThemedAButtonWrapper< AButtonBase >::mBackgroundColorIndex, ThemedAButtonWrapper< AButtonBase >::mForegroundColorIndex, ThemedAButtonWrapper< AButtonBase >::mSets, and theTheme.

Referenced by ThemedAButtonWrapper< AButtonBase >::ThemedAButtonWrapper().

Here is the call graph for this function:

Here is the caller graph for this function:

SetBackgroundColorIndex()

template<typename AButtonBase >

void ThemedAButtonWrapper< AButtonBase >::SetBackgroundColorIndex ( int  index )

inline

Definition at line 223 of file ThemedWrappers.h.

   {
      mBackgroundColorIndex = index;
      if(index != -1)
         AButtonBase::SetBackgroundColour(theTheme.Colour(mBackgroundColorIndex));
   }

References ThemeBase::Colour(), ThemedAButtonWrapper< AButtonBase >::mBackgroundColorIndex, and theTheme.

Here is the call graph for this function:

SetForegroundColorIndex()

template<typename AButtonBase >

void ThemedAButtonWrapper< AButtonBase >::SetForegroundColorIndex ( int  index )

inline

Definition at line 230 of file ThemedWrappers.h.

   {
      mForegroundColorIndex = index;
      if(index != -1)
         AButtonBase::SetForegroundColour(theTheme.Colour(mForegroundColorIndex));
   }

References ThemeBase::Colour(), ThemedAButtonWrapper< AButtonBase >::mForegroundColorIndex, and theTheme.

Here is the call graph for this function:

SetImageIndices()

template<typename AButtonBase >

void ThemedAButtonWrapper< AButtonBase >::SetImageIndices ( int  setIndex, int  up, int  over, int  down, int  overDown, int  disabled  )

inline

Definition at line 210 of file ThemedWrappers.h.

   {
      mSets[setIndex] = { up, over, down, overDown, disabled };
      AButtonBase::SetAlternateImages(
         setIndex,
         theTheme.Image(up),
         theTheme.Image(over),
         theTheme.Image(down),
         theTheme.Image(overDown),
         theTheme.Image(disabled)
      );
   }

References ThemeBase::Image(), ThemedAButtonWrapper< AButtonBase >::mSets, and theTheme.

Here is the call graph for this function:

SetTranslatableLabel()

template<typename AButtonBase >

void ThemedAButtonWrapper< AButtonBase >::SetTranslatableLabel ( TranslatableString  label )

inline

Definition at line 237 of file ThemedWrappers.h.

   {
      mTranslatableLabel = std::move(label);
      AButtonBase::SetLabel(*mTranslatableLabel);
   }

References label, and ThemedAButtonWrapper< AButtonBase >::mTranslatableLabel.

UpdatePrefs()

template<typename AButtonBase >

void ThemedAButtonWrapper< AButtonBase >::UpdatePrefs ( )

inlineoverridevirtual

Implements PrefsListener.

Definition at line 243 of file ThemedWrappers.h.

   {
      PrefsListener::UpdatePrefs();
      if(mTranslatableLabel)
      {
         AButtonBase::SetLabel(*mTranslatableLabel);
         AButtonBase::Refresh(false);
      }
   }

References ThemedAButtonWrapper< AButtonBase >::mTranslatableLabel, and PrefsListener::UpdatePrefs().

Here is the call graph for this function:

Member Data Documentation

mBackgroundColorIndex

template<typename AButtonBase >

int ThemedAButtonWrapper< AButtonBase >::mBackgroundColorIndex {-1}

private

Definition at line 198 of file ThemedWrappers.h.

Referenced by ThemedAButtonWrapper< AButtonBase >::OnThemeChange(), and ThemedAButtonWrapper< AButtonBase >::SetBackgroundColorIndex().

mForegroundColorIndex

template<typename AButtonBase >

int ThemedAButtonWrapper< AButtonBase >::mForegroundColorIndex {-1}

private

Definition at line 199 of file ThemedWrappers.h.

Referenced by ThemedAButtonWrapper< AButtonBase >::OnThemeChange(), and ThemedAButtonWrapper< AButtonBase >::SetForegroundColorIndex().

mSets

template<typename AButtonBase >

std::map<int, std::array<int, AButton::AButtonStateCount> > ThemedAButtonWrapper< AButtonBase >::mSets

private

Definition at line 197 of file ThemedWrappers.h.

Referenced by ThemedAButtonWrapper< AButtonBase >::OnThemeChange(), and ThemedAButtonWrapper< AButtonBase >::SetImageIndices().

mThemeChangeSubscription

template<typename AButtonBase >

Observer::Subscription ThemedAButtonWrapper< AButtonBase >::mThemeChangeSubscription

private

Definition at line 195 of file ThemedWrappers.h.

Referenced by ThemedAButtonWrapper< AButtonBase >::ThemedAButtonWrapper().

mTranslatableLabel

template<typename AButtonBase >

std::optional<TranslatableString> ThemedAButtonWrapper< AButtonBase >::mTranslatableLabel

private

Definition at line 200 of file ThemedWrappers.h.

Referenced by ThemedAButtonWrapper< AButtonBase >::SetTranslatableLabel(), and ThemedAButtonWrapper< AButtonBase >::UpdatePrefs().

---

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

• ThemedWrappers.h