adtf::ui::v0 Namespace Reference

Namespace for all ui classes and interfaces provided since v1.0.0. More...

Classes
class	cQtWindow
class	cThemedIconColorMapping
class	IQtShared
class	IQtXSystem
	Interface definition for the ADTF XSystem based on Qt. Use this interface to create your own displays within the Qt5 ADTF XSystem UI Service. More...
class	qt_ui_filter
class	qt_ui_service

Typedefs
using	cQtUIDynamicFilter
using	cQtUIFilter
using	cQtUIService

Enumerations
enum class	eThemedIcon

Functions
std::pair< QString, QString >	split_result (tResult oResult)
QMessageBox::StandardButton	result_message_box (QWidget *pParent, const QString &strTitle, tResult oResult, const QString &strInformativeText={}, QMessageBox::StandardButtons eButtons=QMessageBox::Ok, QMessageBox::StandardButton eDefaultButton=QMessageBox::NoButton)
QString	get_window_state_folder_name (const QString &strSessionDataDir, const QString &strShortPathName)
	Get the default window state folder name.
QColor	get_color (size_t maxColors, size_t colorIndex)
	Get tableau 10 colors. If maxColors is greater or equal to 20 it uses tableau 20 colors.
QIcon	create_themed_icon (QString file, cThemedIconColorMapping themedIconColorMapping=cThemedIconColorMapping::GetDefaultColorMapping())
	Creates a themed icon from given svg file with color mapping.

Detailed Description

Namespace for all ui classes and interfaces provided since v1.0.0.

Namespace for all functionality provided since v1.0.

Typedef Documentation

cQtUIDynamicFilter

using adtf::ui::spider::cQtUIDynamicFilter

Basic UI Filter implementation.

See also

adtf::filter::hollow::cFilter, adtf::ui::riddler::IQtXSystem, spider::cQtWindow

Remarks

This class is defined for backward compatibility only.

cQtUIFilter

using adtf::ui::spider::cQtUIFilter

Basic UI Filter implementation.

See also

adtf::filter::hollow::cFilter, adtf::ui::riddler::IQtXSystem, spider::cQtWindow

cQtUIService

using adtf::ui::spider::cQtUIService

UI Service basic implementation for cADTFService.

See also

adtf::system::ant::cADTFService, adtf::ui::riddler::IQtXSystem

Enumeration Type Documentation

eThemedIcon

enum class adtf::ui::thor::eThemedIcon

strong

Enum for accessing various icons already delivered in XSystem.

Function Documentation

create_themed_icon()

QIcon adtf::ui::thor::create_themed_icon	(	QString	file,
		cThemedIconColorMapping	themedIconColorMapping = cThemedIconColorMapping::GetDefaultColorMapping() )

Creates a themed icon from given svg file with color mapping.

Remarks

Create an icon with a custom color mapping for light/dark mode (SVG Icons only!).

Parameters

file	The icon file
themedIconColorMapping	The color mapping for the icon, emtpy for default color mapping.

Returns

The created Icon.

get_color()

QColor adtf::ui::thor::get_color	(	size_t	maxColors,
		size_t	colorIndex )

Get tableau 10 colors. If maxColors is greater or equal to 20 it uses tableau 20 colors.

Remarks

Get a color from maxColors that are easily distinguishable.

Parameters

maxColors	Number of distinguishable colors.
colorIndex	Index of the color.

Returns

The color from the index

get_window_state_folder_name()

QString adtf::ui::riddler::get_window_state_folder_name	(	const QString &	strSessionDataDir,
		const QString &	strShortPathName )

Get the default window state folder name.

Parameters

strSessionDataDir	The session data directory (if session manager is used this should be adtf::services::macro::ADTF_SESSION_DATA_DIR)
strShortPathName	The short path for the state identifier (see adtf::ui::riddler::IQtXSystem::IWindowState::GetStateIdentifier)

Returns

QString The default folder name of the window state folder used by adtf::ui::riddler::IQtXSystem.

result_message_box()

QMessageBox::StandardButton adtf::ui::mega::result_message_box	(	QWidget *	pParent,
		const QString &	strTitle,
		tResult	oResult,
		const QString &	strInformativeText = {},
		QMessageBox::StandardButtons	eButtons = QMessageBox::Ok,
		QMessageBox::StandardButton	eDefaultButton = QMessageBox::NoButton )

Display a message box showing the given tResult.

Parameters

[in]	pParent	The parent of the messagebox.
[in]	strTitle	The title of the messagebox.
[in]	oResult	The result to show.
[in]	strInformativeText	An optional informative text, i.e. a question on how to continue.
[in]	eButtons	The buttons that should be shown.
[in]	eDefaultButton	The default button.

Returns

The button that was clicked.

split_result()

std::pair< QString, QString > adtf::ui::mega::split_result

(

tResult

oResult

)

Splits the result into the main error message and a detailed error description.

Parameters

[in]

oResult

The Result that should be split up.

Returns

A pair containing the main error message and the details.