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

FX::FXList

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 Member Functions

 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)
virtual void create ()
virtual void detach ()
virtual void layout ()
virtual FXint getDefaultWidth ()
virtual FXint getDefaultHeight ()
virtual FXint getContentWidth ()
virtual FXint getContentHeight ()
virtual void recalc ()
virtual bool canFocus () const
virtual void setFocus ()
virtual void killFocus ()
FXint getNumItems () const
FXint getNumVisible () const
void setNumVisible (FXint nvis)
FXListItem * getItem (FXint index) const
FXint setItem (FXint index, FXListItem *item, FXbool notify=FALSE)
FXint setItem (FXint index, const FXString &text, FXIcon *icon=NULL, void *ptr=NULL, FXbool notify=FALSE)
FXint fillItems (const FXchar **strings, FXIcon *icon=NULL, void *ptr=NULL, FXbool notify=FALSE)
FXint fillItems (const FXString &strings, FXIcon *icon=NULL, void *ptr=NULL, FXbool notify=FALSE)
FXint insertItem (FXint index, FXListItem *item, FXbool notify=FALSE)
FXint insertItem (FXint index, const FXString &text, FXIcon *icon=NULL, void *ptr=NULL, FXbool notify=FALSE)
FXint appendItem (FXListItem *item, FXbool notify=FALSE)
FXint appendItem (const FXString &text, FXIcon *icon=NULL, void *ptr=NULL, FXbool notify=FALSE)
FXint prependItem (FXListItem *item, FXbool notify=FALSE)
FXint prependItem (const FXString &text, FXIcon *icon=NULL, void *ptr=NULL, FXbool notify=FALSE)
FXint moveItem (FXint newindex, FXint oldindex, FXbool notify=FALSE)
FXListItem * extractItem (FXint index, FXbool notify=FALSE)
void removeItem (FXint index, FXbool notify=FALSE)
void clearItems (FXbool notify=FALSE)
FXint getItemWidth (FXint index) const
FXint getItemHeight (FXint index) const
virtual FXint getItemAt (FXint x, FXint y) const
FXint hitItem (FXint index, FXint x, FXint y) const
FXint findItem (const FXString &text, FXint start=-1, FXuint flags=SEARCH_FORWARD|SEARCH_WRAP) const
FXint findItemByData (const void *ptr, FXint start=-1, FXuint flags=SEARCH_FORWARD|SEARCH_WRAP) const
virtual void makeItemVisible (FXint index)
void setItemText (FXint index, const FXString &text)
FXString getItemText (FXint index) const
void setItemIcon (FXint index, FXIcon *icon, FXbool owned=FALSE)
FXIcon * getItemIcon (FXint index) const
void setItemData (FXint index, void *ptr)
void * getItemData (FXint index) const
FXbool isItemSelected (FXint index) const
FXbool isItemCurrent (FXint index) const
FXbool isItemVisible (FXint index) const
FXbool isItemEnabled (FXint index) const
void updateItem (FXint index) const
virtual FXbool enableItem (FXint index)
virtual FXbool disableItem (FXint index)
virtual FXbool selectItem (FXint index, FXbool notify=FALSE)
virtual FXbool deselectItem (FXint index, FXbool notify=FALSE)
virtual FXbool toggleItem (FXint index, FXbool notify=FALSE)
virtual FXbool extendSelection (FXint index, FXbool notify=FALSE)
virtual FXbool killSelection (FXbool notify=FALSE)
virtual void setCurrentItem (FXint index, FXbool notify=FALSE)
FXint getCurrentItem () const
void setAnchorItem (FXint index)
FXint getAnchorItem () const
FXint getCursorItem () const
void sortItems ()
FXListSortFunc getSortFunc () const
void setSortFunc (FXListSortFunc func)
void setFont (FXFont *fnt)
FXFont * getFont () const
FXColor getTextColor () const
void setTextColor (FXColor clr)
FXColor getSelBackColor () const
void setSelBackColor (FXColor clr)
FXColor getSelTextColor () const
void setSelTextColor (FXColor clr)
FXuint getListStyle () const
void setListStyle (FXuint style)
void setHelpText (const FXString &text)
const FXString & getHelpText () const
virtual void save (FXStream &store) const
virtual void load (FXStream &store)
virtual ~FXList ()

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)

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 added, replaced, or removed, the list sends messages of the type SEL_INSERTED, SEL_REPLACED, or SEL_DELETED. In each of these cases, the index to the item, if any, is passed in the 3rd argument of the message.

See also:

Constructor & Destructor Documentation

FX::FXList::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 FX::FXList::~FXList (   )  [virtual]
 

Destructor.

Member Function Documentation

static FXint FX::FXList::ascending (  const FXListItem *  a,
const FXListItem *  b
)  [static]
 

static FXint FX::FXList::descending (  const FXListItem *  a,
const FXListItem *  b
)  [static]
 

static FXint FX::FXList::ascendingCase (  const FXListItem *  a,
const FXListItem *  b
)  [static]
 

static FXint FX::FXList::descendingCase (  const FXListItem *  a,
const FXListItem *  b
)  [static]
 

virtual void FX::FXList::create (   )  [virtual]
 

Create server-side resources.

Reimplemented from FX::FXComposite.

virtual void FX::FXList::detach (   )  [virtual]
 

Detach server-side resources.

Reimplemented from FX::FXComposite.

virtual void FX::FXList::layout (   )  [virtual]
 

Perform layout.

Reimplemented from FX::FXScrollArea.

virtual FXint FX::FXList::getDefaultWidth (   )  [virtual]
 

Return default width.

Reimplemented from FX::FXScrollArea.

virtual FXint FX::FXList::getDefaultHeight (   )  [virtual]
 

Return default height.

Reimplemented from FX::FXScrollArea.

virtual FXint FX::FXList::getContentWidth (   )  [virtual]
 

Compute and return content width.

Reimplemented from FX::FXScrollArea.

virtual FXint FX::FXList::getContentHeight (   )  [virtual]
 

Return content height.

Reimplemented from FX::FXScrollArea.

virtual void FX::FXList::recalc (   )  [virtual]
 

Recalculate layout.

Reimplemented from FX::FXWindow.

virtual bool FX::FXList::canFocus (   )  const [virtual]
 

List widget can receive focus.

Reimplemented from FX::FXWindow.

virtual void FX::FXList::setFocus (   )  [virtual]
 

Move the focus to this window.

Reimplemented from FX::FXWindow.

virtual void FX::FXList::killFocus (   )  [virtual]
 

Remove the focus from this window.

Reimplemented from FX::FXWindow.

FXint FX::FXList::getNumItems (   )  const [inline]
 

Return the number of items in the list.

FXint FX::FXList::getNumVisible (   )  const [inline]
 

Return number of visible items.

void FX::FXList::setNumVisible (  FXint  nvis  ) 
 

Change the number of visible items.

FXListItem* FX::FXList::getItem (  FXint  index  )  const
 

Return the item at the given index.

FXint FX::FXList::setItem (  FXint  index,
FXListItem *  item,
FXbool  notify = FALSE
) 
 

Replace the item with a [possibly subclassed] item.

FXint FX::FXList::setItem (  FXint  index,
const FXString &  text,
FXIcon *  icon = NULL,
void *  ptr = NULL,
FXbool  notify = FALSE
) 
 

Replace items text, icon, and user-data pointer.

FXint FX::FXList::fillItems (  const FXchar **  strings,
FXIcon *  icon = NULL,
void *  ptr = NULL,
FXbool  notify = FALSE
) 
 

Fill list by appending items from array of strings.

FXint FX::FXList::fillItems (  const FXString &  strings,
FXIcon *  icon = NULL,
void *  ptr = NULL,
FXbool  notify = FALSE
) 
 

Fill list by appending items from newline separated strings.

FXint FX::FXList::insertItem (  FXint  index,
FXListItem *  item,
FXbool  notify = FALSE
) 
 

Insert a new [possibly subclassed] item at the give index.

FXint FX::FXList::insertItem (  FXint  index,
const FXString &  text,
FXIcon *  icon = NULL,
void *  ptr = NULL,
FXbool  notify = FALSE
) 
 

Insert item at index with given text, icon, and user-data pointer.

FXint FX::FXList::appendItem (  FXListItem *  item,
FXbool  notify = FALSE
) 
 

Append a [possibly subclassed] item to the list.

FXint FX::FXList::appendItem (  const FXString &  text,
FXIcon *  icon = NULL,
void *  ptr = NULL,
FXbool  notify = FALSE
) 
 

Append new item with given text and optional icon, and user-data pointer.

FXint FX::FXList::prependItem (  FXListItem *  item,
FXbool  notify = FALSE
) 
 

Prepend a [possibly subclassed] item to the list.

FXint FX::FXList::prependItem (  const FXString &  text,
FXIcon *  icon = NULL,
void *  ptr = NULL,
FXbool  notify = FALSE
) 
 

Prepend new item with given text and optional icon, and user-data pointer.

FXint FX::FXList::moveItem (  FXint  newindex,
FXint  oldindex,
FXbool  notify = FALSE
) 
 

Move item from oldindex to newindex.

FXListItem* FX::FXList::extractItem (  FXint  index,
FXbool  notify = FALSE
) 
 

Extract item from list.

void FX::FXList::removeItem (  FXint  index,
FXbool  notify = FALSE
) 
 

Remove item from list.

void FX::FXList::clearItems (  FXbool  notify = FALSE  ) 
 

Remove all items from list.

FXint FX::FXList::getItemWidth (  FXint  index  )  const
 

Return item width.

FXint FX::FXList::getItemHeight (  FXint  index  )  const
 

Return item height.

virtual FXint FX::FXList::getItemAt (  FXint  x,
FXint  y
)  const [virtual]
 

Return index of item at x,y, if any.

FXint FX::FXList::hitItem (  FXint  index,
FXint  x,
FXint  y
)  const
 

Return item hit code: 0 no hit; 1 hit the icon; 2 hit the text.

FXint FX::FXList::findItem (  const FXString &  text,
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 (  const void *  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.

virtual void FX::FXList::makeItemVisible (  FXint  index  )  [virtual]
 

Scroll to bring item into view.

void FX::FXList::setItemText (  FXint  index,
const FXString &  text
) 
 

Change item text.

FXString FX::FXList::getItemText (  FXint  index  )  const
 

Return item text.

void FX::FXList::setItemIcon (  FXint  index,
FXIcon *  icon,
FXbool  owned = FALSE
) 
 

Change item icon, deleting the old icon if it was owned.

FXIcon* FX::FXList::getItemIcon (  FXint  index  )  const
 

Return item icon, if any.

void FX::FXList::setItemData (  FXint  index,
void *  ptr
) 
 

Change item user-data pointer.

void* FX::FXList::getItemData (  FXint  index  )  const
 

Return item user-data pointer.

FXbool FX::FXList::isItemSelected (  FXint  index  )  const
 

Return TRUE if item is selected.

FXbool FX::FXList::isItemCurrent (  FXint  index  )  const
 

Return TRUE if item is current.

FXbool FX::FXList::isItemVisible (  FXint  index  )  const
 

Return TRUE if item is visible.

FXbool FX::FXList::isItemEnabled (  FXint  index  )  const
 

Return TRUE if item is enabled.

void FX::FXList::updateItem (  FXint  index  )  const
 

Repaint item.

virtual FXbool FX::FXList::enableItem (  FXint  index  )  [virtual]
 

Enable item.

virtual FXbool FX::FXList::disableItem (  FXint  index  )  [virtual]
 

Disable item.

virtual FXbool FX::FXList::selectItem (  FXint  index,
FXbool  notify = FALSE
)  [virtual]
 

Select item.

virtual FXbool FX::FXList::deselectItem (  FXint  index,
FXbool  notify = FALSE
)  [virtual]
 

Deselect item.

virtual FXbool FX::FXList::toggleItem (  FXint  index,
FXbool  notify = FALSE
)  [virtual]
 

Toggle item selection state.

virtual FXbool FX::FXList::extendSelection (  FXint  index,
FXbool  notify = FALSE
)  [virtual]
 

Extend selection from anchor item to index.

virtual FXbool FX::FXList::killSelection (  FXbool  notify = FALSE  )  [virtual]
 

Deselect all items.

virtual void FX::FXList::setCurrentItem (  FXint  index,
FXbool  notify = FALSE
)  [virtual]
 

Change current item.

FXint FX::FXList::getCurrentItem (   )  const [inline]
 

Return current item, if any.

void FX::FXList::setAnchorItem (  FXint  index  ) 
 

Change anchor item.

FXint FX::FXList::getAnchorItem (   )  const [inline]
 

Return anchor item, if any.

FXint FX::FXList::getCursorItem (   )  const [inline]
 

Get item under the cursor, if any.

void FX::FXList::sortItems (   ) 
 

Sort items using current sort function.

FXListSortFunc FX::FXList::getSortFunc (   )  const [inline]
 

Return sort function.

void FX::FXList::setSortFunc (  FXListSortFunc  func  )  [inline]
 

Change sort function.

void FX::FXList::setFont (  FXFont *  fnt  ) 
 

Change text font.

FXFont* FX::FXList::getFont (   )  const [inline]
 

Return text font.

FXColor FX::FXList::getTextColor (   )  const [inline]
 

Return normal text color.

void FX::FXList::setTextColor (  FXColor  clr  ) 
 

Change normal text color.

FXColor FX::FXList::getSelBackColor (   )  const [inline]
 

Return selected text background.

void FX::FXList::setSelBackColor (  FXColor  clr  ) 
 

Change selected text background.

FXColor FX::FXList::getSelTextColor (   )  const [inline]
 

Return selected text color.

void FX::FXList::setSelTextColor (  FXColor  clr  ) 
 

Change selected text color.

FXuint FX::FXList::getListStyle (   )  const
 

Return list style.

void FX::FXList::setListStyle (  FXuint  style  ) 
 

Change list style.

void FX::FXList::setHelpText (  const FXString &  text  ) 
 

Set the status line help text for this list.

const FXString& FX::FXList::getHelpText (   )  const [inline]
 

Get the status line help text for this list.

virtual void FX::FXList::save (  FXStream &  store  )  const [virtual]
 

Save list to a stream.

Reimplemented from FX::FXWindow.

virtual void FX::FXList::load (  FXStream &  store  )  [virtual]
 

Load list from a stream.

Reimplemented from FX::FXWindow.

Copyright © 1997-2005 Jeroen van der Zijp