Implementation of the widget, which is represented as a set of pages. More...

#include <CMultiPageWidget.h>

Inherits QWidget.

Collaboration diagram for iwidgets::CMultiPageWidget:

Public Types
enum	DesignType { DT_SIMPLE , DT_TOOL_BOX , DT_TAB_WIDGET , DT_SPLITTER , DT_STACK , DT_COLLAPSIBLE_GROUPS , DT_MINI_WIDGETS , DT_USER = 1024 }

typedef QWidget	BaseClass

typedef IMultiPageWidgetDelegate::PageHeaderPosition	PageHeaderPosition

Signals
void	EmitPageIndexChanged (int pageIndex)
	Signal will be emitted whenever the currently selected page will be changed.

Public Member Functions
	CMultiPageWidget (QWidget *parentWidgetPtr=nullptr, int designMode=DT_SIMPLE, int containerGuiFlags=IMultiPageWidgetDelegate::CGF_NONE, Qt::Orientation orientation=Qt::Vertical)
	Construct the multi page widget.

virtual QWidget *	GetContainerWidgetPtr () const
	Get page container widget.

void	SetDesignMode (int designMode)
	Set design mode.

void	SetContainerGuiFlags (int containerGuiFlags)
	Set flags for container behavior.

void	SetLayoutOrientation (Qt::Orientation orientation)
	Set layout orientation for the pages in the container UI.

virtual void	ResetPages ()
	Remove all pages from the container widget.

virtual void	SetPageHeaderPosition (PageHeaderPosition pageHeaderPosition)
	Set the position of the page header on the container UI.

virtual int	InsertPage (QWidget *pageWidgetPtr, const QString &pageTitle, int pageIndex=-1)
	Add a new page to the container.

virtual void	RemovePage (int pageIndex)
	Remove the page from the container.

virtual int	GetPagesCount () const
	Get the number of the pages in the container.

virtual QWidget *	GetPageWidgetPtr (int pageIndex) const
	Get page's widget from the container.

virtual int	GetCurrentPage () const
	Get currently active page in the container.

virtual bool	SetCurrentPage (int pageIndex)
	Set active page in the container.

virtual QString	GetPageTitle (int pageIndex) const
	Get the title of the given page.

virtual void	SetPageTitle (int pageIndex, const QString &pageTitle)
	Set the page title.

virtual QIcon	GetPageIcon (int pageIndex) const
	Get the page icon.

virtual void	SetPageIcon (int pageIndex, const QIcon &pageIcon)
	Set the page icon.

virtual QString	GetPageToolTip (int pageIndex) const
	Get the page tool tip.

virtual void	SetPageToolTip (int pageIndex, const QString &pageToolTip)
	Set the page tool tip.

virtual bool	IsPageEnabled (int pageIndex) const
	Get if the page enabled/disabled.

virtual bool	SetPageEnabled (int pageIndex, bool isPageEnabled=true)
	Set page enabled/disabled.

virtual bool	IsPageVisible (int pageIndex) const
	Get if the page visible/hidden.

virtual bool	SetPageVisible (int pageIndex, bool isPageVisible=true)
	Set page visible/hidden.

virtual QSize	GetPageIconSize () const
	Get the size page icon.

virtual bool	SetPageIconSize (const QSize &pageIconSize)
	Set the size of the icon for all pages in the container.

template<class DelegateImpl >
void	RegisterMultiPageWidgetDelegate (int uiMode)
	Register your own page widget delegate objects for the given UI mode.

Static Public Member Functions
static bool	IsPageIndexChangeSupported (int designMode)
	Check if switching of pages is supported for this UI mode.

Protected Slots
void	OnPageIndexChanged (int pageIndex)

Detailed Description

Implementation of the widget, which is represented as a set of pages.

According to a selected UI presentation mode, it can be a tab widget, stacked layout, tool box, or simple a set of lay-outed widgets.

Definition at line 29 of file CMultiPageWidget.h.

Member Typedef Documentation

◆ BaseClass

QWidget iwidgets::CMultiPageWidget::BaseClass

Definition at line 33 of file CMultiPageWidget.h.

◆ PageHeaderPosition

IMultiPageWidgetDelegate::PageHeaderPosition iwidgets::CMultiPageWidget::PageHeaderPosition

Definition at line 34 of file CMultiPageWidget.h.

Member Enumeration Documentation

◆ DesignType

enum iwidgets::CMultiPageWidget::DesignType

Enumerator
DT_SIMPLE	The pages will be placed simple beside each other.
DT_TOOL_BOX	The pages are grouped in a tool box.
DT_TAB_WIDGET	The pages are grouped in a tab widget.
DT_SPLITTER	The same as DT_SIMPLE but a splitter manager is used for lay-outing of the pages.
DT_STACK	The pages are grouped in a stack layout.
DT_COLLAPSIBLE_GROUPS	The pages will be placed into collapsible panels.
DT_MINI_WIDGETS	The pages will be placed into a mini-widget container.
DT_USER	User defined container implementation.

Definition at line 36 of file CMultiPageWidget.h.

Constructor & Destructor Documentation

◆ CMultiPageWidget()

iwidgets::CMultiPageWidget::CMultiPageWidget	(	QWidget *	parentWidgetPtr = nullptr,
		int	designMode = DT_SIMPLE,
		int	containerGuiFlags = IMultiPageWidgetDelegate::CGF_NONE,
		Qt::Orientation	orientation = Qt::Vertical )

Construct the multi page widget.

Parameters

designMode Specify the type of the underlying page container widget.

See also: DesignType

Parameters

orientation Specify how the pages are layouted in the container UI.

Member Function Documentation

◆ EmitPageIndexChanged

void iwidgets::CMultiPageWidget::EmitPageIndexChanged ( int pageIndex )

signal

Signal will be emitted whenever the currently selected page will be changed.

◆ GetContainerWidgetPtr()

virtual QWidget * iwidgets::CMultiPageWidget::GetContainerWidgetPtr ( ) const

virtual

Get page container widget.

◆ GetCurrentPage()

virtual int iwidgets::CMultiPageWidget::GetCurrentPage ( ) const

virtual

Get currently active page in the container.

◆ GetPageIcon()

virtual QIcon iwidgets::CMultiPageWidget::GetPageIcon ( int pageIndex ) const

virtual

Get the page icon.

◆ GetPageIconSize()

virtual QSize iwidgets::CMultiPageWidget::GetPageIconSize ( ) const

virtual

Get the size page icon.

◆ GetPagesCount()

virtual int iwidgets::CMultiPageWidget::GetPagesCount ( ) const

virtual

Get the number of the pages in the container.

◆ GetPageTitle()

virtual QString iwidgets::CMultiPageWidget::GetPageTitle ( int pageIndex ) const

virtual

Get the title of the given page.

◆ GetPageToolTip()

virtual QString iwidgets::CMultiPageWidget::GetPageToolTip ( int pageIndex ) const

virtual

Get the page tool tip.

◆ GetPageWidgetPtr()

virtual QWidget * iwidgets::CMultiPageWidget::GetPageWidgetPtr ( int pageIndex ) const

virtual

Get page's widget from the container.

◆ InsertPage()

virtual int iwidgets::CMultiPageWidget::InsertPage	(	QWidget *	pageWidgetPtr,
		const QString &	pageTitle,
		int	pageIndex = -1 )

virtual

Add a new page to the container.

If pageIndex is negative, the new page will be inserted after the last page. The container overtakes the control about widgetPtr.

Returns: Position of the inserted page.

◆ IsPageEnabled()

virtual bool iwidgets::CMultiPageWidget::IsPageEnabled ( int pageIndex ) const

virtual

Get if the page enabled/disabled.

◆ IsPageIndexChangeSupported()

static bool iwidgets::CMultiPageWidget::IsPageIndexChangeSupported ( int designMode )

static

Check if switching of pages is supported for this UI mode.

◆ IsPageVisible()

virtual bool iwidgets::CMultiPageWidget::IsPageVisible ( int pageIndex ) const

virtual

Get if the page visible/hidden.

◆ OnPageIndexChanged

void iwidgets::CMultiPageWidget::OnPageIndexChanged ( int pageIndex )

protectedslot

◆ RegisterMultiPageWidgetDelegate()

template<class DelegateImpl >

void iwidgets::CMultiPageWidget::RegisterMultiPageWidgetDelegate ( int uiMode )

Register your own page widget delegate objects for the given UI mode.

Definition at line 281 of file CMultiPageWidget.h.

◆ RemovePage()

virtual void iwidgets::CMultiPageWidget::RemovePage ( int pageIndex )

virtual

Remove the page from the container.

The page widget will be destroyed.

◆ ResetPages()

virtual void iwidgets::CMultiPageWidget::ResetPages ( )

virtual

Remove all pages from the container widget.

◆ SetContainerGuiFlags()

void iwidgets::CMultiPageWidget::SetContainerGuiFlags ( int containerGuiFlags )

Set flags for container behavior.

Existing pages will be re-integrated into the new container widget.

Note: Currently, the switching of the container-UI flags after adding some pages to this object is not implemented!

See also: IMultiPageWidgetDelegate::ContainerGuiFlags

◆ SetCurrentPage()

virtual bool iwidgets::CMultiPageWidget::SetCurrentPage ( int pageIndex )

virtual

Set active page in the container.

◆ SetDesignMode()

void iwidgets::CMultiPageWidget::SetDesignMode ( int designMode )

Set design mode.

Existing pages will be re-integrated into the new container widget.

Note: Currently, the switching of the design mode after adding some pages to this object is not implemented!

See also: DesignType

◆ SetLayoutOrientation()

void iwidgets::CMultiPageWidget::SetLayoutOrientation ( Qt::Orientation orientation )

Set layout orientation for the pages in the container UI.

Note: Currently, the switching of the layout orientation after adding some pages to this object is not implemented!

See also: Qt::Orientation

◆ SetPageEnabled()

virtual bool iwidgets::CMultiPageWidget::SetPageEnabled	(	int	pageIndex,
		bool	isPageEnabled = true )

virtual

Set page enabled/disabled.

◆ SetPageHeaderPosition()

virtual void iwidgets::CMultiPageWidget::SetPageHeaderPosition ( PageHeaderPosition pageHeaderPosition )

virtual

Set the position of the page header on the container UI.

◆ SetPageIcon()

virtual void iwidgets::CMultiPageWidget::SetPageIcon	(	int	pageIndex,
		const QIcon &	pageIcon )

virtual

Set the page icon.

◆ SetPageIconSize()

virtual bool iwidgets::CMultiPageWidget::SetPageIconSize ( const QSize & pageIconSize )

virtual

Set the size of the icon for all pages in the container.

◆ SetPageTitle()

virtual void iwidgets::CMultiPageWidget::SetPageTitle	(	int	pageIndex,
		const QString &	pageTitle )

virtual

Set the page title.

◆ SetPageToolTip()

virtual void iwidgets::CMultiPageWidget::SetPageToolTip	(	int	pageIndex,
		const QString &	pageToolTip )

virtual

Set the page tool tip.

◆ SetPageVisible()

virtual bool iwidgets::CMultiPageWidget::SetPageVisible	(	int	pageIndex,
		bool	isPageVisible = true )

virtual

Set page visible/hidden.

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

iwidgets/CMultiPageWidget.h

Public Types

Signals

Public Member Functions

Static Public Member Functions

Protected Slots

Detailed Description

Member Typedef Documentation

◆ BaseClass

◆ PageHeaderPosition

Member Enumeration Documentation

◆ DesignType

Constructor & Destructor Documentation

◆ CMultiPageWidget()

Member Function Documentation

◆ EmitPageIndexChanged

◆ GetContainerWidgetPtr()

◆ GetCurrentPage()

◆ GetPageIcon()

◆ GetPageIconSize()

◆ GetPagesCount()

◆ GetPageTitle()

◆ GetPageToolTip()

◆ GetPageWidgetPtr()

◆ InsertPage()

◆ IsPageEnabled()

◆ IsPageIndexChangeSupported()

◆ IsPageVisible()

◆ OnPageIndexChanged

◆ RegisterMultiPageWidgetDelegate()

◆ RemovePage()

◆ ResetPages()

◆ SetContainerGuiFlags()

◆ SetCurrentPage()

◆ SetDesignMode()

◆ SetLayoutOrientation()

◆ SetPageEnabled()

◆ SetPageHeaderPosition()

◆ SetPageIcon()

◆ SetPageIconSize()

◆ SetPageTitle()

◆ SetPageToolTip()

◆ SetPageVisible()