UNIVERS  15.3
UNIVERS base processing software API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
QfProgress Class Reference

#include <QfProgress.H>

Inheritance diagram for QfProgress:
QfBrick Progress

Public Member Functions

 QfProgress (QfCastle *pControlWindow=NULL, const char *szLabel=NULL, const char *szName=QfPROGRESS_NAME)
 
virtual ~QfProgress ()
 
virtual void set_progress_label (const char *szLabel)
 
virtual void set_comment (const char *szLabel)
 
virtual Logic user_break ()
 
virtual void set_sensitive (Logic flag)
 
virtual void set_limits (double min_value, double max_value)
 
virtual void set_value (double cur_value)
 
- Public Member Functions inherited from QfBrick
 QfBrick ()
 
virtual ~QfBrick ()
 
 operator Widget () const
 
Widget widget () const
 
virtual QfType type () const
 
virtual void manage ()
 
virtual void store_gui ()
 
virtual void load_gui ()
 
virtual void radio_sensitive ()
 
virtual Logic get_sensitive ()
 
virtual void add_callback (const QCallback &qcb)
 
virtual void be_radio_active (const QRadioActive &qra)
 
virtual void realized ()
 
- Public Member Functions inherited from Progress
 Progress (const char *id="unknown")
 
virtual ~Progress ()
 
void set_max (double max_value)
 
void add_value (double incr_value)
 
double scale (double fMax)
 
int scale (int iMax)
 
bool check_limits ()
 

Protected Member Functions

virtual void create_self (Widget wParent)
 
virtual void update ()
 
- Protected Member Functions inherited from QfBrick
virtual void radio_activity ()
 

Static Protected Member Functions

static void keep_position_cb (Widget w, XtPointer pUserData, XtPointer pCallData)
 

Protected Attributes

char * szFmtLabel
 
char * szComment
 
QfCastlepUserBreakControl
 
Widget wLabel
 
Widget wComment
 
Widget wProgress
 
- Protected Attributes inherited from QfBrick
Widget wSelf
 
QCBDescrAr cbList
 
QRadioActiveqRA
 
- Protected Attributes inherited from Progress
char * szName
 
double vMin
 
double vMax
 
double vCur
 

Detailed Description

Progress indicator object. Provides way to display 0% to 100% process.

Constructor & Destructor Documentation

QfProgress::QfProgress ( QfCastle pControlWindow = NULL,
const char *  szLabel = NULL,
const char *  szName = QfPROGRESS_NAME 
)

Progress indicator. QfCastle object is needed just to user_break() implementation.

virtual QfProgress::~QfProgress ( )
virtual

Free resources.

Member Function Documentation

virtual void QfProgress::create_self ( Widget  wParent)
protectedvirtual

XmForm + 3*XmLabel + XmScrollBar.

Implements QfBrick.

static void QfProgress::keep_position_cb ( Widget  w,
XtPointer  pUserData,
XtPointer  pCallData 
)
staticprotected

Prevent user's drag.

virtual void QfProgress::set_comment ( const char *  szLabel)
virtual

Change text comment of the progress indicator view. NULL means turn off the comment.

Reimplemented from Progress.

virtual void QfProgress::set_limits ( double  min_value,
double  max_value 
)
virtual

Set minimum and maximum allowed values of progress indicator

Reimplemented from Progress.

virtual void QfProgress::set_progress_label ( const char *  szLabel)
virtual

Set new label with possible printf format spec. NULL means turn off the label.

virtual void QfProgress::set_sensitive ( Logic  flag)
virtual

Link the object with controlling dialog window. Without this call Avoid sensitivity setting.

Reimplemented from QfBrick.

virtual void QfProgress::set_value ( double  cur_value)
virtual

Set current value of progress; must be in range from 0 to max_value

Reimplemented from Progress.

virtual void QfProgress::update ( )
protectedvirtual

Update progress indicator view

Reimplemented from Progress.

virtual Logic QfProgress::user_break ( )
virtual

Get interruption signal is set (TRUE) or not (FALSE).

Reimplemented from Progress.

Member Data Documentation

QfCastle* QfProgress::pUserBreakControl
protected

Link to QfCastle which is responsible for communication with user.

char* QfProgress::szComment
protected

Custom comment.

char* QfProgress::szFmtLabel
protected

Custom label with format (sprintf) for displaying double current value.

Widget QfProgress::wLabel
protected

wSelf = wForm


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