<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>FXMDIClient.h</h1><div class="fragment"><pre>00001 <span class="comment">/********************************************************************************</span>
00002 <span class="comment">* *</span>
00003 <span class="comment">* M u l t i p l e D o c u m e n t C l i e n t W i n d o w *</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: FXMDIClient.h,v 1.29 2004/02/08 17:17:33 fox Exp $ *</span>
00023 <span class="comment">********************************************************************************/</span>
00024 <span class="preprocessor">#ifndef FXMDICLIENT_H</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define FXMDICLIENT_H</span>
00026 <span class="preprocessor"></span>
00027 <span class="preprocessor">#ifndef FXCOMPOSITE_H</span>
00028 <span class="preprocessor"></span><span class="preprocessor">#include "FXComposite.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="keyword">class </span>FXMDIChild;
00035
00036 <span class="comment"></span>
00037 <span class="comment">/**</span>
00038 <span class="comment">* The MDI client window manages a number of MDI child windows in</span>
00039 <span class="comment">* a multiple-document interface (MDI) application.</span>
00040 <span class="comment">* MDI child windows usually receive messages from the GUI through</span>
00041 <span class="comment">* delegation via the MDI client, i.e. the MDI client window is set as</span>
00042 <span class="comment">* the target for most GUI commands; the MDI client filters out a few messages</span>
00043 <span class="comment">* and forwards all other messages to the active MDI child.</span>
00044 <span class="comment">* MDI client can arrange the MDI child windows in various ways:-</span>
00045 <span class="comment">* it may maximize one of the MDI child windows, arrange them side-by-side,</span>
00046 <span class="comment">* cascade them, or iconify them.</span>
00047 <span class="comment">* MDI child windows are notified about changes in the active MDI child</span>
00048 <span class="comment">* window by the MDI client.</span>
00049 <span class="comment">*/</span>
<a name="l00050"></a><a class="code" href="classFX_1_1FXMDIClient.html">00050</a> <span class="keyword">class </span>FXAPI FXMDIClient : <span class="keyword">public</span> <a class="code" href="classFX_1_1FXComposite.html">FXComposite</a> {
00051 FXDECLARE(FXMDIClient)
00052 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classFX_1_1FXMDIChild.html">FXMDIChild</a>;
00053 <span class="keyword">protected</span>:
00054 <a class="code" href="classFX_1_1FXMDIChild.html">FXMDIChild</a> *active; <span class="comment">// Active child</span>
00055 FXint cascadex; <span class="comment">// Cascade offset X</span>
00056 FXint cascadey; <span class="comment">// Cascade offset Y</span>
00057 <span class="keyword">protected</span>:
00058 FXMDIClient();
00059 <span class="keyword">private</span>:
00060 FXMDIClient(<span class="keyword">const</span> FXMDIClient&);
00061 FXMDIClient &operator=(<span class="keyword">const</span> FXMDIClient&);
00062 <span class="keyword">public</span>:
00063 <span class="keywordtype">long</span> onCmdActivateNext(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00064 <span class="keywordtype">long</span> onCmdActivatePrev(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00065 <span class="keywordtype">long</span> onCmdTileHorizontal(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00066 <span class="keywordtype">long</span> onCmdTileVertical(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00067 <span class="keywordtype">long</span> onCmdCascade(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00068 <span class="keywordtype">long</span> onUpdActivateNext(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00069 <span class="keywordtype">long</span> onUpdActivatePrev(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00070 <span class="keywordtype">long</span> onUpdTileVertical(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00071 <span class="keywordtype">long</span> onUpdTileHorizontal(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00072 <span class="keywordtype">long</span> onUpdCascade(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00073 <span class="keywordtype">long</span> onUpdClose(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00074 <span class="keywordtype">long</span> onUpdMenuClose(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00075 <span class="keywordtype">long</span> onUpdRestore(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00076 <span class="keywordtype">long</span> onUpdMenuRestore(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00077 <span class="keywordtype">long</span> onUpdMinimize(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00078 <span class="keywordtype">long</span> onUpdMenuMinimize(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00079 <span class="keywordtype">long</span> onUpdMaximize(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00080 <span class="keywordtype">long</span> onUpdMenuWindow(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00081 <span class="keywordtype">long</span> onCmdWindowSelect(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00082 <span class="keywordtype">long</span> onUpdWindowSelect(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00083 <span class="keywordtype">long</span> onCmdOthersWindows(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00084 <span class="keywordtype">long</span> onUpdOthersWindows(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00085 <span class="keywordtype">long</span> onUpdAnyWindows(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00086 <span class="keyword">virtual</span> <span class="keywordtype">long</span> onDefault(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00087 <span class="keyword">public</span>:
00088 <span class="keyword">enum</span> {
00089 ID_MDI_ANY=65400,
00090 ID_MDI_1, <span class="comment">// Select MDI child 1</span>
00091 ID_MDI_2,
00092 ID_MDI_3,
00093 ID_MDI_4,
00094 ID_MDI_5,
00095 ID_MDI_6,
00096 ID_MDI_7,
00097 ID_MDI_8,
00098 ID_MDI_9,
00099 ID_MDI_10,
00100 ID_MDI_OVER_1, <span class="comment">// Sensitize MDI menu when 1 or more children</span>
00101 ID_MDI_OVER_2,
00102 ID_MDI_OVER_3,
00103 ID_MDI_OVER_4,
00104 ID_MDI_OVER_5,
00105 ID_MDI_OVER_6,
00106 ID_MDI_OVER_7,
00107 ID_MDI_OVER_8,
00108 ID_MDI_OVER_9,
00109 ID_MDI_OVER_10,
00110 ID_LAST
00111 };
00112 <span class="keyword">public</span>:
00113 <span class="comment"></span>
00114 <span class="comment"> /// Construct MDI Client window</span>
00115 <span class="comment"></span> FXMDIClient(<a class="code" href="classFX_1_1FXComposite.html">FXComposite</a>* p,FXuint opts=0,FXint x=0,FXint y=0,FXint w=0,FXint h=0);
00116 <span class="comment"></span>
00117 <span class="comment"> /// Return default width</span>
00118 <span class="comment"></span> <span class="keyword">virtual</span> FXint getDefaultWidth();
00119 <span class="comment"></span>
00120 <span class="comment"> /// Return default height</span>
00121 <span class="comment"></span> <span class="keyword">virtual</span> FXint getDefaultHeight();
00122 <span class="comment"></span>
00123 <span class="comment"> /// Perform layout</span>
00124 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> layout();
00125 <span class="comment"></span>
00126 <span class="comment"> /**</span>
00127 <span class="comment"> * Pass message to all MDI windows, stopping when one of</span>
00128 <span class="comment"> * the MDI windows fails to handle the message.</span>
00129 <span class="comment"> */</span>
00130 <span class="keywordtype">long</span> forallWindows(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>* sender,FXSelector sel,<span class="keywordtype">void</span>* ptr);
00131 <span class="comment"></span>
00132 <span class="comment"> /**</span>
00133 <span class="comment"> * Pass message once to all MDI windows with the same document,</span>
00134 <span class="comment"> * stopping when one of the MDI windows fails to handle the message.</span>
00135 <span class="comment"> */</span>
00136 <span class="keywordtype">long</span> forallDocuments(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>* sender,FXSelector sel,<span class="keywordtype">void</span>* ptr);
00137 <span class="comment"></span>
00138 <span class="comment"> /**</span>
<a name="l00139"></a><a class="code" href="classFX_1_1FXMDIClient.html#a9">00139</a> <span class="comment"> * Pass message to all MDI Child windows whose target is document,</span>
00140 <span class="comment"> * stopping when one of the MDI windows fails to handle the message.</span>
00141 <span class="comment"> */</span>
00142 <span class="keywordtype">long</span> forallDocWindows(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>* document,<a class="code" href="classFX_1_1FXObject.html">FXObject</a>* sender,FXSelector sel,<span class="keywordtype">void</span>* ptr);
00143 <span class="comment"></span>
00144 <span class="comment"> /// Set active MDI Child</span>
00145 <span class="comment"></span> <span class="keyword">virtual</span> FXbool setActiveChild(<a class="code" href="classFX_1_1FXMDIChild.html">FXMDIChild</a>* child=NULL,FXbool notify=TRUE);
00146 <span class="comment"></span>
00147 <span class="comment"> /// Get current active child; may be NULL!</span>
00148 <span class="comment"></span> <a class="code" href="classFX_1_1FXMDIChild.html">FXMDIChild</a>* getActiveChild()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> active; }
00149
00150 <span class="comment">// Cascade windows</span>
<a name="l00151"></a><a class="code" href="classFX_1_1FXMDIClient.html#a13">00151</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> cascade(FXbool notify=FALSE);
00152
00153 <span class="comment">// Layout horizontally</span>
<a name="l00154"></a><a class="code" href="classFX_1_1FXMDIClient.html#a14">00154</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> horizontal(FXbool notify=FALSE);
00155
00156 <span class="comment">// Layout vertically</span>
<a name="l00157"></a><a class="code" href="classFX_1_1FXMDIClient.html#a15">00157</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> vertical(FXbool notify=FALSE);
00158 <span class="comment"></span>
00159 <span class="comment"> /// Change cascade offset X</span>
<a name="l00160"></a><a class="code" href="classFX_1_1FXMDIClient.html#a16">00160</a> <span class="comment"></span> <span class="keywordtype">void</span> setCascadeX(FXint off){ cascadex=off; }
00161 <span class="comment"></span>
00162 <span class="comment"> /// Change cascade offset Y</span>
00163 <span class="comment"></span> <span class="keywordtype">void</span> setCascadeY(FXint off){ cascadey=off; }
00164 <span class="comment"></span>
00165 <span class="comment"> /// Get cascade offset X</span>
00166 <span class="comment"></span> FXint getCascadeX()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> cascadex; }
00167 <span class="comment"></span>
00168 <span class="comment"> /// Get cascade offset Y</span>
00169 <span class="comment"></span> FXint getCascadeY()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> cascadey; }
00170 <span class="comment"></span>
00171 <span class="comment"> /// Save object to a stream</span>
00172 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> save(FXStream& store) <span class="keyword">const</span>;
00173 <span class="comment"></span>
00174 <span class="comment"> /// Load object from a stream</span>
00175 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> load(FXStream& store);
00176 <span class="comment"></span>
00177 <span class="comment"> /// Destructor</span>
00178 <span class="comment"></span> <span class="keyword">virtual</span> ~FXMDIClient();
00179 };
00180
00181 }
00182
00183 <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>
