<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>FXToolBar.h</h1><div class="fragment"><pre>00001 <span class="comment">/********************************************************************************</span>
00002 <span class="comment">* *</span>
00003 <span class="comment">* T o o l B a r W i d g e t *</span>
00004 <span class="comment">* *</span>
00005 <span class="comment">*********************************************************************************</span>
00006 <span class="comment">* Copyright (C) 2000,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: FXToolBar.h,v 1.5 2004/02/08 17:17:34 fox Exp $ *</span>
00023 <span class="comment">********************************************************************************/</span>
00024 <span class="preprocessor">#ifndef FXTOOLBAR_H</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define FXTOOLBAR_H</span>
00026 <span class="preprocessor"></span>
00027 <span class="preprocessor">#ifndef FXPACKER_H</span>
00028 <span class="preprocessor"></span><span class="preprocessor">#include "FXPacker.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">/**</span>
00035 <span class="comment">* ToolBar control.</span>
00036 <span class="comment">*/</span>
<a name="l00037"></a><a class="code" href="classFX_1_1FXToolBar.html">00037</a> <span class="keyword">class </span>FXAPI FXToolBar : <span class="keyword">public</span> <a class="code" href="classFX_1_1FXPacker.html">FXPacker</a> {
00038 FXDECLARE(FXToolBar)
00039 <span class="keyword">protected</span>:
00040 <a class="code" href="classFX_1_1FXComposite.html">FXComposite</a> *drydock; <span class="comment">// Parent when docked</span>
00041 <a class="code" href="classFX_1_1FXComposite.html">FXComposite</a> *wetdock; <span class="comment">// Parent when floating</span>
00042 <a class="code" href="classFX_1_1FXRectangle.html">FXRectangle</a> outline; <span class="comment">// Outline shown while dragging</span>
00043 <a class="code" href="classFX_1_1FXWindow.html">FXWindow</a> *dockafter; <span class="comment">// Dock after this window</span>
00044 FXuint dockside; <span class="comment">// Dock on this side</span>
00045 FXbool docking; <span class="comment">// Dock it</span>
00046 <span class="keyword">protected</span>:
00047 FXToolBar();
00048 <span class="keyword">private</span>:
00049 FXToolBar(<span class="keyword">const</span> FXToolBar&);
00050 FXToolBar &operator=(<span class="keyword">const</span> FXToolBar&);
00051 <span class="keyword">public</span>:
00052 <span class="keywordtype">long</span> onCmdUndock(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00053 <span class="keywordtype">long</span> onUpdUndock(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00054 <span class="keywordtype">long</span> onCmdDockTop(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00055 <span class="keywordtype">long</span> onUpdDockTop(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00056 <span class="keywordtype">long</span> onCmdDockBottom(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00057 <span class="keywordtype">long</span> onUpdDockBottom(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00058 <span class="keywordtype">long</span> onCmdDockLeft(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00059 <span class="keywordtype">long</span> onUpdDockLeft(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00060 <span class="keywordtype">long</span> onCmdDockRight(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00061 <span class="keywordtype">long</span> onUpdDockRight(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00062 <span class="keywordtype">long</span> onBeginDragGrip(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00063 <span class="keywordtype">long</span> onEndDragGrip(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00064 <span class="keywordtype">long</span> onDraggedGrip(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00065 <span class="keyword">public</span>:
00066 <span class="keyword">enum</span> {
00067 ID_UNDOCK=FXPacker::ID_LAST, <span class="comment">/// Undock the toolbar</span>
00068 <span class="comment"></span> ID_DOCK_TOP, <span class="comment">/// Dock on the top</span>
00069 <span class="comment"></span> ID_DOCK_BOTTOM, <span class="comment">/// Dock on the bottom</span>
00070 <span class="comment"></span> ID_DOCK_LEFT, <span class="comment">/// Dock on the left</span>
00071 <span class="comment"></span> ID_DOCK_RIGHT, <span class="comment">/// Dock on the right</span>
00072 <span class="comment"></span> ID_TOOLBARGRIP, <span class="comment">/// Notifications from toolbar grip</span>
00073 <span class="comment"></span> ID_LAST
00074 };
00075 <span class="keyword">public</span>:
00076 <span class="comment"></span>
00077 <span class="comment"> /**</span>
00078 <span class="comment"> * Construct a floatable toolbar</span>
00079 <span class="comment"> * Normally, the toolbar is docked under window p.</span>
00080 <span class="comment"> * When floated, the toolbar can be docked under window q, which is</span>
00081 <span class="comment"> * typically an FXToolBarShell window.</span>
00082 <span class="comment"> */</span>
00083 FXToolBar(<a class="code" href="classFX_1_1FXComposite.html">FXComposite</a>* p,<a class="code" href="classFX_1_1FXComposite.html">FXComposite</a>* q,FXuint opts=<a class="code" href="group__FXWindow__0.html#a0a2142">LAYOUT_TOP</a>|<a class="code" href="group__FXWindow__0.html#a0a2138">LAYOUT_LEFT</a>|<a class="code" href="group__FXWindow__0.html#a0a2152">LAYOUT_FILL_X</a>,FXint x=0,FXint y=0,FXint w=0,FXint h=0,FXint pl=3,FXint pr=3,FXint pt=2,FXint pb=2,FXint hs=DEFAULT_SPACING,FXint vs=DEFAULT_SPACING);
00084 <span class="comment"></span>
00085 <span class="comment"> /**</span>
00086 <span class="comment"> * Construct a non-floatable toolbar.</span>
00087 <span class="comment"> * The toolbar can not be undocked.</span>
00088 <span class="comment"> */</span>
00089 FXToolBar(<a class="code" href="classFX_1_1FXComposite.html">FXComposite</a>* p,FXuint opts=<a class="code" href="group__FXWindow__0.html#a0a2142">LAYOUT_TOP</a>|<a class="code" href="group__FXWindow__0.html#a0a2138">LAYOUT_LEFT</a>|<a class="code" href="group__FXWindow__0.html#a0a2152">LAYOUT_FILL_X</a>,FXint x=0,FXint y=0,FXint w=0,FXint h=0,FXint pl=2,FXint pr=3,FXint pt=3,FXint pb=2,FXint hs=DEFAULT_SPACING,FXint vs=DEFAULT_SPACING);
00090 <span class="comment"></span>
00091 <span class="comment"> /**</span>
<a name="l00092"></a><a class="code" href="classFX_1_1FXToolBar.html#a4">00092</a> <span class="comment"> * Set parent when docked.</span>
00093 <span class="comment"> * If it was docked, reparent under the new docking window.</span>
00094 <span class="comment"> */</span>
<a name="l00095"></a><a class="code" href="classFX_1_1FXToolBar.html#a5">00095</a> <span class="keywordtype">void</span> setDryDock(<a class="code" href="classFX_1_1FXComposite.html">FXComposite</a>* dry);
00096 <span class="comment"></span>
00097 <span class="comment"> /**</span>
00098 <span class="comment"> * Set parent when floating.</span>
00099 <span class="comment"> * If it was undocked, then reparent under the new floating window.</span>
00100 <span class="comment"> */</span>
00101 <span class="keywordtype">void</span> setWetDock(<a class="code" href="classFX_1_1FXComposite.html">FXComposite</a>* wet);
00102 <span class="comment"></span>
00103 <span class="comment"> /// Return parent when docked</span>
00104 <span class="comment"></span> <a class="code" href="classFX_1_1FXComposite.html">FXComposite</a>* getDryDock()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> drydock; }
00105 <span class="comment"></span>
00106 <span class="comment"> /// Return parent when floating</span>
00107 <span class="comment"></span> FXComposite* getWetDock()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> wetdock; }
00108 <span class="comment"></span>
00109 <span class="comment"> /// Return true if toolbar is docked</span>
00110 <span class="comment"></span> FXbool isDocked() <span class="keyword">const</span>;
00111 <span class="comment"></span>
00112 <span class="comment"> /**</span>
00113 <span class="comment"> * Dock the bar against the given side, after some other widget.</span>
00114 <span class="comment"> * However, if after is -1, it will be docked as the innermost bar just before</span>
00115 <span class="comment"> * the work-area, while if after is 0, if will be docked as the outermost bar.</span>
00116 <span class="comment"> */</span>
00117 <span class="keyword">virtual</span> <span class="keywordtype">void</span> dock(FXuint side=LAYOUT_SIDE_TOP,FXWindow* after=(FXWindow*)-1);
00118 <span class="comment"></span>
00119 <span class="comment"> /**</span>
00120 <span class="comment"> * Undock or float the bar.</span>
00121 <span class="comment"> * The initial position of the wet dock is a few pixels</span>
00122 <span class="comment"> * below and to the right of the original docked position.</span>
00123 <span class="comment"> */</span>
00124 <span class="keyword">virtual</span> <span class="keywordtype">void</span> undock();
00125 <span class="comment"></span>
00126 <span class="comment"> /// Return default width</span>
00127 <span class="comment"></span> <span class="keyword">virtual</span> FXint getDefaultWidth();
00128 <span class="comment"></span>
00129 <span class="comment"> /// Return default height</span>
00130 <span class="comment"></span> <span class="keyword">virtual</span> FXint getDefaultHeight();
00131 <span class="comment"></span>
00132 <span class="comment"> /// Perform layout</span>
00133 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> layout();
00134 <span class="comment"></span>
00135 <span class="comment"> /// Return width for given height</span>
00136 <span class="comment"></span> <span class="keyword">virtual</span> FXint getWidthForHeight(FXint h);
00137 <span class="comment"></span>
00138 <span class="comment"> /// Return height for given width</span>
00139 <span class="comment"></span> <span class="keyword">virtual</span> FXint getHeightForWidth(FXint w);
00140 <span class="comment"></span>
00141 <span class="comment"> /// Set docking side</span>
00142 <span class="comment"></span> <span class="keywordtype">void</span> setDockingSide(FXuint side=LAYOUT_SIDE_TOP);
00143 <span class="comment"></span>
00144 <span class="comment"> /// Return docking side</span>
00145 <span class="comment"></span> FXuint getDockingSide() <span class="keyword">const</span>;
00146 <span class="comment"></span>
00147 <span class="comment"> /// Save toolbar to a stream</span>
00148 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> save(FXStream& store) <span class="keyword">const</span>;
00149 <span class="comment"></span>
00150 <span class="comment"> /// Load toolbar from a stream</span>
00151 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> load(FXStream& store);
00152 <span class="comment"></span>
00153 <span class="comment"> /// Destroy</span>
00154 <span class="comment"></span> <span class="keyword">virtual</span> ~FXToolBar();
00155 };
00156
00157 }
00158
00159 <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>
