castor3d::ButtonStyle Class Reference

#include <StyleButton.hpp>

Inheritance diagram for castor3d::ButtonStyle:

Collaboration diagram for castor3d::ButtonStyle:

Public Member Functions
	ButtonStyle (castor::String const &name, Scene *scene, Engine &engine, castor::String const &fontName)
	ButtonStyle (castor::String const &name, Engine &engine, castor::String const &fontName)
void	setTextMaterial (MaterialObs material)
void	setHighlightedBackgroundMaterial (MaterialObs material)
void	setHighlightedForegroundMaterial (MaterialObs material)
void	setHighlightedTextMaterial (MaterialObs material)
void	setPushedBackgroundMaterial (MaterialObs material)
void	setPushedForegroundMaterial (MaterialObs material)
void	setPushedTextMaterial (MaterialObs material)
void	setDisabledBackgroundMaterial (MaterialObs material)
void	setDisabledForegroundMaterial (MaterialObs material)
void	setDisabledTextMaterial (MaterialObs material)
void	setFont (castor::StringView value)
MaterialObs	getHighlightedBackgroundMaterial () const
MaterialObs	getHighlightedForegroundMaterial () const
MaterialObs	getHighlightedTextMaterial () const
MaterialObs	getPushedBackgroundMaterial () const
MaterialObs	getPushedForegroundMaterial () const
MaterialObs	getPushedTextMaterial () const
MaterialObs	getDisabledBackgroundMaterial () const
MaterialObs	getDisabledForegroundMaterial () const
MaterialObs	getDisabledTextMaterial () const
MaterialObs	getTextMaterial () const
castor::String const &	getFontName () const
Public Member Functions inherited from castor3d::ControlStyle
virtual C3D_API	~ControlStyle () noexcept=default
	ControlStyle (ControlType type, castor::String const &name, Scene *scene, Engine &engine, MouseCursor cursor=MouseCursor::eArrow)
void	setBackgroundMaterial (MaterialObs value)
void	setForegroundMaterial (MaterialObs value)
void	setCursor (MouseCursor value) noexcept
void	setBackgroundInvisible (bool value) noexcept
void	setForegroundInvisible (bool value) noexcept
bool	isBackgroundInvisible () const noexcept
bool	isForegroundInvisible () const noexcept
MaterialObs	getBackgroundMaterial () const noexcept
MaterialObs	getForegroundMaterial () const noexcept
ControlType	getType () const noexcept
MouseCursor	getCursor () const noexcept
Engine &	getEngine () const noexcept
bool	hasScene () const noexcept
Scene &	getScene () const noexcept
Public Member Functions inherited from castor::NamedBaseT< T >
	NamedBaseT (T name) noexcept
	Constructor.
T const &	getName () const noexcept
	Retrieves the name.
void	rename (T name) noexcept

Static Public Attributes
static ControlType constexpr	Type = ControlType::eButton

Additional Inherited Members
Protected Member Functions inherited from castor3d::ControlStyle
MaterialObs	doCreateMaterial (MaterialObs material, float offset, castor::String const &suffix) const
Protected Attributes inherited from castor::NamedBaseT< T >
T	m_name

Constructor & Destructor Documentation

ButtonStyle() [1/2]

castor3d::ButtonStyle::ButtonStyle ( castor::String const & name, Scene * scene, Engine & engine, castor::String const & fontName )

inline

ButtonStyle() [2/2]

castor3d::ButtonStyle::ButtonStyle ( castor::String const & name, Engine & engine, castor::String const & fontName )

inline

Member Function Documentation

getDisabledBackgroundMaterial()

MaterialObs castor3d::ButtonStyle::getDisabledBackgroundMaterial ( ) const

inline

getDisabledForegroundMaterial()

MaterialObs castor3d::ButtonStyle::getDisabledForegroundMaterial ( ) const

inline

getDisabledTextMaterial()

MaterialObs castor3d::ButtonStyle::getDisabledTextMaterial ( ) const

inline

getFontName()

castor::String const & castor3d::ButtonStyle::getFontName ( ) const

inline

getHighlightedBackgroundMaterial()

MaterialObs castor3d::ButtonStyle::getHighlightedBackgroundMaterial ( ) const

inline

getHighlightedForegroundMaterial()

MaterialObs castor3d::ButtonStyle::getHighlightedForegroundMaterial ( ) const

inline

getHighlightedTextMaterial()

MaterialObs castor3d::ButtonStyle::getHighlightedTextMaterial ( ) const

inline

getPushedBackgroundMaterial()

MaterialObs castor3d::ButtonStyle::getPushedBackgroundMaterial ( ) const

inline

getPushedForegroundMaterial()

MaterialObs castor3d::ButtonStyle::getPushedForegroundMaterial ( ) const

inline

getPushedTextMaterial()

MaterialObs castor3d::ButtonStyle::getPushedTextMaterial ( ) const

inline

getTextMaterial()

MaterialObs castor3d::ButtonStyle::getTextMaterial ( ) const

inline

setDisabledBackgroundMaterial()

void castor3d::ButtonStyle::setDisabledBackgroundMaterial ( MaterialObs material )

inline

setDisabledForegroundMaterial()

void castor3d::ButtonStyle::setDisabledForegroundMaterial ( MaterialObs material )

inline

setDisabledTextMaterial()

void castor3d::ButtonStyle::setDisabledTextMaterial ( MaterialObs material )

inline

setFont()

void castor3d::ButtonStyle::setFont ( castor::StringView value )

inline

setHighlightedBackgroundMaterial()

void castor3d::ButtonStyle::setHighlightedBackgroundMaterial ( MaterialObs material )

inline

setHighlightedForegroundMaterial()

void castor3d::ButtonStyle::setHighlightedForegroundMaterial ( MaterialObs material )

inline

setHighlightedTextMaterial()

void castor3d::ButtonStyle::setHighlightedTextMaterial ( MaterialObs material )

inline

setPushedBackgroundMaterial()

void castor3d::ButtonStyle::setPushedBackgroundMaterial ( MaterialObs material )

inline

setPushedForegroundMaterial()

void castor3d::ButtonStyle::setPushedForegroundMaterial ( MaterialObs material )

inline

setPushedTextMaterial()

void castor3d::ButtonStyle::setPushedTextMaterial ( MaterialObs material )

inline

setTextMaterial()

void castor3d::ButtonStyle::setTextMaterial ( MaterialObs material )

inline

Member Data Documentation

Type

ControlType constexpr castor3d::ButtonStyle::Type = ControlType::eButton

staticconstexpr

---

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

• Castor3D/Gui/Theme/StyleButton.hpp