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

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>

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

Public Types

typedef QWidget Superclass
 

Public Slots

virtual void updateGroupBox (ctkWorkflowStep *currentStep)
 

Public Member Functions

QLayout * clientAreaLayout () const
 Get the layout onto which step specific widgets are placed. More...
 
 ctkWorkflowGroupBox (QWidget *parent=0)
 
QString errorText () const
 Set/get the error text. More...
 
bool errorTextEnabled () const
 
QString errorTextFormat () const
 
bool hideWidgetsOfNonCurrentSteps () const
 
QString postText () const
 Set/get the post-text, i.e. the contents of a convenience text section placed just below the client area. More...
 
QString preText () const
 Set/get the pre-text, i.e. the contents of a convenience text section placed just above the client area. More...
 
void setErrorTextEnabled (bool newErrorTextEnabled)
 
void setErrorTextFormat (const QString &format)
 
void setHideWidgetsOfNonCurrentSteps (bool newHideWidgetsOfNonCurrentSteps)
 
void setPostText (const QString &newPostText)
 
void setPreText (const QString &newPreText)
 
void setSubTitleFormat (const QString &format)
 
void setTitleFormat (const QString &format)
 
QString subTitle () const
 Set/get the subtitle text (usually a short sentence or two), located in the top area below the title. More...
 
QString subTitleFormat () const
 
QString title () const
 Get the title text (usually a few words), located in the top area. More...
 
QString titleFormat () const
 
virtual ~ctkWorkflowGroupBox ()
 

Protected Member Functions

virtual void setErrorText (const QString &newErrorText)
 
virtual void setSubTitle (const QString &newSubTitle)
 

Protected Attributes

QScopedPointer< ctkWorkflowGroupBoxPrivate > d_ptr
 

Properties

bool errorTextEnabled
 
QString errorTextFormat
 
bool hideWidgetsOfNonCurrentSteps
 
QString postText
 
QString preText
 
QString subTitleFormat
 
QString titleFormat
 

Detailed Description

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.

Member Typedef Documentation

Definition at line 65 of file ctkWorkflowGroupBox.h.

Constructor & Destructor Documentation

ctkWorkflowGroupBox::ctkWorkflowGroupBox ( QWidget *  parent = 0)
explicit
virtual ctkWorkflowGroupBox::~ctkWorkflowGroupBox ( )
virtual

Member Function Documentation

QLayout* ctkWorkflowGroupBox::clientAreaLayout ( ) const

Get the layout onto which step specific widgets are placed.

QString ctkWorkflowGroupBox::errorText ( ) const

Set/get the error text.

Automatically displays the error text of the ctkWorkflow's current step.

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).

QString ctkWorkflowGroupBox::errorTextFormat ( ) const

Return the errorTextFormat property value.

See also
errorTextFormat, setErrorTextFormat()
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).

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).

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).

virtual void ctkWorkflowGroupBox::setErrorText ( const QString &  newErrorText)
protectedvirtual
void ctkWorkflowGroupBox::setErrorTextEnabled ( bool  newErrorTextEnabled)
void ctkWorkflowGroupBox::setErrorTextFormat ( const QString &  format)

Set the errorTextFormat property value.

See also
errorTextFormat, errorTextFormat()
void ctkWorkflowGroupBox::setHideWidgetsOfNonCurrentSteps ( bool  newHideWidgetsOfNonCurrentSteps)
void ctkWorkflowGroupBox::setPostText ( const QString &  newPostText)
void ctkWorkflowGroupBox::setPreText ( const QString &  newPreText)
virtual void ctkWorkflowGroupBox::setSubTitle ( const QString &  newSubTitle)
protectedvirtual
void ctkWorkflowGroupBox::setSubTitleFormat ( const QString &  format)

Set the subTitleFormat property value.

See also
subTitleFormat, subTitleFormat()
void ctkWorkflowGroupBox::setTitleFormat ( const QString &  format)

Set the titleFormat property value.

See also
titleFormat, titleFormat()
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.

QString ctkWorkflowGroupBox::subTitleFormat ( ) const

Return the subTitleFormat property value.

See also
subTitleFormat, setSubTitleFormat()
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.

QString ctkWorkflowGroupBox::titleFormat ( ) const

Return the titleFormat property value.

See also
titleFormat, setTitleFormat()
virtual void ctkWorkflowGroupBox::updateGroupBox ( ctkWorkflowStep currentStep)
virtualslot

Member Data Documentation

QScopedPointer<ctkWorkflowGroupBoxPrivate> ctkWorkflowGroupBox::d_ptr
protected

Definition at line 152 of file ctkWorkflowGroupBox.h.

Property Documentation

bool ctkWorkflowGroupBox::errorTextEnabled
readwrite

Definition at line 61 of file ctkWorkflowGroupBox.h.

QString ctkWorkflowGroupBox::errorTextFormat
readwrite

This property controls the textof the error view. "{current:statusText}" by default.

See also
errorTextFormat(), setErrorTextFormat(), ctkWorkflow::formatButton(), titleFormat, subTitleFormat

Definition at line 59 of file ctkWorkflowGroupBox.h.

bool ctkWorkflowGroupBox::hideWidgetsOfNonCurrentSteps
readwrite

Definition at line 60 of file ctkWorkflowGroupBox.h.

QString ctkWorkflowGroupBox::postText
readwrite

Definition at line 45 of file ctkWorkflowGroupBox.h.

QString ctkWorkflowGroupBox::preText
readwrite

Definition at line 44 of file ctkWorkflowGroupBox.h.

QString ctkWorkflowGroupBox::subTitleFormat
readwrite

This property controls the text of the subtitle view. "{current:description}" by default.

See also
subTitleFormat(), setSubTitleFormat(), ctkWorkflow::formatButton(), titleFormat, errorTextFormat

Definition at line 54 of file ctkWorkflowGroupBox.h.

QString ctkWorkflowGroupBox::titleFormat
readwrite

This property controls the text, icon and tooltip of the title button. "{current:name}" by default.

See also
titleFormat(), setTitleFormat(), ctkWorkflow::formatButton()

Definition at line 49 of file ctkWorkflowGroupBox.h.


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