<html> <head> <link rel="stylesheet" href="page.css" type="text/css"> <title>fox-toolkit.org - Documentation</title> </head> <body bgcolor=#ffffff link=#990033 vlink=#990033 alink=#990033 text=#000000> <font face='verdana,sans-serif' size=2 > <!---- TOPIC TITLE WITH LOGO---> <table border=0 cellpadding= cellspacing=2 width=100% ><tr><td><a href='http://www.fox-toolkit.org/doc.html'><img src='../art/foxlogo_small.jpg' border=0></a></td><td width=100% valign=bottom><font face='verdana,sans-serif' size=2 ><b> <a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <br><img src='../art/line.gif' width=100% height=1></b></font></td></tr></table> <p> <!--- TOPIC TITLE WITH LOGO ---> <!-- Generated by Doxygen 1.3.3 --> <h1>FX::FXProgressDialog Class Reference</h1>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. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="FXProgressDialog_8h-source.html">FXProgressDialog.h</a>></code> <p> <p>Inheritance diagram for FX::FXProgressDialog: <p><center><img src="classFX_1_1FXProgressDialog.png" usemap="#FX::FXProgressDialog_map" border="0" alt=""></center> <map name="FX::FXProgressDialog_map"> <area href="classFX_1_1FXDialogBox.html" alt="FX::FXDialogBox" shape="rect" coords="0,392,139,416"> <area href="classFX_1_1FXTopWindow.html" alt="FX::FXTopWindow" shape="rect" coords="0,336,139,360"> <area href="classFX_1_1FXShell.html" alt="FX::FXShell" shape="rect" coords="0,280,139,304"> <area href="classFX_1_1FXComposite.html" alt="FX::FXComposite" shape="rect" coords="0,224,139,248"> <area href="classFX_1_1FXWindow.html" alt="FX::FXWindow" shape="rect" coords="0,168,139,192"> <area href="classFX_1_1FXDrawable.html" alt="FX::FXDrawable" shape="rect" coords="0,112,139,136"> <area href="classFX_1_1FXId.html" alt="FX::FXId" shape="rect" coords="0,56,139,80"> <area href="classFX_1_1FXObject.html" alt="FX::FXObject" shape="rect" coords="0,0,139,24"> </map> <a href="classFX_1_1FXProgressDialog-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> <tr><td></td></tr> <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXProgressDialog.html#a0">FXProgressDialog</a> (<a class="el" href="classFX_1_1FXWindow.html">FXWindow</a> *owner, const <a class="el" href="classFX_1_1FXString.html">FXString</a> &caption, const <a class="el" href="classFX_1_1FXString.html">FXString</a> &label, FXuint opts=PROGRESSDIALOG_NORMAL, FXint x=0, FXint y=0, FXint w=0, FXint h=0)</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXProgressDialog.html#a1">setMessage</a> (const <a class="el" href="classFX_1_1FXString.html">FXString</a> &msg)</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classFX_1_1FXString.html">FXString</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXProgressDialog.html#a2">getMessage</a> () const</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXProgressDialog.html#a3">setBarStyle</a> (FXuint style)</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>FXuint </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXProgressDialog.html#a4">getBarStyle</a> () const</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXProgressDialog.html#a5">setProgress</a> (FXuint value)</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>FXuint </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXProgressDialog.html#a6">getProgress</a> () const</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXProgressDialog.html#a7">setTotal</a> (FXuint value)</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>FXuint </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXProgressDialog.html#a8">getTotal</a> () const</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXProgressDialog.html#a9">increment</a> (FXuint value)</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>FXbool </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXProgressDialog.html#a10">isCancelled</a> () const</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXProgressDialog.html#a11">setCancelled</a> (FXbool flg)</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXProgressDialog.html#a12">~FXProgressDialog</a> ()</td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> 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. <p> <hr><h2>Constructor & Destructor Documentation</h2> <a name="a0" doxytag="FX::FXProgressDialog::FXProgressDialog"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> FX::FXProgressDialog::FXProgressDialog </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classFX_1_1FXWindow.html">FXWindow</a> * </td> <td class="mdname" nowrap> <em>owner</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const <a class="el" href="classFX_1_1FXString.html">FXString</a> & </td> <td class="mdname" nowrap> <em>caption</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const <a class="el" href="classFX_1_1FXString.html">FXString</a> & </td> <td class="mdname" nowrap> <em>label</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>FXuint </td> <td class="mdname" nowrap> <em>opts</em> = PROGRESSDIALOG_NORMAL, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>FXint </td> <td class="mdname" nowrap> <em>x</em> = 0, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>FXint </td> <td class="mdname" nowrap> <em>y</em> = 0, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>FXint </td> <td class="mdname" nowrap> <em>w</em> = 0, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>FXint </td> <td class="mdname" nowrap> <em>h</em> = 0</td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Construct input dialog box with given caption, icon, and prompt text. <p> </td> </tr> </table> <a name="a12" doxytag="FX::FXProgressDialog::~FXProgressDialog"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual FX::FXProgressDialog::~<a class="el" href="classFX_1_1FXProgressDialog.html">FXProgressDialog</a> </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Destroy. <p> </td> </tr> </table> <hr><h2>Member Function Documentation</h2> <a name="a1" doxytag="FX::FXProgressDialog::setMessage"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void FX::FXProgressDialog::setMessage </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classFX_1_1FXString.html">FXString</a> & </td> <td class="mdname1" valign="top" nowrap> <em>msg</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Change the progress message. <p> </td> </tr> </table> <a name="a2" doxytag="FX::FXProgressDialog::getMessage"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="classFX_1_1FXString.html">FXString</a> FX::FXProgressDialog::getMessage </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const</td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Get progress message. <p> </td> </tr> </table> <a name="a3" doxytag="FX::FXProgressDialog::setBarStyle"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void FX::FXProgressDialog::setBarStyle </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">FXuint </td> <td class="mdname1" valign="top" nowrap> <em>style</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Change style of the progress bar widget. <p> </td> </tr> </table> <a name="a4" doxytag="FX::FXProgressDialog::getBarStyle"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> FXuint FX::FXProgressDialog::getBarStyle </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const</td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Get style of the progress bar widget. <p> </td> </tr> </table> <a name="a5" doxytag="FX::FXProgressDialog::setProgress"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void FX::FXProgressDialog::setProgress </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">FXuint </td> <td class="mdname1" valign="top" nowrap> <em>value</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Change the amount of progress. <p> </td> </tr> </table> <a name="a6" doxytag="FX::FXProgressDialog::getProgress"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> FXuint FX::FXProgressDialog::getProgress </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const</td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Get current progress. <p> </td> </tr> </table> <a name="a7" doxytag="FX::FXProgressDialog::setTotal"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void FX::FXProgressDialog::setTotal </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">FXuint </td> <td class="mdname1" valign="top" nowrap> <em>value</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Set total amount of progress. <p> </td> </tr> </table> <a name="a8" doxytag="FX::FXProgressDialog::getTotal"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> FXuint FX::FXProgressDialog::getTotal </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const</td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Return total amount of progrss. <p> </td> </tr> </table> <a name="a9" doxytag="FX::FXProgressDialog::increment"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void FX::FXProgressDialog::increment </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">FXuint </td> <td class="mdname1" valign="top" nowrap> <em>value</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Increment progress by given amount. <p> </td> </tr> </table> <a name="a10" doxytag="FX::FXProgressDialog::isCancelled"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> FXbool FX::FXProgressDialog::isCancelled </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const<code> [inline]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Has operation been cancelled? <p> </td> </tr> </table> <a name="a11" doxytag="FX::FXProgressDialog::setCancelled"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void FX::FXProgressDialog::setCancelled </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">FXbool </td> <td class="mdname1" valign="top" nowrap> <em>flg</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inline]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Change cancelled flag. <p> </td> </tr> </table> </font> <!--- COPYRIGHT --> <p> <table width=100% cellpadding=0 cellspacing=0><tr><td width=100% valign=top id=HEADLINE align=right> <img src='../art/line.gif' width=100% height=1><font size=-1> Copyright © 1997-2004 Jeroen van der Zijp</font> </td></tr></table> </p> <!--- COPYRIGHT --> </body> </html>