CApplicationSkinHandling Class Reference

Class handling application support for skin management. More...

#include <ApplicationSkinHandling.h>

Inheritance diagram for CApplicationSkinHandling:

Public Member Functions
	CApplicationSkinHandling (IMsgTargetCallback *msgCb, IWindowManagerCallback *wCb, bool &bInitializing)
void	UnloadSkin ()
void	OnSettingChanged (const std::shared_ptr< const CSetting > &setting) override
	The value of the given setting has changed.
void	ReloadSkin (bool confirm=false)
bool	LoadSkin (const std::string &skinID)
Public Member Functions inherited from IApplicationComponent
virtual	~IApplicationComponent ()=default
Public Member Functions inherited from ISettingCallback
virtual	~ISettingCallback ()=default
virtual bool	OnSettingChanging (const std::shared_ptr< const CSetting > &setting)
	The value of the given setting is being changed.
virtual void	OnSettingAction (const std::shared_ptr< const CSetting > &setting)
	The given setting has been activated.
virtual bool	OnSettingUpdate (const std::shared_ptr< CSetting > &setting, const char *oldSettingId, const TiXmlNode *oldSettingNode)
	The given setting needs to be updated.
virtual void	OnSettingPropertyChanged (const std::shared_ptr< const CSetting > &setting, const char *propertyName)
	The given property of the given setting has changed.

Protected Member Functions
bool	LoadCustomWindows ()
void	ProcessSkin () const
	Called by the application main/render thread for processing operations belonging to the skin.
void	ProcessPendingSkinReload ()
	Run a skin reload that was deferred out of a nested render loop.

Protected Attributes
bool	m_saveSkinOnUnloading = true
bool	m_confirmSkinChange = true
bool	m_ignoreSkinSettingChanges = false
bool	m_pendingSkinReload = false
bool	m_pendingSkinReloadConfirm = false
IMsgTargetCallback *	m_msgCb
IWindowManagerCallback *	m_wCb
bool &	m_bInitializing

Friends
class	CApplication

Detailed Description

Class handling application support for skin management.

Constructor & Destructor Documentation

CApplicationSkinHandling()

CApplicationSkinHandling::CApplicationSkinHandling	(	IMsgTargetCallback *	msgCb,
		IWindowManagerCallback *	wCb,
		bool &	bInitializing )

Member Function Documentation

LoadCustomWindows()

bool CApplicationSkinHandling::LoadCustomWindows ( )

protected

LoadSkin()

bool CApplicationSkinHandling::LoadSkin

(

const std::string &

skinID

)

Todo

Move skin language files to resources/language/ to match other addon structure

OnSettingChanged()

void CApplicationSkinHandling::OnSettingChanged ( const std::shared_ptr< const CSetting > & setting )

overridevirtual

The value of the given setting has changed.

This callback is triggered whenever the value of a setting has been successfully changed (i.e. none of the OnSettingChanging() handlers) has reverted the change.

Parameters

setting

The setting whose value has been changed

Reimplemented from ISettingCallback.

ProcessPendingSkinReload()

void CApplicationSkinHandling::ProcessPendingSkinReload ( )

protected

Run a skin reload that was deferred out of a nested render loop.

Does nothing unless a reload is pending and the render loop has unwound.

ProcessSkin()

void CApplicationSkinHandling::ProcessSkin ( ) const

protected

Called by the application main/render thread for processing operations belonging to the skin.

ReloadSkin()

void CApplicationSkinHandling::ReloadSkin

(

bool

confirm = false

)

UnloadSkin()

void CApplicationSkinHandling::UnloadSkin

(

)

Friends And Related Symbol Documentation

CApplication

friend class CApplication

friend

Member Data Documentation

m_bInitializing

bool& CApplicationSkinHandling::m_bInitializing

protected

m_confirmSkinChange

bool CApplicationSkinHandling::m_confirmSkinChange = true

protected

m_ignoreSkinSettingChanges

bool CApplicationSkinHandling::m_ignoreSkinSettingChanges = false

protected

m_msgCb

IMsgTargetCallback* CApplicationSkinHandling::m_msgCb

protected

m_pendingSkinReload

bool CApplicationSkinHandling::m_pendingSkinReload = false

protected

m_pendingSkinReloadConfirm

bool CApplicationSkinHandling::m_pendingSkinReloadConfirm = false

protected

m_saveSkinOnUnloading

bool CApplicationSkinHandling::m_saveSkinOnUnloading = true

protected

m_wCb

IWindowManagerCallback* CApplicationSkinHandling::m_wCb

protected

---

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

• ApplicationSkinHandling.h
• ApplicationSkinHandling.cpp