Floating frameless container hosting modular Quick-Control settings tabs. More...

#include <quickcontrolview.h>

Public Types
typedef QSharedPointer< QuickControlView >	SPtr
typedef QSharedPointer< const QuickControlView >	ConstSPtr
Public Types inherited from DISPLIB::DraggableFramelessWidget
typedef QSharedPointer< DraggableFramelessWidget >	SPtr
typedef QSharedPointer< const DraggableFramelessWidget >	ConstSPtr

Public Member Functions
	QuickControlView (const QString &sSettingsPath="", const QString &name="", Qt::WindowFlags flags=Qt::Window\|Qt::WindowStaysOnTopHint, QWidget *parent=nullptr, bool bDraggable=true)
	~QuickControlView ()
void	clear ()
QVBoxLayout *	findTabWidgetLayout (const QString &sTabName)
void	addWidgets (const QList< QWidget * > &lWidgets, const QString &sTabName, bool bAddToEnd=false)
void	addWidget (QWidget *pWidget, const QString &sTabName, bool bAddToEnd=false)
void	addGroupBox (QWidget *pWidget, const QString &sGroupBoxName, const QString &sTabName, bool bAddToEnd=false)
void	addGroupBoxWithTabs (QWidget *pWidget, const QString &sGroupBoxName, const QString &sTabNameGroupBox, const QString &sTabName, bool bAddToEnd=false)
void	setOpacityValue (int opactiy)
int	getOpacityValue ()
void	setVisiblityHideOpacityClose (bool bVisibility)
void	saveSettings ()
void	loadSettings ()
Public Member Functions inherited from DISPLIB::DraggableFramelessWidget
	DraggableFramelessWidget (QWidget *parent=0, Qt::WindowFlags flags=Qt::Window, bool bRoundEdges=false, bool bDraggable=true, bool bFrameless=true)
	~DraggableFramelessWidget ()
void	setDraggable (bool bFlag)

Protected Member Functions
void	onOpacityChange (qint32 value)
Protected Member Functions inherited from DISPLIB::DraggableFramelessWidget
void	mouseMoveEvent (QMouseEvent *event)
void	mousePressEvent (QMouseEvent *event)
void	mouseReleaseEvent (QMouseEvent *event)
void	resizeEvent (QResizeEvent *event)
QRegion	roundedRect (const QRect &rect, int r)

Detailed Description

Floating frameless container hosting modular Quick-Control settings tabs.

Owns a QTabWidget into which application code drops arbitrary AbstractView panels grouped by name. Supports opacity, transparency and "pinned" behaviour and persists the current tab through QSettings.

Definition at line 73 of file quickcontrolview.h.

Inheritance diagram for DISPLIB::QuickControlView:

Member Typedef Documentation

◆ ConstSPtr

typedef QSharedPointer<const QuickControlView> DISPLIB::QuickControlView::ConstSPtr

Const shared pointer type for QuickControlView.

Definition at line 79 of file quickcontrolview.h.

◆ SPtr

typedef QSharedPointer<QuickControlView> DISPLIB::QuickControlView::SPtr

Shared pointer type for QuickControlView.

Definition at line 78 of file quickcontrolview.h.

Constructor & Destructor Documentation

◆ QuickControlView()

QuickControlView::QuickControlView	(	const QString &	sSettingsPath = "",
		const QString &	name = "",
		Qt::WindowFlags	flags = Qt::Window \| Qt::WindowStaysOnTopHint,
		QWidget *	parent = nullptr,
		bool	bDraggable = true )

Constructs a QuickControlView which is a child of parent.

Parameters

[in]	name	The name to be displayed on the minimize button.
[in]	flags	The window flags.
[in]	parent	The parent of widget.
[in]	bDraggable	Flag specifying whether this widget is draggable.

Definition at line 46 of file quickcontrolview.cpp.

◆ ~QuickControlView()

QuickControlView::~QuickControlView ( )

Destructs a QuickControlView

Definition at line 81 of file quickcontrolview.cpp.

Member Function Documentation

◆ addGroupBox()

void QuickControlView::addGroupBox	(	QWidget *	pWidget,
		const QString &	sGroupBoxName,
		const QString &	sTabName,
		bool	bAddToEnd = false )

Add a new group box to this Widget. Takes ownership of the passed widget. Takes ownership of the QWidget.

Parameters

[in]	pWidget	The widgets which will be put into the new group box.
[in]	sGroupBoxName	The name of the new group box.
[in]	sTabName	The tab to which the group box is supposed to be added to.
[in]	bAddToEnd	Whether to add the new widgets to the end of the layout. If true, the widgets will inserted in the beginning of the layout.

Definition at line 168 of file quickcontrolview.cpp.

◆ addGroupBoxWithTabs()

void QuickControlView::addGroupBoxWithTabs	(	QWidget *	pWidget,
		const QString &	sGroupBoxName,
		const QString &	sTabNameGroupBox,
		const QString &	sTabName,
		bool	bAddToEnd = false )

Add a new group box with tabs to this Widget. If the group box already exists, a new tab will be added to its QTabWidget. Takes ownership of the QWidget.

Parameters

[in]	pWidget	The widgets which will be put into the new group box.
[in]	sGroupBoxName	The name of the new group box.
[in]	sTabNameGroupBox	The tab name inside the tab widget of the group box.
[in]	sTabName	The tab to which the group box with the tab widget is supposed to be added to.
[in]	bAddToEnd	Whether to add the new widgets to the end of the layout. If true, the widgets will inserted in the beginning of the layout.

Definition at line 192 of file quickcontrolview.cpp.

◆ addWidget()

void QuickControlView::addWidget	(	QWidget *	pWidget,
		const QString &	sTabName,
		bool	bAddToEnd = false )

Add a new group box to this Widget. Takes ownership of the passed widget. Takes ownership of the QWidget.

Parameters

[in]	pWidget	The widget which is supposed to be added.
[in]	sTabName	The tab to which the widget is supposed to be added to.
[in]	bAddToEnd	Whether to add the new widgets to the end of the layout. If true, the widgets will inserted in the beginning of the layout.

Definition at line 154 of file quickcontrolview.cpp.

◆ addWidgets()

void QuickControlView::addWidgets	(	const QList< QWidget * > &	lWidgets,
		const QString &	sTabName,
		bool	bAddToEnd = false )

This convenience function adds control widgets to the QuickControlView based on their set objects names. Takes ownership of the QWidgets.

Parameters

[in]	lWidgets	The widget which are supposed to be added. The widgets will be categorized based on their. object names: "widget_", "group_", "group_tab_".
[in]	sTabName	The tab to which the widgets are supposed to be added to.
[in]	bAddToEnd	Whether to add the new widgets to the end of the layout. If true, the widgets will inserted in the beginning of the layout.

Definition at line 123 of file quickcontrolview.cpp.

◆ clear()

void QuickControlView::clear ( )

Clear this widget by removing all of its child widgets.

Definition at line 90 of file quickcontrolview.cpp.

◆ findTabWidgetLayout()

QVBoxLayout * QuickControlView::findTabWidgetLayout ( const QString & sTabName )

Definition at line 101 of file quickcontrolview.cpp.

◆ getOpacityValue()

int QuickControlView::getOpacityValue ( )

Get current opacity value. Value between 0.0 and 1.0.

Returns: the current set opacity value of this window.

Definition at line 241 of file quickcontrolview.cpp.

◆ loadSettings()

void QuickControlView::loadSettings ( )

Loads and inits all important settings of this view via QSettings.

Definition at line 271 of file quickcontrolview.cpp.

◆ onOpacityChange()

void QuickControlView::onOpacityChange ( qint32 value )

protected

Slot called when opacity slider was changed

Parameters

[in] value opacity value.

Definition at line 293 of file quickcontrolview.cpp.

◆ saveSettings()

void QuickControlView::saveSettings ( )

Saves all important settings of this view via QSettings.

Definition at line 257 of file quickcontrolview.cpp.

◆ setOpacityValue()

void QuickControlView::setOpacityValue ( int opactiy )

Sets the values of the opacity slider. Choose value between 0.0 and 1.0.

Parameters

[in] opactiy the new opacity value.

Definition at line 232 of file quickcontrolview.cpp.

◆ setVisiblityHideOpacityClose()

void QuickControlView::setVisiblityHideOpacityClose ( bool bVisibility )

Sets the visibility of the hide/show and close button

Parameters

[in] bVisibility the new visiblity state.

Definition at line 248 of file quickcontrolview.cpp.

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

src/libraries/disp/viewers/quickcontrolview.h
src/libraries/disp/viewers/quickcontrolview.cpp

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ ConstSPtr

◆ SPtr

Constructor & Destructor Documentation

◆ QuickControlView()

◆ ~QuickControlView()

Member Function Documentation

◆ addGroupBox()

◆ addGroupBoxWithTabs()

◆ addWidget()

◆ addWidgets()

◆ clear()

◆ findTabWidgetLayout()

◆ getOpacityValue()

◆ loadSettings()

◆ onOpacityChange()

◆ saveSettings()

◆ setOpacityValue()

◆ setVisiblityHideOpacityClose()