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

FXColorBar.h

00001 /********************************************************************************
00002 *                                                                               *
00003 *                         C o l o r B a r   W i d g e t                         *
00004 *                                                                               *
00005 *********************************************************************************
00006 * Copyright (C) 2001,2002 by Jeroen van der Zijp.   All Rights Reserved.        *
00007 *********************************************************************************
00008 * This library is free software; you can redistribute it and/or                 *
00009 * modify it under the terms of the GNU Lesser General Public                    *
00010 * License as published by the Free Software Foundation; either                  *
00011 * version 2.1 of the License, or (at your option) any later version.            *
00012 *                                                                               *
00013 * This library is distributed in the hope that it will be useful,               *
00014 * but WITHOUT ANY WARRANTY; without even the implied warranty of                *
00015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU             *
00016 * Lesser General Public License for more details.                               *
00017 *                                                                               *
00018 * You should have received a copy of the GNU Lesser General Public              *
00019 * License along with this library; if not, write to the Free Software           *
00020 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.    *
00021 *********************************************************************************
00022 * $Id: FXColorBar.h,v 1.6 2002/01/18 22:42:51 jeroen Exp $                      *
00023 ********************************************************************************/
00024 #ifndef FXCOLORBAR_H
00025 #define FXCOLORBAR_H
00026 
00027 #ifndef FXFRAME_H
00028 #include "FXFrame.h"
00029 #endif
00030 
00031 
00032 
00033 /// Color bar orientation
00034 enum {
00035   COLORBAR_HORIZONTAL = 0,            /// Color bar shown horizontally
00036   COLORBAR_VERTICAL   = 0x00008000    /// Color bar shown vertically
00037   };
00038 
00039 
00040 class FXImage;
00041 
00042 
00043 /**
00044 * A color bar is a widget which controls the brightness (value) of a
00045 * color by means of the hue, saturation, value specification system.
00046 */
00047 class FXAPI FXColorBar : public FXFrame {
00048   FXDECLARE(FXColorBar)
00049 protected:
00050   FXImage  *bar;          // Intensity bar
00051   FXfloat   hsv[3];       // Hue, saturation, value
00052   FXString  tip;          // Tooltip value
00053   FXString  help;         // Help value
00054 protected:
00055   FXColorBar();
00056   void updatebar();
00057   virtual void layout();
00058 private:
00059   FXColorBar(const FXColorBar&);
00060   FXColorBar &operator=(const FXColorBar&);
00061 public:
00062   long onPaint(FXObject*,FXSelector,void*);
00063   long onLeftBtnPress(FXObject*,FXSelector,void*);
00064   long onLeftBtnRelease(FXObject*,FXSelector,void*);
00065   long onMotion(FXObject*,FXSelector,void*);
00066   long onQueryHelp(FXObject*,FXSelector,void*);
00067   long onQueryTip(FXObject*,FXSelector,void*);
00068 public:
00069 
00070   /// Construct color well with initial color clr
00071   FXColorBar(FXComposite* p,FXObject* tgt=NULL,FXSelector sel=0,FXuint opts=FRAME_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);
00072 
00073   /// Create server-side resources
00074   virtual void create();
00075 
00076   /// Detach server-side resources
00077   virtual void detach();
00078 
00079   /// Return default width
00080   virtual FXint getDefaultWidth();
00081 
00082   /// Return default height
00083   virtual FXint getDefaultHeight();
00084 
00085   /// Change hue
00086   void setHue(FXfloat h);
00087 
00088   /// Return hue
00089   FXfloat getHue() const { return hsv[0]; }
00090 
00091   /// Change saturation
00092   void setSat(FXfloat s);
00093 
00094   /// Return saturation
00095   FXfloat getSat() const { return hsv[1]; }
00096 
00097   /// Change value
00098   void setVal(FXfloat v);
00099 
00100   /// Return value
00101   FXfloat getVal() const { return hsv[2]; }
00102 
00103   /// Change the color bar style
00104   FXuint getBarStyle() const;
00105 
00106   /// Get the color bar style
00107   void setBarStyle(FXuint style);
00108 
00109   /// Set status line help text for this color well
00110   void setHelpText(const FXString& text){ help=text; }
00111 
00112   /// Get status line help text for this color well
00113   FXString getHelpText() const { return help; }
00114 
00115   /// Set tool tip message for this color well
00116   void setTipText(const FXString& text){ tip=text; }
00117 
00118   /// Get tool tip message for this color well
00119   FXString getTipText() const { return tip; }
00120 
00121   /// Save color well to a stream
00122   virtual void save(FXStream& store) const;
00123 
00124   /// Load color well from a stream
00125   virtual void load(FXStream& store);
00126 
00127   /// Destructor
00128   virtual ~FXColorBar();
00129   };
00130 
00131 
00132 #endif