<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>FXToggleButton.h</h1><div class="fragment"><pre>00001 <span class="comment">/********************************************************************************</span>
00002 <span class="comment">* *</span>
00003 <span class="comment">* T o g g l e B u t t o n 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: FXToggleButton.h,v 1.26 2004/02/08 17:17:34 fox Exp $ *</span>
00023 <span class="comment">********************************************************************************/</span>
00024 <span class="preprocessor">#ifndef FXTOGGLEBUTTON_H</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define FXTOGGLEBUTTON_H</span>
00026 <span class="preprocessor"></span>
00027 <span class="preprocessor">#ifndef FXLABEL_H</span>
00028 <span class="preprocessor"></span><span class="preprocessor">#include "FXLabel.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">/// Toggle button flags</span>
00035 <span class="comment"></span><span class="keyword">enum</span> {
00036 <a class="code" href="group__FXToggleButton__0.html#a0a2075">TOGGLEBUTTON_AUTOGRAY</a> = 0x00800000, <span class="comment">/// Automatically gray out when not updated</span>
00037 <span class="comment"></span> <a class="code" href="group__FXToggleButton__0.html#a0a2076">TOGGLEBUTTON_AUTOHIDE</a> = 0x01000000, <span class="comment">/// Automatically hide toggle button when not updated</span>
00038 <span class="comment"></span> <a class="code" href="group__FXToggleButton__0.html#a0a2077">TOGGLEBUTTON_TOOLBAR</a> = 0x02000000, <span class="comment">/// Toolbar style toggle button [flat look]</span>
00039 <span class="comment"></span> <a class="code" href="group__FXToggleButton__0.html#a0a2078">TOGGLEBUTTON_KEEPSTATE</a>= 0x04000000, <span class="comment">/// Draw button according to state</span>
00040 <span class="comment"></span> TOGGLEBUTTON_NORMAL = <a class="code" href="group__FXWindow__1.html#a0a2158">FRAME_RAISED</a>|<a class="code" href="group__FXWindow__1.html#a0a2159">FRAME_THICK</a>|<a class="code" href="group__FXFrame__0.html#a0a463">JUSTIFY_NORMAL</a>|<a class="code" href="group__FXLabel__0.html#a0a1856">ICON_BEFORE_TEXT</a>
00041 };
00042
00043 <span class="comment"></span>
00044 <span class="comment">/**</span>
00045 <span class="comment">* The toggle button provides a two-state button, which toggles between the</span>
00046 <span class="comment">* on and the off state each time it is pressed. For each state, the toggle</span>
00047 <span class="comment">* button has a unique icon and text label.</span>
00048 <span class="comment">* When pressed, the button widget sends a SEL_COMMAND to its target, with the</span>
00049 <span class="comment">* message data set to the current state of the toggle button, of the type FXbool.</span>
00050 <span class="comment">*/</span>
00051 <span class="keyword">class </span>FXAPI FXToggleButton : <span class="keyword">public</span> FXLabel {
00052 FXDECLARE(FXToggleButton)
00053 <span class="keyword">protected</span>:
00054 FXString altlabel;
00055 FXIcon *alticon;
00056 FXHotKey althotkey;
00057 FXint althotoff;
<a name="l00058"></a><a class="code" href="classFX_1_1FXToggleButton.html">00058</a> <a class="code" href="classFX_1_1FXString.html">FXString</a> alttip;
00059 <a class="code" href="classFX_1_1FXString.html">FXString</a> althelp;
00060 FXbool state;
00061 FXbool down;
00062 <span class="keyword">protected</span>:
00063 FXToggleButton();
00064 <span class="keywordtype">void</span> press(FXbool dn);
00065 <span class="keyword">private</span>:
00066 FXToggleButton(<span class="keyword">const</span> FXToggleButton&);
00067 FXToggleButton& operator=(<span class="keyword">const</span> FXToggleButton&);
00068 <span class="keyword">public</span>:
00069 <span class="keywordtype">long</span> onPaint(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00070 <span class="keywordtype">long</span> onUpdate(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00071 <span class="keywordtype">long</span> onEnter(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00072 <span class="keywordtype">long</span> onLeave(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00073 <span class="keywordtype">long</span> onFocusIn(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00074 <span class="keywordtype">long</span> onFocusOut(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00075 <span class="keywordtype">long</span> onUngrabbed(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00076 <span class="keywordtype">long</span> onLeftBtnPress(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00077 <span class="keywordtype">long</span> onLeftBtnRelease(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00078 <span class="keywordtype">long</span> onKeyPress(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00079 <span class="keywordtype">long</span> onKeyRelease(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00080 <span class="keywordtype">long</span> onHotKeyPress(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00081 <span class="keywordtype">long</span> onHotKeyRelease(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00082 <span class="keywordtype">long</span> onCheck(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00083 <span class="keywordtype">long</span> onUncheck(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00084 <span class="keywordtype">long</span> onQueryHelp(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00085 <span class="keywordtype">long</span> onQueryTip(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00086 <span class="keywordtype">long</span> onCmdSetValue(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00087 <span class="keywordtype">long</span> onCmdSetIntValue(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00088 <span class="keywordtype">long</span> onCmdGetIntValue(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00089 <span class="keyword">public</span>:
00090 <span class="comment"></span>
00091 <span class="comment"> /// Construct toggle button with two text labels, and two icons, one for each state</span>
00092 <span class="comment"></span> FXToggleButton(<a class="code" href="classFX_1_1FXComposite.html">FXComposite</a>* p,<span class="keyword">const</span> <a class="code" href="classFX_1_1FXString.html">FXString</a>& text1,<span class="keyword">const</span> <a class="code" href="classFX_1_1FXString.html">FXString</a>& text2,<a class="code" href="classFX_1_1FXIcon.html">FXIcon</a>* icon1=NULL,<a class="code" href="classFX_1_1FXIcon.html">FXIcon</a>* icon2=NULL,<a class="code" href="classFX_1_1FXObject.html">FXObject</a>* tgt=NULL,FXSelector sel=0,FXuint opts=TOGGLEBUTTON_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 <span class="comment"></span>
00094 <span class="comment"> /// Create server-side resources</span>
00095 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> create();
00096 <span class="comment"></span>
00097 <span class="comment"> /// Detach server-side resources</span>
00098 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> detach();
00099 <span class="comment"></span>
00100 <span class="comment"> /// Returns true because a toggle button can receive focus</span>
00101 <span class="comment"></span> <span class="keyword">virtual</span> FXbool canFocus() <span class="keyword">const</span>;
00102 <span class="comment"></span>
00103 <span class="comment"> /// Get default width</span>
00104 <span class="comment"></span> <span class="keyword">virtual</span> FXint getDefaultWidth();
<a name="l00105"></a><a class="code" href="classFX_1_1FXToggleButton.html#a7">00105</a> <span class="comment"></span>
00106 <span class="comment"> /// Get default height</span>
00107 <span class="comment"></span> <span class="keyword">virtual</span> FXint getDefaultHeight();
00108 <span class="comment"></span>
00109 <span class="comment"> /// Change alternate text shown when toggled</span>
00110 <span class="comment"></span> <span class="keywordtype">void</span> setAltText(<span class="keyword">const</span> <a class="code" href="classFX_1_1FXString.html">FXString</a>& text);
<a name="l00111"></a><a class="code" href="classFX_1_1FXToggleButton.html#a9">00111</a> <span class="comment"></span>
00112 <span class="comment"> /// Return alternate text</span>
00113 <span class="comment"></span> <a class="code" href="classFX_1_1FXString.html">FXString</a> getAltText()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> altlabel; }
00114 <span class="comment"></span>
00115 <span class="comment"> /// Change alternate icon shown when toggled</span>
00116 <span class="comment"></span> <span class="keywordtype">void</span> setAltIcon(FXIcon* ic);
<a name="l00117"></a><a class="code" href="classFX_1_1FXToggleButton.html#a11">00117</a> <span class="comment"></span>
00118 <span class="comment"> /// Return alternate icon</span>
00119 <span class="comment"></span> <a class="code" href="classFX_1_1FXIcon.html">FXIcon</a>* getAltIcon()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> alticon; }
00120 <span class="comment"></span>
00121 <span class="comment"> /// Change toggled state</span>
00122 <span class="comment"></span> <span class="keywordtype">void</span> setState(FXbool s=TRUE);
<a name="l00123"></a><a class="code" href="classFX_1_1FXToggleButton.html#a13">00123</a> <span class="comment"></span>
00124 <span class="comment"> /// return toggled state</span>
00125 <span class="comment"></span> FXbool getState()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> state; }
00126 <span class="comment"></span>
00127 <span class="comment"> /// Change alternate help text shown when toggled</span>
00128 <span class="comment"></span> <span class="keywordtype">void</span> setAltHelpText(<span class="keyword">const</span> FXString& text);
<a name="l00129"></a><a class="code" href="classFX_1_1FXToggleButton.html#a15">00129</a> <span class="comment"></span>
00130 <span class="comment"> /// Return alternate help text</span>
00131 <span class="comment"></span> <a class="code" href="classFX_1_1FXString.html">FXString</a> getAltHelpText()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> althelp; }
00132 <span class="comment"></span>
00133 <span class="comment"> /// Change alternate tip text shown when toggled</span>
00134 <span class="comment"></span> <span class="keywordtype">void</span> setAltTipText(<span class="keyword">const</span> FXString& text);
00135 <span class="comment"></span>
00136 <span class="comment"> /// Return alternate tip text</span>
00137 <span class="comment"></span> FXString getAltTipText()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> alttip; }
00138 <span class="comment"></span>
00139 <span class="comment"> /// Set the toggle button style flags</span>
00140 <span class="comment"></span> <span class="keywordtype">void</span> setToggleStyle(FXuint style);
00141 <span class="comment"></span>
00142 <span class="comment"> /// Get the toggle button style flags</span>
00143 <span class="comment"></span> FXuint getToggleStyle() <span class="keyword">const</span>;
00144 <span class="comment"></span>
00145 <span class="comment"> /// Save toggle button to a stream</span>
00146 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> save(FXStream& store) <span class="keyword">const</span>;
00147 <span class="comment"></span>
00148 <span class="comment"> /// Load toggle button from a stream</span>
00149 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> load(FXStream& store);
00150 <span class="comment"></span>
00151 <span class="comment"> /// Destructor</span>
00152 <span class="comment"></span> <span class="keyword">virtual</span> ~FXToggleButton();
00153 };
00154
00155 }
00156
00157 <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>
