<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>FXTreeListBox.h</h1><div class="fragment"><pre>00001 <span class="comment">/********************************************************************************</span>
00002 <span class="comment">* *</span>
00003 <span class="comment">* T r e e L i s t B o x W i d g e t *</span>
00004 <span class="comment">* *</span>
00005 <span class="comment">*********************************************************************************</span>
00006 <span class="comment">* Copyright (C) 1999,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: FXTreeListBox.h,v 1.27 2004/02/08 17:17:34 fox Exp $ *</span>
00023 <span class="comment">********************************************************************************/</span>
00024 <span class="preprocessor">#ifndef FXTREELISTBOX_H</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define FXTREELISTBOX_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">/// Tree List Box styles</span>
00035 <span class="comment"></span><span class="keyword">enum</span> {
00036 <a class="code" href="group__FXTreeListBox__0.html#a0a2115">TREELISTBOX_NORMAL</a> = 0 <span class="comment">/// Normal style</span>
00037 <span class="comment"></span> };
00038
00039
00040 <span class="keyword">class </span>FXButton;
00041 <span class="keyword">class </span>FXMenuButton;
00042 <span class="keyword">class </span>FXTreeList;
00043 <span class="keyword">class </span>FXPopup;
00044
00045 <span class="comment"></span>
00046 <span class="comment">/// Tree List Box</span>
00047 <span class="comment"></span><span class="keyword">class </span>FXAPI FXTreeListBox : <span class="keyword">public</span> FXPacker {
00048 FXDECLARE(FXTreeListBox)
00049 <span class="keyword">protected</span>:
00050 FXButton *field;
00051 FXMenuButton *button;
00052 FXTreeList *tree;
00053 FXPopup *pane;
00054 <span class="keyword">protected</span>:
<a name="l00055"></a><a class="code" href="classFX_1_1FXTreeListBox.html">00055</a> FXTreeListBox(){}
00056 <span class="keyword">private</span>:
00057 FXTreeListBox(<span class="keyword">const</span> FXTreeListBox&);
00058 FXTreeListBox& operator=(<span class="keyword">const</span> FXTreeListBox&);
00059 <span class="keyword">public</span>:
00060 <span class="keywordtype">long</span> onFocusUp(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00061 <span class="keywordtype">long</span> onFocusDown(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00062 <span class="keywordtype">long</span> onFocusSelf(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00063 <span class="keywordtype">long</span> onChanged(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00064 <span class="keywordtype">long</span> onCommand(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00065 <span class="keywordtype">long</span> onFieldButton(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00066 <span class="keywordtype">long</span> onTreeChanged(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00067 <span class="keywordtype">long</span> onTreeClicked(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00068 <span class="keywordtype">long</span> onUpdFmTree(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00069 <span class="keyword">public</span>:
00070 <span class="keyword">enum</span>{
00071 ID_TREE=FXPacker::ID_LAST,
00072 ID_FIELD,
00073 ID_LAST
00074 };
00075 <span class="keyword">public</span>:
00076 <span class="comment"></span>
00077 <span class="comment"> /// Construct tree list box</span>
00078 <span class="comment"></span> FXTreeListBox(FXComposite *p,FXObject* tgt=NULL,FXSelector sel=0,FXuint opts=FRAME_SUNKEN|FRAME_THICK|TREELISTBOX_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);
00079 <span class="comment"></span>
00080 <span class="comment"> /// Create server-side resources</span>
00081 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> create();
00082 <span class="comment"></span>
00083 <span class="comment"> /// Detach server-side resources</span>
00084 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> detach();
00085 <span class="comment"></span>
00086 <span class="comment"> /// Destroy server-side resources</span>
00087 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> destroy();
00088 <span class="comment"></span>
00089 <span class="comment"> /// Perform layout</span>
00090 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> layout();
00091 <span class="comment"></span>
00092 <span class="comment"> /// Enable widget</span>
00093 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> enable();
00094 <span class="comment"></span>
00095 <span class="comment"> /// Disable widget</span>
00096 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> disable();
00097 <span class="comment"></span>
00098 <span class="comment"> /// Return default with</span>
00099 <span class="comment"></span> <span class="keyword">virtual</span> FXint getDefaultWidth();
00100 <span class="comment"></span>
00101 <span class="comment"> /// Return default height</span>
00102 <span class="comment"></span> <span class="keyword">virtual</span> FXint getDefaultHeight();
00103 <span class="comment"></span>
00104 <span class="comment"> /// Return number of items</span>
00105 <span class="comment"></span> FXint getNumItems() <span class="keyword">const</span>;
00106 <span class="comment"></span>
00107 <span class="comment"> /// Return number of visible items</span>
00108 <span class="comment"></span> FXint getNumVisible() <span class="keyword">const</span>;
00109 <span class="comment"></span>
00110 <span class="comment"> /// Set number of visible items to determine default height</span>
00111 <span class="comment"></span> <span class="keywordtype">void</span> setNumVisible(FXint nvis);
00112 <span class="comment"></span>
00113 <span class="comment"> /// Return first top-level item</span>
00114 <span class="comment"></span> FXTreeItem* getFirstItem() <span class="keyword">const</span>;
00115 <span class="comment"></span>
00116 <span class="comment"> /// Return last top-level item</span>
00117 <span class="comment"></span> FXTreeItem* getLastItem() <span class="keyword">const</span>;
00118 <span class="comment"></span>
00119 <span class="comment"> /// Add item as first child of parent p</span>
00120 <span class="comment"></span> FXTreeItem* addItemFirst(FXTreeItem* p,FXTreeItem* item);
00121 <span class="comment"></span>
00122 <span class="comment"> /// Add item as last child after parent p</span>
00123 <span class="comment"></span> FXTreeItem* addItemLast(FXTreeItem* p,FXTreeItem* item);
00124 <span class="comment"></span>
00125 <span class="comment"> /// Add item after other item</span>
00126 <span class="comment"></span> FXTreeItem* addItemAfter(FXTreeItem* other,FXTreeItem* item);
00127 <span class="comment"></span>
00128 <span class="comment"> /// Add item before other item</span>
00129 <span class="comment"></span> FXTreeItem* addItemBefore(FXTreeItem* other,FXTreeItem* item);
00130 <span class="comment"></span>
00131 <span class="comment"> /// Add item as first child of parent p</span>
00132 <span class="comment"></span> FXTreeItem* addItemFirst(FXTreeItem* p,<span class="keyword">const</span> FXString& text,FXIcon* oi=NULL,FXIcon* ci=NULL,<span class="keywordtype">void</span>* ptr=NULL);
00133 <span class="comment"></span>
00134 <span class="comment"> /// Add item as last child of parent p</span>
00135 <span class="comment"></span> FXTreeItem* addItemLast(FXTreeItem* p,<span class="keyword">const</span> FXString& text,FXIcon* oi=NULL,FXIcon* ci=NULL,<span class="keywordtype">void</span>* ptr=NULL);
00136 <span class="comment"></span>
00137 <span class="comment"> /// Add item after other item</span>
00138 <span class="comment"></span> FXTreeItem* addItemAfter(FXTreeItem* other,<span class="keyword">const</span> FXString& text,FXIcon* oi=NULL,FXIcon* ci=NULL,<span class="keywordtype">void</span>* ptr=NULL);
00139 <span class="comment"></span>
00140 <span class="comment"> /// Add item before other item</span>
00141 <span class="comment"></span> FXTreeItem* addItemBefore(FXTreeItem* other,<span class="keyword">const</span> FXString& text,FXIcon* oi=NULL,FXIcon* ci=NULL,<span class="keywordtype">void</span>* ptr=NULL);
00142 <span class="comment"></span>
00143 <span class="comment"> /// Remove item</span>
00144 <span class="comment"></span> <span class="keywordtype">void</span> removeItem(FXTreeItem* item);
00145 <span class="comment"></span>
00146 <span class="comment"> /// Remove all items in range [fm...to]</span>
00147 <span class="comment"></span> <span class="keywordtype">void</span> removeItems(FXTreeItem* fm,FXTreeItem* to);
00148 <span class="comment"></span>
00149 <span class="comment"> /// Remove all items from list</span>
00150 <span class="comment"></span> <span class="keywordtype">void</span> clearItems();
00151 <span class="comment"></span>
00152 <span class="comment"> /**</span>
00153 <span class="comment"> * Search items for item by name, starting from start item; the</span>
00154 <span class="comment"> * flags argument controls the search direction, and case sensitivity.</span>
00155 <span class="comment"> */</span>
00156 FXTreeItem* findItem(<span class="keyword">const</span> FXString& text,FXTreeItem* start=NULL,FXuint flags=SEARCH_FORWARD|SEARCH_WRAP) <span class="keyword">const</span>;
00157 <span class="comment"></span>
00158 <span class="comment"> /// Return TRUE if item is the current item</span>
00159 <span class="comment"></span> FXbool isItemCurrent(<span class="keyword">const</span> FXTreeItem* item) <span class="keyword">const</span>;
00160 <span class="comment"></span>
00161 <span class="comment"> /// Return TRUE if item is leaf-item, i.e. has no children</span>
00162 <span class="comment"></span> FXbool isItemLeaf(<span class="keyword">const</span> FXTreeItem* item) <span class="keyword">const</span>;
00163 <span class="comment"></span>
00164 <span class="comment"> /// Sort the toplevel items with the sort function</span>
00165 <span class="comment"></span> <span class="keywordtype">void</span> sortRootItems();
00166 <span class="comment"></span>
00167 <span class="comment"> /// Sort all items recursively</span>
00168 <span class="comment"></span> <span class="keywordtype">void</span> sortItems();
00169 <span class="comment"></span>
00170 <span class="comment"> /// Sort child items of item</span>
00171 <span class="comment"></span> <span class="keywordtype">void</span> sortChildItems(FXTreeItem* item);
00172 <span class="comment"></span>
00173 <span class="comment"> /// Change current item</span>
00174 <span class="comment"></span> <span class="keywordtype">void</span> setCurrentItem(FXTreeItem* item,FXbool notify=FALSE);
00175 <span class="comment"></span>
00176 <span class="comment"> /// Return current item</span>
00177 <span class="comment"></span> FXTreeItem* getCurrentItem() <span class="keyword">const</span>;
00178 <span class="comment"></span>
00179 <span class="comment"> /// Change item label</span>
00180 <span class="comment"></span> <span class="keywordtype">void</span> setItemText(FXTreeItem* item,<span class="keyword">const</span> FXString& text);
00181 <span class="comment"></span>
00182 <span class="comment"> /// Return item label</span>
00183 <span class="comment"></span> FXString getItemText(<span class="keyword">const</span> FXTreeItem* item) <span class="keyword">const</span>;
00184 <span class="comment"></span>
00185 <span class="comment"> /// Change item's open icon</span>
00186 <span class="comment"></span> <span class="keywordtype">void</span> setItemOpenIcon(FXTreeItem* item,FXIcon* icon);
00187 <span class="comment"></span>
00188 <span class="comment"> /// Return item's open icon</span>
00189 <span class="comment"></span> FXIcon* getItemOpenIcon(<span class="keyword">const</span> FXTreeItem* item) <span class="keyword">const</span>;
00190 <span class="comment"></span>
00191 <span class="comment"> /// Change item's closed icon</span>
00192 <span class="comment"></span> <span class="keywordtype">void</span> setItemClosedIcon(FXTreeItem* item,FXIcon* icon);
00193 <span class="comment"></span>
00194 <span class="comment"> /// Return item's closed icon</span>
00195 <span class="comment"></span> FXIcon* getItemClosedIcon(<span class="keyword">const</span> FXTreeItem* item) <span class="keyword">const</span>;
00196 <span class="comment"></span>
00197 <span class="comment"> /// Change item's user data</span>
00198 <span class="comment"></span> <span class="keywordtype">void</span> setItemData(FXTreeItem* item,<span class="keywordtype">void</span>* ptr) <span class="keyword">const</span>;
00199 <span class="comment"></span>
00200 <span class="comment"> /// Return item's user data</span>
00201 <span class="comment"></span> <span class="keywordtype">void</span>* getItemData(<span class="keyword">const</span> FXTreeItem* item) <span class="keyword">const</span>;
00202 <span class="comment"></span>
00203 <span class="comment"> /// Return item sort function</span>
00204 <span class="comment"></span> FXTreeListSortFunc getSortFunc() <span class="keyword">const</span>;
00205 <span class="comment"></span>
00206 <span class="comment"> /// Change item sort function</span>
00207 <span class="comment"></span> <span class="keywordtype">void</span> setSortFunc(FXTreeListSortFunc func);
00208 <span class="comment"></span>
00209 <span class="comment"> /// Is the pane shown</span>
00210 <span class="comment"></span> FXbool isPaneShown() <span class="keyword">const</span>;
00211 <span class="comment"></span>
00212 <span class="comment"> /// Change font</span>
00213 <span class="comment"></span> <span class="keywordtype">void</span> setFont(FXFont* fnt);
00214 <span class="comment"></span>
00215 <span class="comment"> /// Return font</span>
00216 <span class="comment"></span> FXFont* getFont() <span class="keyword">const</span>;
00217 <span class="comment"></span>
00218 <span class="comment"> /// Return list style</span>
00219 <span class="comment"></span> FXuint getListStyle() <span class="keyword">const</span>;
00220 <span class="comment"></span>
00221 <span class="comment"> /// Change list style</span>
00222 <span class="comment"></span> <span class="keywordtype">void</span> setListStyle(FXuint style);
00223 <span class="comment"></span>
00224 <span class="comment"> /// Change help text</span>
00225 <span class="comment"></span> <span class="keywordtype">void</span> setHelpText(<span class="keyword">const</span> FXString& txt);
00226 <span class="comment"></span>
00227 <span class="comment"> /// Return help text</span>
00228 <span class="comment"></span> FXString getHelpText() <span class="keyword">const</span>;
00229 <span class="comment"></span>
00230 <span class="comment"> /// Change tip text</span>
00231 <span class="comment"></span> <span class="keywordtype">void</span> setTipText(<span class="keyword">const</span> FXString& txt);
00232 <span class="comment"></span>
00233 <span class="comment"> /// Return tip text</span>
00234 <span class="comment"></span> FXString getTipText() <span class="keyword">const</span>;
00235 <span class="comment"></span>
00236 <span class="comment"> /// Save object to a stream</span>
00237 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> save(FXStream& store) <span class="keyword">const</span>;
00238 <span class="comment"></span>
00239 <span class="comment"> /// Load object from a stream</span>
00240 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> load(FXStream& store);
00241 <span class="comment"></span>
00242 <span class="comment"> /// Destructor</span>
00243 <span class="comment"></span> <span class="keyword">virtual</span> ~FXTreeListBox();
00244 };
00245
00246 }
00247
00248 <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>
