<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>FXListBox.h</h1><div class="fragment"><pre>00001 <span class="comment">/********************************************************************************</span>
00002 <span class="comment">* *</span>
00003 <span class="comment">* 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) 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: FXListBox.h,v 1.29 2004/02/08 17:17:33 fox Exp $ *</span>
00023 <span class="comment">********************************************************************************/</span>
00024 <span class="preprocessor">#ifndef FXLISTBOX_H</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define FXLISTBOX_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">/// List Box styles</span>
00035 <span class="comment"></span><span class="keyword">enum</span> {
00036 <a class="code" href="group__FXListBox__0.html#a0a1872">LISTBOX_NORMAL</a> = 0 <span class="comment">// Normal style</span>
00037 };
00038
00039
00040 <span class="keyword">class </span>FXButton;
00041 <span class="keyword">class </span>FXMenuButton;
00042 <span class="keyword">class </span>FXList;
00043 <span class="keyword">class </span>FXPopup;
00044
00045 <span class="comment"></span>
00046 <span class="comment">/// List Box</span>
00047 <span class="comment"></span><span class="keyword">class </span>FXAPI FXListBox : <span class="keyword">public</span> FXPacker {
00048 FXDECLARE(FXListBox)
00049 <span class="keyword">protected</span>:
00050 FXButton *field;
00051 FXMenuButton *button;
00052 FXList *list;
00053 FXPopup *pane;
00054 <span class="keyword">protected</span>:
<a name="l00055"></a><a class="code" href="classFX_1_1FXListBox.html">00055</a> FXListBox(){}
00056 <span class="keyword">private</span>:
00057 FXListBox(<span class="keyword">const</span> FXListBox&);
00058 FXListBox &operator=(<span class="keyword">const</span> FXListBox&);
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> onFieldButton(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00064 <span class="keywordtype">long</span> onListUpdate(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00065 <span class="keywordtype">long</span> onListChanged(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00066 <span class="keywordtype">long</span> onListClicked(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00067 <span class="keywordtype">long</span> onCmdSetValue(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00068 <span class="keywordtype">long</span> onCmdGetIntValue(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00069 <span class="keywordtype">long</span> onCmdSetIntValue(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00070 <span class="keyword">public</span>:
00071 <span class="keyword">enum</span> {
00072 ID_LIST=FXPacker::ID_LAST,
00073 ID_FIELD,
00074 ID_LAST
00075 };
00076 <span class="keyword">public</span>:
00077 <span class="comment"></span>
00078 <span class="comment"> /// Constructor</span>
00079 <span class="comment"></span> FXListBox(FXComposite *p,FXObject* tgt=NULL,FXSelector sel=0,FXuint opts=FRAME_SUNKEN|FRAME_THICK|LISTBOX_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);
00080 <span class="comment"></span>
00081 <span class="comment"> /// Create server-side resources</span>
00082 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> create();
00083 <span class="comment"></span>
00084 <span class="comment"> /// Detach server-side resources</span>
00085 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> detach();
00086 <span class="comment"></span>
00087 <span class="comment"> /// Destroy server-side resources</span>
00088 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> destroy();
00089 <span class="comment"></span>
00090 <span class="comment"> /// Perform layout</span>
00091 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> layout();
00092 <span class="comment"></span>
00093 <span class="comment"> /// Enable drive box</span>
00094 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> enable();
00095 <span class="comment"></span>
00096 <span class="comment"> /// Disable drive box</span>
00097 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> disable();
00098 <span class="comment"></span>
00099 <span class="comment"> /// Return default width</span>
00100 <span class="comment"></span> <span class="keyword">virtual</span> FXint getDefaultWidth();
00101 <span class="comment"></span>
00102 <span class="comment"> /// Return default height</span>
00103 <span class="comment"></span> <span class="keyword">virtual</span> FXint getDefaultHeight();
00104 <span class="comment"></span>
00105 <span class="comment"> /// Return the number of items in the list</span>
00106 <span class="comment"></span> FXint getNumItems() <span class="keyword">const</span>;
00107 <span class="comment"></span>
00108 <span class="comment"> /// Return the number of visible items</span>
00109 <span class="comment"></span> FXint getNumVisible() <span class="keyword">const</span>;
00110 <span class="comment"></span>
00111 <span class="comment"> /// Set the number of visible items</span>
00112 <span class="comment"></span> <span class="keywordtype">void</span> setNumVisible(FXint nvis);
00113 <span class="comment"></span>
00114 <span class="comment"> /// Return true if current item</span>
00115 <span class="comment"></span> FXbool isItemCurrent(FXint index) <span class="keyword">const</span>;
00116 <span class="comment"></span>
00117 <span class="comment"> /// Set the current item (index is zero-based)</span>
00118 <span class="comment"></span> <span class="keywordtype">void</span> setCurrentItem(FXint index);
00119 <span class="comment"></span>
00120 <span class="comment"> /// Get the current item's index</span>
00121 <span class="comment"></span> FXint getCurrentItem() <span class="keyword">const</span>;
00122 <span class="comment"></span>
00123 <span class="comment"> /// Return the item at the given index</span>
00124 <span class="comment"></span> FXString getItem(FXint index) <span class="keyword">const</span>;
00125 <span class="comment"></span>
00126 <span class="comment"> /// Replace the item at index</span>
00127 <span class="comment"></span> FXint setItem(FXint index,<span class="keyword">const</span> FXString& text,FXIcon* icon=NULL,<span class="keywordtype">void</span>* ptr=NULL);
00128 <span class="comment"></span>
00129 <span class="comment"> /// Insert a new item at index</span>
00130 <span class="comment"></span> FXint insertItem(FXint index,<span class="keyword">const</span> FXString& text,FXIcon* icon=NULL,<span class="keywordtype">void</span>* ptr=NULL);
00131 <span class="comment"></span>
00132 <span class="comment"> /// Add an item to the end of the list</span>
00133 <span class="comment"></span> FXint appendItem(<span class="keyword">const</span> FXString& text,FXIcon* icon=NULL,<span class="keywordtype">void</span>* ptr=NULL);
00134 <span class="comment"></span>
00135 <span class="comment"> /// Prepend an item to the list</span>
00136 <span class="comment"></span> FXint prependItem(<span class="keyword">const</span> FXString& text,FXIcon* icon=NULL,<span class="keywordtype">void</span>* ptr=NULL);
00137 <span class="comment"></span>
00138 <span class="comment"> /// Move item from oldindex to newindex</span>
00139 <span class="comment"></span> FXint moveItem(FXint newindex,FXint oldindex);
00140 <span class="comment"></span>
00141 <span class="comment"> /// Remove this item from the list</span>
00142 <span class="comment"></span> <span class="keywordtype">void</span> removeItem(FXint index);
00143 <span class="comment"></span>
00144 <span class="comment"> /// Remove all items from the list</span>
00145 <span class="comment"></span> <span class="keywordtype">void</span> clearItems();
00146 <span class="comment"></span>
00147 <span class="comment"> /**</span>
00148 <span class="comment"> * Search items for item by name, starting from start item; the</span>
00149 <span class="comment"> * flags argument controls the search direction, and case sensitivity.</span>
00150 <span class="comment"> */</span>
00151 FXint findItem(<span class="keyword">const</span> FXString& text,FXint start=-1,FXuint flags=SEARCH_FORWARD|SEARCH_WRAP) <span class="keyword">const</span>;
00152 <span class="comment"></span>
00153 <span class="comment"> /// Set text for specified item</span>
00154 <span class="comment"></span> <span class="keywordtype">void</span> setItemText(FXint index,<span class="keyword">const</span> FXString& text);
00155 <span class="comment"></span>
00156 <span class="comment"> /// Get text for specified item</span>
00157 <span class="comment"></span> FXString getItemText(FXint index) <span class="keyword">const</span>;
00158 <span class="comment"></span>
00159 <span class="comment"> /// Change item icon</span>
00160 <span class="comment"></span> <span class="keywordtype">void</span> setItemIcon(FXint index,FXIcon* icon);
00161 <span class="comment"></span>
00162 <span class="comment"> /// Return icon of item at index</span>
00163 <span class="comment"></span> FXIcon* getItemIcon(FXint index) <span class="keyword">const</span>;
00164 <span class="comment"></span>
00165 <span class="comment"> /// Set data pointer for specified item</span>
00166 <span class="comment"></span> <span class="keywordtype">void</span> setItemData(FXint index,<span class="keywordtype">void</span>* ptr) <span class="keyword">const</span>;
00167 <span class="comment"></span>
00168 <span class="comment"> /// Get data pointer for specified item</span>
00169 <span class="comment"></span> <span class="keywordtype">void</span>* getItemData(FXint index) <span class="keyword">const</span>;
00170 <span class="comment"></span>
00171 <span class="comment"> /// Is the pane shown</span>
00172 <span class="comment"></span> FXbool isPaneShown() <span class="keyword">const</span>;
00173 <span class="comment"></span>
00174 <span class="comment"> /// Sort items using current sort function</span>
00175 <span class="comment"></span> <span class="keywordtype">void</span> sortItems();
00176 <span class="comment"></span>
00177 <span class="comment"> /// Set text font</span>
00178 <span class="comment"></span> <span class="keywordtype">void</span> setFont(FXFont* fnt);
00179 <span class="comment"></span>
00180 <span class="comment"> /// Get text font</span>
00181 <span class="comment"></span> FXFont* getFont() <span class="keyword">const</span>;
00182 <span class="comment"></span>
00183 <span class="comment"> /// Set window background color</span>
00184 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> setBackColor(FXColor clr);
00185 <span class="comment"></span>
00186 <span class="comment"> /// Get background color</span>
00187 <span class="comment"></span> FXColor getBackColor() <span class="keyword">const</span>;
00188 <span class="comment"></span>
00189 <span class="comment"> /// Change text color</span>
00190 <span class="comment"></span> <span class="keywordtype">void</span> setTextColor(FXColor clr);
00191 <span class="comment"></span>
00192 <span class="comment"> /// Return text color</span>
00193 <span class="comment"></span> FXColor getTextColor() <span class="keyword">const</span>;
00194 <span class="comment"></span>
00195 <span class="comment"> /// Change selected background color</span>
00196 <span class="comment"></span> <span class="keywordtype">void</span> setSelBackColor(FXColor clr);
00197 <span class="comment"></span>
00198 <span class="comment"> /// Return selected background color</span>
00199 <span class="comment"></span> FXColor getSelBackColor() <span class="keyword">const</span>;
00200 <span class="comment"></span>
00201 <span class="comment"> /// Change selected text color</span>
00202 <span class="comment"></span> <span class="keywordtype">void</span> setSelTextColor(FXColor clr);
00203 <span class="comment"></span>
00204 <span class="comment"> /// Return selected text color</span>
00205 <span class="comment"></span> FXColor getSelTextColor() <span class="keyword">const</span>;
00206 <span class="comment"></span>
00207 <span class="comment"> /// Return sort function</span>
00208 <span class="comment"></span> FXListSortFunc getSortFunc() <span class="keyword">const</span>;
00209 <span class="comment"></span>
00210 <span class="comment"> /// Change sort function</span>
00211 <span class="comment"></span> <span class="keywordtype">void</span> setSortFunc(FXListSortFunc func);
00212 <span class="comment"></span>
00213 <span class="comment"> /// Set the combobox help text</span>
00214 <span class="comment"></span> <span class="keywordtype">void</span> setHelpText(<span class="keyword">const</span> FXString& txt);
00215 <span class="comment"></span>
00216 <span class="comment"> /// Get the combobox help text</span>
00217 <span class="comment"></span> FXString getHelpText() <span class="keyword">const</span>;
00218 <span class="comment"></span>
00219 <span class="comment"> /// Set the tool tip message for this combobox</span>
00220 <span class="comment"></span> <span class="keywordtype">void</span> setTipText(<span class="keyword">const</span> FXString& txt);
00221 <span class="comment"></span>
00222 <span class="comment"> /// Get the tool tip message for this combobox</span>
00223 <span class="comment"></span> FXString getTipText() <span class="keyword">const</span>;
00224 <span class="comment"></span>
00225 <span class="comment"> /// Save combobox to a stream</span>
00226 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> save(FXStream& store) <span class="keyword">const</span>;
00227 <span class="comment"></span>
00228 <span class="comment"> /// Load combobox from a stream</span>
00229 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> load(FXStream& store);
00230 <span class="comment"></span>
00231 <span class="comment"> /// Destructor</span>
00232 <span class="comment"></span> <span class="keyword">virtual</span> ~FXListBox();
00233 };
00234
00235 }
00236
00237 <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>
