<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>FXMenuCaption.h</h1><div class="fragment"><pre>00001 <span class="comment">/********************************************************************************</span>
00002 <span class="comment">* *</span>
00003 <span class="comment">* M e n u C a p t i 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) 1997,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: FXMenuCaption.h,v 1.28 2004/02/08 17:17:33 fox Exp $ *</span>
00023 <span class="comment">********************************************************************************/</span>
00024 <span class="preprocessor">#ifndef FXMENUCAPTION_H</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define FXMENUCAPTION_H</span>
00026 <span class="preprocessor"></span>
00027 <span class="preprocessor">#ifndef FXWINDOW_H</span>
00028 <span class="preprocessor"></span><span class="preprocessor">#include "FXWindow.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">/// Menu Caption options</span>
00035 <span class="comment"></span><span class="keyword">enum</span> {
00036 <a class="code" href="group__FXMenuCaption__0.html#a0a1893">MENU_AUTOGRAY</a> = 0x00008000, <span class="comment">/// Automatically gray out when not updated</span>
00037 <span class="comment"></span> <a class="code" href="group__FXMenuCaption__0.html#a0a1894">MENU_AUTOHIDE</a> = 0x00010000 <span class="comment">/// Automatically hide button when not updated</span>
00038 <span class="comment"></span> };
00039
00040
00041 <span class="keyword">class </span>FXIcon;
00042 <span class="keyword">class </span>FXFont;
00043
00044 <span class="comment"></span>
00045 <span class="comment">/**</span>
00046 <span class="comment">* The menu caption is a widget which can be used as a caption</span>
00047 <span class="comment">* above a number of menu commands in a menu.</span>
00048 <span class="comment">*/</span>
00049 <span class="keyword">class </span>FXAPI FXMenuCaption : <span class="keyword">public</span> FXWindow {
00050 FXDECLARE(FXMenuCaption)
00051 <span class="keyword">protected</span>:
00052 FXString label;
00053 FXString help;
00054 FXIcon *icon;
00055 FXFont *font;
<a name="l00056"></a><a class="code" href="classFX_1_1FXMenuCaption.html">00056</a> FXint hotoff;
00057 FXHotKey hotkey;
00058 FXColor textColor;
00059 FXColor selbackColor;
00060 FXColor seltextColor;
00061 FXColor hiliteColor;
00062 FXColor shadowColor;
00063 <span class="keyword">protected</span>:
00064 FXMenuCaption();
00065 <span class="keyword">private</span>:
00066 FXMenuCaption(<span class="keyword">const</span> FXMenuCaption&);
00067 FXMenuCaption &operator=(<span class="keyword">const</span> FXMenuCaption&);
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> onCmdGetStringValue(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00072 <span class="keywordtype">long</span> onCmdSetStringValue(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00073 <span class="keywordtype">long</span> onCmdSetIconValue(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00074 <span class="keywordtype">long</span> onCmdGetIconValue(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00075 <span class="keywordtype">long</span> onCmdSetHelp(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00076 <span class="keywordtype">long</span> onCmdGetHelp(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00077 <span class="keywordtype">long</span> onQueryHelp(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00078 <span class="keyword">public</span>:
00079 <span class="comment"></span>
00080 <span class="comment"> /// Construct a menu caption</span>
00081 <span class="comment"></span> FXMenuCaption(<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>& text,<a class="code" href="classFX_1_1FXIcon.html">FXIcon</a>* ic=NULL,FXuint opts=0);
00082 <span class="comment"></span>
00083 <span class="comment"> /// Create server-side resources</span>
00084 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> create();
00085 <span class="comment"></span>
00086 <span class="comment"> /// Detach server-side resources</span>
00087 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> detach();
00088 <span class="comment"></span>
00089 <span class="comment"> /// Enable the menu</span>
00090 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> enable();
00091 <span class="comment"></span>
00092 <span class="comment"> /// Disable the menu</span>
00093 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> disable();
00094 <span class="comment"></span>
<a name="l00095"></a><a class="code" href="classFX_1_1FXMenuCaption.html#a8">00095</a> <span class="comment"> /// Return default width</span>
00096 <span class="comment"></span> <span class="keyword">virtual</span> FXint getDefaultWidth();
00097 <span class="comment"></span>
00098 <span class="comment"> /// Return default height</span>
00099 <span class="comment"></span> <span class="keyword">virtual</span> FXint getDefaultHeight();
00100 <span class="comment"></span>
<a name="l00101"></a><a class="code" href="classFX_1_1FXMenuCaption.html#a10">00101</a> <span class="comment"> /// Set the text for this menu</span>
00102 <span class="comment"></span> <span class="keywordtype">void</span> setText(<span class="keyword">const</span> <a class="code" href="classFX_1_1FXString.html">FXString</a>& text);
00103 <span class="comment"></span>
00104 <span class="comment"> /// Get the text for this menu</span>
00105 <span class="comment"></span> <a class="code" href="classFX_1_1FXString.html">FXString</a> getText()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> label; }
00106 <span class="comment"></span>
<a name="l00107"></a><a class="code" href="classFX_1_1FXMenuCaption.html#a12">00107</a> <span class="comment"> /// Set the icon for this menu</span>
00108 <span class="comment"></span> <span class="keywordtype">void</span> setIcon(<a class="code" href="classFX_1_1FXIcon.html">FXIcon</a>* ic);
00109 <span class="comment"></span>
00110 <span class="comment"> /// Get the icon for this menu</span>
00111 <span class="comment"></span> <a class="code" href="classFX_1_1FXIcon.html">FXIcon</a>* getIcon()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> icon; }
00112 <span class="comment"></span>
00113 <span class="comment"> /// Set the text font</span>
00114 <span class="comment"></span> <span class="keywordtype">void</span> setFont(FXFont* fnt);
00115 <span class="comment"></span>
<a name="l00116"></a><a class="code" href="classFX_1_1FXMenuCaption.html#a15">00116</a> <span class="comment"> /// Return the text font</span>
00117 <span class="comment"></span> <a class="code" href="classFX_1_1FXFont.html">FXFont</a>* getFont()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> font; }
00118 <span class="comment"></span>
00119 <span class="comment"> /// Set menu caption style</span>
00120 <span class="comment"></span> <span class="keywordtype">void</span> setMenuStyle(FXuint style);
00121 <span class="comment"></span>
<a name="l00122"></a><a class="code" href="classFX_1_1FXMenuCaption.html#a17">00122</a> <span class="comment"> /// Get menu caption style</span>
00123 <span class="comment"></span> FXuint getMenuStyle() <span class="keyword">const</span>;
00124 <span class="comment"></span>
00125 <span class="comment"> /// Get the current text color</span>
00126 <span class="comment"></span> FXColor getTextColor()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> textColor; }
00127 <span class="comment"></span>
<a name="l00128"></a><a class="code" href="classFX_1_1FXMenuCaption.html#a19">00128</a> <span class="comment"> /// Return the current text color</span>
00129 <span class="comment"></span> <span class="keywordtype">void</span> setTextColor(FXColor clr);
00130 <span class="comment"></span>
00131 <span class="comment"> /// Return the selection background color</span>
00132 <span class="comment"></span> FXColor getSelBackColor()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> selbackColor; }
00133 <span class="comment"></span>
00134 <span class="comment"> /// Return the selection background color</span>
00135 <span class="comment"></span> <span class="keywordtype">void</span> setSelBackColor(FXColor clr);
00136 <span class="comment"></span>
<a name="l00137"></a><a class="code" href="classFX_1_1FXMenuCaption.html#a22">00137</a> <span class="comment"> /// Return the selection text color</span>
00138 <span class="comment"></span> FXColor getSelTextColor()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> seltextColor; }
00139 <span class="comment"></span>
00140 <span class="comment"> /// Return the selection text color</span>
00141 <span class="comment"></span> <span class="keywordtype">void</span> setSelTextColor(FXColor clr);
00142 <span class="comment"></span>
<a name="l00143"></a><a class="code" href="classFX_1_1FXMenuCaption.html#a24">00143</a> <span class="comment"> /// Change highlight color</span>
00144 <span class="comment"></span> <span class="keywordtype">void</span> setHiliteColor(FXColor clr);
00145 <span class="comment"></span>
00146 <span class="comment"> /// Get highlight color</span>
00147 <span class="comment"></span> FXColor getHiliteColor()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> hiliteColor; }
00148 <span class="comment"></span>
<a name="l00149"></a><a class="code" href="classFX_1_1FXMenuCaption.html#a26">00149</a> <span class="comment"> /// Change shadow color</span>
00150 <span class="comment"></span> <span class="keywordtype">void</span> setShadowColor(FXColor clr);
00151 <span class="comment"></span>
00152 <span class="comment"> /// Get shadow color</span>
00153 <span class="comment"></span> FXColor getShadowColor()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> shadowColor; }
00154 <span class="comment"></span>
00155 <span class="comment"> /// Set the status line help text for this menu</span>
00156 <span class="comment"></span> <span class="keywordtype">void</span> setHelpText(<span class="keyword">const</span> FXString& text);
00157 <span class="comment"></span>
00158 <span class="comment"> /// Get the status line help text for this menu</span>
00159 <span class="comment"></span> FXString getHelpText()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> help; }
00160 <span class="comment"></span>
00161 <span class="comment"> /// Save menu to a stream</span>
00162 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> save(FXStream& store) <span class="keyword">const</span>;
00163 <span class="comment"></span>
00164 <span class="comment"> /// Load menu from a stream</span>
00165 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> load(FXStream& store);
00166 <span class="comment"></span>
00167 <span class="comment"> /// Destructor</span>
00168 <span class="comment"></span> <span class="keyword">virtual</span> ~FXMenuCaption();
00169 };
00170
00171 }
00172
00173 <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>
