Interface of a delegate object used for operating on concrete UI-container implementation. More...

#include <IMultiPageWidgetDelegate.h>

Inheritance diagram for iwidgets::IMultiPageWidgetDelegate:

Collaboration diagram for iwidgets::IMultiPageWidgetDelegate:

Public Types
enum	PageHeaderPosition { PHP_AUTO , PHP_LEFT , PHP_TOP , PHP_RIGHT , PHP_BOTTOM }
	Enum for describing of page header bar position on the container widget. More...

enum	ContainerGuiFlags { CGF_NONE = 0 , CGF_UNIFORM_SIZES = 1 , CGF_COMPACT = 2 }
	Flags for specifying the visual behavior of the page widgets in the UI-container. More...

Public Member Functions
virtual QWidget *	CreateContainerWidget (QWidget *parentWidgetPtr, int containerGuiFlags=CGF_NONE, int orientation=Qt::Horizontal)=0
	Create container for the page widgets.

virtual bool	ConnectPageIndexListener (QWidget &containerWidget, QObject receiverPtr, const char receiverSlotName)=0
	Connect object, which will be notified about changing of the current selected page index.

virtual bool	SetPageHeaderPosition (QWidget &containerWidget, PageHeaderPosition pageHeaderPosition)=0
	Set the position of the page header bar on the container UI.

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

virtual void	RemovePage (QWidget &containerWidget, int pageIndex)=0
	Remove the page from the container.

virtual void	ResetPages (QWidget &containerWidget)=0
	Remove all pages from the container.

virtual int	GetPagesCount (const QWidget &containerWidget) const =0
	Get the number of the pages in the container.

virtual QWidget *	GetPageWidgetPtr (const QWidget &containerWidget, int pageIndex) const =0
	Get page's widget from the container.

virtual int	GetCurrentPage (const QWidget &containerWidget) const =0
	Get currently active page in the container.

virtual bool	SetCurrentPage (QWidget &containerWidget, int pageIndex)=0
	Set active page in the container.

virtual QString	GetPageTitle (const QWidget &containerWidget, int pageIndex) const =0
	Get the title of the given page.

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

virtual QIcon	GetPageIcon (const QWidget &containerWidget, int pageIndex) const =0
	Get the page icon.

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

virtual QString	GetPageToolTip (const QWidget &containerWidget, int pageIndex) const =0
	Get the page tool tip.

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

virtual bool	IsPageEnabled (const QWidget &containerWidget, int pageIndex) const =0
	Get if the page enabled/disabled.

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

virtual bool	IsPageVisible (const QWidget &containerWidget, int pageIndex) const =0
	Get if the page visible/hidden.

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

virtual QSize	GetPageIconSize (const QWidget &containerWidget) const =0
	Get the size page icon.

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

Detailed Description

Interface of a delegate object used for operating on concrete UI-container implementation.

The delegate itself is no widget, but it provides all necessary management functionalities for a page container widget.

See also: CTabWidgetDelegate, CSplitterDelegate, CToolBoxDelegate and CSimpleGuiContainerDelegate

Definition at line 29 of file IMultiPageWidgetDelegate.h.

Member Enumeration Documentation

◆ ContainerGuiFlags

enum iwidgets::IMultiPageWidgetDelegate::ContainerGuiFlags

Flags for specifying the visual behavior of the page widgets in the UI-container.

Enumerator
CGF_NONE	Default behavior of the UI container.
CGF_UNIFORM_SIZES	If set, the container will try to preserve the same size of the page widgets.
CGF_COMPACT	If set, the container will try to minimize the size of the page content.

Definition at line 66 of file IMultiPageWidgetDelegate.h.

◆ PageHeaderPosition

enum iwidgets::IMultiPageWidgetDelegate::PageHeaderPosition

Enum for describing of page header bar position on the container widget.

Enumerator
PHP_AUTO	Default page header position (decided by container implementation)
PHP_LEFT	The page header will be placed on the left side of the container if possible.
PHP_TOP	The page header will be placed on the top side of the container if possible.
PHP_RIGHT	The page header will be placed on the right side of the container if possible.
PHP_BOTTOM	The page header will be placed on the bottom side of the container if possible.

Definition at line 35 of file IMultiPageWidgetDelegate.h.

Member Function Documentation

◆ ConnectPageIndexListener()

virtual bool iwidgets::IMultiPageWidgetDelegate::ConnectPageIndexListener	(	QWidget &	containerWidget,
		QObject *	receiverPtr,
		const char *	receiverSlotName )

pure virtual

Connect object, which will be notified about changing of the current selected page index.

Parameters

containerWidget	Container widget which provides initiate switching of the page
receiverPtr	Receiver of the page changing notification
receiverSlotName	Name of the slot implemented in the receiver implementation, which will be triggered on page switching.

Implemented in iwidgets::CCollapsibleGroupWidgetDelegate, iwidgets::CMiniWidgetDelegate, iwidgets::CSimpleGuiContainerDelegate, iwidgets::CSplitterDelegate, iwidgets::CStackWidgetDelegate, iwidgets::CTabWidgetDelegate, and iwidgets::CToolBoxDelegate.

◆ CreateContainerWidget()

virtual QWidget * iwidgets::IMultiPageWidgetDelegate::CreateContainerWidget	(	QWidget *	parentWidgetPtr,
		int	containerGuiFlags = CGF_NONE,
		int	orientation = Qt::Horizontal )

pure virtual

Create container for the page widgets.

Implemented in iwidgets::CCollapsibleGroupWidgetDelegate, iwidgets::CMiniWidgetDelegate, iwidgets::CSimpleGuiContainerDelegate, iwidgets::CSplitterDelegate, iwidgets::CStackWidgetDelegate, iwidgets::CTabWidgetDelegate, and iwidgets::CToolBoxDelegate.

◆ GetCurrentPage()

virtual int iwidgets::IMultiPageWidgetDelegate::GetCurrentPage ( const QWidget & containerWidget ) const

pure virtual

Get currently active page in the container.

Implemented in iwidgets::CCollapsibleGroupWidgetDelegate, iwidgets::CMiniWidgetDelegate, iwidgets::CSimpleGuiContainerDelegate, iwidgets::CSplitterDelegate, iwidgets::CStackWidgetDelegate, iwidgets::CTabWidgetDelegate, and iwidgets::CToolBoxDelegate.

◆ GetPageIcon()

virtual QIcon iwidgets::IMultiPageWidgetDelegate::GetPageIcon	(	const QWidget &	containerWidget,
		int	pageIndex ) const

pure virtual

Get the page icon.

Implemented in iwidgets::CCollapsibleGroupWidgetDelegate, iwidgets::CMiniWidgetDelegate, iwidgets::CSimpleGuiContainerDelegate, iwidgets::CSplitterDelegate, iwidgets::CStackWidgetDelegate, iwidgets::CTabWidgetDelegate, and iwidgets::CToolBoxDelegate.

◆ GetPageIconSize()

virtual QSize iwidgets::IMultiPageWidgetDelegate::GetPageIconSize ( const QWidget & containerWidget ) const

pure virtual

Get the size page icon.

Implemented in iwidgets::CCollapsibleGroupWidgetDelegate, iwidgets::CMiniWidgetDelegate, iwidgets::CSimpleGuiContainerDelegate, iwidgets::CSplitterDelegate, iwidgets::CStackWidgetDelegate, iwidgets::CTabWidgetDelegate, and iwidgets::CToolBoxDelegate.

◆ GetPagesCount()

virtual int iwidgets::IMultiPageWidgetDelegate::GetPagesCount ( const QWidget & containerWidget ) const

pure virtual

Get the number of the pages in the container.

Implemented in iwidgets::CCollapsibleGroupWidgetDelegate, iwidgets::CMiniWidgetDelegate, iwidgets::CSimpleGuiContainerDelegate, iwidgets::CSplitterDelegate, iwidgets::CStackWidgetDelegate, iwidgets::CTabWidgetDelegate, and iwidgets::CToolBoxDelegate.

◆ GetPageTitle()

virtual QString iwidgets::IMultiPageWidgetDelegate::GetPageTitle	(	const QWidget &	containerWidget,
		int	pageIndex ) const

pure virtual

Get the title of the given page.

Implemented in iwidgets::CCollapsibleGroupWidgetDelegate, iwidgets::CMiniWidgetDelegate, iwidgets::CSimpleGuiContainerDelegate, iwidgets::CSplitterDelegate, iwidgets::CStackWidgetDelegate, iwidgets::CTabWidgetDelegate, and iwidgets::CToolBoxDelegate.

◆ GetPageToolTip()

virtual QString iwidgets::IMultiPageWidgetDelegate::GetPageToolTip	(	const QWidget &	containerWidget,
		int	pageIndex ) const

pure virtual

Get the page tool tip.

Implemented in iwidgets::CCollapsibleGroupWidgetDelegate, iwidgets::CMiniWidgetDelegate, iwidgets::CSimpleGuiContainerDelegate, iwidgets::CSplitterDelegate, iwidgets::CStackWidgetDelegate, iwidgets::CTabWidgetDelegate, and iwidgets::CToolBoxDelegate.

◆ GetPageWidgetPtr()

virtual QWidget * iwidgets::IMultiPageWidgetDelegate::GetPageWidgetPtr	(	const QWidget &	containerWidget,
		int	pageIndex ) const

pure virtual

Get page's widget from the container.

Implemented in iwidgets::CCollapsibleGroupWidgetDelegate, iwidgets::CMiniWidgetDelegate, iwidgets::CSimpleGuiContainerDelegate, iwidgets::CSplitterDelegate, iwidgets::CStackWidgetDelegate, iwidgets::CTabWidgetDelegate, and iwidgets::CToolBoxDelegate.

◆ InsertPage()

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

pure 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.

Implemented in iwidgets::CCollapsibleGroupWidgetDelegate, iwidgets::CMiniWidgetDelegate, iwidgets::CSimpleGuiContainerDelegate, iwidgets::CSplitterDelegate, iwidgets::CStackWidgetDelegate, iwidgets::CTabWidgetDelegate, and iwidgets::CToolBoxDelegate.

◆ IsPageEnabled()

virtual bool iwidgets::IMultiPageWidgetDelegate::IsPageEnabled	(	const QWidget &	containerWidget,
		int	pageIndex ) const

pure virtual

Get if the page enabled/disabled.

Implemented in iwidgets::CCollapsibleGroupWidgetDelegate, iwidgets::CMiniWidgetDelegate, iwidgets::CSimpleGuiContainerDelegate, iwidgets::CSplitterDelegate, iwidgets::CStackWidgetDelegate, iwidgets::CTabWidgetDelegate, and iwidgets::CToolBoxDelegate.

◆ IsPageVisible()

virtual bool iwidgets::IMultiPageWidgetDelegate::IsPageVisible	(	const QWidget &	containerWidget,
		int	pageIndex ) const

pure virtual

Get if the page visible/hidden.

Implemented in iwidgets::CCollapsibleGroupWidgetDelegate, iwidgets::CMiniWidgetDelegate, iwidgets::CSimpleGuiContainerDelegate, iwidgets::CSplitterDelegate, iwidgets::CStackWidgetDelegate, iwidgets::CTabWidgetDelegate, and iwidgets::CToolBoxDelegate.

◆ RemovePage()

virtual void iwidgets::IMultiPageWidgetDelegate::RemovePage	(	QWidget &	containerWidget,
		int	pageIndex )

pure virtual

Remove the page from the container.

The page widget will be destroyed.

Implemented in iwidgets::CCollapsibleGroupWidgetDelegate, iwidgets::CMiniWidgetDelegate, iwidgets::CSimpleGuiContainerDelegate, iwidgets::CSplitterDelegate, iwidgets::CStackWidgetDelegate, iwidgets::CTabWidgetDelegate, and iwidgets::CToolBoxDelegate.

◆ ResetPages()

virtual void iwidgets::IMultiPageWidgetDelegate::ResetPages ( QWidget & containerWidget )

pure virtual

Remove all pages from the container.

All page widgets will be destroyed.

Implemented in iwidgets::CCollapsibleGroupWidgetDelegate, iwidgets::CMiniWidgetDelegate, iwidgets::CSimpleGuiContainerDelegate, iwidgets::CSplitterDelegate, iwidgets::CStackWidgetDelegate, iwidgets::CTabWidgetDelegate, and iwidgets::CToolBoxDelegate.

◆ SetCurrentPage()

virtual bool iwidgets::IMultiPageWidgetDelegate::SetCurrentPage	(	QWidget &	containerWidget,
		int	pageIndex )

pure virtual

Set active page in the container.

Implemented in iwidgets::CCollapsibleGroupWidgetDelegate, iwidgets::CMiniWidgetDelegate, iwidgets::CSimpleGuiContainerDelegate, iwidgets::CSplitterDelegate, iwidgets::CStackWidgetDelegate, iwidgets::CTabWidgetDelegate, and iwidgets::CToolBoxDelegate.

◆ SetPageEnabled()

virtual bool iwidgets::IMultiPageWidgetDelegate::SetPageEnabled	(	QWidget &	containerWidget,
		int	pageIndex,
		bool	isPageEnabled = true )

pure virtual

Set page enabled/disabled.

Implemented in iwidgets::CCollapsibleGroupWidgetDelegate, iwidgets::CMiniWidgetDelegate, iwidgets::CSimpleGuiContainerDelegate, iwidgets::CSplitterDelegate, iwidgets::CStackWidgetDelegate, iwidgets::CTabWidgetDelegate, and iwidgets::CToolBoxDelegate.

◆ SetPageHeaderPosition()

virtual bool iwidgets::IMultiPageWidgetDelegate::SetPageHeaderPosition	(	QWidget &	containerWidget,
		PageHeaderPosition	pageHeaderPosition )

pure virtual

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

Implemented in iwidgets::CCollapsibleGroupWidgetDelegate, iwidgets::CMiniWidgetDelegate, iwidgets::CSimpleGuiContainerDelegate, iwidgets::CSplitterDelegate, iwidgets::CStackWidgetDelegate, iwidgets::CTabWidgetDelegate, and iwidgets::CToolBoxDelegate.

◆ SetPageIcon()

virtual void iwidgets::IMultiPageWidgetDelegate::SetPageIcon	(	QWidget &	containerWidget,
		int	pageIndex,
		const QIcon &	pageIcon )

pure virtual

Set the page icon.

Implemented in iwidgets::CCollapsibleGroupWidgetDelegate, iwidgets::CMiniWidgetDelegate, iwidgets::CSimpleGuiContainerDelegate, iwidgets::CSplitterDelegate, iwidgets::CStackWidgetDelegate, iwidgets::CTabWidgetDelegate, and iwidgets::CToolBoxDelegate.

◆ SetPageIconSize()

virtual bool iwidgets::IMultiPageWidgetDelegate::SetPageIconSize	(	QWidget &	containerWidget,
		const QSize &	pageIconSize )

pure virtual

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

Implemented in iwidgets::CCollapsibleGroupWidgetDelegate, iwidgets::CMiniWidgetDelegate, iwidgets::CSimpleGuiContainerDelegate, iwidgets::CSplitterDelegate, iwidgets::CStackWidgetDelegate, iwidgets::CTabWidgetDelegate, and iwidgets::CToolBoxDelegate.

◆ SetPageTitle()

virtual void iwidgets::IMultiPageWidgetDelegate::SetPageTitle	(	QWidget &	containerWidget,
		int	pageIndex,
		const QString &	pageTitle )

pure virtual

Set the page title.

Implemented in iwidgets::CCollapsibleGroupWidgetDelegate, iwidgets::CMiniWidgetDelegate, iwidgets::CSimpleGuiContainerDelegate, iwidgets::CSplitterDelegate, iwidgets::CStackWidgetDelegate, iwidgets::CTabWidgetDelegate, and iwidgets::CToolBoxDelegate.

◆ SetPageToolTip()

virtual void iwidgets::IMultiPageWidgetDelegate::SetPageToolTip	(	QWidget &	containerWidget,
		int	pageIndex,
		const QString &	pageToolTip )

pure virtual

Set the page tool tip.

Implemented in iwidgets::CCollapsibleGroupWidgetDelegate, iwidgets::CMiniWidgetDelegate, iwidgets::CSimpleGuiContainerDelegate, iwidgets::CSplitterDelegate, iwidgets::CStackWidgetDelegate, iwidgets::CTabWidgetDelegate, and iwidgets::CToolBoxDelegate.

◆ SetPageVisible()

virtual bool iwidgets::IMultiPageWidgetDelegate::SetPageVisible	(	QWidget &	containerWidget,
		int	pageIndex,
		bool	isPageVisible = true )

pure virtual

Set page visible/hidden.

Implemented in iwidgets::CCollapsibleGroupWidgetDelegate, iwidgets::CMiniWidgetDelegate, iwidgets::CSimpleGuiContainerDelegate, iwidgets::CSplitterDelegate, iwidgets::CStackWidgetDelegate, iwidgets::CTabWidgetDelegate, and iwidgets::CToolBoxDelegate.

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

iwidgets/IMultiPageWidgetDelegate.h

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ ContainerGuiFlags

◆ PageHeaderPosition

Member Function Documentation

◆ ConnectPageIndexListener()

◆ CreateContainerWidget()

◆ GetCurrentPage()

◆ GetPageIcon()

◆ GetPageIconSize()

◆ GetPagesCount()

◆ GetPageTitle()

◆ GetPageToolTip()

◆ GetPageWidgetPtr()

◆ InsertPage()

◆ IsPageEnabled()

◆ IsPageVisible()

◆ RemovePage()

◆ ResetPages()

◆ SetCurrentPage()

◆ SetPageEnabled()

◆ SetPageHeaderPosition()

◆ SetPageIcon()

◆ SetPageIconSize()

◆ SetPageTitle()

◆ SetPageToolTip()

◆ SetPageVisible()