Base class for all check boxes. More...

#include <BaseCheckBox.h>

Inheritance diagram for gui_framework::BaseCheckBox:

Public Member Functions
	BaseCheckBox (const std::wstring &checkBoxName, const std::wstring &checkBoxText, const utility::ComponentSettings &settings, BaseComposite *parent, const std::function< void()> &onCheck, const std::function< void()> &onClear, const std::function< void()> &onClick=nullptr)

void	setOnCheck (const std::function< void()> &onCheck)

void	setOnCheck (const std::string &functionName, const std::string &moduleName)

void	setOnClear (const std::function< void()> &onClear)

void	setOnClear (const std::string &functionName, const std::string &moduleName)

const std::function< void()> &	getOnCheck () const

const std::function< void()> &	getOnClear () const

virtual size_t	getHash () const override=0
	Used as key in creators.

virtual json::JSONBuilder	getStructure () const override

virtual	~BaseCheckBox ()=default

Public Member Functions inherited from gui_framework::BaseButton
	BaseButton (const std::wstring &buttonName, const std::wstring &buttonText, const utility::ComponentSettings &settings, const styles::ButtonStyles &styles, BaseComposite *parent, const std::function< void()> &onClick=nullptr)

	BaseButton (const std::wstring &buttonName, const std::wstring &buttonText, const utility::ComponentSettings &settings, const styles::ButtonStyles &styles, BaseComposite *parent, const std::string &functionName, const std::string &moduleName)

void	setOnClick (const std::function< void()> &onClick)
	Can't serialize.

virtual void	setOnClick (const std::string &functionName, const std::string &moduleName)
	Load function from module. Can be seriazlied.

const std::function< void()> &	getOnClick () const

const std::string &	getFunctionName () const
	Get onClick function name from loaded module.

const std::string &	getModuleName () const
	Get onClick function associated module name.

virtual void	setTextColor (uint8_t red, uint8_t green, uint8_t blue) final override
	Not implemented.

virtual void	setText (std::string_view localizationKey) final override

virtual	~BaseButton ()=default

Public Member Functions inherited from gui_framework::interfaces::ISingleTextLocalized
	ISingleTextLocalized (bool autoUpdate=true)

virtual void	setLocalizationKey (std::string_view localizationKey) final

virtual void	setLocalizationKey (std::string &&localizationKey) noexcept final

virtual const std::string &	getLocalizationKey () const final

virtual bool	updateLocalizationEvent () final override

virtual	~ISingleTextLocalized ()=default

Public Member Functions inherited from gui_framework::interfaces::ITextLocalized
	ITextLocalized (bool autoUpdate=true)

virtual void	setAutoUpdate (bool autoUpdate) final

virtual bool	getAutoUpdate () const final

virtual	~ITextLocalized ()=default

Public Member Functions inherited from gui_framework::BaseComponent
	BaseComponent (std::wstring_view className, std::wstring_view windowName, const utility::ComponentSettings &settings, const interfaces::IStyles &styles, BaseComposite *parent=nullptr, std::string_view windowFunctionName="", std::string_view moduleName="", uint16_t smallIconResource=NULL, uint16_t largeIconResource=NULL)

LRESULT	handleMessages (HWND handle, UINT message, WPARAM wparam, LPARAM lparam, bool &isUsed)

bool	destroyComponent ()

bool	asyncDestroyComponent ()

void	enable ()

void	disable ()

bool	isEnabled () const

bool	isDisabled () const

LRESULT	sendRawMessage (UINT message, WPARAM wparam, LPARAM lparam)
	SendMessage WinAPI wrapper.

void	setDesiredWidth (uint16_t desiredWidth)

void	setDesiredHeight (uint16_t desiredHeight)

void	setDesiredX (int desiredX)

void	setDesiredY (int desiredY)

virtual void	setBackgroundColor (uint8_t red, uint8_t green, uint8_t blue)

BaseComponent *	getParent () const

HWND	getHandle () const

std::wstring_view	getWindowName () const

std::wstring_view	getClassName () const

uint16_t	getDesiredWidth () const

uint16_t	getDesiredHeight () const

uint16_t	getActualWidth () const

uint16_t	getActualHeight () const

RECT	getActualCoordinates () const

int	getDesiredX () const

int	getDesiredY () const

uint32_t	getId () const

COLORREF	getBackgroundColor () const

COLORREF	getTextColor () const

const smartPointerType< interfaces::IStyles > &	getStyles () const

virtual	~BaseComponent ()

Public Member Functions inherited from gui_framework::interfaces::ISerializable
	ISerializable ()=default

virtual	~ISerializable ()=default

Public Member Functions inherited from gui_framework::interfaces::ITextOperations
	ITextOperations (HWND handle, const std::wstring &text=L"")

	ITextOperations (HWND handle, const std::string &localizationKey)

void	setText (std::wstring_view text)

virtual std::wstring	getText () const final
	Get text from control.

virtual	~ITextOperations ()=default

Static Public Attributes
static constexpr uint16_t	checkBoxWidth = 200

static constexpr uint16_t	checkBoxHeight = 20

Static Public Attributes inherited from gui_framework::BaseButton
static constexpr uint16_t	buttonWidth = 200

static constexpr uint16_t	buttonHeight = 20

Protected Attributes
std::function< void()>	onCheck

std::function< void()>	onClear

std::string	onCheckFunctionName

std::string	onCheckModuleName

std::string	onClearFunctionName

std::string	onClearModuleName

Protected Attributes inherited from gui_framework::BaseButton
std::function< void()>	onClick

std::string	functionName

std::string	moduleName

Protected Attributes inherited from gui_framework::BaseComponent
BaseComposite *	parent

const std::wstring	className

const std::wstring	windowName

HWND	handle

uint16_t	desiredWidth

uint16_t	desiredHeight

int	desiredX

int	desiredY

uint32_t	id

COLORREF	backgroundColor

COLORREF	textColor

smartPointerType< interfaces::IStyles >	styles

Protected Attributes inherited from gui_framework::interfaces::ITextOperations
HWND	textHandle

Additional Inherited Members
Static Public Member Functions inherited from gui_framework::BaseComponent
static void	runFunctionAsync (const std::function< void()> &callable, const std::function< void()> &callback=nullptr) noexcept
	Add task to thread pool.

static void	runFunctionAsync (std::function< void()> &&callable, const std::function< void()> &callback=nullptr) noexcept
	Add task to thread pool.

Static Public Member Functions inherited from gui_framework::interfaces::ISerializable
static uint32_t	getCodepage ()

Protected Member Functions inherited from gui_framework::BaseButton
virtual void	updateLocalization (std::wstring_view localizedText) override

Protected Member Functions inherited from gui_framework::interfaces::ISingleTextLocalized
Protected Member Functions inherited from gui_framework::BaseComponent
virtual LRESULT	preWindowMessagesHandle (HWND handle, UINT message, WPARAM wparam, LPARAM lparam, bool &isUsed)

virtual void	setLocalizationKeys (interfaces::ITextLocalized *localized, const std::vector< std::string > &localizationKeys)
	Override for custom localization.

Detailed Description

Base class for all check boxes.

Definition at line 8 of file BaseCheckBox.h.

Constructor & Destructor Documentation

◆ BaseCheckBox()

gui_framework::BaseCheckBox::BaseCheckBox	(	const std::wstring &	checkBoxName,
		const std::wstring &	checkBoxText,
		const utility::ComponentSettings &	settings,
		BaseComposite *	parent,
		const std::function< void()> &	onCheck,
		const std::function< void()> &	onClear,
		const std::function< void()> &	onClick = nullptr )

Definition at line 47 of file BaseCheckBox.cpp.

◆ ~BaseCheckBox()

virtual gui_framework::BaseCheckBox::~BaseCheckBox ( )

virtualdefault

Member Function Documentation

◆ getHash()

virtual size_t gui_framework::BaseCheckBox::getHash ( ) const

overridepure virtual

Used as key in creators.

Returns: typeid().hash_code()

Implements gui_framework::BaseButton.

Implemented in gui_framework::CheckBox.

◆ getOnCheck()

const function< void()> & gui_framework::BaseCheckBox::getOnCheck ( ) const

Definition at line 115 of file BaseCheckBox.cpp.

◆ getOnClear()

const function< void()> & gui_framework::BaseCheckBox::getOnClear ( ) const

Definition at line 120 of file BaseCheckBox.cpp.

◆ getStructure()

json::JSONBuilder gui_framework::BaseCheckBox::getStructure ( ) const

overridevirtual

Reimplemented from gui_framework::BaseButton.

Reimplemented in gui_framework::CheckBox.

Definition at line 125 of file BaseCheckBox.cpp.

◆ setOnCheck() [1/2]

void gui_framework::BaseCheckBox::setOnCheck ( const std::function< void()> & onCheck )

◆ setOnCheck() [2/2]

void gui_framework::BaseCheckBox::setOnCheck	(	const std::string &	functionName,
		const std::string &	moduleName )

◆ setOnClear() [1/2]

void gui_framework::BaseCheckBox::setOnClear ( const std::function< void()> & onClear )

◆ setOnClear() [2/2]

void gui_framework::BaseCheckBox::setOnClear	(	const std::string &	functionName,
		const std::string &	moduleName )

Member Data Documentation

◆ checkBoxHeight

uint16_t gui_framework::BaseCheckBox::checkBoxHeight = 20

inlinestaticconstexpr

Definition at line 12 of file BaseCheckBox.h.

◆ checkBoxWidth

uint16_t gui_framework::BaseCheckBox::checkBoxWidth = 200

inlinestaticconstexpr

Definition at line 11 of file BaseCheckBox.h.

◆ onCheck

std::function<void()> gui_framework::BaseCheckBox::onCheck

protected

Definition at line 15 of file BaseCheckBox.h.

◆ onCheckFunctionName

std::string gui_framework::BaseCheckBox::onCheckFunctionName

protected

Definition at line 17 of file BaseCheckBox.h.

◆ onCheckModuleName

std::string gui_framework::BaseCheckBox::onCheckModuleName

protected

Definition at line 18 of file BaseCheckBox.h.

◆ onClear

std::function<void()> gui_framework::BaseCheckBox::onClear

protected

Definition at line 16 of file BaseCheckBox.h.

◆ onClearFunctionName

std::string gui_framework::BaseCheckBox::onClearFunctionName

protected

Definition at line 19 of file BaseCheckBox.h.

◆ onClearModuleName

std::string gui_framework::BaseCheckBox::onClearModuleName

protected

Definition at line 20 of file BaseCheckBox.h.

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

GUIFramework/src/BaseComponents/StandardComponents/Buttons/BaseCheckBox.h
GUIFramework/src/BaseComponents/StandardComponents/Buttons/BaseCheckBox.cpp

Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BaseCheckBox()

◆ ~BaseCheckBox()

Member Function Documentation

◆ getHash()

◆ getOnCheck()

◆ getOnClear()

◆ getStructure()

◆ setOnCheck() [1/2]

◆ setOnCheck() [2/2]

◆ setOnClear() [1/2]

◆ setOnClear() [2/2]

Member Data Documentation

◆ checkBoxHeight

◆ checkBoxWidth

◆ onCheck

◆ onCheckFunctionName

◆ onCheckModuleName

◆ onClear

◆ onClearFunctionName

◆ onClearModuleName