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

FXCheckButton.h

00001 /********************************************************************************
00002 *                                                                               *
00003 *                    C h e c k   B u t t o n   W i d g e t                      *
00004 *                                                                               *
00005 *********************************************************************************
00006 * Copyright (C) 1998,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: FXCheckButton.h,v 1.20 2002/01/18 22:42:51 jeroen Exp $                  *
00023 ********************************************************************************/
00024 #ifndef FXCHECKBUTTON_H
00025 #define FXCHECKBUTTON_H
00026 
00027 #ifndef FXLABEL_H
00028 #include "FXLabel.h"
00029 #endif
00030 
00031 
00032 
00033 /// CheckButton styles
00034 enum {
00035   CHECKBUTTON_AUTOGRAY = 0x00800000,    /// Automatically gray out when not updated
00036   CHECKBUTTON_AUTOHIDE = 0x01000000,    /// Automatically hide when not updated
00037   CHECKBUTTON_NORMAL   = JUSTIFY_NORMAL|ICON_BEFORE_TEXT
00038   };
00039 
00040 
00041 /**
00042 * A check button is a tri-state button.  Normally, it is either
00043 * TRUE or FALSE, and toggles between TRUE or FALSE whenever it is pressed.
00044 * A third state MAYBE may be set to indicate that no selection has been made yet
00045 * by the user, or that the state is ambiguous.
00046 * When pressed, the check button sends a SEL_COMMAND to its target, and the
00047 * message data represents the state of the check button.
00048 */
00049 class FXAPI FXCheckButton : public FXLabel {
00050   FXDECLARE(FXCheckButton)
00051 protected:
00052   FXbool   check;
00053   FXbool   oldcheck;
00054   FXColor  boxColor;
00055 protected:
00056   FXCheckButton();
00057 private:
00058   FXCheckButton(const FXCheckButton&);
00059   FXCheckButton &operator=(const FXCheckButton&);
00060 public:
00061   long onPaint(FXObject*,FXSelector,void*);
00062   long onUpdate(FXObject*,FXSelector,void*);
00063   long onEnter(FXObject*,FXSelector,void*);
00064   long onLeave(FXObject*,FXSelector,void*);
00065   long onFocusIn(FXObject*,FXSelector,void*);
00066   long onFocusOut(FXObject*,FXSelector,void*);
00067   long onUngrabbed(FXObject*,FXSelector,void*);
00068   long onLeftBtnPress(FXObject*,FXSelector,void*);
00069   long onLeftBtnRelease(FXObject*,FXSelector,void*);
00070   long onKeyPress(FXObject*,FXSelector,void*);
00071   long onKeyRelease(FXObject*,FXSelector,void*);
00072   long onHotKeyPress(FXObject*,FXSelector,void*);
00073   long onHotKeyRelease(FXObject*,FXSelector,void*);
00074   long onCheck(FXObject*,FXSelector,void*);
00075   long onUncheck(FXObject*,FXSelector,void*);
00076   long onUnknown(FXObject*,FXSelector,void*);
00077   long onCmdSetValue(FXObject*,FXSelector,void*);
00078   long onCmdSetIntValue(FXObject*,FXSelector,void*);
00079   long onCmdGetIntValue(FXObject*,FXSelector,void*);
00080 public:
00081 
00082   /// Construct new check button
00083   FXCheckButton(FXComposite* p,const FXString& text,FXObject* tgt=NULL,FXSelector sel=0,FXuint opts=CHECKBUTTON_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);
00084 
00085   /// Returns true because a check button can receive focus
00086   virtual FXbool canFocus() const;
00087 
00088   /// Get default width
00089   virtual FXint getDefaultWidth();
00090 
00091   /// Get default height
00092   virtual FXint getDefaultHeight();
00093 
00094   /// Set check button state (TRUE, FALSE or MAYBE)
00095   void setCheck(FXbool state=TRUE);
00096 
00097   /// Get check button state (TRUE, FALSE or MAYBE)
00098   FXbool getCheck() const { return check; }
00099 
00100   /// Change check button style
00101   void setCheckButtonStyle(FXuint style);
00102 
00103   /// Return current check button style
00104   FXuint getCheckButtonStyle() const;
00105 
00106   /// Get the box background color
00107   FXColor getBoxColor() const { return boxColor; }
00108 
00109   /// Set the box background color
00110   void setBoxColor(FXColor clr);
00111 
00112   /// Save check button to a stream
00113   virtual void save(FXStream& store) const;
00114 
00115   /// Load check button from a stream
00116   virtual void load(FXStream& store);
00117   };
00118 
00119 
00120 #endif