ThemedButtonWrapper< ButtonBase > Class Template Reference

#include <ThemedWrappers.h>

Inheritance diagram for ThemedButtonWrapper< ButtonBase >:

Collaboration diagram for ThemedButtonWrapper< ButtonBase >:

Public Member Functions
template<typename... Args>
	ThemedButtonWrapper (Args &&... args)
int	GetBitmapIndex () const
void	SetBitmapFocusIndex (int index)
void	SetBitmapIndex (int index)
void	SetBitmapLabelIndex (int index)
void	SetBitmapPressedIndex (int index)
void	SetBitmapCurrentIndex (int index)
void	SetBackgroundColorIndex (int index)
void	SetTranslatableLabel (TranslatableString label)
void	UpdatePrefs () override
Public Member Functions inherited from PrefsListener
	PrefsListener ()
virtual	~PrefsListener ()
virtual void	UpdatePrefs ()=0

Protected Member Functions
void	OnThemeChange (ThemeChangeMessage message)
Protected Member Functions inherited from PrefsListener
virtual void	UpdateSelectedPrefs (int id)

Private Attributes
Observer::Subscription	mThemeChangeSubscription
int	mBitmapIndex { -1 }
int	mFocusBitmapIndex { -1 }
int	mLabelBitmapIndex { -1 }
int	mPressedBitmapIndex { -1 }
int	mCurrentBitmapIndex { -1 }
int	mBackgroundColorIndex { -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...

Detailed Description

template<class ButtonBase>
class ThemedButtonWrapper< ButtonBase >

Definition at line 92 of file ThemedWrappers.h.

Constructor & Destructor Documentation

ThemedButtonWrapper()

template<class ButtonBase >

template<typename... Args>

ThemedButtonWrapper< ButtonBase >::ThemedButtonWrapper ( Args &&...  args )

inline

Definition at line 107 of file ThemedWrappers.h.

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

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

Here is the call graph for this function:

Member Function Documentation

GetBitmapIndex()

template<class ButtonBase >

int ThemedButtonWrapper< ButtonBase >::GetBitmapIndex ( ) const

inline

Definition at line 113 of file ThemedWrappers.h.

   {
      return mBitmapIndex;
   }

References ThemedButtonWrapper< ButtonBase >::mBitmapIndex.

OnThemeChange()

template<class ButtonBase >

void ThemedButtonWrapper< ButtonBase >::OnThemeChange ( ThemeChangeMessage  message )

inlineprotected

Definition at line 168 of file ThemedWrappers.h.

   {
      if (message.appearance)
      {
         if(mBitmapIndex != -1)
            ButtonBase::SetBitmap(theTheme.Bitmap(mBitmapIndex));
         if(mLabelBitmapIndex != -1)
            ButtonBase::SetBitmapLabel(theTheme.Bitmap(mLabelBitmapIndex));
         if(mPressedBitmapIndex != -1)
            ButtonBase::SetBitmapPressed(theTheme.Bitmap(mPressedBitmapIndex));
         if(mCurrentBitmapIndex != -1)
            ButtonBase::SetBitmapCurrent(theTheme.Bitmap(mCurrentBitmapIndex));
         if(mFocusBitmapIndex != -1)
            ButtonBase::SetBitmapFocus(theTheme.Bitmap(mFocusBitmapIndex));
 
         if(mBackgroundColorIndex != -1)
            ButtonBase::SetBackgroundColour(theTheme.Colour(mBackgroundColorIndex));
         ButtonBase::Refresh();
      }
   }

References ThemeChangeMessage::appearance, ThemeBase::Bitmap(), ThemeBase::Colour(), ThemedButtonWrapper< ButtonBase >::mBackgroundColorIndex, ThemedButtonWrapper< ButtonBase >::mBitmapIndex, ThemedButtonWrapper< ButtonBase >::mCurrentBitmapIndex, ThemedButtonWrapper< ButtonBase >::mFocusBitmapIndex, ThemedButtonWrapper< ButtonBase >::mLabelBitmapIndex, ThemedButtonWrapper< ButtonBase >::mPressedBitmapIndex, and theTheme.

Referenced by ThemedButtonWrapper< ButtonBase >::ThemedButtonWrapper().

Here is the call graph for this function:

Here is the caller graph for this function:

SetBackgroundColorIndex()

template<class ButtonBase >

void ThemedButtonWrapper< ButtonBase >::SetBackgroundColorIndex ( int  index )

inline

Definition at line 147 of file ThemedWrappers.h.

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

References ThemeBase::Colour(), ThemedButtonWrapper< ButtonBase >::mBackgroundColorIndex, and theTheme.

Here is the call graph for this function:

SetBitmapCurrentIndex()

template<class ButtonBase >

void ThemedButtonWrapper< ButtonBase >::SetBitmapCurrentIndex ( int  index )

inline

Definition at line 141 of file ThemedWrappers.h.

   {
      mCurrentBitmapIndex = index;
      ButtonBase::SetBitmapCurrent(theTheme.Bitmap(mCurrentBitmapIndex));
   }

References ThemeBase::Bitmap(), ThemedButtonWrapper< ButtonBase >::mCurrentBitmapIndex, and theTheme.

Here is the call graph for this function:

SetBitmapFocusIndex()

template<class ButtonBase >

void ThemedButtonWrapper< ButtonBase >::SetBitmapFocusIndex ( int  index )

inline

Definition at line 118 of file ThemedWrappers.h.

   {
      mFocusBitmapIndex = index;
      ButtonBase::SetBitmapFocus(theTheme.Bitmap(mFocusBitmapIndex));
   }

References ThemeBase::Bitmap(), ThemedButtonWrapper< ButtonBase >::mFocusBitmapIndex, and theTheme.

Here is the call graph for this function:

SetBitmapIndex()

template<class ButtonBase >

void ThemedButtonWrapper< ButtonBase >::SetBitmapIndex ( int  index )

inline

Definition at line 124 of file ThemedWrappers.h.

   {
      mBitmapIndex = index;
      ButtonBase::SetBitmap(theTheme.Bitmap(mBitmapIndex));
   }

References ThemeBase::Bitmap(), ThemedButtonWrapper< ButtonBase >::mBitmapIndex, and theTheme.

Here is the call graph for this function:

SetBitmapLabelIndex()

template<class ButtonBase >

void ThemedButtonWrapper< ButtonBase >::SetBitmapLabelIndex ( int  index )

inline

Definition at line 130 of file ThemedWrappers.h.

   {
      mLabelBitmapIndex = index;
      ButtonBase::SetBitmapLabel(theTheme.Bitmap(mLabelBitmapIndex));
   }

References ThemeBase::Bitmap(), ThemedButtonWrapper< ButtonBase >::mLabelBitmapIndex, and theTheme.

Here is the call graph for this function:

SetBitmapPressedIndex()

template<class ButtonBase >

void ThemedButtonWrapper< ButtonBase >::SetBitmapPressedIndex ( int  index )

inline

Definition at line 135 of file ThemedWrappers.h.

   {
      mPressedBitmapIndex = index;
      ButtonBase::SetBitmapPressed(theTheme.Bitmap(mPressedBitmapIndex));
   }

References ThemeBase::Bitmap(), ThemedButtonWrapper< ButtonBase >::mPressedBitmapIndex, and theTheme.

Here is the call graph for this function:

SetTranslatableLabel()

template<class ButtonBase >

void ThemedButtonWrapper< ButtonBase >::SetTranslatableLabel ( TranslatableString  label )

inline

Definition at line 154 of file ThemedWrappers.h.

   {
      mTranslatableLabel = std::move(label);
      ButtonBase::SetLabel(mTranslatableLabel->Translation());
   }

References label, and ThemedButtonWrapper< ButtonBase >::mTranslatableLabel.

UpdatePrefs()

template<class ButtonBase >

void ThemedButtonWrapper< ButtonBase >::UpdatePrefs ( )

inlineoverridevirtual

Implements PrefsListener.

Definition at line 160 of file ThemedWrappers.h.

   {
      PrefsListener::UpdatePrefs();
      if(mTranslatableLabel)
         ButtonBase::SetLabel(mTranslatableLabel->Translation());
   }

References ThemedButtonWrapper< ButtonBase >::mTranslatableLabel, and PrefsListener::UpdatePrefs().

Here is the call graph for this function:

Member Data Documentation

mBackgroundColorIndex

template<class ButtonBase >

int ThemedButtonWrapper< ButtonBase >::mBackgroundColorIndex { -1 }

private

Definition at line 102 of file ThemedWrappers.h.

Referenced by ThemedButtonWrapper< ButtonBase >::OnThemeChange(), and ThemedButtonWrapper< ButtonBase >::SetBackgroundColorIndex().

mBitmapIndex

template<class ButtonBase >

int ThemedButtonWrapper< ButtonBase >::mBitmapIndex { -1 }

private

Definition at line 97 of file ThemedWrappers.h.

Referenced by ThemedButtonWrapper< ButtonBase >::GetBitmapIndex(), ThemedButtonWrapper< ButtonBase >::OnThemeChange(), and ThemedButtonWrapper< ButtonBase >::SetBitmapIndex().

mCurrentBitmapIndex

template<class ButtonBase >

int ThemedButtonWrapper< ButtonBase >::mCurrentBitmapIndex { -1 }

private

Definition at line 101 of file ThemedWrappers.h.

Referenced by ThemedButtonWrapper< ButtonBase >::OnThemeChange(), and ThemedButtonWrapper< ButtonBase >::SetBitmapCurrentIndex().

mFocusBitmapIndex

template<class ButtonBase >

int ThemedButtonWrapper< ButtonBase >::mFocusBitmapIndex { -1 }

private

Definition at line 98 of file ThemedWrappers.h.

Referenced by ThemedButtonWrapper< ButtonBase >::OnThemeChange(), and ThemedButtonWrapper< ButtonBase >::SetBitmapFocusIndex().

mLabelBitmapIndex

template<class ButtonBase >

int ThemedButtonWrapper< ButtonBase >::mLabelBitmapIndex { -1 }

private

Definition at line 99 of file ThemedWrappers.h.

Referenced by ThemedButtonWrapper< ButtonBase >::OnThemeChange(), and ThemedButtonWrapper< ButtonBase >::SetBitmapLabelIndex().

mPressedBitmapIndex

template<class ButtonBase >

int ThemedButtonWrapper< ButtonBase >::mPressedBitmapIndex { -1 }

private

Definition at line 100 of file ThemedWrappers.h.

Referenced by ThemedButtonWrapper< ButtonBase >::OnThemeChange(), and ThemedButtonWrapper< ButtonBase >::SetBitmapPressedIndex().

mThemeChangeSubscription

template<class ButtonBase >

Observer::Subscription ThemedButtonWrapper< ButtonBase >::mThemeChangeSubscription

private

Definition at line 96 of file ThemedWrappers.h.

Referenced by ThemedButtonWrapper< ButtonBase >::ThemedButtonWrapper().

mTranslatableLabel

template<class ButtonBase >

std::optional<TranslatableString> ThemedButtonWrapper< ButtonBase >::mTranslatableLabel

private

Definition at line 103 of file ThemedWrappers.h.

Referenced by ThemedButtonWrapper< ButtonBase >::SetTranslatableLabel(), and ThemedButtonWrapper< ButtonBase >::UpdatePrefs().

---

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

• ThemedWrappers.h