Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

FX::FXList Class Reference

A List Widget displays a list of items, each with a text and optional icon. More...

#include <FXList.h>

Inheritance diagram for FX::FXList:
FX::FXScrollArea FX::FXComposite FX::FXWindow FX::FXDrawable FX::FXId FX::FXObject FX::FXColorList

List of all members.

Public Types

enum  { ID_LOOKUPTIMER = FXScrollArea::ID_LAST, ID_LAST }
- Public Types inherited from FX::FXScrollArea
enum  { ID_AUTOSCROLL = FXComposite::ID_LAST, ID_VSCROLLED, ID_HSCROLLED, ID_LAST }

Public Member Functions

long onPaint (FXObject *, FXSelector, void *)
long onEnter (FXObject *, FXSelector, void *)
long onLeave (FXObject *, FXSelector, void *)
long onUngrabbed (FXObject *, FXSelector, void *)
long onKeyPress (FXObject *, FXSelector, void *)
long onKeyRelease (FXObject *, FXSelector, void *)
long onLeftBtnPress (FXObject *, FXSelector, void *)
long onLeftBtnRelease (FXObject *, FXSelector, void *)
long onRightBtnPress (FXObject *, FXSelector, void *)
long onRightBtnRelease (FXObject *, FXSelector, void *)
long onMotion (FXObject *, FXSelector, void *)
long onFocusIn (FXObject *, FXSelector, void *)
long onFocusOut (FXObject *, FXSelector, void *)
long onAutoScroll (FXObject *, FXSelector, void *)
long onClicked (FXObject *, FXSelector, void *)
long onDoubleClicked (FXObject *, FXSelector, void *)
long onTripleClicked (FXObject *, FXSelector, void *)
long onCommand (FXObject *, FXSelector, void *)
long onQueryTip (FXObject *, FXSelector, void *)
long onQueryHelp (FXObject *, FXSelector, void *)
long onTipTimer (FXObject *, FXSelector, void *)
long onLookupTimer (FXObject *, FXSelector, void *)
long onCmdSetValue (FXObject *, FXSelector, void *)
long onCmdGetIntValue (FXObject *, FXSelector, void *)
long onCmdSetIntValue (FXObject *, FXSelector, void *)
 FXList (FXComposite *p, FXObject *tgt=NULL, FXSelector sel=0, FXuint opts=LIST_NORMAL, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
 Construct a list with initially no items in it.
virtual void create ()
 Create server-side resources.
virtual void detach ()
 Detach server-side resources.
virtual void layout ()
 Perform layout.
virtual FXint getDefaultWidth ()
 Return default width.
virtual FXint getDefaultHeight ()
 Return default height.
virtual FXint getContentWidth ()
 Compute and return content width.
virtual FXint getContentHeight ()
 Return content height.
virtual void recalc ()
 Recalculate layout.
virtual FXbool canFocus () const
 List widget can receive focus.
virtual void setFocus ()
 Move the focus to this window.
virtual void killFocus ()
 Remove the focus from this window.
FXint getNumItems () const
 Return the number of items in the list.
FXint getNumVisible () const
 Return number of visible items.
void setNumVisible (FXint nvis)
 Change the number of visible items.
FXListItemgetItem (FXint index) const
 Return the item at the given index.
FXint setItem (FXint index, FXListItem *item, FXbool notify=false)
 Replace the item with a [possibly subclassed] item.
FXint setItem (FXint index, const FXString &text, FXIcon *icon=NULL, FXptr ptr=NULL, FXbool notify=false)
 Replace items text, icon, and user-data pointer.
FXint fillItems (const FXchar *const *strings, FXIcon *icon=NULL, FXptr ptr=NULL, FXbool notify=false)
 Fill list by appending items from array of strings.
FXint fillItems (const FXString *strings, FXIcon *icon=NULL, FXptr ptr=NULL, FXbool notify=false)
 Fill list by appending items from array of strings.
FXint fillItems (const FXString &strings, FXIcon *icon=NULL, FXptr ptr=NULL, FXbool notify=false)
 Fill list by appending items from newline separated strings.
FXint insertItem (FXint index, FXListItem *item, FXbool notify=false)
 Insert a new [possibly subclassed] item at the give index.
FXint insertItem (FXint index, const FXString &text, FXIcon *icon=NULL, FXptr ptr=NULL, FXbool notify=false)
 Insert item at index with given text, icon, and user-data pointer.
FXint appendItem (FXListItem *item, FXbool notify=false)
 Append a [possibly subclassed] item to the list.
FXint appendItem (const FXString &text, FXIcon *icon=NULL, FXptr ptr=NULL, FXbool notify=false)
 Append new item with given text and optional icon, and user-data pointer.
FXint prependItem (FXListItem *item, FXbool notify=false)
 Prepend a [possibly subclassed] item to the list.
FXint prependItem (const FXString &text, FXIcon *icon=NULL, FXptr ptr=NULL, FXbool notify=false)
 Prepend new item with given text and optional icon, and user-data pointer.
FXint moveItem (FXint newindex, FXint oldindex, FXbool notify=false)
 Move item from oldindex to newindex.
FXListItemextractItem (FXint index, FXbool notify=false)
 Extract item from list.
void removeItem (FXint index, FXbool notify=false)
 Remove item from list.
void clearItems (FXbool notify=false)
 Remove all items from list.
FXint getItemWidth (FXint index) const
 Return item width.
FXint getItemHeight (FXint index) const
 Return item height.
virtual FXint getItemAt (FXint x, FXint y) const
 Return index of item at x,y, if any.
FXint hitItem (FXint index, FXint x, FXint y) const
 Return item hit code: 0 no hit; 1 hit the icon; 2 hit the text.
virtual void makeItemVisible (FXint index)
 Scroll to bring item into view.
FXint findItem (const FXString &string, FXint start=-1, FXuint flags=SEARCH_FORWARD|SEARCH_WRAP) const
 Search items by name, beginning from item start.
FXint findItemByData (FXptr ptr, FXint start=-1, FXuint flags=SEARCH_FORWARD|SEARCH_WRAP) const
 Search items by associated user data, beginning from item start.
void setItemText (FXint index, const FXString &text)
 Change item text.
FXString getItemText (FXint index) const
 Return item text.
void setItemIcon (FXint index, FXIcon *icon, FXbool owned=false)
 Change item icon, deleting the old icon if it was owned.
FXIcongetItemIcon (FXint index) const
 Return item icon, if any.
void setItemData (FXint index, FXptr ptr)
 Change item user-data pointer.
FXptr getItemData (FXint index) const
 Return item user-data pointer.
FXbool isItemSelected (FXint index) const
 Return true if item is selected.
FXbool isItemCurrent (FXint index) const
 Return true if item is current.
FXbool isItemVisible (FXint index) const
 Return true if item is visible.
FXbool isItemEnabled (FXint index) const
 Return true if item is enabled.
void updateItem (FXint index) const
 Repaint item.
virtual FXbool enableItem (FXint index)
 Enable item.
virtual FXbool disableItem (FXint index)
 Disable item.
virtual FXbool selectItem (FXint index, FXbool notify=false)
 Select item.
virtual FXbool deselectItem (FXint index, FXbool notify=false)
 Deselect item.
virtual FXbool toggleItem (FXint index, FXbool notify=false)
 Toggle item selection state.
virtual FXbool extendSelection (FXint index, FXbool notify=false)
 Extend selection from anchor item to index.
virtual FXbool selectAll (FXbool notify=false)
 Select all items.
virtual FXbool killSelection (FXbool notify=false)
 Deselect all items.
virtual void setCurrentItem (FXint index, FXbool notify=false)
 Change current item.
FXint getCurrentItem () const
 Return current item, if any.
void setAnchorItem (FXint index)
 Change anchor item.
FXint getAnchorItem () const
 Return anchor item, if any.
void sortItems ()
 Sort items using current sort function.
FXListSortFunc getSortFunc () const
 Return sort function.
void setSortFunc (FXListSortFunc func)
 Change sort function.
void setFont (FXFont *fnt)
 Change text font.
FXFontgetFont () const
 Return text font.
FXColor getTextColor () const
 Return normal text color.
void setTextColor (FXColor clr)
 Change normal text color.
FXColor getSelBackColor () const
 Return selected text background.
void setSelBackColor (FXColor clr)
 Change selected text background.
FXColor getSelTextColor () const
 Return selected text color.
void setSelTextColor (FXColor clr)
 Change selected text color.
FXuint getListStyle () const
 Return list style.
void setListStyle (FXuint style)
 Change list style.
void setHelpText (const FXString &text)
 Set the status line help text for this list.
const FXStringgetHelpText () const
 Get the status line help text for this list.
virtual void save (FXStream &store) const
 Save list to a stream.
virtual void load (FXStream &store)
 Load list from a stream.
virtual ~FXList ()
 Destructor.
- Public Member Functions inherited from FX::FXScrollArea
long onHMouseWheel (FXObject *, FXSelector, void *)
long onVMouseWheel (FXObject *, FXSelector, void *)
long onHScrollerChanged (FXObject *, FXSelector, void *)
long onVScrollerChanged (FXObject *, FXSelector, void *)
long onHScrollerDragged (FXObject *, FXSelector, void *)
long onVScrollerDragged (FXObject *, FXSelector, void *)
void setPosition (FXint x, FXint y)
 Set the current position.
void getPosition (FXint &x, FXint &y) const
 Get the current position.
FXint getContentX () const
 Return content area x position.
FXint getContentY () const
 Return content area y position.
virtual FXint getVisibleX () const
 Return visible scroll-area x position.
virtual FXint getVisibleY () const
 Return visible scroll-area y position.
virtual FXint getVisibleWidth () const
 Return visible scroll-area width.
virtual FXint getVisibleHeight () const
 Return visible scroll-area height.
FXbool isHorizontalScrollable () const
 Return true if horizontally scrollable.
FXbool isVerticalScrollable () const
 Return true if vertically scrollable.
void setScrollStyle (FXuint style)
 Change scroll style.
FXuint getScrollStyle () const
 Return scroll style.
FXScrollBarhorizontalScrollBar () const
 Return a pointer to the horizontal scrollbar.
FXScrollBarverticalScrollBar () const
 Return a pointer to the vertical scrollbar.
virtual ~FXScrollArea ()
 Destructor.
- Public Member Functions inherited from FX::FXComposite
long onFocusNext (FXObject *, FXSelector, void *)
long onFocusPrev (FXObject *, FXSelector, void *)
long onCmdUpdate (FXObject *, FXSelector, void *)
 FXComposite (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
 Constructor.
virtual void destroy ()
 Destroy server-side resources.
FXint maxChildWidth () const
 Return the width of the widest child window.
FXint maxChildHeight () const
 Return the height of the tallest child window.
virtual FXbool isComposite () const
 Overrides this virtual function to return true.
virtual ~FXComposite ()
 Destructor.
- Public Member Functions inherited from FX::FXWindow
long onMap (FXObject *, FXSelector, void *)
long onUnmap (FXObject *, FXSelector, void *)
long onConfigure (FXObject *, FXSelector, void *)
long onUpdate (FXObject *, FXSelector, void *)
long onMouseWheel (FXObject *, FXSelector, void *)
long onMiddleBtnPress (FXObject *, FXSelector, void *)
long onMiddleBtnRelease (FXObject *, FXSelector, void *)
long onSpaceBallMotion (FXObject *, FXSelector, void *)
long onSpaceBallButtonPress (FXObject *, FXSelector, void *)
long onSpaceBallButtonRelease (FXObject *, FXSelector, void *)
long onBeginDrag (FXObject *, FXSelector, void *)
long onEndDrag (FXObject *, FXSelector, void *)
long onDragged (FXObject *, FXSelector, void *)
long onDestroy (FXObject *, FXSelector, void *)
long onFocusSelf (FXObject *, FXSelector, void *)
long onSelectionLost (FXObject *, FXSelector, void *)
long onSelectionGained (FXObject *, FXSelector, void *)
long onSelectionRequest (FXObject *, FXSelector, void *)
long onClipboardLost (FXObject *, FXSelector, void *)
long onClipboardGained (FXObject *, FXSelector, void *)
long onClipboardRequest (FXObject *, FXSelector, void *)
long onDNDEnter (FXObject *, FXSelector, void *)
long onDNDLeave (FXObject *, FXSelector, void *)
long onDNDMotion (FXObject *, FXSelector, void *)
long onDNDDrop (FXObject *, FXSelector, void *)
long onDNDRequest (FXObject *, FXSelector, void *)
long onCmdShow (FXObject *, FXSelector, void *)
long onCmdHide (FXObject *, FXSelector, void *)
long onUpdToggleShown (FXObject *, FXSelector, void *)
long onCmdToggleShown (FXObject *, FXSelector, void *)
long onCmdRaise (FXObject *, FXSelector, void *)
long onCmdLower (FXObject *, FXSelector, void *)
long onCmdEnable (FXObject *, FXSelector, void *)
long onCmdDisable (FXObject *, FXSelector, void *)
long onUpdToggleEnabled (FXObject *, FXSelector, void *)
long onCmdToggleEnabled (FXObject *, FXSelector, void *)
long onUpdYes (FXObject *, FXSelector, void *)
long onCmdDelete (FXObject *, FXSelector, void *)
 FXWindow (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
 Constructor.
FXWindowgetParent () const
 Return a pointer to the parent window.
FXWindowgetOwner () const
 Return a pointer to the owner window.
FXWindowgetShell () const
 Return a pointer to the shell window.
FXWindowgetRoot () const
 Return a pointer to the root window.
FXWindowgetNext () const
 Return a pointer to the next (sibling) window, if any.
FXWindowgetPrev () const
 Return a pointer to the previous (sibling) window , if any.
FXWindowgetFirst () const
 Return a pointer to this window's first child window , if any.
FXWindowgetLast () const
 Return a pointer to this window's last child window, if any.
FXWindowgetFocus () const
 Return a pointer to the currently focused child window.
virtual WindowClass getWindowClass () const
 Get window class.
void setKey (FXuint k)
 Change window key.
FXuint getKey () const
 Return window key.
FXWindowgetChildWithKey (FXuint k) const
 Return child window with given window key.
void setTarget (FXObject *t)
 Set the message target object for this window.
FXObjectgetTarget () const
 Get the message target object for this window, if any.
void setSelector (FXSelector sel)
 Set the message identifier for this window.
FXSelector getSelector () const
 Get the message identifier for this window.
FXint getX () const
 Get this window's x-coordinate, in the parent's coordinate system.
FXint getY () const
 Get this window's y-coordinate, in the parent's coordinate system.
virtual FXint getWidthForHeight (FXint givenheight)
 Return width for given height.
virtual FXint getHeightForWidth (FXint givenwidth)
 Return height for given width.
void setX (FXint x)
 Set this window's x-coordinate, in the parent's coordinate system.
void setY (FXint y)
 Set this window's y-coordinate, in the parent's coordinate system.
void setWidth (FXint w)
 Set the window width; and flag the widget as being in need of layout by its parent.
void setHeight (FXint h)
 Set the window height; and flag the widget as being in need of layout by its parent.
void setLayoutHints (FXuint lout)
 Set layout hints for this window.
FXuint getLayoutHints () const
 Get layout hints for this window.
FXAccelTablegetAccelTable () const
 Return a pointer to the accelerator table.
void setAccelTable (FXAccelTable *acceltable)
 Set the accelerator table.
void addHotKey (FXHotKey code)
 Add a hot key.
void remHotKey (FXHotKey code)
 Remove a hot key.
void setHelpTag (const FXString &text)
 Change help tag for this widget.
const FXStringgetHelpTag () const
 Get the help tag for this widget.
FXbool isShell () const
 Return true if window is a shell window.
FXbool isOwnerOf (const FXWindow *window) const
 Return true if specified window is owned by this window.
FXbool isChildOf (const FXWindow *window) const
 Return true if specified window is ancestor of this window.
FXbool containsChild (const FXWindow *child) const
 Return true if this window contains child in its subtree.
FXWindowgetChildAt (FXint x, FXint y) const
 Return the child window at specified coordinates.
FXint numChildren () const
 Return the number of child windows for this window.
FXint indexOfChild (const FXWindow *window) const
 Return the index (starting from zero) of the specified child window, or -1 if the window is not a child or NULL.
FXWindowchildAtIndex (FXint index) const
 Return the child window at specified index, or NULL if the index is negative or out of range.
FXComposeContextgetComposeContext () const
 Return compose context.
void createComposeContext ()
 Create compose context.
void destroyComposeContext ()
 Destroy compose context.
FXbool cursorShown () const
 Is cursor shown.
void showCursor (FXbool flag=true)
 Show or hide the cursor.
void setDefaultCursor (FXCursor *cur)
 Set the default cursor for this window.
FXCursorgetDefaultCursor () const
 Return the default cursor for this window.
void setDragCursor (FXCursor *cur)
 Set the drag cursor for this window.
FXCursorgetDragCursor () const
 Return the drag cursor for this window.
FXbool getCursorPosition (FXint &x, FXint &y, FXuint &buttons) const
 Return the cursor position and mouse button-state.
FXbool setCursorPosition (FXint x, FXint y)
 Warp the cursor to the new position.
FXbool isActive () const
 Return true if the window is active.
FXbool hasFocus () const
 Return true if this window has the focus.
FXbool inFocusChain () const
 Return true if this window is in focus chain.
virtual void changeFocus (FXWindow *child)
 Notification that focus moved to new child.
FXbool isDefault () const
 Return true if this is the default window.
virtual void setDefault (FXuchar flag=true)
 This changes the default window which responds to the Return key in a dialog.
FXWindowfindDefault () const
 Find default window among this window's children.
FXbool isInitial () const
 Return true if this is the initial default window.
void setInitial (FXbool flag=true)
 Make this window the initial default window.
FXWindowfindInitial () const
 Find inital default window among this window's children.
FXbool isEnabled () const
 Return true if this window is able to receive mouse and keyboard events.
virtual void enable ()
 Enable the window to receive mouse and keyboard events.
virtual void disable ()
 Disable the window from receiving mouse and keyboard events.
virtual void attach (FXID w)
 Attach foreign window handle to this window.
virtual void setShape (const FXRegion &region)
 Set window shape by means of region.
virtual void setShape (FXBitmap *bitmap)
 Set window shape by means of bitmap.
virtual void setShape (FXIcon *icon)
 Set window shape by means of icon.
virtual void clearShape ()
 Clear window shape.
virtual void raise ()
 Raise this window to the top of the stacking order.
virtual void lower ()
 Lower this window to the bottom of the stacking order.
virtual void move (FXint x, FXint y)
 Move the window immediately, in the parent's coordinate system.
virtual void resize (FXint w, FXint h)
 Resize the window to the specified width and height immediately, updating the server representation as well, if the window was realized.
virtual void position (FXint x, FXint y, FXint w, FXint h)
 Move and resize the window immediately, in the parent's coordinate system.
void forceRefresh ()
 Generate a SEL_UPDATE message for the window and its children.
virtual void reparent (FXWindow *father, FXWindow *other=NULL)
 Reparent this window under new father before other.
void scroll (FXint x, FXint y, FXint w, FXint h, FXint dx, FXint dy) const
 Scroll rectangle x,y,w,h by a shift of dx,dy.
void update (FXint x, FXint y, FXint w, FXint h) const
 Mark the specified rectangle to be repainted later.
void update () const
 Mark the entire window to be repainted later.
void repaint (FXint x, FXint y, FXint w, FXint h) const
 Process any outstanding repaint messages immediately, for the given rectangle.
void repaint () const
 Process any outstanding repaint messages immediately.
FXbool grabbed () const
 Return true if the window has been grabbed.
void grab ()
 Grab the mouse to this window; future mouse events will be reported to this window even while the cursor goes outside of this window.
void ungrab ()
 Release the mouse grab.
FXbool grabbedKeyboard () const
 Return true if active grab is in effect.
void grabKeyboard ()
 Grab keyboard device.
void ungrabKeyboard ()
 Ungrab keyboard device.
FXbool shown () const
 Return true if the window is shown.
virtual void show ()
 Show this window.
virtual void hide ()
 Hide this window.
FXbool underCursor () const
 Return true if the window is under the cursor.
FXbool hasSelection () const
 Return true if this window owns the primary selection.
FXbool acquireSelection (const FXDragType *types, FXuint numtypes)
 Try to acquire the primary selection, given a list of drag types.
FXbool releaseSelection ()
 Release the primary selection.
FXbool hasClipboard () const
 Return true if this window owns the clipboard.
FXbool acquireClipboard (const FXDragType *types, FXuint numtypes)
 Try to acquire the clipboard, given a list of drag types.
FXbool releaseClipboard ()
 Release the clipboard.
FXbool isDropEnabled () const
 Return true if this window is able to receive drops.
virtual void dropEnable ()
 Enable this window to receive drops.
virtual void dropDisable ()
 Disable this window from receiving drops.
FXbool isDragging () const
 Return true if a drag operaion has been initiated from this window.
FXbool beginDrag (const FXDragType *types, FXuint numtypes)
 Initiate a drag operation with a list of previously registered drag types.
FXbool handleDrag (FXint x, FXint y, FXDragAction action=DRAG_COPY)
 When dragging, inform the drop-target of the new position and the drag action.
FXDragAction endDrag (FXbool drop=true)
 Terminate the drag operation with or without actually dropping the data Returns the action performed by the target.
FXbool isDropTarget () const
 Return true if this window is the target of a drop.
void setDragRectangle (FXint x, FXint y, FXint w, FXint h, FXbool wantupdates=true) const
 When being dragged over, indicate that no further SEL_DND_MOTION messages are required while the cursor is inside the given rectangle.
void clearDragRectangle () const
 When being dragged over, indicate we want to receive SEL_DND_MOTION messages every time the cursor moves.
void acceptDrop (FXDragAction action=DRAG_ACCEPT) const
 When being dragged over, indicate acceptance or rejection of the dragged data.
FXDragAction didAccept () const
 The target accepted our drop.
void dropFinished (FXDragAction action=DRAG_REJECT) const
 Sent by the drop target in response to SEL_DND_DROP.
FXbool inquireDNDTypes (FXDNDOrigin origin, FXDragType *&types, FXuint &numtypes) const
 When being dragged over, inquire the drag types which are being offered.
FXbool offeredDNDType (FXDNDOrigin origin, FXDragType type) const
 When being dragged over, return true if we are offered the given drag type.
FXDragAction inquireDNDAction () const
 When being dragged over, return the drag action.
FXbool setDNDData (FXDNDOrigin origin, FXDragType type, FXuchar *data, FXuint size) const
 Set DND data; the array must be allocated with allocElms() and ownership is transferred to the system.
FXbool setDNDData (FXDNDOrigin origin, FXDragType type, const FXString &string) const
 Set DND data from string value.
FXbool getDNDData (FXDNDOrigin origin, FXDragType type, FXuchar *&data, FXuint &size) const
 Get DND data; the caller becomes the owner of the array and must free it with freeElms().
FXbool getDNDData (FXDNDOrigin origin, FXDragType type, FXString &string) const
 Get DND data into string value.
virtual FXbool contains (FXint parentx, FXint parenty) const
 Return true if window logically contains the given point.
void translateCoordinatesFrom (FXint &tox, FXint &toy, const FXWindow *fromwindow, FXint fromx, FXint fromy) const
 Translate coordinates from fromwindow's coordinate space to this window's coordinate space.
void translateCoordinatesTo (FXint &tox, FXint &toy, const FXWindow *towindow, FXint fromx, FXint fromy) const
 Translate coordinates from this window's coordinate space to towindow's coordinate space.
virtual void setBackColor (FXColor clr)
 Set window background color.
FXColor getBackColor () const
 Get background color.
virtual FXbool doesSaveUnder () const
 Does save-unders.
virtual const FXchar * tr (const FXchar *text, const FXchar *hint=NULL, FXint count=-1) const FX_FORMAT(2)
 Translate message for localization; using the current FXTranslator, an attempt is made to translate the given message into the current language.
virtual ~FXWindow ()
 Destroy window.
- Public Member Functions inherited from FX::FXDrawable
FXVisualgetVisual () const
 Get the visual.
FXint getWidth () const
 Width of drawable.
FXint getHeight () const
 Height of drawable.
void setVisual (FXVisual *vis)
 Change visual.
virtual ~FXDrawable ()
 Cleanup.
- Public Member Functions inherited from FX::FXId
FXAppgetApp () const
 Get application.
FXID id () const
 Get XID handle.
void setUserData (FXptr ptr)
 Set user data pointer.
FXptr getUserData () const
 Get user data pointer.
virtual ~FXId ()
 Destructor.
- Public Member Functions inherited from FX::FXObject
const FXchar * getClassName () const
 Get class name of some object.
FXbool isMemberOf (const FXMetaClass *metaclass) const
 Check if object is member of metaclass.
virtual long tryHandle (FXObject *sender, FXSelector sel, void *ptr)
 Try handle message safely, catching certain exceptions.
virtual long onDefault (FXObject *, FXSelector, void *)
 Called for unhandled messages.
virtual ~FXObject ()
 Virtual destructor.

Static Public Member Functions

static FXint ascending (const FXListItem *a, const FXListItem *b)
static FXint descending (const FXListItem *a, const FXListItem *b)
static FXint ascendingCase (const FXListItem *a, const FXListItem *b)
static FXint descendingCase (const FXListItem *a, const FXListItem *b)

Protected Member Functions

void recompute ()
virtual FXListItemcreateItem (const FXString &text, FXIcon *icon, FXptr ptr)
- Protected Member Functions inherited from FX::FXScrollArea
 FXScrollArea (FXComposite *p, FXuint opts, FXint x, FXint y, FXint w, FXint h)
virtual void moveContents (FXint x, FXint y)
FXbool startAutoScroll (FXEvent *event, FXbool onlywheninside=false)
void stopAutoScroll ()
void placeScrollBars (FXint vw, FXint vh)
- Protected Member Functions inherited from FX::FXComposite
 FXComposite (FXApp *a, FXVisual *vis)
 FXComposite (FXApp *a, FXWindow *own, FXuint opts, FXint x, FXint y, FXint w, FXint h)
- Protected Member Functions inherited from FX::FXWindow
 FXWindow (FXApp *a, FXVisual *vis)
 FXWindow (FXApp *a, FXWindow *own, FXuint opts, FXint x, FXint y, FXint w, FXint h)
virtual FXbool doesOverrideRedirect () const
void addColormapWindows ()
void remColormapWindows ()
- Protected Member Functions inherited from FX::FXDrawable
 FXDrawable (FXApp *a, FXint w, FXint h)
- Protected Member Functions inherited from FX::FXId
 FXId (FXApp *a)

Protected Attributes

FXListItemList items
FXint anchor
FXint current
FXint extent
FXint viewable
FXFontfont
FXColor textColor
FXColor selbackColor
FXColor seltextColor
FXint listWidth
FXint listHeight
FXint visible
FXString help
FXListSortFunc sortfunc
FXint grabx
FXint graby
FXString lookup
FXbool state
- Protected Attributes inherited from FX::FXScrollArea
FXScrollBarhorizontal
FXScrollBarvertical
FXScrollCornercorner
FXint pos_x
FXint pos_y

Detailed Description

A List Widget displays a list of items, each with a text and optional icon.

When an item's selected state changes, the list sends a SEL_SELECTED or SEL_DESELECTED message. A change of the current item is signified by the SEL_CHANGED message. The list sends SEL_COMMAND messages when the user clicks on an item, and SEL_CLICKED, SEL_DOUBLECLICKED, and SEL_TRIPLECLICKED when the user clicks once, twice, or thrice, respectively. When items are inserted or removed, the list sends messages of the type SEL_INSERTED or SEL_DELETED. In each of these cases, the index to the item, if any, is passed in the 3rd argument of the message.


Member Function Documentation

FXint FX::FXList::findItem ( const FXString string,
FXint  start = -1,
FXuint  flags = SEARCH_FORWARD|SEARCH_WRAP 
) const

Search items by name, beginning from item start.

If the start item is -1 the search will start at the first item in the list. Flags may be SEARCH_FORWARD or SEARCH_BACKWARD to control the search direction; this can be combined with SEARCH_NOWRAP or SEARCH_WRAP to control whether the search wraps at the start or end of the list. The option SEARCH_IGNORECASE causes a case-insensitive match. Finally, passing SEARCH_PREFIX causes searching for a prefix of the item name. Return -1 if no matching item is found.

FXint FX::FXList::findItemByData ( FXptr  ptr,
FXint  start = -1,
FXuint  flags = SEARCH_FORWARD|SEARCH_WRAP 
) const

Search items by associated user data, beginning from item start.

If the start item is -1 the search will start at the first item in the list. Flags may be SEARCH_FORWARD or SEARCH_BACKWARD to control the search direction; this can be combined with SEARCH_NOWRAP or SEARCH_WRAP to control whether the search wraps at the start or end of the list.


The documentation for this class was generated from the following file:

Copyright © 1997-2016 Jeroen van der Zijp