ctkWorkflowGroupBox is a widget displaying the user interface elements, title, description and/or error status of the current step of a ctkWorkflow.
More...
#include <Libs/Widgets/ctkWorkflowGroupBox.h>
|
QScopedPointer< ctkWorkflowGroupBoxPrivate > | d_ptr |
|
ctkWorkflowGroupBox is a widget displaying the user interface elements, title, description and/or error status of the current step of a ctkWorkflow.
Definition at line 41 of file ctkWorkflowGroupBox.h.
◆ Superclass
◆ ctkWorkflowGroupBox()
ctkWorkflowGroupBox::ctkWorkflowGroupBox |
( |
QWidget * |
parent = 0 | ) |
|
|
explicit |
◆ ~ctkWorkflowGroupBox()
virtual ctkWorkflowGroupBox::~ctkWorkflowGroupBox |
( |
| ) |
|
|
virtual |
◆ clientAreaLayout()
QLayout* ctkWorkflowGroupBox::clientAreaLayout |
( |
| ) |
const |
Get the layout onto which step specific widgets are placed.
◆ errorText()
QString ctkWorkflowGroupBox::errorText |
( |
| ) |
const |
Set/get the error text.
Automatically displays the error text of the ctkWorkflow's current step.
◆ errorTextEnabled()
bool ctkWorkflowGroupBox::errorTextEnabled |
( |
| ) |
const |
If errorTextEnabled is turned on, then a possible error text will be shown just underneath the client area. If it is turned off, then a possible error text will never be shown. (Default ON).
◆ errorTextFormat()
QString ctkWorkflowGroupBox::errorTextFormat |
( |
| ) |
const |
◆ hideWidgetsOfNonCurrentSteps()
bool ctkWorkflowGroupBox::hideWidgetsOfNonCurrentSteps |
( |
| ) |
const |
If hideWidgetsOfNonCurrentSteps is turned on, then a step's widgets will be hidden when that step is not the current step. If it is turned off, then they will be shown but disabled. (Default OFF).
◆ postText()
QString ctkWorkflowGroupBox::postText |
( |
| ) |
const |
Set/get the post-text, i.e. the contents of a convenience text section placed just below the client area.
(Text is constant, regardless of the ctkWorkflow's current step).
◆ preText()
QString ctkWorkflowGroupBox::preText |
( |
| ) |
const |
Set/get the pre-text, i.e. the contents of a convenience text section placed just above the client area.
(Text is constant, regardless of the ctkWorkflow's current step).
◆ setErrorText()
virtual void ctkWorkflowGroupBox::setErrorText |
( |
const QString & |
newErrorText | ) |
|
|
protectedvirtual |
◆ setErrorTextEnabled()
void ctkWorkflowGroupBox::setErrorTextEnabled |
( |
bool |
newErrorTextEnabled | ) |
|
◆ setErrorTextFormat()
void ctkWorkflowGroupBox::setErrorTextFormat |
( |
const QString & |
format | ) |
|
◆ setHideWidgetsOfNonCurrentSteps()
void ctkWorkflowGroupBox::setHideWidgetsOfNonCurrentSteps |
( |
bool |
newHideWidgetsOfNonCurrentSteps | ) |
|
◆ setPostText()
void ctkWorkflowGroupBox::setPostText |
( |
const QString & |
newPostText | ) |
|
◆ setPreText()
void ctkWorkflowGroupBox::setPreText |
( |
const QString & |
newPreText | ) |
|
◆ setSubTitle()
virtual void ctkWorkflowGroupBox::setSubTitle |
( |
const QString & |
newSubTitle | ) |
|
|
protectedvirtual |
◆ setSubTitleFormat()
void ctkWorkflowGroupBox::setSubTitleFormat |
( |
const QString & |
format | ) |
|
◆ setTitleFormat()
void ctkWorkflowGroupBox::setTitleFormat |
( |
const QString & |
format | ) |
|
◆ subTitle()
QString ctkWorkflowGroupBox::subTitle |
( |
| ) |
const |
Set/get the subtitle text (usually a short sentence or two), located in the top area below the title.
Automatically displays the description of the ctkWorkflow's current step.
◆ subTitleFormat()
QString ctkWorkflowGroupBox::subTitleFormat |
( |
| ) |
const |
◆ title()
QString ctkWorkflowGroupBox::title |
( |
| ) |
const |
Get the title text (usually a few words), located in the top area.
Automatically displays the name of the ctkWorkflow's current step.
◆ titleFormat()
QString ctkWorkflowGroupBox::titleFormat |
( |
| ) |
const |
◆ updateGroupBox
virtual void ctkWorkflowGroupBox::updateGroupBox |
( |
ctkWorkflowStep * |
currentStep | ) |
|
|
virtualslot |
◆ d_ptr
QScopedPointer<ctkWorkflowGroupBoxPrivate> ctkWorkflowGroupBox::d_ptr |
|
protected |
◆ errorTextEnabled
bool ctkWorkflowGroupBox::errorTextEnabled |
|
readwrite |
◆ errorTextFormat
QString ctkWorkflowGroupBox::errorTextFormat |
|
readwrite |
◆ hideWidgetsOfNonCurrentSteps
bool ctkWorkflowGroupBox::hideWidgetsOfNonCurrentSteps |
|
readwrite |
◆ postText
QString ctkWorkflowGroupBox::postText |
|
readwrite |
◆ preText
QString ctkWorkflowGroupBox::preText |
|
readwrite |
◆ subTitleFormat
QString ctkWorkflowGroupBox::subTitleFormat |
|
readwrite |
◆ titleFormat
QString ctkWorkflowGroupBox::titleFormat |
|
readwrite |
The documentation for this class was generated from the following file: