<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>FXProgressBar.h</h1><div class="fragment"><pre>00001 <span class="comment">/********************************************************************************</span>
00002 <span class="comment">* *</span>
00003 <span class="comment">* P r o g r e s s B a r W i d g e t *</span>
00004 <span class="comment">* *</span>
00005 <span class="comment">*********************************************************************************</span>
00006 <span class="comment">* Copyright (C) 1998,2004 by Jeroen van der Zijp. All Rights Reserved. *</span>
00007 <span class="comment">*********************************************************************************</span>
00008 <span class="comment">* This library is free software; you can redistribute it and/or *</span>
00009 <span class="comment">* modify it under the terms of the GNU Lesser General Public *</span>
00010 <span class="comment">* License as published by the Free Software Foundation; either *</span>
00011 <span class="comment">* version 2.1 of the License, or (at your option) any later version. *</span>
00012 <span class="comment">* *</span>
00013 <span class="comment">* This library is distributed in the hope that it will be useful, *</span>
00014 <span class="comment">* but WITHOUT ANY WARRANTY; without even the implied warranty of *</span>
00015 <span class="comment">* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *</span>
00016 <span class="comment">* Lesser General Public License for more details. *</span>
00017 <span class="comment">* *</span>
00018 <span class="comment">* You should have received a copy of the GNU Lesser General Public *</span>
00019 <span class="comment">* License along with this library; if not, write to the Free Software *</span>
00020 <span class="comment">* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. *</span>
00021 <span class="comment">*********************************************************************************</span>
00022 <span class="comment">* $Id: FXProgressBar.h,v 1.20 2004/02/08 17:17:34 fox Exp $ *</span>
00023 <span class="comment">********************************************************************************/</span>
00024 <span class="preprocessor">#ifndef FXPROGRESSBAR_H</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define FXPROGRESSBAR_H</span>
00026 <span class="preprocessor"></span>
00027 <span class="preprocessor">#ifndef FXFRAME_H</span>
00028 <span class="preprocessor"></span><span class="preprocessor">#include "FXFrame.h"</span>
00029 <span class="preprocessor">#endif</span>
00030 <span class="preprocessor"></span>
00031 <span class="keyword">namespace </span>FX {
00032
00033 <span class="comment"></span>
00034 <span class="comment">/// Progress bar styles</span>
00035 <span class="comment"></span><span class="keyword">enum</span> {
00036 <a class="code" href="group__FXProgressBar__0.html#a0a1919">PROGRESSBAR_HORIZONTAL</a> = 0, <span class="comment">/// Horizontal display</span>
00037 <span class="comment"></span> <a class="code" href="group__FXProgressBar__0.html#a0a1920">PROGRESSBAR_VERTICAL</a> = 0x00008000, <span class="comment">/// Vertical display</span>
00038 <span class="comment"></span> <a class="code" href="group__FXProgressBar__0.html#a0a1921">PROGRESSBAR_PERCENTAGE</a> = 0x00010000, <span class="comment">/// Show percentage done</span>
00039 <span class="comment"></span> <a class="code" href="group__FXProgressBar__0.html#a0a1922">PROGRESSBAR_DIAL</a> = 0x00020000, <span class="comment">/// Show as a dial instead of bar</span>
00040 <span class="comment"></span> PROGRESSBAR_NORMAL = <a class="code" href="group__FXWindow__1.html#a0a2157">FRAME_SUNKEN</a>|<a class="code" href="group__FXWindow__1.html#a0a2159">FRAME_THICK</a>
00041 };
00042
00043 <span class="comment"></span>
00044 <span class="comment">/// Progress bar widget</span>
00045 <span class="comment"></span><span class="keyword">class </span>FXAPI FXProgressBar : <span class="keyword">public</span> FXFrame {
00046 FXDECLARE(FXProgressBar)
00047 <span class="keyword">protected</span>:
00048 FXuint progress; <span class="comment">// Integer percentage number</span>
00049 FXuint total; <span class="comment">// Amount for completion</span>
00050 FXint barsize; <span class="comment">// Bar size</span>
00051 FXFont* font;
00052 FXColor barBGColor;
<a name="l00053"></a><a class="code" href="classFX_1_1FXProgressBar.html">00053</a> FXColor barColor;
00054 FXColor textNumColor;
00055 FXColor textAltColor;
00056 <span class="keyword">protected</span>:
00057 FXProgressBar(){}
00058 <span class="keywordtype">void</span> drawInterior(FXDCWindow& dc);
00059 <span class="keyword">private</span>:
00060 FXProgressBar(<span class="keyword">const</span> FXProgressBar&);
00061 FXProgressBar &operator=(<span class="keyword">const</span> FXProgressBar&);
00062 <span class="keyword">public</span>:
00063 <span class="keywordtype">long</span> onPaint(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00064 <span class="keywordtype">long</span> onCmdSetValue(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00065 <span class="keywordtype">long</span> onCmdSetIntValue(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00066 <span class="keywordtype">long</span> onCmdGetIntValue(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00067 <span class="keyword">public</span>:
00068 <span class="comment"></span>
00069 <span class="comment"> /// Construct progress bar</span>
00070 <span class="comment"></span> FXProgressBar(FXComposite* p,FXObject* target=NULL,FXSelector sel=0,FXuint opts=PROGRESSBAR_NORMAL,FXint x=0,FXint y=0,FXint w=0,FXint h=0,FXint pl=DEFAULT_PAD,FXint pr=DEFAULT_PAD,FXint pt=DEFAULT_PAD,FXint pb=DEFAULT_PAD);
00071 <span class="comment"></span>
00072 <span class="comment"> /// Create server-side resources</span>
00073 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> create();
00074 <span class="comment"></span>
00075 <span class="comment"> /// Detach server-side resources</span>
00076 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> detach();
00077 <span class="comment"></span>
00078 <span class="comment"> /// Return default width</span>
00079 <span class="comment"></span> <span class="keyword">virtual</span> FXint getDefaultWidth();
00080 <span class="comment"></span>
<a name="l00081"></a><a class="code" href="classFX_1_1FXProgressBar.html#a6">00081</a> <span class="comment"> /// Return default height</span>
00082 <span class="comment"></span> <span class="keyword">virtual</span> FXint getDefaultHeight();
00083 <span class="comment"></span>
00084 <span class="comment"> /// Change the amount of progress</span>
00085 <span class="comment"></span> <span class="keywordtype">void</span> setProgress(FXuint value);
00086 <span class="comment"></span>
<a name="l00087"></a><a class="code" href="classFX_1_1FXProgressBar.html#a8">00087</a> <span class="comment"> /// Get current progress</span>
00088 <span class="comment"></span> FXuint getProgress()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> progress; }
00089 <span class="comment"></span>
00090 <span class="comment"> /// Set total amount of progress</span>
00091 <span class="comment"></span> <span class="keywordtype">void</span> setTotal(FXuint value);
00092 <span class="comment"></span>
00093 <span class="comment"> /// Return total amount of progrss</span>
00094 <span class="comment"></span> FXuint getTotal()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> total; }
00095 <span class="comment"></span>
00096 <span class="comment"> /// Increment progress by given amount</span>
00097 <span class="comment"></span> <span class="keywordtype">void</span> increment(FXuint value);
00098 <span class="comment"></span>
00099 <span class="comment"> /// Hide progress percentage</span>
00100 <span class="comment"></span> <span class="keywordtype">void</span> hideNumber();
00101 <span class="comment"></span>
<a name="l00102"></a><a class="code" href="classFX_1_1FXProgressBar.html#a13">00102</a> <span class="comment"> /// Show progress percentage</span>
00103 <span class="comment"></span> <span class="keywordtype">void</span> showNumber();
00104 <span class="comment"></span>
00105 <span class="comment"> /// Change progress bar width</span>
00106 <span class="comment"></span> <span class="keywordtype">void</span> setBarSize(FXint size);
00107 <span class="comment"></span>
<a name="l00108"></a><a class="code" href="classFX_1_1FXProgressBar.html#a15">00108</a> <span class="comment"> /// Return progress bar width</span>
00109 <span class="comment"></span> FXint getBarSize()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> barsize; }
00110 <span class="comment"></span>
00111 <span class="comment"> /// Change backgroundcolor</span>
00112 <span class="comment"></span> <span class="keywordtype">void</span> setBarBGColor(FXColor clr);
00113 <span class="comment"></span>
<a name="l00114"></a><a class="code" href="classFX_1_1FXProgressBar.html#a17">00114</a> <span class="comment"> /// Return background color</span>
00115 <span class="comment"></span> FXColor getBarBGColor()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> barBGColor; }
00116 <span class="comment"></span>
00117 <span class="comment"> /// Change bar color</span>
00118 <span class="comment"></span> <span class="keywordtype">void</span> setBarColor(FXColor clr);
00119 <span class="comment"></span>
<a name="l00120"></a><a class="code" href="classFX_1_1FXProgressBar.html#a19">00120</a> <span class="comment"> /// Return bar color</span>
00121 <span class="comment"></span> FXColor getBarColor()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> barColor; }
00122 <span class="comment"></span>
00123 <span class="comment"> /// Change text color</span>
00124 <span class="comment"></span> <span class="keywordtype">void</span> setTextColor(FXColor clr);
00125 <span class="comment"></span>
<a name="l00126"></a><a class="code" href="classFX_1_1FXProgressBar.html#a21">00126</a> <span class="comment"> /// Return text color</span>
00127 <span class="comment"></span> FXColor getTextColor()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> textNumColor; }
00128 <span class="comment"></span>
00129 <span class="comment"> /// Change alternate text color shown when bar under text</span>
00130 <span class="comment"></span> <span class="keywordtype">void</span> setTextAltColor(FXColor clr);
00131 <span class="comment"></span>
<a name="l00132"></a><a class="code" href="classFX_1_1FXProgressBar.html#a23">00132</a> <span class="comment"> /// Return alternate text color</span>
00133 <span class="comment"></span> FXColor getTextAltColor()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> textAltColor; }
00134 <span class="comment"></span>
00135 <span class="comment"> /// Set the text font</span>
00136 <span class="comment"></span> <span class="keywordtype">void</span> setFont(FXFont *fnt);
00137 <span class="comment"></span>
00138 <span class="comment"> /// Get the text font</span>
00139 <span class="comment"></span> FXFont* getFont()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> font; }
00140 <span class="comment"></span>
00141 <span class="comment"> /// Change progress bar style</span>
00142 <span class="comment"></span> <span class="keywordtype">void</span> setBarStyle(FXuint style);
00143 <span class="comment"></span>
00144 <span class="comment"> /// Return current progress bar style</span>
00145 <span class="comment"></span> FXuint getBarStyle() <span class="keyword">const</span>;
00146 <span class="comment"></span>
00147 <span class="comment"> /// Save progress bar to a stream</span>
00148 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> save(FXStream& store) <span class="keyword">const</span>;
00149 <span class="comment"></span>
00150 <span class="comment"> /// Load progress bar from a stream</span>
00151 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> load(FXStream& store);
00152 <span class="comment"></span>
00153 <span class="comment"> /// Destructor</span>
00154 <span class="comment"></span> <span class="keyword">virtual</span> ~FXProgressBar();
00155 };
00156
00157 }
00158
00159 <span class="preprocessor">#endif</span>
</pre></div></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>
