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 Slots | Public Member Functions | Protected Slots | Protected Attributes | Properties | List of all members
ctkWorkflowButtonBoxWidget Class Reference

A widget that controls a workflow. More...

#include <Libs/Widgets/ctkWorkflowButtonBoxWidget.h>

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

Public Types

typedef QWidget Superclass
 

Public Slots

virtual void updateButtons (ctkWorkflowStep *currentStep)
 

Public Member Functions

Q_INVOKABLE ctkPushButtonbackButton () const
 Get the 'back' button. More...
 
QString backButtonFormat () const
 
 ctkWorkflowButtonBoxWidget (ctkWorkflow *newWorkflow, QWidget *newParent=0)
 
 ctkWorkflowButtonBoxWidget (QWidget *newParent=0)
 
QBoxLayout::Direction direction () const
 
QList< ctkPushButton * > goToButtons () const
 Get a list of the 'goTo' buttons. More...
 
QString goToButtonsFormat () const
 
bool hideGoToButtons () const
 
bool hideInvalidButtons () const
 
Q_INVOKABLE ctkPushButtonnextButton () const
 Get the 'next' button. More...
 
QString nextButtonFormat () const
 
void setBackButtonFormat (const QString &format)
 
void setDirection (const QBoxLayout::Direction &newDirection)
 
void setGoToButtonsFormat (const QString &format)
 
void setHideGoToButtons (bool hide)
 
void setHideInvalidButtons (bool newHide)
 
void setNextButtonFormat (const QString &format)
 
void setWorkflow (ctkWorkflow *newWorkflow)
 Set the workflow associated with the widget. More...
 
ctkWorkflowworkflow () const
 Get the workflow associated with the widget. More...
 
virtual ~ctkWorkflowButtonBoxWidget ()
 

Protected Slots

virtual void prepareGoToStep ()
 

Protected Attributes

QScopedPointer< ctkWorkflowButtonBoxWidgetPrivate > d_ptr
 

Properties

QString backButtonFormat
 
QString goToButtonsFormat
 
bool hideGoToButtons
 
bool hideInvalidButtons
 
QString nextButtonFormat
 

Detailed Description

A widget that controls a workflow.

Creates:

The updateButtons() slot updates the buttons to reflect the current status of the workflow, and should be called whenever the workflow's current step has changed

Definition at line 50 of file ctkWorkflowButtonBoxWidget.h.

Member Typedef Documentation

◆ Superclass

Definition at line 87 of file ctkWorkflowButtonBoxWidget.h.

Constructor & Destructor Documentation

◆ ctkWorkflowButtonBoxWidget() [1/2]

ctkWorkflowButtonBoxWidget::ctkWorkflowButtonBoxWidget ( ctkWorkflow newWorkflow,
QWidget *  newParent = 0 
)
explicit

◆ ctkWorkflowButtonBoxWidget() [2/2]

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

◆ ~ctkWorkflowButtonBoxWidget()

virtual ctkWorkflowButtonBoxWidget::~ctkWorkflowButtonBoxWidget ( )
virtual

Member Function Documentation

◆ backButton()

Q_INVOKABLE ctkPushButton* ctkWorkflowButtonBoxWidget::backButton ( ) const

Get the 'back' button.

◆ backButtonFormat()

QString ctkWorkflowButtonBoxWidget::backButtonFormat ( ) const

Return the backButtonFormat property value.

See also
backButtonFormat, setBackButtonFormat()

◆ direction()

QBoxLayout::Direction ctkWorkflowButtonBoxWidget::direction ( ) const

Sets the direction of the QBoxLayout that manages this widget (default is QBoxLayout::LeftToRight)

◆ goToButtons()

QList<ctkPushButton*> ctkWorkflowButtonBoxWidget::goToButtons ( ) const

Get a list of the 'goTo' buttons.

◆ goToButtonsFormat()

QString ctkWorkflowButtonBoxWidget::goToButtonsFormat ( ) const

Return the goToButtonsFormat property value.

See also
goToButtonsFormat, setGoToButtonsFormat()

◆ hideGoToButtons()

bool ctkWorkflowButtonBoxWidget::hideGoToButtons ( ) const

Return the hideGoToButtons property value.

See also
hideGoToButtons

◆ hideInvalidButtons()

bool ctkWorkflowButtonBoxWidget::hideInvalidButtons ( ) const

If true, invalid buttons are hidden. If false, invalid buttons are shown but disabled. Default is false.

◆ nextButton()

Q_INVOKABLE ctkPushButton* ctkWorkflowButtonBoxWidget::nextButton ( ) const

Get the 'next' button.

◆ nextButtonFormat()

QString ctkWorkflowButtonBoxWidget::nextButtonFormat ( ) const

Return the nextButtonFormat property value.

See also
nextButtonFormat, setNextButtonFormat()

◆ prepareGoToStep

virtual void ctkWorkflowButtonBoxWidget::prepareGoToStep ( )
protectedvirtualslot

is called when a 'goTo' button is clicked, and retrieves the corresponding goTo step's id to send to the workflow

◆ setBackButtonFormat()

void ctkWorkflowButtonBoxWidget::setBackButtonFormat ( const QString &  format)

Set the backButtonFormat property value.

See also
backButtonFormat, backButtonFormat()

◆ setDirection()

void ctkWorkflowButtonBoxWidget::setDirection ( const QBoxLayout::Direction &  newDirection)

◆ setGoToButtonsFormat()

void ctkWorkflowButtonBoxWidget::setGoToButtonsFormat ( const QString &  format)

Set the goToButtonsFormat property value.

See also
goToButtonsFormat, goToButtonsFormat()

◆ setHideGoToButtons()

void ctkWorkflowButtonBoxWidget::setHideGoToButtons ( bool  hide)

Set the hideGoToButtons property value.

See also
hideGoToButtons

◆ setHideInvalidButtons()

void ctkWorkflowButtonBoxWidget::setHideInvalidButtons ( bool  newHide)

◆ setNextButtonFormat()

void ctkWorkflowButtonBoxWidget::setNextButtonFormat ( const QString &  format)

Set the nextButtonFormat property value.

See also
nextButtonFormat, nextButtonFormat()

◆ setWorkflow()

void ctkWorkflowButtonBoxWidget::setWorkflow ( ctkWorkflow newWorkflow)

Set the workflow associated with the widget.

◆ updateButtons

virtual void ctkWorkflowButtonBoxWidget::updateButtons ( ctkWorkflowStep currentStep)
virtualslot

Updates the buttons to reflect the current status of the workflow, and should be called whenever the workflow's current step has changed

◆ workflow()

ctkWorkflow* ctkWorkflowButtonBoxWidget::workflow ( ) const

Get the workflow associated with the widget.

Member Data Documentation

◆ d_ptr

QScopedPointer<ctkWorkflowButtonBoxWidgetPrivate> ctkWorkflowButtonBoxWidget::d_ptr
protected

Definition at line 159 of file ctkWorkflowButtonBoxWidget.h.

Property Documentation

◆ backButtonFormat

QString ctkWorkflowButtonBoxWidget::backButtonFormat
readwrite

This property controls the text, icon and tooltip of the back button. "[<-]{backButtonText|\"Back"}(back:description)" by default.

See also
backButtonFormat(), setBackButtonFormat(), ctkWorkflow::formatButton(), nextButtonFormat, goToButtonFormat

Definition at line 1 of file ctkWorkflowButtonBoxWidget.h.

◆ goToButtonsFormat

QString ctkWorkflowButtonBoxWidget::goToButtonsFormat
readwrite

This property controls the text, icon and tooltip of the goTo/finish button. "[icon]{stepid|\"Finish"}" by default.

See also
goToButtonsFormat(), setGoToButtonsFormat(), ctkWorkflow::formatButton(), backButtonFormat, nextButtonFormat

Definition at line 1 of file ctkWorkflowButtonBoxWidget.h.

◆ hideGoToButtons

bool ctkWorkflowButtonBoxWidget::hideGoToButtons
readwrite

This property controls whether the goTo buttons are visible or hidden. False (visible) by default.

See also
hideInvalidButtons

Definition at line 1 of file ctkWorkflowButtonBoxWidget.h.

◆ hideInvalidButtons

bool ctkWorkflowButtonBoxWidget::hideInvalidButtons
readwrite

This property controls whether the back, next or goTo buttons are hidden when disabled. Note that buttons can also be hidden via ctkWorkflowWidgetStep::buttonHints.

See also
ctkWofklowWidgetStep::buttonBoxHints

Definition at line 1 of file ctkWorkflowButtonBoxWidget.h.

◆ nextButtonFormat

QString ctkWorkflowButtonBoxWidget::nextButtonFormat
readwrite

This property controls the text, icon and tooltip of the next button. "{nextButtonText|\"Next"}(next:description)[->]" by default.

See also
nextButtonFormat(), setNextButtonFormat(), ctkWorkflow::formatButton(), backButtonFormat, goToButtonFormat

Definition at line 1 of file ctkWorkflowButtonBoxWidget.h.


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