<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>FXArrowButton.h</h1><div class="fragment"><pre>00001 <span class="comment">/********************************************************************************</span>
00002 <span class="comment">* *</span>
00003 <span class="comment">* A r r o w 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: FXArrowButton.h,v 1.35 2004/02/08 17:17:33 fox Exp $ *</span>
00023 <span class="comment">********************************************************************************/</span>
00024 <span class="preprocessor">#ifndef FXARROWBUTTON_H</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define FXARROWBUTTON_H</span>
00026 <span class="preprocessor"></span>
00027 <span class="preprocessor">#ifndef FXFRAME_H</span>
00028 <span class="preprocessor"></span><span class="preprocessor">#include "FXFrame.h"</span>
00029 <span class="preprocessor">#endif</span>
00030 <span class="preprocessor"></span>
00031 <span class="keyword">namespace </span>FX {
00032
00033
00034 <span class="comment">// Arrow style options</span>
00035 <span class="keyword">enum</span> {
00036 <a class="code" href="group__FXArrowButton__0.html#a0a35">ARROW_NONE</a> = 0, <span class="comment">// No arrow</span>
00037 <a class="code" href="group__FXArrowButton__0.html#a0a36">ARROW_UP</a> = 0x00080000, <span class="comment">// Arrow points up</span>
00038 <a class="code" href="group__FXArrowButton__0.html#a0a37">ARROW_DOWN</a> = 0x00100000, <span class="comment">// Arrow points down</span>
00039 <a class="code" href="group__FXArrowButton__0.html#a0a38">ARROW_LEFT</a> = 0x00200000, <span class="comment">// Arrow points left</span>
00040 <a class="code" href="group__FXArrowButton__0.html#a0a39">ARROW_RIGHT</a> = 0x00400000, <span class="comment">// Arrow points right</span>
00041 <a class="code" href="group__FXArrowButton__0.html#a0a40">ARROW_AUTO</a> = 0x00800000, <span class="comment">// Automatically fire when hovering mouse over button</span>
00042 <a class="code" href="group__FXArrowButton__0.html#a0a41">ARROW_REPEAT</a> = 0x01000000, <span class="comment">// Button repeats if held down</span>
00043 <a class="code" href="group__FXArrowButton__0.html#a0a42">ARROW_AUTOGRAY</a> = 0x02000000, <span class="comment">// Automatically gray out when not updated</span>
00044 <a class="code" href="group__FXArrowButton__0.html#a0a43">ARROW_AUTOHIDE</a> = 0x04000000, <span class="comment">// Automatically hide when not updated</span>
00045 <a class="code" href="group__FXArrowButton__0.html#a0a44">ARROW_TOOLBAR</a> = 0x08000000, <span class="comment">// Button is toolbar-style</span>
00046 ARROW_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__FXArrowButton__0.html#a0a36">ARROW_UP</a>
00047 };
00048
00049 <span class="comment"></span>
00050 <span class="comment">/**</span>
00051 <span class="comment">* Button with an arrow; the arrow can point in any direction.</span>
00052 <span class="comment">* When clicked, the arrow button sends a SEL_COMMAND to its target.</span>
00053 <span class="comment">* When ARROW_REPEAT is passed, the arrow button sends a SEL_COMMAND</span>
00054 <span class="comment">* repeatedly while the button is pressed.</span>
00055 <span class="comment">* The option ARROW_AUTO together with ARROW_REPEAT makes the arrow</span>
00056 <span class="comment">* button work in repeat mode simply by hovering the cursor over it.</span>
00057 <span class="comment">*/</span>
00058 <span class="keyword">class </span>FXAPI FXArrowButton : <span class="keyword">public</span> FXFrame {
00059 FXDECLARE(FXArrowButton)
00060 <span class="keyword">protected</span>:
00061 FXColor arrowColor; <span class="comment">// Arrow color</span>
00062 FXint arrowSize; <span class="comment">// Arrow size</span>
00063 FXString tip; <span class="comment">// Tooltip value</span>
00064 FXString help; <span class="comment">// Help value</span>
<a name="l00065"></a><a class="code" href="classFX_1_1FXArrowButton.html">00065</a> FXbool state; <span class="comment">// State of button</span>
00066 FXbool fired; <span class="comment">// Timer has fired</span>
00067 <span class="keyword">protected</span>:
00068 FXArrowButton();
00069 <span class="keyword">private</span>:
00070 FXArrowButton(<span class="keyword">const</span> FXArrowButton&);
00071 FXArrowButton &operator=(<span class="keyword">const</span> FXArrowButton&);
00072 <span class="keyword">public</span>:
00073 <span class="keywordtype">long</span> onPaint(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00074 <span class="keywordtype">long</span> onUpdate(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00075 <span class="keywordtype">long</span> onEnter(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00076 <span class="keywordtype">long</span> onLeave(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00077 <span class="keywordtype">long</span> onLeftBtnPress(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00078 <span class="keywordtype">long</span> onLeftBtnRelease(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00079 <span class="keywordtype">long</span> onUngrabbed(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00080 <span class="keywordtype">long</span> onRepeat(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00081 <span class="keywordtype">long</span> onAuto(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00082 <span class="keywordtype">long</span> onKeyPress(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00083 <span class="keywordtype">long</span> onKeyRelease(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00084 <span class="keywordtype">long</span> onHotKeyPress(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00085 <span class="keywordtype">long</span> onHotKeyRelease(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00086 <span class="keywordtype">long</span> onCmdSetHelp(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00087 <span class="keywordtype">long</span> onCmdGetHelp(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00088 <span class="keywordtype">long</span> onCmdSetTip(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00089 <span class="keywordtype">long</span> onCmdGetTip(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00090 <span class="keywordtype">long</span> onQueryHelp(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00091 <span class="keywordtype">long</span> onQueryTip(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00092 <span class="keyword">public</span>:
00093 <span class="keyword">enum</span> {
00094 ID_REPEAT=FXFrame::ID_LAST,
00095 ID_AUTO,
00096 ID_LAST
00097 };
00098 <span class="keyword">public</span>:
00099 <span class="comment"></span>
00100 <span class="comment"> /// Construct arrow button</span>
00101 <span class="comment"></span> FXArrowButton(FXComposite* p,FXObject* tgt=NULL,FXSelector sel=0,FXuint opts=ARROW_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);
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();
00105 <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"> /// Enable the button</span>
00110 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> enable();
00111 <span class="comment"></span>
<a name="l00112"></a><a class="code" href="classFX_1_1FXArrowButton.html#a7">00112</a> <span class="comment"> /// Disable the button</span>
00113 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> disable();
00114 <span class="comment"></span>
<a name="l00115"></a><a class="code" href="classFX_1_1FXArrowButton.html#a8">00115</a> <span class="comment"> /// Returns true because a button can receive focus</span>
00116 <span class="comment"></span> <span class="keyword">virtual</span> FXbool canFocus() <span class="keyword">const</span>;
00117 <span class="comment"></span>
<a name="l00118"></a><a class="code" href="classFX_1_1FXArrowButton.html#a9">00118</a> <span class="comment"> /// Set the button state (where TRUE means the button is down)</span>
00119 <span class="comment"></span> <span class="keywordtype">void</span> setState(FXbool s);
00120 <span class="comment"></span>
<a name="l00121"></a><a class="code" href="classFX_1_1FXArrowButton.html#a10">00121</a> <span class="comment"> /// Get the button state (where TRUE means the button is down)</span>
00122 <span class="comment"></span> FXbool getState()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> state; }
00123 <span class="comment"></span>
<a name="l00124"></a><a class="code" href="classFX_1_1FXArrowButton.html#a11">00124</a> <span class="comment"> /// Set status line help text for this arrow button</span>
00125 <span class="comment"></span> <span class="keywordtype">void</span> setHelpText(<span class="keyword">const</span> <a class="code" href="classFX_1_1FXString.html">FXString</a>& text){ help=text; }
00126 <span class="comment"></span>
00127 <span class="comment"> /// Get status line help text for this arrow button</span>
00128 <span class="comment"></span> FXString getHelpText()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> help; }
00129 <span class="comment"></span>
00130 <span class="comment"> /// Set tool tip message for this arrow button</span>
00131 <span class="comment"></span> <span class="keywordtype">void</span> setTipText(<span class="keyword">const</span> FXString& text){ tip=text; }
00132 <span class="comment"></span>
00133 <span class="comment"> /// Get tool tip message for this arrow button</span>
00134 <span class="comment"></span> FXString getTipText()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> tip; }
00135 <span class="comment"></span>
<a name="l00136"></a><a class="code" href="classFX_1_1FXArrowButton.html#a15">00136</a> <span class="comment"> /// Set the arrow style flags</span>
00137 <span class="comment"></span> <span class="keywordtype">void</span> setArrowStyle(FXuint style);
00138 <span class="comment"></span>
00139 <span class="comment"> /// Get the arrow style flags</span>
00140 <span class="comment"></span> FXuint getArrowStyle() <span class="keyword">const</span>;
00141 <span class="comment"></span>
00142 <span class="comment"> /// Set the default arrow size</span>
00143 <span class="comment"></span> <span class="keywordtype">void</span> setArrowSize(FXint size);
00144 <span class="comment"></span>
<a name="l00145"></a><a class="code" href="classFX_1_1FXArrowButton.html#a18">00145</a> <span class="comment"> /// Get the default arrow size</span>
00146 <span class="comment"></span> FXint getArrowSize()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> arrowSize; }
00147 <span class="comment"></span>
00148 <span class="comment"> /// Set the current justification mode.</span>
00149 <span class="comment"></span> <span class="keywordtype">void</span> setJustify(FXuint mode);
00150 <span class="comment"></span>
00151 <span class="comment"> /// Get the current justification mode.</span>
00152 <span class="comment"></span> FXuint getJustify() <span class="keyword">const</span>;
00153 <span class="comment"></span>
00154 <span class="comment"> /// Get the fill color for the arrow</span>
00155 <span class="comment"></span> FXColor getArrowColor()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> arrowColor; }
00156 <span class="comment"></span>
00157 <span class="comment"> /// Set the fill color for the arrow</span>
00158 <span class="comment"></span> <span class="keywordtype">void</span> setArrowColor(FXColor clr);
00159 <span class="comment"></span>
00160 <span class="comment"> /// Save label to a stream</span>
00161 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> save(FXStream& store) <span class="keyword">const</span>;
00162 <span class="comment"></span>
00163 <span class="comment"> /// Load label from a stream</span>
00164 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> load(FXStream& store);
00165 <span class="comment"></span>
00166 <span class="comment"> /// Destructor</span>
00167 <span class="comment"></span> <span class="keyword">virtual</span> ~FXArrowButton();
00168 };
00169
00170 }
00171
00172 <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>
