<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>FXList.h</h1><div class="fragment"><pre>00001 <span class="comment">/********************************************************************************</span>
00002 <span class="comment">* *</span>
00003 <span class="comment">* L i s t 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: FXList.h,v 1.67 2004/02/08 17:17:33 fox Exp $ *</span>
00023 <span class="comment">********************************************************************************/</span>
00024 <span class="preprocessor">#ifndef FXLIST_H</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define FXLIST_H</span>
00026 <span class="preprocessor"></span>
00027 <span class="preprocessor">#ifndef FXSCROLLAREA_H</span>
00028 <span class="preprocessor"></span><span class="preprocessor">#include "FXScrollArea.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 styles</span>
00035 <span class="comment"></span><span class="keyword">enum</span> {
00036 <a class="code" href="group__FXList__0.html#a0a1866">LIST_EXTENDEDSELECT</a> = 0, <span class="comment">/// Extended selection mode allows for drag-selection of ranges of items</span>
00037 <span class="comment"></span> <a class="code" href="group__FXList__0.html#a0a1867">LIST_SINGLESELECT</a> = 0x00100000, <span class="comment">/// Single selection mode allows up to one item to be selected</span>
00038 <span class="comment"></span> <a class="code" href="group__FXList__0.html#a0a1868">LIST_BROWSESELECT</a> = 0x00200000, <span class="comment">/// Browse selection mode enforces one single item to be selected at all times</span>
00039 <span class="comment"></span> <a class="code" href="group__FXList__0.html#a0a1869">LIST_MULTIPLESELECT</a> = 0x00300000, <span class="comment">/// Multiple selection mode is used for selection of individual items</span>
00040 <span class="comment"></span> <a class="code" href="group__FXList__0.html#a0a1870">LIST_AUTOSELECT</a> = 0x00400000, <span class="comment">/// Automatically select under cursor</span>
00041 <span class="comment"></span> LIST_NORMAL = <a class="code" href="group__FXList__0.html#a0a1866">LIST_EXTENDEDSELECT</a>
00042 };
00043
00044
00045 <span class="keyword">class </span>FXIcon;
00046 <span class="keyword">class </span>FXFont;
00047 <span class="keyword">class </span>FXList;
00048
00049 <span class="comment"></span>
00050 <span class="comment">/// List item</span>
00051 <span class="comment"></span><span class="keyword">class </span>FXAPI FXListItem : <span class="keyword">public</span> FXObject {
00052 FXDECLARE(FXListItem)
00053 <span class="keyword">friend</span> <span class="keyword">class </span>FXList;
00054 <span class="keyword">protected</span>:
00055 FXString label;
00056 FXIcon *icon;
00057 <span class="keywordtype">void</span> *data;
00058 FXuint state;
<a name="l00059"></a><a class="code" href="classFX_1_1FXListItem.html">00059</a> FXint x,y;
00060 <span class="keyword">protected</span>:
00061 FXListItem():icon(NULL),data(NULL),state(0),x(0),y(0){}
00062 <span class="keyword">virtual</span> <span class="keywordtype">void</span> draw(<span class="keyword">const</span> FXList* list,FXDC& dc,FXint x,FXint y,FXint w,FXint h);
00063 <span class="keyword">virtual</span> FXint hitItem(<span class="keyword">const</span> FXList* list,FXint x,FXint y) <span class="keyword">const</span>;
00064 <span class="keyword">protected</span>:
00065 <span class="keyword">enum</span> {
00066 SELECTED = 1,
00067 FOCUS = 2,
00068 DISABLED = 4,
00069 DRAGGABLE = 8,
00070 ICONOWNED = 16
00071 };
00072 <span class="keyword">public</span>:
00073 FXListItem(<span class="keyword">const</span> FXString& text,FXIcon* ic=NULL,<span class="keywordtype">void</span>* ptr=NULL):label(text),icon(ic),data(ptr),state(0),x(0),y(0){}
00074 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setText(<span class="keyword">const</span> FXString& txt){ label=txt; }
00075 <span class="keyword">const</span> FXString& getText()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> label; }
00076 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setIcon(FXIcon* icn){ icon=icn; }
00077 FXIcon* getIcon()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> icon; }
00078 <span class="keywordtype">void</span> setData(<span class="keywordtype">void</span>* ptr){ data=ptr; }
00079 <span class="keywordtype">void</span>* getData()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> data; }
00080 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setFocus(FXbool focus);
00081 FXbool hasFocus()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (state&FOCUS)!=0; }
00082 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setSelected(FXbool selected);
00083 FXbool isSelected()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (state&SELECTED)!=0; }
00084 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setEnabled(FXbool enabled);
00085 FXbool isEnabled()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (state&DISABLED)==0; }
00086 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setDraggable(FXbool draggable);
00087 FXbool isDraggable()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (state&DRAGGABLE)!=0; }
00088 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setIconOwned(FXuint owned=ICONOWNED);
00089 FXuint isIconOwned()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (state&ICONOWNED); }
00090 <span class="keyword">virtual</span> FXint getWidth(<span class="keyword">const</span> FXList* list) <span class="keyword">const</span>;
00091 <span class="keyword">virtual</span> FXint getHeight(<span class="keyword">const</span> FXList* list) <span class="keyword">const</span>;
00092 <span class="keyword">virtual</span> <span class="keywordtype">void</span> create();
00093 <span class="keyword">virtual</span> <span class="keywordtype">void</span> detach();
00094 <span class="keyword">virtual</span> <span class="keywordtype">void</span> destroy();
00095 <span class="keyword">virtual</span> <span class="keywordtype">void</span> save(FXStream& store) <span class="keyword">const</span>;
00096 <span class="keyword">virtual</span> <span class="keywordtype">void</span> load(FXStream& store);
00097 <span class="keyword">virtual</span> ~FXListItem();
00098 };
00099
<a name="l00100"></a><a class="code" href="classFX_1_1FXList.html">00100</a> <span class="comment"></span>
00101 <span class="comment">/// List item collate function</span>
00102 <span class="comment"></span><span class="keyword">typedef</span> FXint (*FXListSortFunc)(<span class="keyword">const</span> FXListItem*,<span class="keyword">const</span> FXListItem*);
00103
00104 <span class="comment"></span>
00105 <span class="comment">/// List Widget</span>
00106 <span class="comment"></span><span class="keyword">class </span>FXAPI FXList : <span class="keyword">public</span> <a class="code" href="classFX_1_1FXScrollArea.html">FXScrollArea</a> {
00107 FXDECLARE(FXList)
00108 <span class="keyword">protected</span>:
00109 FXListItem **items; <span class="comment">// Item list</span>
00110 FXint nitems; <span class="comment">// Number of items</span>
00111 FXint anchor; <span class="comment">// Anchor item</span>
00112 FXint current; <span class="comment">// Current item</span>
00113 FXint extent; <span class="comment">// Extent item</span>
00114 FXint cursor; <span class="comment">// Cursor item</span>
00115 <a class="code" href="classFX_1_1FXFont.html">FXFont</a> *font; <span class="comment">// Font</span>
00116 FXColor textColor; <span class="comment">// Text color</span>
00117 FXColor selbackColor; <span class="comment">// Selected back color</span>
00118 FXColor seltextColor; <span class="comment">// Selected text color</span>
00119 FXint listWidth; <span class="comment">// List width</span>
00120 FXint listHeight; <span class="comment">// List height</span>
00121 FXint visible; <span class="comment">// Number of rows high</span>
00122 <a class="code" href="classFX_1_1FXString.html">FXString</a> help; <span class="comment">// Help text</span>
00123 FXListSortFunc sortfunc; <span class="comment">// Item sort function</span>
00124 FXint grabx; <span class="comment">// Grab point x</span>
00125 FXint graby; <span class="comment">// Grab point y</span>
00126 <a class="code" href="classFX_1_1FXString.html">FXString</a> lookup; <span class="comment">// Lookup string</span>
00127 FXbool state; <span class="comment">// State of item</span>
00128 <span class="keyword">protected</span>:
00129 FXList();
00130 <span class="keywordtype">void</span> recompute();
00131 <span class="keyword">virtual</span> FXListItem *createItem(<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>* icon,<span class="keywordtype">void</span>* ptr);
00132 <span class="keyword">private</span>:
00133 FXList(<span class="keyword">const</span> FXList&);
00134 FXList &operator=(<span class="keyword">const</span> FXList&);
00135 <span class="keyword">public</span>:
00136 <span class="keywordtype">long</span> onPaint(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00137 <span class="keywordtype">long</span> onEnter(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00138 <span class="keywordtype">long</span> onLeave(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00139 <span class="keywordtype">long</span> onUngrabbed(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00140 <span class="keywordtype">long</span> onKeyPress(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00141 <span class="keywordtype">long</span> onKeyRelease(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00142 <span class="keywordtype">long</span> onLeftBtnPress(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00143 <span class="keywordtype">long</span> onLeftBtnRelease(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00144 <span class="keywordtype">long</span> onRightBtnPress(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00145 <span class="keywordtype">long</span> onRightBtnRelease(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00146 <span class="keywordtype">long</span> onMotion(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00147 <span class="keywordtype">long</span> onFocusIn(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00148 <span class="keywordtype">long</span> onFocusOut(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00149 <span class="keywordtype">long</span> onAutoScroll(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00150 <span class="keywordtype">long</span> onClicked(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00151 <span class="keywordtype">long</span> onDoubleClicked(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00152 <span class="keywordtype">long</span> onTripleClicked(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00153 <span class="keywordtype">long</span> onCommand(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00154 <span class="keywordtype">long</span> onQueryTip(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00155 <span class="keywordtype">long</span> onQueryHelp(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00156 <span class="keywordtype">long</span> onTipTimer(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00157 <span class="keywordtype">long</span> onLookupTimer(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00158 <span class="keywordtype">long</span> onCmdSetValue(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);<span class="keyword">public</span>:
00159 <span class="keywordtype">long</span> onCmdGetIntValue(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00160 <span class="keywordtype">long</span> onCmdSetIntValue(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00161 <span class="keyword">public</span>:
00162 <span class="keyword">static</span> FXint ascending(<span class="keyword">const</span> FXListItem* a,<span class="keyword">const</span> FXListItem* b);
00163 <span class="keyword">static</span> FXint descending(<span class="keyword">const</span> FXListItem* a,<span class="keyword">const</span> FXListItem* b);
00164 <span class="keyword">static</span> FXint ascendingCase(<span class="keyword">const</span> FXListItem* a,<span class="keyword">const</span> FXListItem* b);
00165 <span class="keyword">static</span> FXint descendingCase(<span class="keyword">const</span> FXListItem* a,<span class="keyword">const</span> FXListItem* b);
00166 <span class="keyword">public</span>:
00167 <span class="keyword">enum</span> {
00168 ID_LOOKUPTIMER=FXScrollArea::ID_LAST,
00169 ID_LAST
00170 };
00171 <span class="keyword">public</span>:
00172 <span class="comment"></span>
<a name="l00173"></a><a class="code" href="classFX_1_1FXList.html#a12">00173</a> <span class="comment"> /// Construct a list with nvis visible items; the list is initially empty</span>
00174 <span class="comment"></span> FXList(<a class="code" href="classFX_1_1FXComposite.html">FXComposite</a> *p,<a class="code" href="classFX_1_1FXObject.html">FXObject</a>* tgt=NULL,FXSelector sel=0,FXuint opts=LIST_NORMAL,FXint x=0,FXint y=0,FXint w=0,FXint h=0);
00175 <span class="comment"></span>
<a name="l00176"></a><a class="code" href="classFX_1_1FXList.html#a13">00176</a> <span class="comment"> /// Create server-side resources</span>
00177 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> create();
00178 <span class="comment"></span>
00179 <span class="comment"> /// Detach server-side resources</span>
00180 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> detach();
00181 <span class="comment"></span>
00182 <span class="comment"> /// Perform layout</span>
00183 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> layout();
00184 <span class="comment"></span>
00185 <span class="comment"> /// Return default width</span>
00186 <span class="comment"></span> <span class="keyword">virtual</span> FXint getDefaultWidth();
00187 <span class="comment"></span>
00188 <span class="comment"> /// Return default height</span>
00189 <span class="comment"></span> <span class="keyword">virtual</span> FXint getDefaultHeight();
00190 <span class="comment"></span>
00191 <span class="comment"> /// Compute and return content width</span>
00192 <span class="comment"></span> <span class="keyword">virtual</span> FXint getContentWidth();
00193 <span class="comment"></span>
00194 <span class="comment"> /// Return content height</span>
00195 <span class="comment"></span> <span class="keyword">virtual</span> FXint getContentHeight();
00196 <span class="comment"></span>
00197 <span class="comment"> /// Recalculate layout</span>
00198 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> recalc();
00199 <span class="comment"></span>
00200 <span class="comment"> /// List widget can receive focus</span>
00201 <span class="comment"></span> <span class="keyword">virtual</span> FXbool canFocus() <span class="keyword">const</span>;
00202 <span class="comment"></span>
00203 <span class="comment"> /// Move the focus to this window</span>
00204 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> setFocus();
00205 <span class="comment"></span>
00206 <span class="comment"> /// Remove the focus from this window</span>
00207 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> killFocus();
00208 <span class="comment"></span>
00209 <span class="comment"> /// Return the number of items in the list</span>
00210 <span class="comment"></span> FXint getNumItems()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> nitems; }
00211 <span class="comment"></span>
00212 <span class="comment"> /// Return number of visible items</span>
00213 <span class="comment"></span> FXint getNumVisible()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> visible; }
00214 <span class="comment"></span>
00215 <span class="comment"> /// Change the number of visible items</span>
00216 <span class="comment"></span> <span class="keywordtype">void</span> setNumVisible(FXint nvis);
00217 <span class="comment"></span>
00218 <span class="comment"> /// Return the item at the given index</span>
00219 <span class="comment"></span> FXListItem *getItem(FXint index) <span class="keyword">const</span>;
00220 <span class="comment"></span>
00221 <span class="comment"> /// Replace the item with a [possibly subclassed] item</span>
00222 <span class="comment"></span> FXint setItem(FXint index,FXListItem* item,FXbool notify=FALSE);
00223 <span class="comment"></span>
00224 <span class="comment"> /// Replace items text, icon, and user-data pointer</span>
00225 <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,FXbool notify=FALSE);
00226 <span class="comment"></span>
00227 <span class="comment"> /// Insert a new [possibly subclassed] item at the give index</span>
00228 <span class="comment"></span> FXint insertItem(FXint index,FXListItem* item,FXbool notify=FALSE);
00229 <span class="comment"></span>
00230 <span class="comment"> /// Insert item at index with given text, icon, and user-data pointer</span>
00231 <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,FXbool notify=FALSE);
00232 <span class="comment"></span>
00233 <span class="comment"> /// Append a [possibly subclassed] item to the list</span>
00234 <span class="comment"></span> FXint appendItem(FXListItem* item,FXbool notify=FALSE);
00235 <span class="comment"></span>
00236 <span class="comment"> /// Append new item with given text and optional icon, and user-data pointer</span>
00237 <span class="comment"></span> FXint appendItem(<span class="keyword">const</span> FXString& text,FXIcon *icon=NULL,<span class="keywordtype">void</span>* ptr=NULL,FXbool notify=FALSE);
00238 <span class="comment"></span>
00239 <span class="comment"> /// Prepend a [possibly subclassed] item to the list</span>
00240 <span class="comment"></span> FXint prependItem(FXListItem* item,FXbool notify=FALSE);
00241 <span class="comment"></span>
00242 <span class="comment"> /// Prepend new item with given text and optional icon, and user-data pointer</span>
00243 <span class="comment"></span> FXint prependItem(<span class="keyword">const</span> FXString& text,FXIcon *icon=NULL,<span class="keywordtype">void</span>* ptr=NULL,FXbool notify=FALSE);
00244 <span class="comment"></span>
00245 <span class="comment"> /// Move item from oldindex to newindex</span>
00246 <span class="comment"></span> FXint moveItem(FXint newindex,FXint oldindex,FXbool notify=FALSE);
00247 <span class="comment"></span>
00248 <span class="comment"> /// Remove item from list</span>
00249 <span class="comment"></span> <span class="keywordtype">void</span> removeItem(FXint index,FXbool notify=FALSE);
00250 <span class="comment"></span>
00251 <span class="comment"> /// Remove all items from list</span>
00252 <span class="comment"></span> <span class="keywordtype">void</span> clearItems(FXbool notify=FALSE);
00253 <span class="comment"></span>
00254 <span class="comment"> /// Return item width</span>
00255 <span class="comment"></span> FXint getItemWidth(FXint index) <span class="keyword">const</span>;
00256 <span class="comment"></span>
00257 <span class="comment"> /// Return item height</span>
00258 <span class="comment"></span> FXint getItemHeight(FXint index) <span class="keyword">const</span>;
00259 <span class="comment"></span>
00260 <span class="comment"> /// Return index of item at x,y, if any</span>
00261 <span class="comment"></span> FXint getItemAt(FXint x,FXint y) <span class="keyword">const</span>;
00262 <span class="comment"></span>
00263 <span class="comment"> /// Return item hit code: 0 no hit; 1 hit the icon; 2 hit the text</span>
00264 <span class="comment"></span> FXint hitItem(FXint index,FXint x,FXint y) <span class="keyword">const</span>;
00265 <span class="comment"></span>
00266 <span class="comment"> /**</span>
00267 <span class="comment"> * Search items for item by name, starting from start item; the</span>
00268 <span class="comment"> * flags argument controls the search direction, and case sensitivity.</span>
00269 <span class="comment"> */</span>
00270 FXint findItem(<span class="keyword">const</span> FXString& text,FXint start=-1,FXuint flags=SEARCH_FORWARD|SEARCH_WRAP) <span class="keyword">const</span>;
00271 <span class="comment"></span>
00272 <span class="comment"> /// Scroll to bring item into view</span>
00273 <span class="comment"></span> <span class="keywordtype">void</span> makeItemVisible(FXint index);
00274 <span class="comment"></span>
00275 <span class="comment"> /// Change item text</span>
00276 <span class="comment"></span> <span class="keywordtype">void</span> setItemText(FXint index,<span class="keyword">const</span> FXString& text);
00277 <span class="comment"></span>
00278 <span class="comment"> /// Return item text</span>
00279 <span class="comment"></span> FXString getItemText(FXint index) <span class="keyword">const</span>;
00280 <span class="comment"></span>
00281 <span class="comment"> /// Change item icon</span>
00282 <span class="comment"></span> <span class="keywordtype">void</span> setItemIcon(FXint index,FXIcon* icon);
00283 <span class="comment"></span>
00284 <span class="comment"> /// Return item icon, if any</span>
00285 <span class="comment"></span> FXIcon* getItemIcon(FXint index) <span class="keyword">const</span>;
00286 <span class="comment"></span>
00287 <span class="comment"> /// Change item user-data pointer</span>
00288 <span class="comment"></span> <span class="keywordtype">void</span> setItemData(FXint index,<span class="keywordtype">void</span>* ptr);
00289 <span class="comment"></span>
00290 <span class="comment"> /// Return item user-data pointer</span>
00291 <span class="comment"></span> <span class="keywordtype">void</span>* getItemData(FXint index) <span class="keyword">const</span>;
00292 <span class="comment"></span>
00293 <span class="comment"> /// Return TRUE if item is selected</span>
00294 <span class="comment"></span> FXbool isItemSelected(FXint index) <span class="keyword">const</span>;
00295 <span class="comment"></span>
<a name="l00296"></a><a class="code" href="classFX_1_1FXList.html#a52">00296</a> <span class="comment"> /// Return TRUE if item is current</span>
00297 <span class="comment"></span> FXbool isItemCurrent(FXint index) <span class="keyword">const</span>;
00298 <span class="comment"></span>
00299 <span class="comment"> /// Return TRUE if item is visible</span>
00300 <span class="comment"></span> FXbool isItemVisible(FXint index) <span class="keyword">const</span>;
00301 <span class="comment"></span>
<a name="l00302"></a><a class="code" href="classFX_1_1FXList.html#a54">00302</a> <span class="comment"> /// Return TRUE if item is enabled</span>
00303 <span class="comment"></span> FXbool isItemEnabled(FXint index) <span class="keyword">const</span>;
00304 <span class="comment"></span>
<a name="l00305"></a><a class="code" href="classFX_1_1FXList.html#a55">00305</a> <span class="comment"> /// Repaint item</span>
00306 <span class="comment"></span> <span class="keywordtype">void</span> updateItem(FXint index) <span class="keyword">const</span>;
00307 <span class="comment"></span>
00308 <span class="comment"> /// Enable item</span>
00309 <span class="comment"></span> FXbool enableItem(FXint index);
00310 <span class="comment"></span>
00311 <span class="comment"> /// Disable item</span>
00312 <span class="comment"></span> FXbool disableItem(FXint index);
00313 <span class="comment"></span>
<a name="l00314"></a><a class="code" href="classFX_1_1FXList.html#a58">00314</a> <span class="comment"> /// Select item</span>
00315 <span class="comment"></span> <span class="keyword">virtual</span> FXbool selectItem(FXint index,FXbool notify=FALSE);
00316 <span class="comment"></span>
<a name="l00317"></a><a class="code" href="classFX_1_1FXList.html#a59">00317</a> <span class="comment"> /// Deselect item</span>
00318 <span class="comment"></span> <span class="keyword">virtual</span> FXbool deselectItem(FXint index,FXbool notify=FALSE);
00319 <span class="comment"></span>
00320 <span class="comment"> /// Toggle item selection state</span>
00321 <span class="comment"></span> <span class="keyword">virtual</span> FXbool toggleItem(FXint index,FXbool notify=FALSE);
00322 <span class="comment"></span>
<a name="l00323"></a><a class="code" href="classFX_1_1FXList.html#a61">00323</a> <span class="comment"> /// Extend selection from anchor item to index</span>
00324 <span class="comment"></span> <span class="keyword">virtual</span> FXbool extendSelection(FXint index,FXbool notify=FALSE);
00325 <span class="comment"></span>
00326 <span class="comment"> /// Deselect all items</span>
00327 <span class="comment"></span> <span class="keyword">virtual</span> FXbool killSelection(FXbool notify=FALSE);
00328 <span class="comment"></span>
<a name="l00329"></a><a class="code" href="classFX_1_1FXList.html#a63">00329</a> <span class="comment"> /// Change current item</span>
00330 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> setCurrentItem(FXint index,FXbool notify=FALSE);
00331 <span class="comment"></span>
00332 <span class="comment"> /// Return current item, if any</span>
00333 <span class="comment"></span> FXint getCurrentItem()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> current; }
00334 <span class="comment"></span>
<a name="l00335"></a><a class="code" href="classFX_1_1FXList.html#a65">00335</a> <span class="comment"> /// Change anchor item</span>
00336 <span class="comment"></span> <span class="keywordtype">void</span> setAnchorItem(FXint index);
00337 <span class="comment"></span>
<a name="l00338"></a><a class="code" href="classFX_1_1FXList.html#a66">00338</a> <span class="comment"> /// Return anchor item, if any</span>
00339 <span class="comment"></span> FXint getAnchorItem()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> anchor; }
00340 <span class="comment"></span>
00341 <span class="comment"> /// Get item under the cursor, if any</span>
00342 <span class="comment"></span> FXint getCursorItem()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> cursor; }
00343 <span class="comment"></span>
00344 <span class="comment"> /// Sort items using current sort function</span>
00345 <span class="comment"></span> <span class="keywordtype">void</span> sortItems();
00346 <span class="comment"></span>
00347 <span class="comment"> /// Change text font</span>
00348 <span class="comment"></span> <span class="keywordtype">void</span> setFont(FXFont* fnt);
00349 <span class="comment"></span>
<a name="l00350"></a><a class="code" href="classFX_1_1FXList.html#a70">00350</a> <span class="comment"> /// Return text font</span>
00351 <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; }
00352 <span class="comment"></span>
00353 <span class="comment"> /// Return normal text color</span>
00354 <span class="comment"></span> FXColor getTextColor()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> textColor; }
00355 <span class="comment"></span>
00356 <span class="comment"> /// Change normal text color</span>
00357 <span class="comment"></span> <span class="keywordtype">void</span> setTextColor(FXColor clr);
00358 <span class="comment"></span>
00359 <span class="comment"> /// Return selected text background</span>
00360 <span class="comment"></span> FXColor getSelBackColor()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> selbackColor; }
00361 <span class="comment"></span>
00362 <span class="comment"> /// Change selected text background</span>
00363 <span class="comment"></span> <span class="keywordtype">void</span> setSelBackColor(FXColor clr);
00364 <span class="comment"></span>
00365 <span class="comment"> /// Return selected text color</span>
00366 <span class="comment"></span> FXColor getSelTextColor()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> seltextColor; }
00367 <span class="comment"></span>
00368 <span class="comment"> /// Change selected text color</span>
00369 <span class="comment"></span> <span class="keywordtype">void</span> setSelTextColor(FXColor clr);
00370 <span class="comment"></span>
00371 <span class="comment"> /// Return sort function</span>
00372 <span class="comment"></span> FXListSortFunc getSortFunc()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> sortfunc; }
00373 <span class="comment"></span>
00374 <span class="comment"> /// Change sort function</span>
00375 <span class="comment"></span> <span class="keywordtype">void</span> setSortFunc(FXListSortFunc func){ sortfunc=func; }
00376 <span class="comment"></span>
00377 <span class="comment"> /// Return list style</span>
00378 <span class="comment"></span> FXuint getListStyle() <span class="keyword">const</span>;
00379 <span class="comment"></span>
00380 <span class="comment"> /// Change list style</span>
00381 <span class="comment"></span> <span class="keywordtype">void</span> setListStyle(FXuint style);
00382 <span class="comment"></span>
00383 <span class="comment"> /// Set the status line help text for this list</span>
00384 <span class="comment"></span> <span class="keywordtype">void</span> setHelpText(<span class="keyword">const</span> FXString& text);
00385 <span class="comment"></span>
00386 <span class="comment"> /// Get the status line help text for this list</span>
00387 <span class="comment"></span> FXString getHelpText()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> help; }
00388 <span class="comment"></span>
00389 <span class="comment"> /// Save list to a stream</span>
00390 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> save(FXStream& store) <span class="keyword">const</span>;
00391 <span class="comment"></span>
00392 <span class="comment"> /// Load list from a stream</span>
00393 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> load(FXStream& store);
00394 <span class="comment"></span>
00395 <span class="comment"> /// Destructor</span>
00396 <span class="comment"></span> <span class="keyword">virtual</span> ~FXList();
00397 };
00398
00399 }
00400
00401 <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>
distrib
>
Mandriva
>
10.0
>
i586
>
media
>
contrib
>
by-pkgid
>
af7a4b7f1ee5a4a084c41b9005da5527
>
files
>
1502
