ProgressBar.h

00001 /*
00002  * Copyright (c) 2003-2005, Bram Stein
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without 
00006  * modification, are permitted provided that the following conditions 
00007  * are met:
00008  * 
00009  *  1. Redistributions of source code must retain the above copyright
00010  *     notice, this list of conditions and the following disclaimer. 
00011  *  2. Redistributions in binary form must reproduce the above copyright 
00012  *     notice, this list of conditions and the following disclaimer in the 
00013  *     documentation and/or other materials provided with the distribution. 
00014  *  3. The name of the author may not be used to endorse or promote products 
00015  *     derived from this software without specific prior written permission. 
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED 
00018  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
00019  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 
00020  * EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
00021  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
00022  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
00023  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY 
00024  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 
00025  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
00026  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00027  */
00028 #ifndef PROGRESSBAR_H
00029 #define PROGRESSBAR_H
00030 
00031 #include "..\Component.h"
00032 
00033 namespace ui
00034 {
00035     /*
00036      * A ProgressBar can display horizontal or verticel
00037      * progress bars, which can be used for displaying
00038      * 'load' time, or some other event where the user
00039      * has to wait, but needs visual feedback of the progress.
00040      */
00041     class ProgressBar :     public Component
00042     {
00043     public:
00052         ProgressBar(int min, int max);
00053 
00065         ProgressBar(int min, int max, int orientation);
00066 
00067 
00071         enum ORIENTATION
00072         {
00077             VERTICAL,
00078 
00083             HORIZONTAL
00084         };
00085 
00092         void setStringPainted(bool b);
00093 
00098         bool isStringPainted() const;
00099 
00104         void setMaximum(int max);
00105 
00110         int getMaximum() const;
00111 
00116         void setMinimum(int min);
00117 
00122         int getMinimum() const;
00123 
00130         void setValue(int val);
00131 
00136         int getValue() const;
00137 
00138         void setOrientation(int orientation);
00139 
00140         int getOrientation() const;
00141 
00142     private:
00143         void init(int min, int max, int orientation);
00144         int min, max, orient, value;
00145         bool stringPainted;
00146     };
00147 }
00148 
00149 #endif

Generated on Mon Jun 20 19:41:34 2005 for UI by doxygen 1.3.1 using KingsTools