Base class for all dialog boxes. More...

#include <BaseDialogBox.h>

Inheritance diagram for gui_framework::BaseDialogBox:

Public Types
enum class	messageBoxType { ok = MB_OK , okCancel , abortRetryIgnore , yesNoCancel , yesNo , retryCancel , cancelTryContinue }

enum class	messageBoxResponse { ok = IDOK , cancel , abort , retry , ignore , yes , no , tryAgain = IDTRYAGAIN , continueResponse }

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

Public Member Functions
	BaseDialogBox (const std::wstring &className, const std::wstring &title, const utility::ComponentSettings &settings, const std::string &dialogBoxFunctionName="", const std::string &moduleName="", uint16_t smallIconResource=NULL, uint16_t largeIconResource=NULL)

int	showDialog ()

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

virtual	~BaseDialogBox ()

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 void	setBackgroundColor (uint8_t red, uint8_t green, uint8_t blue) override

virtual json::JSONBuilder	getStructure () const 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

Static Public Member Functions
static messageBoxResponse	createMessageBox (const std::wstring &text, const std::wstring &title, messageBoxType type, BaseComposite *parent=nullptr, bool helpButton=false)

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
bool	isShowDialogUsed

HWND	windowWithUserFocus

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

Additional Inherited Members
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 all dialog boxes.

Definition at line 10 of file BaseDialogBox.h.

Member Enumeration Documentation

◆ messageBoxResponse

enum class gui_framework::BaseDialogBox::messageBoxResponse

strong

Enumerator
ok
cancel
abort
retry
ignore
yes
no
tryAgain
continueResponse

Definition at line 27 of file BaseDialogBox.h.

◆ messageBoxType

enum class gui_framework::BaseDialogBox::messageBoxType

strong

Enumerator
ok
okCancel
abortRetryIgnore
yesNoCancel
yesNo
retryCancel
cancelTryContinue

Definition at line 16 of file BaseDialogBox.h.

Constructor & Destructor Documentation

◆ BaseDialogBox()

gui_framework::BaseDialogBox::BaseDialogBox	(	const std::wstring &	className,
		const std::wstring &	title,
		const utility::ComponentSettings &	settings,
		const std::string &	dialogBoxFunctionName = "",
		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 16 of file BaseDialogBox.cpp.

◆ ~BaseDialogBox()

gui_framework::BaseDialogBox::~BaseDialogBox ( )

virtual

Definition at line 66 of file BaseDialogBox.cpp.

Member Function Documentation

◆ createMessageBox()

BaseDialogBox::messageBoxResponse gui_framework::BaseDialogBox::createMessageBox	(	const std::wstring &	text,
		const std::wstring &	title,
		messageBoxType	type,
		BaseComposite *	parent = nullptr,
		bool	helpButton = false )

static

Definition at line 11 of file BaseDialogBox.cpp.

◆ getHash()

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

overridepure virtual

Used as key in creators.

Returns: typeid().hash_code()

Implements gui_framework::BaseComposite.

Implemented in gui_framework::DialogBox.

◆ showDialog()

int gui_framework::BaseDialogBox::showDialog ( )

Definition at line 39 of file BaseDialogBox.cpp.

Member Data Documentation

◆ isShowDialogUsed

bool gui_framework::BaseDialogBox::isShowDialogUsed

protected

Definition at line 44 of file BaseDialogBox.h.

◆ windowWithUserFocus

HWND gui_framework::BaseDialogBox::windowWithUserFocus

protected

Definition at line 45 of file BaseDialogBox.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members