Qtilities::CoreGui::DynamicSideWidgetViewer Class Reference

The widget which can display dynamic side widgets (widgets implementing the ISideViewerWidget interface). More...

#include <DynamicSideWidgetViewer.h>

List of all members.

Public Slots
void	handleNewSideWidgetRequest ()
	Handles requests for new side widgets.
void	handleSideWidgetDestroyed (QWidget *widget)
	Handles the deletion of side widgets.

Signals
void	toggleVisibility (bool toggle)
	Signal indicating that this side widget viewer must be hidden.

Public Member Functions
QStringList	hiddenSideWidgets () const
	Gets the side widgets which are hidden.
bool	isExclusive () const
	Indicates if this widget handles dynamic widgets in an exclusive way.
void	setHiddenSideWidgets (const QStringList &widget_names)
	Specifies side widgets which should be hidden.
void	setIFaceMap (QMap< QString, ISideViewerWidget * > text_iface_map, bool is_exclusive=false, const QStringList &widget_order=QStringList())
	Adds a widget to the bottom of the dynamic viewer.
QList< ISideViewerWidget * >	sideViewerWidgetInterfaces () const
	Returns a list of all side viewer widget interfaces displayed in this viewer.
QList< QWidget * >	sideViewerWidgets () const
	Returns a list of all side viewer widgets displayed in this viewer.
QStringList	widgetNames () const
	Returns a list of all widget names available in this widget.

---

Detailed Description

The widget which can display dynamic side widgets (widgets implementing the ISideViewerWidget interface).

---

Member Function Documentation

QStringList Qtilities::CoreGui::DynamicSideWidgetViewer::hiddenSideWidgets

(

)

const

Gets the side widgets which are hidden.

This function was added in Qtilities v1.3.

bool Qtilities::CoreGui::DynamicSideWidgetViewer::isExclusive

(

)

const

Indicates if this widget handles dynamic widgets in an exclusive way.

See also:

setIFaceMap();

void Qtilities::CoreGui::DynamicSideWidgetViewer::setHiddenSideWidgets

(

const QStringList &

widget_names

)

Specifies side widgets which should be hidden.

Calling this function will hide the specified widgets and also remove it from all combo boxes. All widgets not part of this list will be handled as normal.

This function was added in Qtilities v1.3.

void Qtilities::CoreGui::DynamicSideWidgetViewer::setIFaceMap	(	QMap< QString, ISideViewerWidget * >	text_iface_map,
		bool	is_exclusive = false,
		const QStringList &	widget_order = QStringList()
	)

Adds a widget to the bottom of the dynamic viewer.

This functions gets a map with name-interface pairs of all the side viewer widgets found in the global object pool. The function will automatically filter the widgets depending on the destination mode assigned to this widget in its constructor.

Parameters:

text_iface_map	A map with the name-interface pairs of side viewer widgets in the global object pool.
is_exclusive	When true, the side viewer widgets are exclusive which means that they can only appear once. If a widget is already active, it will not appear in the combo box to be switched to again.
widget_order	A list containing the names of side widget you would like to show first (at the top) in your side widget viewer.

QList< ISideViewerWidget * > Qtilities::CoreGui::DynamicSideWidgetViewer::sideViewerWidgetInterfaces

(

)

const

Returns a list of all side viewer widget interfaces displayed in this viewer.

Returns:

A list of all side viewer widget interfaces displayed in this viewer.

This function was added in Qtilities v1.2.

QList< QWidget * > Qtilities::CoreGui::DynamicSideWidgetViewer::sideViewerWidgets

(

)

const

Returns a list of all side viewer widgets displayed in this viewer.

Returns:

A list of all side viewer widgets displayed in this viewer.

This function was added in Qtilities v1.2.