CTK  0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ctkWorkflowAbstractPagedWidget Class Referenceabstract

#include <Libs/Widgets/ctkWorkflowAbstractPagedWidget.h>

Inheritance diagram for ctkWorkflowAbstractPagedWidget:
Inheritance graph
[legend]
Collaboration diagram for ctkWorkflowAbstractPagedWidget:
Collaboration graph
[legend]

Public Types

typedef ctkWorkflowWidget Superclass
 
- Public Types inherited from ctkWorkflowWidget
typedef QWidget Superclass
 

Public Member Functions

virtual void associateStepWithLabel (ctkWorkflowStep *step, QString label)
 Optionally specify the label to be displayed on the page shown for the given step. More...
 
virtual void associateStepWithPage (ctkWorkflowStep *step, int index)
 
virtual void associateStepWithPage (ctkWorkflowStep *step, int index, QString label)
 
 ctkWorkflowAbstractPagedWidget (QWidget *newParent=0)
 
virtual Q_INVOKABLE ctkWorkflowGroupBoxworkflowGroupBox () const
 Get the workflow group box associated with a particular step. More...
 
virtual ctkWorkflowGroupBoxworkflowGroupBox (ctkWorkflowStep *step) const
 
virtual ~ctkWorkflowAbstractPagedWidget ()
 
- Public Member Functions inherited from ctkWorkflowWidget
Q_INVOKABLE ctkWorkflowButtonBoxWidgetbuttonBoxWidget () const
 Get the widget with the 'next', 'back' and 'goTo' buttons. More...
 
 ctkWorkflowWidget (QWidget *parent=0)
 
void setShowButtonBoxWidget (bool newShowButtonBoxWidget)
 
virtual Q_INVOKABLE void setWorkflow (ctkWorkflow *newWorkflow)
 
bool showButtonBoxWidget () const
 Set/get whether or not to associate a buttonBoxWidget with this step (default true) More...
 
Q_INVOKABLE ctkWorkflowWidgetStepwidgetStep (const QString &id) const
 
virtual Q_INVOKABLE ctkWorkflowworkflow () const
 Set/get the workflow associated with this widget. More...
 
virtual Q_INVOKABLE ctkWorkflowGroupBoxworkflowGroupBox () const
 
virtual ~ctkWorkflowWidget ()
 

Protected Member Functions

virtual QWidget * clientArea ()=0
 
virtual void createNewPage (QWidget *widget)=0
 
virtual void initClientArea ()=0
 
virtual void showPage (QWidget *widget, const QString &label)=0
 
virtual void updateStepUI (ctkWorkflowStep *currentStep)
 
- Protected Member Functions inherited from ctkWorkflowWidget
void updateButtonBoxUI (ctkWorkflowStep *currentStep)
 

Protected Attributes

QScopedPointer< ctkWorkflowAbstractPagedWidgetPrivate > d_ptr
 
- Protected Attributes inherited from ctkWorkflowWidget
QScopedPointer< ctkWorkflowWidgetPrivate > d_ptr
 

Additional Inherited Members

- Public Slots inherited from ctkWorkflowWidget
virtual void onCurrentStepChanged (ctkWorkflowStep *currentStep)
 
- Static Public Member Functions inherited from ctkWorkflowWidget
static void formatButton (QAbstractButton *button, const QString &format, ctkWorkflowWidgetStep *step)
 
static QString formatText (const QString &format, ctkWorkflowWidgetStep *step)
 
- Protected Slots inherited from ctkWorkflowWidget
void onStepRegistered (ctkWorkflowStep *step)
 
- Static Protected Member Functions inherited from ctkWorkflowWidget
static QVariant buttonItem (QString formatItem, ctkWorkflowWidgetStep *step)
 
static QMap< QString, QVariant > parse (const QString &format, ctkWorkflowWidgetStep *step)
 
- Properties inherited from ctkWorkflowWidget
bool showButtonBoxWidget
 

Detailed Description

ctkWorkflowAbstractPagedWidget is the basis for a workflow with a user interface containing multiple pages. By default, each step is placed onto its own page. Multiple workflow steps can be placed on the same page using associateStepWithPage().

Definition at line 40 of file ctkWorkflowAbstractPagedWidget.h.

Member Typedef Documentation

◆ Superclass

Definition at line 46 of file ctkWorkflowAbstractPagedWidget.h.

Constructor & Destructor Documentation

◆ ctkWorkflowAbstractPagedWidget()

ctkWorkflowAbstractPagedWidget::ctkWorkflowAbstractPagedWidget ( QWidget *  newParent = 0)
explicit

◆ ~ctkWorkflowAbstractPagedWidget()

virtual ctkWorkflowAbstractPagedWidget::~ctkWorkflowAbstractPagedWidget ( )
virtual

Member Function Documentation

◆ associateStepWithLabel()

virtual void ctkWorkflowAbstractPagedWidget::associateStepWithLabel ( ctkWorkflowStep step,
QString  label 
)
virtual

Optionally specify the label to be displayed on the page shown for the given step.

◆ associateStepWithPage() [1/2]

virtual void ctkWorkflowAbstractPagedWidget::associateStepWithPage ( ctkWorkflowStep step,
int  index 
)
virtual

Dictate that a step be displayed on a particular page index, to override the default setting to display each encountered step on a new page. A label can also be provided for the step's page.

◆ associateStepWithPage() [2/2]

virtual void ctkWorkflowAbstractPagedWidget::associateStepWithPage ( ctkWorkflowStep step,
int  index,
QString  label 
)
virtual

◆ clientArea()

virtual QWidget* ctkWorkflowAbstractPagedWidget::clientArea ( )
protectedpure virtual

◆ createNewPage()

virtual void ctkWorkflowAbstractPagedWidget::createNewPage ( QWidget *  widget)
protectedpure virtual

◆ initClientArea()

virtual void ctkWorkflowAbstractPagedWidget::initClientArea ( )
protectedpure virtual

◆ showPage()

virtual void ctkWorkflowAbstractPagedWidget::showPage ( QWidget *  widget,
const QString &  label 
)
protectedpure virtual

◆ updateStepUI()

virtual void ctkWorkflowAbstractPagedWidget::updateStepUI ( ctkWorkflowStep currentStep)
protectedvirtual

Reimplemented from ctkWorkflowWidget.

◆ workflowGroupBox() [1/2]

virtual Q_INVOKABLE ctkWorkflowGroupBox* ctkWorkflowWidget::workflowGroupBox

Get the workflow group box associated with a particular step.

◆ workflowGroupBox() [2/2]

virtual ctkWorkflowGroupBox* ctkWorkflowAbstractPagedWidget::workflowGroupBox ( ctkWorkflowStep step) const
virtual

Member Data Documentation

◆ d_ptr

QScopedPointer<ctkWorkflowAbstractPagedWidgetPrivate> ctkWorkflowAbstractPagedWidget::d_ptr
protected

Definition at line 78 of file ctkWorkflowAbstractPagedWidget.h.


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