Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

FX::FXProgressDialog Class Reference

A Progress Dialog is a simple dialog which is used to keep a user informed of the progress of a lengthy operation in a program and that the program is in fact still working. More...

#include <FXProgressDialog.h>

Inheritance diagram for FX::FXProgressDialog:

FX::FXDialogBox FX::FXTopWindow FX::FXShell FX::FXComposite FX::FXWindow FX::FXDrawable FX::FXId FX::FXObject

List of all members.

Public Member Functions

 FXProgressDialog (FXWindow *owner, const FXString &caption, const FXString &label, FXuint opts=PROGRESSDIALOG_NORMAL, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
void setMessage (const FXString &msg)
FXString getMessage () const
void setBarStyle (FXuint style)
FXuint getBarStyle () const
void setProgress (FXuint value)
FXuint getProgress () const
void setTotal (FXuint value)
FXuint getTotal () const
void increment (FXuint value)
FXbool isCancelled () const
void setCancelled (FXbool flg)
virtual ~FXProgressDialog ()


Detailed Description

A Progress Dialog is a simple dialog which is used to keep a user informed of the progress of a lengthy operation in a program and that the program is in fact still working.

The PROGRESSDIALOG_CANCEL option enables the display of the cancel button in the Progress Dialog.


Constructor & Destructor Documentation

FX::FXProgressDialog::FXProgressDialog ( FXWindow owner,
const FXString caption,
const FXString label,
FXuint  opts = PROGRESSDIALOG_NORMAL,
FXint  x = 0,
FXint  y = 0,
FXint  w = 0,
FXint  h = 0 
)

Construct input dialog box with given caption, icon, and prompt text.

virtual FX::FXProgressDialog::~FXProgressDialog (  )  [virtual]

Destroy.


Member Function Documentation

void FX::FXProgressDialog::setMessage ( const FXString msg  ) 

Change the progress message.

FXString FX::FXProgressDialog::getMessage (  )  const

Get progress message.

void FX::FXProgressDialog::setBarStyle ( FXuint  style  ) 

Change style of the progress bar widget.

FXuint FX::FXProgressDialog::getBarStyle (  )  const

Get style of the progress bar widget.

void FX::FXProgressDialog::setProgress ( FXuint  value  ) 

Change the amount of progress.

FXuint FX::FXProgressDialog::getProgress (  )  const

Get current progress.

void FX::FXProgressDialog::setTotal ( FXuint  value  ) 

Set total amount of progress.

FXuint FX::FXProgressDialog::getTotal (  )  const

Return total amount of progrss.

void FX::FXProgressDialog::increment ( FXuint  value  ) 

Increment progress by given amount.

FXbool FX::FXProgressDialog::isCancelled (  )  const [inline]

Has operation been cancelled?

void FX::FXProgressDialog::setCancelled ( FXbool  flg  )  [inline]

Change cancelled flag.

Copyright © 1997-2009 Jeroen van der Zijp