Image List Skin. More...

#include <SSkin.h>

Inheritance diagram for SSkinImgList:

Public Member Functions
	SSkinImgList ()
	Constructor for SSkinImgList.

virtual	~SSkinImgList ()
	Destructor for SSkinImgList.

SIZE	GetSkinSize () SCONST OVERRIDE
	Gets the size of the skin.

int	GetStates () SCONST OVERRIDE
	Gets the number of states in the skin.

void	OnColorize (COLORREF cr) OVERRIDE
	Handles colorization of the skin.

virtual void	SetStates (int nStates)
	Sets the number of states in the skin.

virtual bool	SetImage (IBitmapS *pImg)
	Sets the image for the skin.

virtual IBitmapS *	GetImage () const
	Gets the image used by the skin.

virtual void	SetTile (BOOL bTile)
	Sets whether the image should be tiled.

virtual BOOL	IsTile () const
	Checks if the image is tiled.

virtual void	SetVertical (BOOL bVertical)
	Sets whether the images are arranged vertically.

virtual BOOL	IsVertical () const
	Checks if the images are arranged vertically.

Public Member Functions inherited from SSkinObjBase
	SSkinObjBase ()
	Constructor.

LPCWSTR	GetName () SCONST OVERRIDE
	Gets the name of the skin object.

void	DrawByState2 (IRenderTarget *pRT, LPCRECT rcDraw, DWORD dwState, BYTE byAlpha) SCONST OVERRIDE
	Draws the skin by state with alpha blending.

void	DrawByState (IRenderTarget *pRT, LPCRECT rcDraw, DWORD dwState) SCONST OVERRIDE
	Draws the skin by state without alpha blending.

void	DrawByIndex2 (IRenderTarget *pRT, LPCRECT rcDraw, int iState, BYTE byAlpha) SCONST OVERRIDE
	Draws the skin by index with alpha blending.

void	DrawByIndex (IRenderTarget *pRT, LPCRECT rcDraw, int iState) SCONST OVERRIDE
	Draws the skin by index without alpha blending.

SIZE	GetSkinSize () SCONST OVERRIDE
	Gets the size of the skin.

int	GetStates () SCONST OVERRIDE
	Gets the number of states supported by the skin.

BYTE	GetAlpha () SCONST OVERRIDE
	Gets the alpha value of the skin.

void	SetAlpha (BYTE byAlpha) OVERRIDE
	Sets the alpha value of the skin.

int	GetScale () SCONST OVERRIDE
	Gets the scale factor of the skin.

void	SetScale (int scale) OVERRIDE
	Sets the scale factor of the skin.

ISkinObj *	Scale (int nScale) OVERRIDE
	Scales the skin.

void	OnColorize (COLORREF cr) OVERRIDE
	Applies colorization to the skin.

int	State2Index (DWORD dwState) const
	Converts a state to its corresponding index.

Public Member Functions inherited from TObjRefImpl< SObjectImpl< ISkinObj > >
	TObjRefImpl ()
	Constructor that initializes the reference count to 1.

virtual	~TObjRefImpl ()
	Virtual destructor.

long	AddRef () override
	Increments the reference count.

long	Release () override
	Decrements the reference count and deletes the object if the count reaches zero.

void	OnFinalRelease () override
	Deletes the object.

Public Member Functions inherited from SObjectImpl< ISkinObj >
	SObjectImpl ()
	Constructor.

BOOL	InitFromXml (IXmlNode *pXmlNode) OVERRIDE
	Initializes the object from an XML node.

LPCWSTR	GetName () SCONST OVERRIDE
	Retrieves the object's name.

LPCSTR	GetNameA () SCONST OVERRIDE
	Retrieves the object's name in ANSI format.

void	SetName (LPCWSTR pszName) OVERRIDE
	Sets the object's name.

int	GetID () SCONST OVERRIDE
	Retrieves the object's ID.

void	SetID (int nID) OVERRIDE
	Sets the object's ID.

HRESULT	AfterAttribute (LPCWSTR strAttribName, LPCWSTR strValue, BOOL bLoading, HRESULT hr) OVERRIDE
	Handles attribute processing after setting an attribute.

HRESULT	SetAttributeA (LPCSTR pszAttr, LPCSTR pszValue, BOOL bLoading) OVERRIDE
	Sets an attribute using ANSI strings.

HRESULT	SetAttribute (LPCWSTR pszAttr, LPCWSTR pszValue, BOOL bLoading) OVERRIDE
	Sets an attribute using wide strings.

virtual HRESULT	SetAttribute (const SStringW &strAttr, const SStringW &strValue, BOOL bLoading)
	Sets an attribute using wide strings.

HRESULT	ISetAttribute (const IStringW strAttr, const IStringW strValue, BOOL bLoading) OVERRIDE
	Sets an attribute using IStringW objects.

LPCWSTR	GetObjectClass () SCONST OVERRIDE
	Retrieves the object's class name.

int	GetObjectType () SCONST OVERRIDE
	Retrieves the object's type.

BOOL	IsClass (LPCWSTR lpszName) SCONST OVERRIDE
	Checks if the object is of a specific class.

BOOL	GetAttribute (LPCWSTR strAttr, IStringW *pValue) SCONST OVERRIDE
	Retrieves an attribute value.

void	OnInitFinished (IXmlNode *xmlNode) OVERRIDE
	Handles initialization completion.

void	SetAttrHandler (FunAttrHandler attrHandler) OVERRIDE
	Sets the attribute handler.

virtual HRESULT	DefAttributeProc (const SStringW &strAttr, const SStringW &strValue, BOOL bLoading)
	Default attribute processing.

Public Member Functions inherited from ISkinObj
long	AddRef () PURE
	Add reference.

long	Release () PURE
	Release reference.

void	OnFinalRelease () PURE
	Final release of the object.

BOOL	IsClass (LPCWSTR lpszName) SCONST PURE
	Checks if the object is of a specified class type.

LPCWSTR	GetObjectClass () SCONST PURE
	Retrieves the class name of the object.

int	GetObjectType () SCONST PURE
	Retrieves the type of the object.

int	GetID () SCONST PURE
	Retrieves the ID of the object.

void	SetID (int nID) PURE
	Sets the ID of the object.

LPCWSTR	GetName () SCONST PURE
	Retrieves the name of the object.

LPCSTR	GetNameA () SCONST PURE
	Retrieves the name of the object as an ANSI string.

void	SetName (LPCWSTR pszName) PURE
	Sets the name of the object.

BOOL	InitFromXml (IXmlNode *xmlNode) PURE
	Initializes the object from an XML node.

void	OnInitFinished (IXmlNode *xmlNode) PURE
	Handles the completion of attribute initialization.

HRESULT	ISetAttribute (const IStringW strAttribName, const IStringW strValue, BOOL bLoading) PURE
	Sets an attribute of the object.

HRESULT	SetAttributeA (LPCSTR pszAttr, LPCSTR pszValue, BOOL bLoading=FALSE) PURE
	Sets an attribute of the object using ANSI strings.

HRESULT	SetAttribute (LPCWSTR pszAttr, LPCWSTR pszValue, BOOL bLoading=FALSE) PURE
	Sets an attribute of the object using wide strings.

BOOL	GetAttribute (LPCWSTR strAttr, IStringW *pValue) SCONST PURE
	Retrieves the value of an attribute by its name.

HRESULT	AfterAttribute (LPCWSTR pszAttr, LPCWSTR pszValue, BOOL bLoading, HRESULT hr) PURE
	Handles the completion of attribute processing.

void	SetAttrHandler (FunAttrHandler attrHandler) PURE
	Sets the attribute handler callback function.

void	DrawByState2 (IRenderTarget *pRT, LPCRECT rcDraw, DWORD dwState, BYTE byAlpha) SCONST PURE
	Draws the skin object to the specified render target with a given state and transparency.

void	DrawByState (IRenderTarget *pRT, LPCRECT rcDraw, DWORD dwState) SCONST PURE
	Draws the skin object to the specified render target with a given state.

void	DrawByIndex2 (IRenderTarget *pRT, LPCRECT rcDraw, int iState, BYTE byAlpha) SCONST PURE
	Draws the skin object to the specified render target with a given index and transparency.

void	DrawByIndex (IRenderTarget *pRT, LPCRECT rcDraw, int iState) SCONST PURE
	Draws the skin object to the specified render target with a given index.

SIZE	GetSkinSize () SCONST PURE
	Retrieves the default size of the skin object.

int	GetStates () SCONST PURE
	Retrieves the number of states contained in the skin object.

BYTE	GetAlpha () SCONST PURE
	Retrieves the transparency of the skin object.

void	SetAlpha (BYTE byAlpha) PURE
	Sets the transparency of the skin object.

void	OnColorize (COLORREF cr) PURE
	Adjusts the hue of the skin object based on a reference color.

int	GetScale () SCONST PURE
	Retrieves the scaling factor of the skin object.

void	SetScale (int scale) PURE
	Sets the scaling factor of the skin object.

ISkinObj *	Scale (int nScale) PURE
	Scales the skin object by a specified factor.

Protected Member Functions
virtual UINT	GetExpandMode () const
	Gets the expand mode for the skin.

void	OnInitFinished (IXmlNode *pNode) OVERRIDE
	Called when initialization is finished.

void	_DrawByIndex (IRenderTarget *pRT, LPCRECT rcDraw, int iState, BYTE byAlpha) const override
	Draws the skin by index.

void	_Scale (ISkinObj *skinObj, int nScale) override
	Scales the skin.

HRESULT	OnAttrSrc (const SStringW &value, BOOL bLoading)
	Handles the 'src' attribute.

virtual HRESULT	SetAttribute (const SNS::SStringW &amp;amp;amp;strAttribName, const SNS::SStringW &amp;amp;amp;strValue, BOOL bLoading=FALSE)

Protected Member Functions inherited from SSkinObjBase
void	OnInitFinished (IXmlNode *pNode) OVERRIDE
	Called when initialization is finished.

virtual void	_DrawByState (IRenderTarget *pRT, LPCRECT rcDraw, DWORD dwState, BYTE byAlpha) const
	Draws the skin by state with alpha blending.

Protected Attributes
int	m_nStates

BOOL	m_bTile

BOOL	m_bAutoFit

BOOL	m_bVertical

SAutoRefPtr< IBitmapS >	m_imgBackup

FilterLevel	m_filterLevel

SAutoRefPtr< IBitmapS >	m_pImg

SStringW	m_strSrc

BOOL	m_bLazyLoad

Protected Attributes inherited from SSkinObjBase
BYTE	m_byAlpha

COLORREF	m_crColorize

bool	m_bEnableColorize

int	m_nScale

bool	m_bEnableScale

bool	m_checkAsPushdown

SState2Index	m_state2Index

Protected Attributes inherited from TObjRefImpl< SObjectImpl< ISkinObj > >
LONG	m_cRef
	Reference count.

Protected Attributes inherited from SObjectImpl< ISkinObj >
SStringW	m_strName

int	m_nID

FunAttrHandler	m_attrHandler

Additional Inherited Members
Static Public Member Functions inherited from SObjectImpl< ISkinObj >
static int	GetClassType ()
	Retrieves the class type.

static LPCWSTR	GetClassName ()
	Retrieves the class name.

static LPCWSTR	GetClassAlias ()
	Retrieves the class alias.

static void	MarkAttributeHandled (SXmlAttr xmlAttr, bool bHandled)
	Marks an attribute as handled.

static bool	IsAttributeHandled (SXmlAttr xmlAttr)
	Checks if an attribute is handled.

Detailed Description

Image List Skin.

Description: Represents a skin that uses an image list to display different states.

Definition at line 31 of file SSkin.h.

Constructor & Destructor Documentation

◆ SSkinImgList()

SNSBEGIN SSkinImgList::SSkinImgList ( )

Constructor for SSkinImgList.

Definition at line 12 of file SSkin.cpp.

◆ ~SSkinImgList()

SSkinImgList::~SSkinImgList ( )

virtual

Destructor for SSkinImgList.

Definition at line 22 of file SSkin.cpp.

Member Function Documentation

◆ _DrawByIndex()

void SSkinImgList::_DrawByIndex	(	IRenderTarget *	pRT,
		LPCRECT	rcDraw,
		int	iState,
		BYTE	byAlpha ) const

overrideprotectedvirtual

Draws the skin by index.

Parameters

pRT	Pointer to the render target.
rcDraw	Rectangle to draw in.
iState	State index.
byAlpha	Alpha value for transparency.

Implements SSkinObjBase.

Reimplemented in SSkinScrollbar.

Definition at line 52 of file SSkin.cpp.

◆ _Scale()

void SSkinImgList::_Scale	(	ISkinObj *	skinObj,
		int	nScale )

overrideprotectedvirtual

Scales the skin.

Parameters

skinObj	Pointer to the skin object.
nScale	Scale factor.

Reimplemented from SSkinObjBase.

Reimplemented in SSkinScrollbar.

Definition at line 136 of file SSkin.cpp.

◆ GetExpandMode()

UINT SSkinImgList::GetExpandMode ( ) const

protectedvirtual

Gets the expand mode for the skin.

Returns: Expand mode.

Reimplemented in SSkinImgFrame.

Definition at line 65 of file SSkin.cpp.

◆ GetImage()

IBitmapS * SSkinImgList::GetImage ( ) const

virtual

Gets the image used by the skin.

Returns: Pointer to the bitmap source.

Definition at line 94 of file SSkin.cpp.

◆ GetSkinSize()

SIZE SSkinImgList::GetSkinSize ( )

Gets the size of the skin.

Returns: Size of the skin.

Definition at line 26 of file SSkin.cpp.

◆ GetStates()

int SSkinImgList::GetStates ( )

Gets the number of states in the skin.

Returns: Number of states.

Definition at line 38 of file SSkin.cpp.

◆ IsTile()

virtual BOOL SSkinImgList::IsTile ( ) const

inlinevirtual

Checks if the image is tiled.

Returns: TRUE if tiled, FALSE otherwise.

Definition at line 98 of file SSkin.h.

◆ IsVertical()

virtual BOOL SSkinImgList::IsVertical ( ) const

inlinevirtual

Checks if the images are arranged vertically.

Returns: TRUE if vertical, FALSE otherwise.

Definition at line 116 of file SSkin.h.

◆ OnAttrSrc()

HRESULT SSkinImgList::OnAttrSrc	(	const SStringW &	value,
		BOOL	bLoading )

protected

Handles the 'src' attribute.

Parameters

value	Source string.
bLoading	TRUE if loading, FALSE otherwise.

Returns: Result of the attribute handling.

Definition at line 73 of file SSkin.cpp.

◆ OnColorize()

void SSkinImgList::OnColorize ( COLORREF cr )

Handles colorization of the skin.

Parameters

cr	Color reference for colorization.

Definition at line 106 of file SSkin.cpp.

◆ OnInitFinished()

void SSkinImgList::OnInitFinished ( IXmlNode * pNode )

protected

Called when initialization is finished.

Parameters

pNode Pointer to the XML node.

Definition at line 43 of file SSkin.cpp.

◆ SetAttribute()

virtual HRESULT SSkinImgList::SetAttribute	(	const SNS::SStringW &amp;amp;amp;	strAttribName,
		const SNS::SStringW &amp;amp;amp;	strValue,
		BOOL	bLoading = FALSE )

inlineprotectedvirtual

Reimplemented from SSkinObjBase.

Definition at line 173 of file SSkin.h.

◆ SetImage()

bool SSkinImgList::SetImage ( IBitmapS * pImg )

virtual

Sets the image for the skin.

Parameters

pImg	Pointer to the bitmap source.

Returns: TRUE if successful, FALSE otherwise.

Definition at line 86 of file SSkin.cpp.

◆ SetStates()

virtual void SSkinImgList::SetStates ( int nStates )

inlinevirtual

Sets the number of states in the skin.

Parameters

nStates Number of states.

Definition at line 67 of file SSkin.h.

◆ SetTile()

virtual void SSkinImgList::SetTile ( BOOL bTile )

inlinevirtual

Sets whether the image should be tiled.

Parameters

bTile TRUE to tile the image, FALSE otherwise.

Definition at line 89 of file SSkin.h.

◆ SetVertical()

virtual void SSkinImgList::SetVertical ( BOOL bVertical )

inlinevirtual

Sets whether the images are arranged vertically.

Parameters

bVertical TRUE for vertical arrangement, FALSE for horizontal.

Definition at line 107 of file SSkin.h.

Member Data Documentation

◆ m_bAutoFit

BOOL SSkinImgList::m_bAutoFit

protected

Definition at line 154 of file SSkin.h.

◆ m_bLazyLoad

BOOL SSkinImgList::m_bLazyLoad

protected

Definition at line 162 of file SSkin.h.

◆ m_bTile

BOOL SSkinImgList::m_bTile

protected

Definition at line 153 of file SSkin.h.

◆ m_bVertical

BOOL SSkinImgList::m_bVertical

protected

Definition at line 155 of file SSkin.h.

◆ m_filterLevel

FilterLevel SSkinImgList::m_filterLevel

protected

Definition at line 157 of file SSkin.h.

◆ m_imgBackup

SAutoRefPtr<IBitmapS> SSkinImgList::m_imgBackup

protected

Definition at line 156 of file SSkin.h.

◆ m_nStates

int SSkinImgList::m_nStates

protected

Definition at line 152 of file SSkin.h.

◆ m_pImg

SAutoRefPtr<IBitmapS> SSkinImgList::m_pImg

mutableprotected

Definition at line 160 of file SSkin.h.

◆ m_strSrc

SStringW SSkinImgList::m_strSrc

mutableprotected

Definition at line 161 of file SSkin.h.

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

SOUI/include/core/SSkin.h
SOUI/src/core/SSkin.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SSkinImgList()

◆ ~SSkinImgList()

Member Function Documentation

◆ _DrawByIndex()

◆ _Scale()

◆ GetExpandMode()

◆ GetImage()

◆ GetSkinSize()

◆ GetStates()

◆ IsTile()

◆ IsVertical()

◆ OnAttrSrc()

◆ OnColorize()

◆ OnInitFinished()

◆ SetAttribute()

◆ SetImage()

◆ SetStates()

◆ SetTile()

◆ SetVertical()

Member Data Documentation

◆ m_bAutoFit

◆ m_bLazyLoad

◆ m_bTile

◆ m_bVertical

◆ m_filterLevel

◆ m_imgBackup

◆ m_nStates

◆ m_pImg

◆ m_strSrc