ctkWorkflowWidget is the basis for a workflow with a user interface. It groups together and manages a ctkWorkflowGroupBox (to display the step) and a ctkWorkflowButtonBoxWidget (providing buttons for traversing the workflow).
More...
#include <Libs/Widgets/ctkWorkflowWidget.h>
|
QScopedPointer< ctkWorkflowWidgetPrivate > | d_ptr |
|
ctkWorkflowWidget is the basis for a workflow with a user interface. It groups together and manages a ctkWorkflowGroupBox (to display the step) and a ctkWorkflowButtonBoxWidget (providing buttons for traversing the workflow).
Definition at line 44 of file ctkWorkflowWidget.h.
◆ Superclass
◆ ctkWorkflowWidget()
ctkWorkflowWidget::ctkWorkflowWidget |
( |
QWidget * |
parent = 0 | ) |
|
|
explicit |
◆ ~ctkWorkflowWidget()
virtual ctkWorkflowWidget::~ctkWorkflowWidget |
( |
| ) |
|
|
virtual |
◆ buttonBoxWidget()
Get the widget with the 'next', 'back' and 'goTo' buttons.
◆ buttonItem()
Return the value of the formatItem.
- See also
- format()
◆ formatButton()
static void ctkWorkflowWidget::formatButton |
( |
QAbstractButton * |
button, |
|
|
const QString & |
format, |
|
|
ctkWorkflowWidgetStep * |
step |
|
) |
| |
|
static |
Apply the text, icon and tooltip format to the button.
- {PROP}, [prop] or (PROP): value of the PROP property (e.g. stepid, name, description...) used as button text, icon or tooltip respectively. PROP can be prefixed by 'back:', 'next:' or 'current:', the property will then be the one of the previous, next or current step.
- [<-]: Back arrow icon. If it is the first item, the icon is to the left of the button text.
- [->]: Next arrow icon. If it is the last item, the icon is to the right of the button text if the button is a ctkPushButton.
- {#} or (#): 1-based index of the step (int)
- {!#} or {!#} : Total number of steps (int)
- "ABCD": text for the button
- {PROP|"ABCD"}: Use ABCD as fallback if PROP is not a valid property or if the text is empty.
Examples: "{next:#}"/"{!#}") "{next:name}(next:description)[->]" will format the button with:
- text="3/3) Compute Algorithm" if the next step is the last step of a 3-step-workflow, and its name is "Compute Algorithm".
- icon=QStyle::SP_ArrowRight
- tooltip="This step computes the algorithm" if the next step description is "This step...".
- See also
- parse(), formatText()
◆ formatText()
◆ onCurrentStepChanged
virtual void ctkWorkflowWidget::onCurrentStepChanged |
( |
ctkWorkflowStep * |
currentStep | ) |
|
|
virtualslot |
Triggers updates of the the workflowGroupBox and the buttonBoxWidget when the current workflow step has changed.
◆ onStepRegistered
◆ parse()
static QMap<QString, QVariant> ctkWorkflowWidget::parse |
( |
const QString & |
format, |
|
|
ctkWorkflowWidgetStep * |
step |
|
) |
| |
|
staticprotected |
◆ setShowButtonBoxWidget()
void ctkWorkflowWidget::setShowButtonBoxWidget |
( |
bool |
newShowButtonBoxWidget | ) |
|
◆ setWorkflow()
virtual Q_INVOKABLE void ctkWorkflowWidget::setWorkflow |
( |
ctkWorkflow * |
newWorkflow | ) |
|
|
virtual |
◆ showButtonBoxWidget()
bool ctkWorkflowWidget::showButtonBoxWidget |
( |
| ) |
const |
Set/get whether or not to associate a buttonBoxWidget with this step (default true)
◆ updateButtonBoxUI()
◆ updateStepUI()
virtual void ctkWorkflowWidget::updateStepUI |
( |
ctkWorkflowStep * |
currentStep | ) |
|
|
protectedvirtual |
◆ widgetStep()
◆ workflow()
virtual Q_INVOKABLE ctkWorkflow* ctkWorkflowWidget::workflow |
( |
| ) |
const |
|
virtual |
Set/get the workflow associated with this widget.
◆ workflowGroupBox()
Get the widget constaining the title, subtitle, pre-text, post-text, error-text and client area layout.
◆ d_ptr
QScopedPointer<ctkWorkflowWidgetPrivate> ctkWorkflowWidget::d_ptr |
|
protected |
◆ showButtonBoxWidget
bool ctkWorkflowWidget::showButtonBoxWidget |
|
readwrite |
The documentation for this class was generated from the following file: