Base class for composite windows. More...

#include <BaseWindow.h>

Inheritance diagram for gui_framework::BaseWindow:

Public Member Functions
	BaseWindow (const std::wstring &className, const std::wstring &windowName, const utility::ComponentSettings &settings, const interfaces::IStyles &styles, BaseComposite *parent=nullptr, const std::string &windowFunctionName="", const std::string &moduleName="", uint16_t smallIconResource=NULL, uint16_t largeIconResource=NULL)

virtual void	initDrawing (const std::string &pictureBlockName, uint16_t imagesWidth, uint16_t imagesHeight, utility::BaseLoadableHolder::imageType type) final
	Initialize block of pictures with same size.

virtual void	addImage (const std::string &pictureBlockName, int x, int y, const std::filesystem::path &pathToImage)
	Draw image in window.

virtual void	removeImage (const std::string &pictureBlockName, const std::filesystem::path &pathToImage)
	Remove image from window.

virtual void	drawAllImages () final
	Clear window and draw all images.

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

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

virtual json::JSONBuilder	getStructure () const override

virtual	~BaseWindow ()=default

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

void	removeChild (BaseComponent *child)

void	removeComponents (const std::wstring &componentName)

BaseComponent *	findChild (const std::wstring &windowName) const

BaseComponent *	findChild (HWND handle) const

std::vector< BaseComponent * >	findChildren (const std::wstring &windowName) const

virtual std::unique_ptr< Menu > &	createMainMenu (const std::wstring &menuName)
	It needs to be called once.

virtual Menu &	addPopupMenu (const std::wstring &menuName)
	Don't call move operator with return value.

virtual void	removePopupMenus (const std::wstring &menuName)
	Remove all pop-up menus with menuName.

void	setExitMode (exitMode mode)

void	setOnDestroy (const std::function< void()> &onDestroy)

void	setOnDestroy (const std::string &onDestroyFunctionName, const std::string &onDestroyFunctionModuleName)
	Load function from module. Can be seriazlied.

exitMode	getExitMode () const

int	getExitCode () const

const std::vector< std::unique_ptr< BaseComponent > > &	getChildren () const

const std::unique_ptr< Menu > &	getMainMenu () const

std::unique_ptr< Menu > &	getMainMenu ()

std::vector< const Menu * >	getPopupMenus () const

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

virtual iterators::composite_forward_iterator	begin () noexcept override

virtual iterators::composite_const_forward_iterator	cbegin () const noexcept override

virtual iterators::composite_forward_iterator	end () noexcept override

virtual iterators::composite_const_forward_iterator	cend () const noexcept override

virtual	~BaseComposite ()

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	setTextColor (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::IIterable< BaseComponent, iterators::composite_forward_iterator, iterators::composite_const_forward_iterator >
	IIterable ()=default

virtual	~IIterable ()=default

Public Member Functions inherited from gui_framework::interfaces::IComponentVisibility
	IComponentVisibility (HWND componentVisibilityHandle)

void	show () const

void	hide () const

virtual	~IComponentVisibility ()=default

Protected Attributes
std::unordered_map< std::string, drawedImages >	pictures

Protected Attributes inherited from gui_framework::BaseComposite
std::string	windowFunctionName

exitMode	mode

int	exitCode

std::vector< std::unique_ptr< BaseComponent > >	children

std::unordered_map< HMENU, Menu >	popupMenus

std::unique_ptr< Menu >	mainMenu

std::function< void()>	onDestroy

std::string	onDestroyFunctionName

std::string	onDestroyFunctionModuleName

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::IComponentVisibility
HWND	componentVisibilityHandle

Additional Inherited Members
Public Types inherited from gui_framework::BaseComposite
enum class	exitMode { destroyWindow , quit }

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

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

virtual LRESULT	preWindowMessagesHandle (HWND handle, UINT message, WPARAM wparam, LPARAM lparam, bool &isUsed) override

Protected Member Functions inherited from gui_framework::BaseComponent
virtual void	setLocalizationKeys (interfaces::ITextLocalized *localized, const std::vector< std::string > &localizationKeys)
	Override for custom localization.

Detailed Description

Base class for composite windows.

Definition at line 10 of file BaseWindow.h.

Constructor & Destructor Documentation

◆ BaseWindow()

gui_framework::BaseWindow::BaseWindow	(	const std::wstring &	className,
		const std::wstring &	windowName,
		const utility::ComponentSettings &	settings,
		const interfaces::IStyles &	styles,
		BaseComposite *	parent = nullptr,
		const std::string &	windowFunctionName = "",
		const std::string &	moduleName = "",
		uint16_t	smallIconResource = NULL,
		uint16_t	largeIconResource = NULL )

Parameters

moduleName	Name of loaded resource module with icons
smallIconResource	Integer value from auto generated Visual Studio resources
largeIconResource	Integer value from auto generated Visual Studio resources

Definition at line 36 of file BaseWindow.cpp.

◆ ~BaseWindow()

virtual gui_framework::BaseWindow::~BaseWindow ( )

virtualdefault

Member Function Documentation

◆ addImage()

void gui_framework::BaseWindow::addImage	(	const std::string &	pictureBlockName,
		int	x,
		int	y,
		const std::filesystem::path &	pathToImage )

virtual

Draw image in window.

Parameters

pictureBlockName	Name of pictures block
x
y
pathToImage

Exceptions

FileDoesNotExist
std::out_of_range

Definition at line 79 of file BaseWindow.cpp.

◆ drawAllImages()

void gui_framework::BaseWindow::drawAllImages ( )

finalvirtual

Clear window and draw all images.

Definition at line 102 of file BaseWindow.cpp.

◆ getHash()

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

overridepure virtual

Used as key in creators.

Returns: typeid().hash_code()

Implements gui_framework::BaseComposite.

Implemented in gui_framework::BaseChildWindow, gui_framework::BaseMainWindow, gui_framework::BaseSeparateWindow, gui_framework::ChildWindow, and gui_framework::SeparateWindow.

◆ getStructure()

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

overridevirtual

Reimplemented from gui_framework::BaseComposite.

Reimplemented in gui_framework::BaseMainWindow, and gui_framework::BaseSeparateWindow.

Definition at line 153 of file BaseWindow.cpp.

◆ initDrawing()

void gui_framework::BaseWindow::initDrawing	(	const std::string &	pictureBlockName,
		uint16_t	imagesWidth,
		uint16_t	imagesHeight,
		utility::BaseLoadableHolder::imageType	type )

finalvirtual

Initialize block of pictures with same size.

Parameters

pictureBlockName	Name of pictures block
imagesWidth	Pictures width in pixels
imagesHeight	Pictures height in pixels
type	Holder's data type - BaseLoadableHolder::imageType::cursor doesn't support

Exceptions

std::runtime_error Wrong type value

Definition at line 54 of file BaseWindow.cpp.

◆ removeImage()

void gui_framework::BaseWindow::removeImage	(	const std::string &	pictureBlockName,
		const std::filesystem::path &	pathToImage )

virtual

Remove image from window.

Parameters

pictureBlockName	Name of pictures block
pathToImage

Exceptions

std::out_of_range

Definition at line 93 of file BaseWindow.cpp.

◆ setBackgroundColor()

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

finaloverridevirtual

Reimplemented from gui_framework::BaseComposite.

Definition at line 146 of file BaseWindow.cpp.

Member Data Documentation

◆ pictures

std::unordered_map<std::string, drawedImages> gui_framework::BaseWindow::pictures

protected

Definition at line 29 of file BaseWindow.h.

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

GUIFramework/src/BaseComposites/StandardComposites/BaseWindow.h
GUIFramework/src/BaseComposites/StandardComposites/BaseWindow.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BaseWindow()

◆ ~BaseWindow()

Member Function Documentation

◆ addImage()

◆ drawAllImages()

◆ getHash()

◆ getStructure()

◆ initDrawing()

◆ removeImage()

◆ setBackgroundColor()

Member Data Documentation

◆ pictures