Standard updatable progress bar. More...

#include <ProgressBar.h>

Inheritance diagram for gui_framework::ProgressBar:

Public Member Functions
	ProgressBar (const std::wstring &progressBarName, const utility::ComponentSettings &settings, BaseComposite *parent, int minRange=defaultMinRange, int maxRange=defaultMaxRange, int updateStep=defaultUpdateStep)

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

json::JSONBuilder	getStructure () const override

	~ProgressBar ()=default

Public Member Functions inherited from gui_framework::BaseProgressBar
	BaseProgressBar (const std::wstring &progressBarName, const utility::ComponentSettings &settings, BaseComposite *parent, int minRange=defaultMinRange, int maxRange=defaultMaxRange, int updateStep=defaultUpdateStep)

virtual void	update (int newPosition) final

virtual void	update () final

virtual void	advancePosition (int position) final

virtual void	setMinRange (int minRange) final

virtual void	setMaxRange (int maxRange) final

virtual void	setUpdateStep (int updateStep) final

virtual int	getMinRange () const final

virtual int	getMaxRange () const final

virtual int	getUpdateStep () 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	~BaseProgressBar ()=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

Public Member Functions inherited from gui_framework::interfaces::IResizableComponent
	IResizableComponent (HWND resizeableHandle, HWND parent, bool autoResize=false, bool blockResize=false)

virtual void	resize (uint16_t width, uint16_t height)
	Resize component.

virtual RECT	calculateNewSizes (uint16_t width, uint16_t height) final

virtual void	setBlockResize (bool blockResize) final

virtual void	setAutoResize (bool autoResize) final

virtual bool	getBlockResize () const final

virtual bool	getAutoResize () const final

virtual	~IResizableComponent ()=default

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 ()

Static Public Attributes inherited from gui_framework::BaseProgressBar
static constexpr int	defaultUpdateStep = 10

static constexpr int	defaultMinRange = 0

static constexpr int	defaultMaxRange = 100

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.

Protected Attributes inherited from gui_framework::BaseProgressBar
int	minRange

int	maxRange

int	updateStep

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::IResizableComponent
bool	blockResize

bool	autoResize

int	initX

int	initY

uint16_t	initWidth

uint16_t	initHeight

uint16_t	parentWidth

uint16_t	parentHeight

Detailed Description

Standard updatable progress bar.

Definition at line 9 of file ProgressBar.h.

Constructor & Destructor Documentation

◆ ProgressBar()

gui_framework::ProgressBar::ProgressBar	(	const std::wstring &	progressBarName,
		const utility::ComponentSettings &	settings,
		BaseComposite *	parent,
		int	minRange = defaultMinRange,
		int	maxRange = defaultMaxRange,
		int	updateStep = defaultUpdateStep )

Definition at line 9 of file ProgressBar.cpp.

◆ ~ProgressBar()

gui_framework::ProgressBar::~ProgressBar ( )

default

Member Function Documentation

◆ getHash()

size_t gui_framework::ProgressBar::getHash ( ) const

overridevirtual

Used as key in creators.

Returns: typeid().hash_code()

Implements gui_framework::BaseProgressBar.

Definition at line 28 of file ProgressBar.cpp.

◆ getStructure()

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

overridevirtual

Reimplemented from gui_framework::BaseProgressBar.

Definition at line 33 of file ProgressBar.cpp.

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

GUIFramework/src/Components/ProgressBars/ProgressBar.h
GUIFramework/src/Components/ProgressBars/ProgressBar.cpp

Public Member Functions