![]() |
CTK
0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
|
A widget that controls a workflow. More...
#include <Libs/Widgets/ctkWorkflowButtonBoxWidget.h>
Public Types | |
typedef QWidget | Superclass |
Public Slots | |
virtual void | updateButtons (ctkWorkflowStep *currentStep) |
Public Member Functions | |
Q_INVOKABLE ctkPushButton * | backButton () 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 ctkPushButton * | nextButton () 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... | |
ctkWorkflow * | workflow () 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 |
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.
typedef QWidget ctkWorkflowButtonBoxWidget::Superclass |
Definition at line 87 of file ctkWorkflowButtonBoxWidget.h.
|
explicit |
|
explicit |
|
virtual |
Q_INVOKABLE ctkPushButton* ctkWorkflowButtonBoxWidget::backButton | ( | ) | const |
Get the 'back' button.
QString ctkWorkflowButtonBoxWidget::backButtonFormat | ( | ) | const |
Return the backButtonFormat property value.
QBoxLayout::Direction ctkWorkflowButtonBoxWidget::direction | ( | ) | const |
Sets the direction of the QBoxLayout that manages this widget (default is QBoxLayout::LeftToRight)
QList<ctkPushButton*> ctkWorkflowButtonBoxWidget::goToButtons | ( | ) | const |
Get a list of the 'goTo' buttons.
QString ctkWorkflowButtonBoxWidget::goToButtonsFormat | ( | ) | const |
Return the goToButtonsFormat property value.
bool ctkWorkflowButtonBoxWidget::hideGoToButtons | ( | ) | const |
Return the hideGoToButtons property value.
bool ctkWorkflowButtonBoxWidget::hideInvalidButtons | ( | ) | const |
If true, invalid buttons are hidden. If false, invalid buttons are shown but disabled. Default is false.
Q_INVOKABLE ctkPushButton* ctkWorkflowButtonBoxWidget::nextButton | ( | ) | const |
Get the 'next' button.
QString ctkWorkflowButtonBoxWidget::nextButtonFormat | ( | ) | const |
Return the nextButtonFormat property value.
|
protectedvirtualslot |
is called when a 'goTo' button is clicked, and retrieves the corresponding goTo step's id to send to the workflow
void ctkWorkflowButtonBoxWidget::setBackButtonFormat | ( | const QString & | format | ) |
Set the backButtonFormat property value.
void ctkWorkflowButtonBoxWidget::setDirection | ( | const QBoxLayout::Direction & | newDirection | ) |
void ctkWorkflowButtonBoxWidget::setGoToButtonsFormat | ( | const QString & | format | ) |
Set the goToButtonsFormat property value.
void ctkWorkflowButtonBoxWidget::setHideGoToButtons | ( | bool | hide | ) |
Set the hideGoToButtons property value.
void ctkWorkflowButtonBoxWidget::setHideInvalidButtons | ( | bool | newHide | ) |
void ctkWorkflowButtonBoxWidget::setNextButtonFormat | ( | const QString & | format | ) |
Set the nextButtonFormat property value.
void ctkWorkflowButtonBoxWidget::setWorkflow | ( | ctkWorkflow * | newWorkflow | ) |
Set the workflow associated with the widget.
|
virtualslot |
Updates the buttons to reflect the current status of the workflow, and should be called whenever the workflow's current step has changed
ctkWorkflow* ctkWorkflowButtonBoxWidget::workflow | ( | ) | const |
Get the workflow associated with the widget.
|
protected |
Definition at line 159 of file ctkWorkflowButtonBoxWidget.h.
|
readwrite |
This property controls the text, icon and tooltip of the back button. "[<-]{backButtonText|\"Back"}(back:description)" by default.
Definition at line 1 of file ctkWorkflowButtonBoxWidget.h.
|
readwrite |
This property controls the text, icon and tooltip of the goTo/finish button. "[icon]{stepid|\"Finish"}" by default.
Definition at line 1 of file ctkWorkflowButtonBoxWidget.h.
|
readwrite |
This property controls whether the goTo buttons are visible or hidden. False (visible) by default.
Definition at line 1 of file ctkWorkflowButtonBoxWidget.h.
|
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.
Definition at line 1 of file ctkWorkflowButtonBoxWidget.h.
|
readwrite |
This property controls the text, icon and tooltip of the next button. "{nextButtonText|\"Next"}(next:description)[->]" by default.
Definition at line 1 of file ctkWorkflowButtonBoxWidget.h.