GUIFramework 1.1.0
Framework for desktop GUI applications in C++.
Loading...
Searching...
No Matches
gui_framework::BaseProgressBar Class Referenceabstract

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

#include <BaseProgressBar.h>

Inheritance diagram for gui_framework::BaseProgressBar:
gui_framework::BaseComponent gui_framework::interfaces::IProgressBarColor gui_framework::interfaces::ISerializable gui_framework::ProgressBar

Public Member Functions

 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 size_t getHash () const override=0
 Used as key in creators.
 
virtual json::JSONBuilder getStructure () const override
 
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)
 
BaseComponentgetParent () 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
 

Static Public Attributes

static constexpr int defaultUpdateStep = 10
 
static constexpr int defaultMinRange = 0
 
static constexpr int defaultMaxRange = 100
 

Protected Attributes

int minRange
 
int maxRange
 
int updateStep
 
- Protected Attributes inherited from gui_framework::BaseComponent
BaseCompositeparent
 
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::IStylesstyles
 

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 updatable progress bars.

Definition at line 9 of file BaseProgressBar.h.

Constructor & Destructor Documentation

◆ BaseProgressBar()

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

Definition at line 10 of file BaseProgressBar.cpp.

◆ ~BaseProgressBar()

virtual gui_framework::BaseProgressBar::~BaseProgressBar ( )
virtualdefault

Member Function Documentation

◆ advancePosition()

void gui_framework::BaseProgressBar::advancePosition ( int position)
finalvirtual

Definition at line 40 of file BaseProgressBar.cpp.

◆ getHash()

virtual size_t gui_framework::BaseProgressBar::getHash ( ) const
overridepure virtual

Used as key in creators.

Returns
typeid().hash_code()

Implements gui_framework::BaseComponent.

Implemented in gui_framework::ProgressBar.

◆ getMaxRange()

int gui_framework::BaseProgressBar::getMaxRange ( ) const
finalvirtual

Definition at line 76 of file BaseProgressBar.cpp.

◆ getMinRange()

int gui_framework::BaseProgressBar::getMinRange ( ) const
finalvirtual

Definition at line 71 of file BaseProgressBar.cpp.

◆ getStructure()

json::JSONBuilder gui_framework::BaseProgressBar::getStructure ( ) const
overridevirtual

Reimplemented from gui_framework::BaseComponent.

Reimplemented in gui_framework::ProgressBar.

Definition at line 100 of file BaseProgressBar.cpp.

◆ getUpdateStep()

int gui_framework::BaseProgressBar::getUpdateStep ( ) const
finalvirtual

Definition at line 66 of file BaseProgressBar.cpp.

◆ setBackgroundColor()

void gui_framework::BaseProgressBar::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 81 of file BaseProgressBar.cpp.

◆ setMaxRange()

void gui_framework::BaseProgressBar::setMaxRange ( int maxRange)
finalvirtual

Definition at line 52 of file BaseProgressBar.cpp.

◆ setMinRange()

void gui_framework::BaseProgressBar::setMinRange ( int minRange)
finalvirtual

Definition at line 45 of file BaseProgressBar.cpp.

◆ setProgressBarBackgroundColor()

void gui_framework::BaseProgressBar::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 88 of file BaseProgressBar.cpp.

◆ setTextColor()

void gui_framework::BaseProgressBar::setTextColor ( uint8_t red,
uint8_t green,
uint8_t blue )
finaloverridevirtual

Not implemented.

Parameters
red
green
blue
Exceptions
NotImplementedText color does not affects at progress bar

Reimplemented from gui_framework::BaseComponent.

Definition at line 95 of file BaseProgressBar.cpp.

◆ setUpdateStep()

void gui_framework::BaseProgressBar::setUpdateStep ( int updateStep)
finalvirtual

Definition at line 59 of file BaseProgressBar.cpp.

◆ update() [1/2]

void gui_framework::BaseProgressBar::update ( )
finalvirtual

Definition at line 35 of file BaseProgressBar.cpp.

◆ update() [2/2]

void gui_framework::BaseProgressBar::update ( int newPosition)
finalvirtual

Definition at line 30 of file BaseProgressBar.cpp.

Member Data Documentation

◆ defaultMaxRange

int gui_framework::BaseProgressBar::defaultMaxRange = 100
inlinestaticconstexpr

Definition at line 16 of file BaseProgressBar.h.

◆ defaultMinRange

int gui_framework::BaseProgressBar::defaultMinRange = 0
inlinestaticconstexpr

Definition at line 15 of file BaseProgressBar.h.

◆ defaultUpdateStep

int gui_framework::BaseProgressBar::defaultUpdateStep = 10
inlinestaticconstexpr

Definition at line 14 of file BaseProgressBar.h.

◆ maxRange

int gui_framework::BaseProgressBar::maxRange
protected

Definition at line 20 of file BaseProgressBar.h.

◆ minRange

int gui_framework::BaseProgressBar::minRange
protected

Definition at line 19 of file BaseProgressBar.h.

◆ updateStep

int gui_framework::BaseProgressBar::updateStep
protected

Definition at line 21 of file BaseProgressBar.h.


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