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

Base class for all static controls. More...

#include <BaseStaticControl.h>

Inheritance diagram for gui_framework::BaseStaticControl:
gui_framework::interfaces::ISingleTextLocalized gui_framework::BaseComponent gui_framework::interfaces::ITextOperations gui_framework::interfaces::ITextLocalized gui_framework::interfaces::ISerializable gui_framework::StaticControl

Public Member Functions

 BaseStaticControl (const std::wstring &staticControlName, const std::wstring &staticControlText, const utility::ComponentSettings &settings, BaseComposite *parent)
 
void addBorder ()
 Add border.
 
void removeBorder ()
 Remove border.
 
virtual void setText (std::string_view localizationKey) final override
 
virtual size_t getHash () const override=0
 Used as key in creators.
 
virtual ~BaseStaticControl ()=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)
 
virtual void setTextColor (uint8_t red, uint8_t green, uint8_t blue)
 
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 json::JSONBuilder getStructure () const override
 
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 staticControlWidth = 200
 
static constexpr uint16_t staticControlHeight = 40
 

Protected Member Functions

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 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.
 

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 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
 
- Protected Attributes inherited from gui_framework::interfaces::ITextOperations
HWND textHandle
 

Detailed Description

Base class for all static controls.

Definition at line 10 of file BaseStaticControl.h.

Constructor & Destructor Documentation

◆ BaseStaticControl()

gui_framework::BaseStaticControl::BaseStaticControl ( const std::wstring & staticControlName,
const std::wstring & staticControlText,
const utility::ComponentSettings & settings,
BaseComposite * parent )

Definition at line 14 of file BaseStaticControl.cpp.

◆ ~BaseStaticControl()

virtual gui_framework::BaseStaticControl::~BaseStaticControl ( )
virtualdefault

Member Function Documentation

◆ addBorder()

void gui_framework::BaseStaticControl::addBorder ( )

Add border.

Definition at line 28 of file BaseStaticControl.cpp.

◆ getHash()

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

Used as key in creators.

Returns
typeid().hash_code()

Implements gui_framework::BaseComponent.

Implemented in gui_framework::StaticControl.

◆ removeBorder()

void gui_framework::BaseStaticControl::removeBorder ( )

Remove border.

Definition at line 33 of file BaseStaticControl.cpp.

◆ setText()

void gui_framework::BaseStaticControl::setText ( std::string_view localizationKey)
finaloverridevirtual

Reimplemented from gui_framework::interfaces::ITextOperations.

Definition at line 38 of file BaseStaticControl.cpp.

◆ updateLocalization()

void gui_framework::BaseStaticControl::updateLocalization ( std::wstring_view localizedText)
overrideprotectedvirtual

Member Data Documentation

◆ staticControlHeight

uint16_t gui_framework::BaseStaticControl::staticControlHeight = 40
inlinestaticconstexpr

Definition at line 17 of file BaseStaticControl.h.

◆ staticControlWidth

uint16_t gui_framework::BaseStaticControl::staticControlWidth = 200
inlinestaticconstexpr

Definition at line 16 of file BaseStaticControl.h.


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