Builder for dialog boxes. More...

#include <DialogBox.h>

Public Types
enum class	alignment { left , center , right }

Public Member Functions
	DialogBoxBuilder (const std::wstring &className, const std::wstring &dialogBoxName, int x, int y, const std::string &dialogBoxFunctionName, const std::string &moduleName="", uint16_t smallIconResource=NULL, uint16_t largeIconResource=NULL)

DialogBoxBuilder &	clear ()

template<std::derived_from< BaseComponent > T>
DialogBoxBuilder &	addComponent (const std::wstring &componentName, uint16_t width, uint16_t height, alignment type, const utility::AdditionalCreationData< T > &additionalData=utility::AdditionalCreationData< T >(), int leftOffset=0, int topOffset=0, int rightOffset=0, int bottomOffset=0, const interfaces::IStyles &styles=interfaces::IStyles())

DialogBox *	build () const

	~DialogBoxBuilder ()=default

template<std::derived_from< BaseComponent > T>
DialogBox::DialogBoxBuilder &	addComponent (const std::wstring &componentName, uint16_t width, uint16_t height, alignment type, const utility::AdditionalCreationData< T > &additionalData, int leftOffset, int topOffset, int rightOffset, int bottomOffset, const interfaces::IStyles &styles)

Detailed Description

Builder for dialog boxes.

Definition at line 18 of file DialogBox.h.

Member Enumeration Documentation

◆ alignment

enum class gui_framework::DialogBox::DialogBoxBuilder::alignment

strong

Enumerator
left
center
right

Definition at line 21 of file DialogBox.h.

Constructor & Destructor Documentation

◆ DialogBoxBuilder()

gui_framework::DialogBoxBuilder::DialogBoxBuilder	(	const std::wstring &	className,
		const std::wstring &	dialogBoxName,
		int	x,
		int	y,
		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 11 of file DialogBox.cpp.

◆ ~DialogBoxBuilder()

gui_framework::DialogBox::DialogBoxBuilder::~DialogBoxBuilder ( )

default

Member Function Documentation

◆ addComponent() [1/2]

template<std::derived_from< BaseComponent > T>

DialogBox::DialogBoxBuilder & gui_framework::DialogBox::DialogBoxBuilder::addComponent	(	const std::wstring &	componentName,
		uint16_t	width,
		uint16_t	height,
		alignment	type,
		const utility::AdditionalCreationData< T > &	additionalData,
		int	leftOffset,
		int	topOffset,
		int	rightOffset,
		int	bottomOffset,
		const interfaces::IStyles &	styles )

Definition at line 84 of file DialogBox.h.

◆ addComponent() [2/2]

template<std::derived_from< BaseComponent > T>

DialogBoxBuilder & gui_framework::DialogBox::DialogBoxBuilder::addComponent	(	const std::wstring &	componentName,
		uint16_t	width,
		uint16_t	height,
		alignment	type,
		const utility::AdditionalCreationData< T > &	additionalData = utility::AdditionalCreationData< T >(),
		int	leftOffset = 0,
		int	topOffset = 0,
		int	rightOffset = 0,
		int	bottomOffset = 0,
		const interfaces::IStyles &	styles = interfaces::IStyles() )

◆ build()

DialogBox * gui_framework::DialogBoxBuilder::build ( ) const

Returns

Exceptions

std::out_of_range Can't find creator for one of components

Definition at line 36 of file DialogBox.cpp.

◆ clear()

DialogBoxBuilder & gui_framework::DialogBoxBuilder::clear ( )

Definition at line 29 of file DialogBox.cpp.

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

GUIFramework/src/Composites/DialogBox.h
GUIFramework/src/Composites/DialogBox.cpp

Public Types

Public Member Functions