<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>FXLabel.h</h1><div class="fragment"><pre>00001 <span class="comment">/********************************************************************************</span>
00002 <span class="comment">* *</span>
00003 <span class="comment">* L a b e l 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: FXLabel.h,v 1.24 2004/02/08 17:17:33 fox Exp $ *</span>
00023 <span class="comment">********************************************************************************/</span>
00024 <span class="preprocessor">#ifndef FXLABEL_H</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define FXLABEL_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 <span class="comment"></span>
00034 <span class="comment">/// Relationship options for icon-labels</span>
00035 <span class="comment"></span><span class="keyword">enum</span> {
00036 <a class="code" href="group__FXLabel__0.html#a0a1854">ICON_UNDER_TEXT</a> = 0, <span class="comment">/// Icon appears under text</span>
00037 <span class="comment"></span> <a class="code" href="group__FXLabel__0.html#a0a1855">ICON_AFTER_TEXT</a> = 0x00080000, <span class="comment">/// Icon appears after text (to its right)</span>
00038 <span class="comment"></span> <a class="code" href="group__FXLabel__0.html#a0a1856">ICON_BEFORE_TEXT</a> = 0x00100000, <span class="comment">/// Icon appears before text (to its left)</span>
00039 <span class="comment"></span> <a class="code" href="group__FXLabel__0.html#a0a1857">ICON_ABOVE_TEXT</a> = 0x00200000, <span class="comment">/// Icon appears above text</span>
00040 <span class="comment"></span> <a class="code" href="group__FXLabel__0.html#a0a1858">ICON_BELOW_TEXT</a> = 0x00400000, <span class="comment">/// Icon appears below text</span>
00041 <span class="comment"></span> <a class="code" href="group__FXLabel__0.html#a0a1859">TEXT_OVER_ICON</a> = <a class="code" href="group__FXLabel__0.html#a0a1854">ICON_UNDER_TEXT</a>, <span class="comment">/// Same as ICON_UNDER_TEXT</span>
00042 <span class="comment"></span> <a class="code" href="group__FXLabel__0.html#a0a1860">TEXT_AFTER_ICON</a> = <a class="code" href="group__FXLabel__0.html#a0a1856">ICON_BEFORE_TEXT</a>, <span class="comment">/// Same as ICON_BEFORE_TEXT</span>
00043 <span class="comment"></span> <a class="code" href="group__FXLabel__0.html#a0a1861">TEXT_BEFORE_ICON</a> = <a class="code" href="group__FXLabel__0.html#a0a1855">ICON_AFTER_TEXT</a>, <span class="comment">/// Same as ICON_AFTER_TEXT</span>
00044 <span class="comment"></span> <a class="code" href="group__FXLabel__0.html#a0a1862">TEXT_ABOVE_ICON</a> = <a class="code" href="group__FXLabel__0.html#a0a1858">ICON_BELOW_TEXT</a>, <span class="comment">/// Same as ICON_BELOW_TEXT</span>
00045 <span class="comment"></span> <a class="code" href="group__FXLabel__0.html#a0a1863">TEXT_BELOW_ICON</a> = <a class="code" href="group__FXLabel__0.html#a0a1857">ICON_ABOVE_TEXT</a> <span class="comment">/// Same as ICON_ABOVE_TEXT</span>
00046 <span class="comment"></span> };
00047
00048 <span class="comment"></span>
00049 <span class="comment">/// Normal way to show label</span>
00050 <span class="comment"></span><span class="keyword">enum</span> {
00051 LABEL_NORMAL = <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>
00052 };
00053
00054
00055 <span class="keyword">class </span>FXIcon;
00056 <span class="keyword">class </span>FXFont;
00057
00058 <span class="comment"></span>
00059 <span class="comment">/**</span>
00060 <span class="comment">* A label widget can be used to place a text and/or icon for</span>
00061 <span class="comment">* explanation purposes. The text label may have an optional tooltip</span>
00062 <span class="comment">* and/or help string.</span>
00063 <span class="comment">*/</span>
00064 <span class="keyword">class </span>FXAPI FXLabel : <span class="keyword">public</span> FXFrame {
00065 FXDECLARE(FXLabel)
00066 <span class="keyword">protected</span>:
00067 FXString label;
00068 FXIcon* icon;
00069 FXFont* font;
00070 FXHotKey hotkey;
00071 FXint hotoff;
00072 FXColor textColor;
00073 FXString tip;
00074 FXString help;
00075 <span class="keyword">protected</span>:
<a name="l00076"></a><a class="code" href="classFX_1_1FXLabel.html">00076</a> FXLabel();
00077 FXint labelHeight(<span class="keyword">const</span> <a class="code" href="classFX_1_1FXString.html">FXString</a>& text) <span class="keyword">const</span>;
00078 FXint labelWidth(<span class="keyword">const</span> <a class="code" href="classFX_1_1FXString.html">FXString</a>& text) <span class="keyword">const</span>;
00079 <span class="keywordtype">void</span> drawLabel(<a class="code" href="classFX_1_1FXDCWindow.html">FXDCWindow</a>& dc,<span class="keyword">const</span> <a class="code" href="classFX_1_1FXString.html">FXString</a>& text,FXint hot,FXint tx,FXint ty,FXint tw,FXint th);
00080 <span class="keywordtype">void</span> just_x(FXint& tx,FXint& ix,FXint tw,FXint iw);
00081 <span class="keywordtype">void</span> just_y(FXint& ty,FXint& iy,FXint th,FXint ih);
00082 <span class="keyword">private</span>:
00083 FXLabel(<span class="keyword">const</span> FXLabel&);
00084 FXLabel &operator=(<span class="keyword">const</span> FXLabel&);
00085 <span class="keyword">public</span>:
00086 <span class="keywordtype">long</span> onPaint(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00087 <span class="keywordtype">long</span> onHotKeyPress(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00088 <span class="keywordtype">long</span> onHotKeyRelease(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00089 <span class="keywordtype">long</span> onCmdSetStringValue(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00090 <span class="keywordtype">long</span> onCmdGetStringValue(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00091 <span class="keywordtype">long</span> onCmdSetIconValue(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00092 <span class="keywordtype">long</span> onCmdGetIconValue(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00093 <span class="keywordtype">long</span> onCmdSetHelp(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00094 <span class="keywordtype">long</span> onCmdGetHelp(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00095 <span class="keywordtype">long</span> onCmdSetTip(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00096 <span class="keywordtype">long</span> onCmdGetTip(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00097 <span class="keywordtype">long</span> onQueryHelp(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00098 <span class="keywordtype">long</span> onQueryTip(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00099 <span class="keyword">public</span>:
00100 <span class="comment"></span>
00101 <span class="comment"> /// Construct label with given text and icon</span>
00102 <span class="comment"></span> FXLabel(<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=0,FXuint opts=LABEL_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);
00103 <span class="comment"></span>
00104 <span class="comment"> /// Create server-side resources</span>
00105 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> create();
00106 <span class="comment"></span>
00107 <span class="comment"> /// Detach server-side resources</span>
00108 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> detach();
00109 <span class="comment"></span>
00110 <span class="comment"> /// Enable the window</span>
00111 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> enable();
00112 <span class="comment"></span>
00113 <span class="comment"> /// Disable the window</span>
00114 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> disable();
00115 <span class="comment"></span>
00116 <span class="comment"> /// Return default width</span>
00117 <span class="comment"></span> <span class="keyword">virtual</span> FXint getDefaultWidth();
00118 <span class="comment"></span>
<a name="l00119"></a><a class="code" href="classFX_1_1FXLabel.html#a8">00119</a> <span class="comment"> /// Return default height</span>
00120 <span class="comment"></span> <span class="keyword">virtual</span> FXint getDefaultHeight();
00121 <span class="comment"></span>
00122 <span class="comment"> /// Set the text for this label</span>
00123 <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);
00124 <span class="comment"></span>
<a name="l00125"></a><a class="code" href="classFX_1_1FXLabel.html#a10">00125</a> <span class="comment"> /// Get the text for this label</span>
00126 <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; }
00127 <span class="comment"></span>
00128 <span class="comment"> /// Set the icon for this label</span>
00129 <span class="comment"></span> <span class="keywordtype">void</span> setIcon(FXIcon* ic);
00130 <span class="comment"></span>
<a name="l00131"></a><a class="code" href="classFX_1_1FXLabel.html#a12">00131</a> <span class="comment"> /// Get the icon for this label</span>
00132 <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; }
00133 <span class="comment"></span>
<a name="l00134"></a><a class="code" href="classFX_1_1FXLabel.html#a13">00134</a> <span class="comment"> /// Set the text font</span>
00135 <span class="comment"></span> <span class="keywordtype">void</span> setFont(<a class="code" href="classFX_1_1FXFont.html">FXFont</a> *fnt);
00136 <span class="comment"></span>
00137 <span class="comment"> /// Get the text font</span>
00138 <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; }
00139 <span class="comment"></span>
00140 <span class="comment"> /// Get the current text color</span>
00141 <span class="comment"></span> FXColor getTextColor()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> textColor; }
00142 <span class="comment"></span>
00143 <span class="comment"> /// Set the current text color</span>
00144 <span class="comment"></span> <span class="keywordtype">void</span> setTextColor(FXColor clr);
00145 <span class="comment"></span>
00146 <span class="comment"> /// Set the current text-justification mode.</span>
00147 <span class="comment"></span> <span class="keywordtype">void</span> setJustify(FXuint mode);
00148 <span class="comment"></span>
00149 <span class="comment"> /// Get the current text-justification mode.</span>
00150 <span class="comment"></span> FXuint getJustify() <span class="keyword">const</span>;
00151 <span class="comment"></span>
00152 <span class="comment"> /// Set the current icon position</span>
00153 <span class="comment"></span> <span class="keywordtype">void</span> setIconPosition(FXuint mode);
00154 <span class="comment"></span>
<a name="l00155"></a><a class="code" href="classFX_1_1FXLabel.html#a20">00155</a> <span class="comment"> /// Get the current icon position</span>
00156 <span class="comment"></span> FXuint getIconPosition() <span class="keyword">const</span>;
00157 <span class="comment"></span>
00158 <span class="comment"> /// Set the status line help text for this label</span>
00159 <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);
00160 <span class="comment"></span>
<a name="l00161"></a><a class="code" href="classFX_1_1FXLabel.html#a22">00161</a> <span class="comment"> /// Get the status line help text for this label</span>
00162 <span class="comment"></span> <a class="code" href="classFX_1_1FXString.html">FXString</a> getHelpText()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> help; }
00163 <span class="comment"></span>
00164 <span class="comment"> /// Set the tool tip message for this label</span>
00165 <span class="comment"></span> <span class="keywordtype">void</span> setTipText(<span class="keyword">const</span> FXString& text);
00166 <span class="comment"></span>
00167 <span class="comment"> /// Get the tool tip message for this label</span>
00168 <span class="comment"></span> FXString getTipText()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> tip; }
00169 <span class="comment"></span>
00170 <span class="comment"> /// Save label to a stream</span>
00171 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> save(FXStream& store) <span class="keyword">const</span>;
00172 <span class="comment"></span>
00173 <span class="comment"> /// Load label from a stream</span>
00174 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> load(FXStream& store);
00175 <span class="comment"></span>
00176 <span class="comment"> /// Destructor</span>
00177 <span class="comment"></span> <span class="keyword">virtual</span> ~FXLabel();
00178 };
00179
00180 }
00181
00182 <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>
