Public Types | Public Member Functions | List of all members
iwidgets::IMultiPageWidgetDelegate Class Referenceabstract

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

#include <IMultiPageWidgetDelegate.h>

Inheritance diagram for iwidgets::IMultiPageWidgetDelegate:
istd::IPolymorphic iwidgets::CCollapsibleGroupWidgetDelegate iwidgets::CSimpleGuiContainerDelegate iwidgets::CSplitterDelegate iwidgets::CStackWidgetDelegate iwidgets::CTabWidgetDelegate iwidgets::CToolBoxDelegate

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. More...
 
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. More...
 
virtual bool SetPageHeaderPosition (QWidget &containerWidget, PageHeaderPosition pageHeaderPosition)=0
 Set the position of the page header bar on the container UI. More...
 
virtual int InsertPage (QWidget &containerWidget, QWidget *pageWidgetPtr, const QString &pageTitle, int pageIndex=-1)=0
 Add a new page to the container. More...
 
virtual void RemovePage (QWidget &containerWidget, int pageIndex)=0
 Remove the page from the container. More...
 
virtual void ResetPages (QWidget &containerWidget)=0
 Remove all pages from the container. More...
 
virtual int GetPagesCount (const QWidget &containerWidget) const =0
 Get the number of the pages in the container. More...
 
virtual QWidget * GetPageWidgetPtr (const QWidget &containerWidget, int pageIndex) const =0
 Get page's widget from the container. More...
 
virtual int GetCurrentPage (const QWidget &containerWidget) const =0
 Get currently active page in the container. More...
 
virtual bool SetCurrentPage (QWidget &containerWidget, int pageIndex)=0
 Set active page in the container. More...
 
virtual QString GetPageTitle (const QWidget &containerWidget, int pageIndex) const =0
 Get the title of the given page. More...
 
virtual void SetPageTitle (QWidget &containerWidget, int pageIndex, const QString &pageTitle)=0
 Set the page title. More...
 
virtual QIcon GetPageIcon (const QWidget &containerWidget, int pageIndex) const =0
 Get the page icon. More...
 
virtual void SetPageIcon (QWidget &containerWidget, int pageIndex, const QIcon &pageIcon)=0
 Set the page icon. More...
 
virtual QString GetPageToolTip (const QWidget &containerWidget, int pageIndex) const =0
 Get the page tool tip. More...
 
virtual void SetPageToolTip (QWidget &containerWidget, int pageIndex, const QString &pageToolTip)=0
 Set the page tool tip. More...
 
virtual bool IsPageEnabled (const QWidget &containerWidget, int pageIndex) const =0
 Get if the page enabled/disabled. More...
 
virtual bool SetPageEnabled (QWidget &containerWidget, int pageIndex, bool isPageEnabled=true)=0
 Set page enabled/disabled. More...
 
virtual bool IsPageVisible (const QWidget &containerWidget, int pageIndex) const =0
 Get if the page visible/hidden. More...
 
virtual bool SetPageVisible (QWidget &containerWidget, int pageIndex, bool isPageVisible=true)=0
 Set page visible/hidden. More...
 
virtual QSize GetPageIconSize (const QWidget &containerWidget) const =0
 Get the size page icon. More...
 
virtual bool SetPageIconSize (QWidget &containerWidget, const QSize &pageIconSize)=0
 Set the size of the icon for all pages in the container. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 

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 28 of file IMultiPageWidgetDelegate.h.

Member Enumeration Documentation

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 65 of file IMultiPageWidgetDelegate.h.

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 34 of file IMultiPageWidgetDelegate.h.

Member Function Documentation

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
containerWidgetContainer widget which provides initiate switching of the page
receiverPtrReceiver of the page changing notification
receiverSlotNameName of the slot implemented in the receiver implementation, which will be triggered on page switching.

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

virtual QWidget* iwidgets::IMultiPageWidgetDelegate::CreateContainerWidget ( QWidget *  parentWidgetPtr,
int  containerGuiFlags = CGF_NONE,
int  orientation = Qt::Horizontal 
)
pure virtual
virtual int iwidgets::IMultiPageWidgetDelegate::GetCurrentPage ( const QWidget &  containerWidget) const
pure virtual
virtual QIcon iwidgets::IMultiPageWidgetDelegate::GetPageIcon ( const QWidget &  containerWidget,
int  pageIndex 
) const
pure virtual
virtual QSize iwidgets::IMultiPageWidgetDelegate::GetPageIconSize ( const QWidget &  containerWidget) const
pure virtual
virtual int iwidgets::IMultiPageWidgetDelegate::GetPagesCount ( const QWidget &  containerWidget) const
pure virtual
virtual QString iwidgets::IMultiPageWidgetDelegate::GetPageTitle ( const QWidget &  containerWidget,
int  pageIndex 
) const
pure virtual
virtual QString iwidgets::IMultiPageWidgetDelegate::GetPageToolTip ( const QWidget &  containerWidget,
int  pageIndex 
) const
pure virtual
virtual QWidget* iwidgets::IMultiPageWidgetDelegate::GetPageWidgetPtr ( const QWidget &  containerWidget,
int  pageIndex 
) const
pure virtual
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::CTabWidgetDelegate, iwidgets::CCollapsibleGroupWidgetDelegate, iwidgets::CSimpleGuiContainerDelegate, iwidgets::CSplitterDelegate, iwidgets::CStackWidgetDelegate, and iwidgets::CToolBoxDelegate.

virtual bool iwidgets::IMultiPageWidgetDelegate::IsPageEnabled ( const QWidget &  containerWidget,
int  pageIndex 
) const
pure virtual
virtual bool iwidgets::IMultiPageWidgetDelegate::IsPageVisible ( const QWidget &  containerWidget,
int  pageIndex 
) const
pure virtual
virtual void iwidgets::IMultiPageWidgetDelegate::RemovePage ( QWidget &  containerWidget,
int  pageIndex 
)
pure virtual
virtual void iwidgets::IMultiPageWidgetDelegate::ResetPages ( QWidget &  containerWidget)
pure virtual
virtual bool iwidgets::IMultiPageWidgetDelegate::SetCurrentPage ( QWidget &  containerWidget,
int  pageIndex 
)
pure virtual
virtual bool iwidgets::IMultiPageWidgetDelegate::SetPageEnabled ( QWidget &  containerWidget,
int  pageIndex,
bool  isPageEnabled = true 
)
pure virtual
virtual bool iwidgets::IMultiPageWidgetDelegate::SetPageHeaderPosition ( QWidget &  containerWidget,
PageHeaderPosition  pageHeaderPosition 
)
pure virtual
virtual void iwidgets::IMultiPageWidgetDelegate::SetPageIcon ( QWidget &  containerWidget,
int  pageIndex,
const QIcon &  pageIcon 
)
pure virtual
virtual bool iwidgets::IMultiPageWidgetDelegate::SetPageIconSize ( QWidget &  containerWidget,
const QSize &  pageIconSize 
)
pure virtual
virtual void iwidgets::IMultiPageWidgetDelegate::SetPageTitle ( QWidget &  containerWidget,
int  pageIndex,
const QString &  pageTitle 
)
pure virtual
virtual void iwidgets::IMultiPageWidgetDelegate::SetPageToolTip ( QWidget &  containerWidget,
int  pageIndex,
const QString &  pageToolTip 
)
pure virtual
virtual bool iwidgets::IMultiPageWidgetDelegate::SetPageVisible ( QWidget &  containerWidget,
int  pageIndex,
bool  isPageVisible = true 
)
pure virtual

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

© 2007-2017 Witold Gantzke and Kirill Lepskiy