![]() |
Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members
![]() |
00001 /******************************************************************************** 00002 * * 00003 * D i a l 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: FXDial.h,v 1.23 2002/09/30 13:06:55 fox Exp $ * 00023 ********************************************************************************/ 00024 #ifndef FXDIAL_H 00025 #define FXDIAL_H 00026 00027 #ifndef FXFRAME_H 00028 #include "FXFrame.h" 00029 #endif 00030 00031 namespace FX { 00032 00033 00034 // Dial style options 00035 enum { 00036 DIAL_VERTICAL = 0, // Vertically oriented 00037 DIAL_HORIZONTAL = 0x00008000, // Horizontal oriented 00038 DIAL_CYCLIC = 0x00010000, // Value wraps around 00039 DIAL_HAS_NOTCH = 0x00020000, // Dial has a Center Notch 00040 DIAL_NORMAL = DIAL_VERTICAL 00041 }; 00042 00043 00044 /** 00045 * The dial widget is a valuator widget which is able to provide a cyclic 00046 * value range, or a simple linear value range. Optionally, the zero point 00047 * may be displayed by means of a colored notch. 00048 * While being turned, the dial sends a SEL_CHANGED message to its target; 00049 * at the end of the interaction, a SEL_COMMAND message is sent. 00050 * The message data represents the current value, of type FXint. 00051 */ 00052 class FXAPI FXDial : public FXFrame { 00053 FXDECLARE(FXDial) 00054 protected: 00055 FXint range[2]; // Reported data range 00056 FXColor notchColor; // Main notch color 00057 FXint notchangle; // Angle of main notch 00058 FXint notchspacing; // Angle between notches 00059 FXint notchoffset; // Notch offset 00060 FXint dragpoint; // Place where clicked 00061 FXint dragpos; // Value where clicked 00062 FXint incr; // Rate of change/revolution 00063 FXint pos; // Reported data position 00064 FXString help; // Help string 00065 FXString tip; // Tip string 00066 protected: 00067 FXDial(){} 00068 private: 00069 FXDial(const FXDial&); 00070 FXDial &operator=(const FXDial&); 00071 public: 00072 long onPaint(FXObject*,FXSelector,void*); 00073 long onMotion(FXObject*,FXSelector,void*); 00074 long onMouseWheel(FXObject*,FXSelector,void*); 00075 long onLeftBtnPress(FXObject*,FXSelector,void* ); 00076 long onLeftBtnRelease(FXObject*,FXSelector,void*); 00077 long onUngrabbed(FXObject*,FXSelector,void*); 00078 long onCmdSetValue(FXObject*,FXSelector,void*); 00079 long onCmdSetIntValue(FXObject*,FXSelector,void*); 00080 long onCmdGetIntValue(FXObject*,FXSelector,void*); 00081 long onCmdSetRealValue(FXObject*,FXSelector,void*); 00082 long onCmdGetRealValue(FXObject*,FXSelector,void*); 00083 long onCmdSetIntRange(FXObject*,FXSelector,void*); 00084 long onCmdGetIntRange(FXObject*,FXSelector,void*); 00085 long onCmdSetRealRange(FXObject*,FXSelector,void*); 00086 long onCmdGetRealRange(FXObject*,FXSelector,void*); 00087 long onQueryHelp(FXObject*,FXSelector,void*); 00088 long onQueryTip(FXObject*,FXSelector,void*); 00089 public: 00090 00091 /// Construct a dial widget 00092 FXDial(FXComposite *p,FXObject* tgt=NULL,FXSelector sel=0,FXuint opts=DIAL_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); 00093 00094 /// Return default width 00095 virtual FXint getDefaultWidth(); 00096 00097 /// Return default height 00098 virtual FXint getDefaultHeight(); 00099 00100 /// Set the dial value 00101 void setValue(FXint value); 00102 00103 /// Return the dial value 00104 FXint getValue() const { return pos; } 00105 00106 /// Change the dial's range 00107 void setRange(FXint lo,FXint hi); 00108 00109 /// Obtain the current range of the dial 00110 void getRange(FXint& lo,FXint& hi) const { lo=range[0]; hi=range[1]; } 00111 00112 /** 00113 * Set the revolution increment, which is the amount of change 00114 * in the position for revolution of the dial; the dial may go 00115 * through multiple revolutions to go through its whole range 00116 */ 00117 void setRevolutionIncrement(FXint i); 00118 00119 /// Get the current value of the revolution increment 00120 FXint getRevolutionIncrement() const { return incr; } 00121 00122 /** 00123 * Change the spacing for the small notches; this should be set 00124 * in tenths of degrees in the range [1,3600], and the value should 00125 * be a divisor of 3600, so as to make the notches come out evenly 00126 */ 00127 void setNotchSpacing(FXint spacing); 00128 00129 /// Get the current notch spacing 00130 FXint getNotchSpacing() const { return notchspacing; } 00131 00132 /** 00133 * Change the notch offset, which is the position of the 00134 * center notch; the value should be tenths of degrees 00135 * in the range [-3600,3600] 00136 */ 00137 void setNotchOffset(FXint offset); 00138 00139 /// Get the current center notch offset 00140 FXint getNotchOffset() const { return notchoffset; } 00141 00142 /// Changes the dial style. 00143 void setDialStyle(FXuint opts); 00144 00145 /// Get the current dial style. 00146 FXuint getDialStyle() const; 00147 00148 /// Change the center notch color 00149 void setNotchColor(FXColor clr); 00150 00151 /// Get the current center notch color 00152 FXColor getNotchColor() const { return notchColor; } 00153 00154 /// Set the help text to be displayed on the status line 00155 void setHelpText(const FXString& text); 00156 00157 /// Get the current help text 00158 const FXString& getHelpText() const { return help; } 00159 00160 /// Set the tip text to be displayed in the tooltip 00161 void setTipText(const FXString& text); 00162 00163 /// Get the current tooltip text value 00164 const FXString& getTipText() const { return tip; } 00165 00166 /// Save to stream 00167 virtual void save(FXStream& store) const; 00168 00169 /// Load from stream 00170 virtual void load(FXStream& store); 00171 }; 00172 00173 } 00174 00175 #endif