Base class for separate windows. More...

#include <BaseSeparateWindow.h>

Inheritance diagram for gui_framework::BaseSeparateWindow:

Public Member Functions
	BaseSeparateWindow (const std::wstring &className, const std::wstring &titleName, const utility::ComponentSettings &settings, const std::string &windowFunctionName, bool maximize=false, bool minimize=false, const std::string &moduleName="", uint16_t smallIconResource=NULL, uint16_t largeIconResource=NULL)

void	enableResize ()
	Enable resize button and window resizing.

void	disableResize ()
	Disable resize button and window resizing.

void	setLargeIcon (const std::filesystem::path &pathToLargeIcon)
	Set large icon(32x32) for specific window.

void	setSmallIcon (const std::filesystem::path &pathToSmallIcon)
	Set small icon(16x16) for specific window.

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

virtual json::JSONBuilder	getStructure () const override

virtual	~BaseSeparateWindow ()

Public Member Functions inherited from 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)

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

Public Member Functions inherited from gui_framework::interfaces::ICloseable
	ICloseable (HWND closeableHandle)

bool	close (int exitCode)

virtual void	setOnClose (const std::function< bool()> &onClose) final

virtual void	setOnClose (const std::string &onCloseFunctionName, const std::string &onCloseFunctionModuleName) final
	Load function from module. Can be seriazlied.

virtual const std::function< bool()> &	getOnClose () const final

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

Protected Attributes
HICON	largeIcon

HICON	smallIcon

std::filesystem::path	pathToSmallIcon

std::filesystem::path	pathToLargeIcon

Protected Attributes inherited from gui_framework::BaseWindow
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

Protected Attributes inherited from gui_framework::interfaces::ICloseable
HWND	closeableHandle

std::function< bool()>	onClose

std::string	onCloseFunctionName

std::string	onCloseFunctionModuleName

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

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

Definition at line 10 of file BaseSeparateWindow.h.

Constructor & Destructor Documentation

◆ BaseSeparateWindow()

gui_framework::BaseSeparateWindow::BaseSeparateWindow	(	const std::wstring &	className,
		const std::wstring &	titleName,
		const utility::ComponentSettings &	settings,
		const std::string &	windowFunctionName,
		bool	maximize = false,
		bool	minimize = false,
		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 13 of file BaseSeparateWindow.cpp.

◆ ~BaseSeparateWindow()

gui_framework::BaseSeparateWindow::~BaseSeparateWindow ( )

virtual

Definition at line 120 of file BaseSeparateWindow.cpp.

Member Function Documentation

◆ disableResize()

void gui_framework::BaseSeparateWindow::disableResize ( )

Disable resize button and window resizing.

Definition at line 45 of file BaseSeparateWindow.cpp.

◆ enableResize()

void gui_framework::BaseSeparateWindow::enableResize ( )

Enable resize button and window resizing.

Definition at line 38 of file BaseSeparateWindow.cpp.

◆ getHash()

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

overridepure virtual

Used as key in creators.

Returns: typeid().hash_code()

Implements gui_framework::BaseWindow.

Implemented in gui_framework::BaseMainWindow, and gui_framework::SeparateWindow.

◆ getStructure()

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

overridevirtual

Reimplemented from gui_framework::BaseWindow.

Reimplemented in gui_framework::BaseMainWindow.

Definition at line 94 of file BaseSeparateWindow.cpp.

◆ setLargeIcon()

void gui_framework::BaseSeparateWindow::setLargeIcon ( const std::filesystem::path & pathToLargeIcon )

Set large icon(32x32) for specific window.

Parameters

pathToLargeIcon

Exceptions

FileDoesNotExist

Definition at line 52 of file BaseSeparateWindow.cpp.

◆ setSmallIcon()

void gui_framework::BaseSeparateWindow::setSmallIcon ( const std::filesystem::path & pathToSmallIcon )

Set small icon(16x16) for specific window.

Parameters

pathToSmallIcon

Exceptions

FileDoesNotExist

Definition at line 73 of file BaseSeparateWindow.cpp.

Member Data Documentation

◆ largeIcon

HICON gui_framework::BaseSeparateWindow::largeIcon

protected

Definition at line 16 of file BaseSeparateWindow.h.

◆ pathToLargeIcon

std::filesystem::path gui_framework::BaseSeparateWindow::pathToLargeIcon

protected

Definition at line 19 of file BaseSeparateWindow.h.

◆ pathToSmallIcon

std::filesystem::path gui_framework::BaseSeparateWindow::pathToSmallIcon

protected

Definition at line 18 of file BaseSeparateWindow.h.

◆ smallIcon

HICON gui_framework::BaseSeparateWindow::smallIcon

protected

Definition at line 17 of file BaseSeparateWindow.h.

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BaseSeparateWindow()

◆ ~BaseSeparateWindow()

Member Function Documentation

◆ disableResize()

◆ enableResize()

◆ getHash()

◆ getStructure()

◆ setLargeIcon()

◆ setSmallIcon()

Member Data Documentation

◆ largeIcon

◆ pathToLargeIcon

◆ pathToSmallIcon

◆ smallIcon