Base class for all non updatable progress bars. More...

#include <BaseInfiniteProgressBar.h>

Inheritance diagram for gui_framework::BaseInfiniteProgressBar:

Public Member Functions
	BaseInfiniteProgressBar (const std::wstring &progressBarName, const utility::ComponentSettings &settings, BaseComposite *parent, int animationPeriod=NULL)

virtual void	playAnimation () final

virtual void	stopAnimation () final

virtual void	setAnimationPeriod (int animationPeriod) final

virtual int	getAnimationPeriod () const final

virtual void	setBackgroundColor (uint8_t red, uint8_t green, uint8_t blue) final override
	Same as setProgressBarBackgroundColor.

virtual void	setProgressBarBackgroundColor (uint8_t red, uint8_t green, uint8_t blue) final override
	Inherited from IProgressBarColor.

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

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

virtual json::JSONBuilder	getStructure () const override

virtual	~BaseInfiniteProgressBar ()=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)

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::IProgressBarColor
	IProgressBarColor (HWND progressBarHandle)

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

virtual COLORREF	getProgressBarBackgroundColor () const final

virtual COLORREF	getProgressBarColor () const final

virtual	~IProgressBarColor ()=default

Protected Attributes
int	animationPeriod

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

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::BaseComponent
virtual LRESULT	preWindowMessagesHandle (HWND handle, UINT message, WPARAM wparam, LPARAM lparam, bool &isUsed)

virtual LRESULT	windowMessagesHandle (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 non updatable progress bars.

Definition at line 9 of file BaseInfiniteProgressBar.h.

Constructor & Destructor Documentation

◆ BaseInfiniteProgressBar()

gui_framework::BaseInfiniteProgressBar::BaseInfiniteProgressBar	(	const std::wstring &	progressBarName,
		const utility::ComponentSettings &	settings,
		BaseComposite *	parent,
		int	animationPeriod = NULL )

Parameters

progressBarName
settings
parent
animationPeriod	Period between animation in milliseconds

Definition at line 10 of file BaseInfiniteProgressBar.cpp.

◆ ~BaseInfiniteProgressBar()

virtual gui_framework::BaseInfiniteProgressBar::~BaseInfiniteProgressBar ( )

virtualdefault

Member Function Documentation

◆ getAnimationPeriod()

int gui_framework::BaseInfiniteProgressBar::getAnimationPeriod ( ) const

finalvirtual

Definition at line 43 of file BaseInfiniteProgressBar.cpp.

◆ getHash()

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

overridepure virtual

Used as key in creators.

Returns: typeid().hash_code()

Implements gui_framework::BaseComponent.

Implemented in gui_framework::InfiniteProgressBar.

◆ getStructure()

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

overridevirtual

Reimplemented from gui_framework::BaseComponent.

Reimplemented in gui_framework::InfiniteProgressBar.

Definition at line 67 of file BaseInfiniteProgressBar.cpp.

◆ playAnimation()

void gui_framework::BaseInfiniteProgressBar::playAnimation ( )

finalvirtual

Definition at line 28 of file BaseInfiniteProgressBar.cpp.

◆ setAnimationPeriod()

void gui_framework::BaseInfiniteProgressBar::setAnimationPeriod ( int animationPeriod )

finalvirtual

Parameters

animationPeriod Period between animation in milliseconds

Definition at line 38 of file BaseInfiniteProgressBar.cpp.

◆ setBackgroundColor()

void gui_framework::BaseInfiniteProgressBar::setBackgroundColor	(	uint8_t	red,
		uint8_t	green,
		uint8_t	blue )

finaloverridevirtual

Same as setProgressBarBackgroundColor.

Parameters

red
green
blue

Reimplemented from gui_framework::BaseComponent.

Definition at line 48 of file BaseInfiniteProgressBar.cpp.

◆ setProgressBarBackgroundColor()

void gui_framework::BaseInfiniteProgressBar::setProgressBarBackgroundColor	(	uint8_t	red,
		uint8_t	green,
		uint8_t	blue )

finaloverridevirtual

Inherited from IProgressBarColor.

Parameters

red
green
blue

Reimplemented from gui_framework::interfaces::IProgressBarColor.

Definition at line 55 of file BaseInfiniteProgressBar.cpp.

◆ setTextColor()

void gui_framework::BaseInfiniteProgressBar::setTextColor	(	uint8_t	red,
		uint8_t	green,
		uint8_t	blue )

finaloverridevirtual

Not implemented.

Parameters

red
green
blue

Exceptions

NotImplemented Text color does not affects at progress bar

Reimplemented from gui_framework::BaseComponent.

Definition at line 62 of file BaseInfiniteProgressBar.cpp.

◆ stopAnimation()

void gui_framework::BaseInfiniteProgressBar::stopAnimation ( )

finalvirtual

Definition at line 33 of file BaseInfiniteProgressBar.cpp.

Member Data Documentation

◆ animationPeriod

int gui_framework::BaseInfiniteProgressBar::animationPeriod

protected

Definition at line 14 of file BaseInfiniteProgressBar.h.

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

GUIFramework/src/BaseComponents/StandardComponents/ProgressBars/BaseInfiniteProgressBar.h
GUIFramework/src/BaseComponents/StandardComponents/ProgressBars/BaseInfiniteProgressBar.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BaseInfiniteProgressBar()

◆ ~BaseInfiniteProgressBar()

Member Function Documentation

◆ getAnimationPeriod()

◆ getHash()

◆ getStructure()

◆ playAnimation()

◆ setAnimationPeriod()

◆ setBackgroundColor()

◆ setProgressBarBackgroundColor()

◆ setTextColor()

◆ stopAnimation()

Member Data Documentation

◆ animationPeriod