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

FX::FXListBox Class Reference

#include <FXListBox.h>

Inheritance diagram for FX::FXListBox:
FX::FXPacker FX::FXComposite FX::FXWindow FX::FXDrawable FX::FXId FX::FXObject FX::FXDriveBox

List of all members.

Public Member Functions

 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)
virtual void create ()
virtual void detach ()
virtual void destroy ()
virtual void layout ()
virtual void enable ()
virtual void disable ()
virtual FXint getDefaultWidth ()
virtual FXint getDefaultHeight ()
FXint getNumItems () const
FXint getNumVisible () const
void setNumVisible (FXint nvis)
FXbool isItemCurrent (FXint index) const
virtual void setCurrentItem (FXint index, FXbool notify=FALSE)
FXint getCurrentItem () const
FXString getItem (FXint index) const
FXint setItem (FXint index, const FXString &text, FXIcon *icon=NULL, void *ptr=NULL)
FXint fillItems (const FXchar **strings, FXIcon *icon=NULL, void *ptr=NULL)
FXint fillItems (const FXString &strings, FXIcon *icon=NULL, void *ptr=NULL)
FXint insertItem (FXint index, const FXString &text, FXIcon *icon=NULL, void *ptr=NULL)
FXint appendItem (const FXString &text, FXIcon *icon=NULL, void *ptr=NULL)
FXint prependItem (const FXString &text, FXIcon *icon=NULL, void *ptr=NULL)
FXint moveItem (FXint newindex, FXint oldindex)
FXListItemextractItem (FXint index)
void removeItem (FXint index)
void clearItems ()
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
void setItemText (FXint index, const FXString &text)
FXString getItemText (FXint index) const
void setItemIcon (FXint index, FXIcon *icon, FXbool owned=FALSE)
FXIcongetItemIcon (FXint index) const
void setItemData (FXint index, void *ptr) const
void * getItemData (FXint index) const
FXbool isPaneShown () const
void sortItems ()
void setFont (FXFont *fnt)
FXFontgetFont () const
virtual void setBackColor (FXColor clr)
FXColor getBackColor () const
void setTextColor (FXColor clr)
FXColor getTextColor () const
void setSelBackColor (FXColor clr)
FXColor getSelBackColor () const
void setSelTextColor (FXColor clr)
FXColor getSelTextColor () const
FXListSortFunc getSortFunc () const
void setSortFunc (FXListSortFunc func)
void setHelpText (const FXString &txt)
const FXStringgetHelpText () const
void setTipText (const FXString &txt)
const FXStringgetTipText () const
virtual void save (FXStream &store) const
virtual void load (FXStream &store)
virtual ~FXListBox ()

Detailed Description

The List Box is a control to select one of a list of options.

It looks similar to a Combo Box except that List Box yields integer numbers only. When an option is selected, List Box will send an SEL_COMMAND with the index of the opton. While manipulating the list, it may send SEL_CHANGED messages to indicate which option the cursor is hovering over. The List Box is able to receive ID_GETINTVALUE and ID_SETINTVALUE which will retrieve the current option or change the selected option.

See also:


Constructor & Destructor Documentation

FX::FXListBox::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 
)

Constructor.

virtual FX::FXListBox::~FXListBox ( ) [virtual]

Destructor.


Member Function Documentation

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

Create server-side resources.

Reimplemented from FX::FXComposite.

Reimplemented in FX::FXDriveBox.

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

Detach server-side resources.

Reimplemented from FX::FXComposite.

Reimplemented in FX::FXDriveBox.

virtual void FX::FXListBox::destroy ( ) [virtual]

Destroy server-side resources.

Reimplemented from FX::FXComposite.

Reimplemented in FX::FXDriveBox.

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

Perform layout.

Reimplemented from FX::FXPacker.

virtual void FX::FXListBox::enable ( ) [virtual]

Enable drive box.

Reimplemented from FX::FXWindow.

virtual void FX::FXListBox::disable ( ) [virtual]

Disable drive box.

Reimplemented from FX::FXWindow.

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

Return default width.

Reimplemented from FX::FXPacker.

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

Return default height.

Reimplemented from FX::FXPacker.

Return the number of items in the list.

Return the number of visible items.

Set the number of visible items.

Return true if current item.

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

Set the current item (index is zero-based)

Get the current item's index.

Return the item at the given index.

FXint FX::FXListBox::setItem ( FXint  index,
const FXString text,
FXIcon icon = NULL,
void *  ptr = NULL 
)

Replace the item at index.

FXint FX::FXListBox::fillItems ( const FXchar **  strings,
FXIcon icon = NULL,
void *  ptr = NULL 
)

Fill list box by appending items from array of strings.

FXint FX::FXListBox::fillItems ( const FXString strings,
FXIcon icon = NULL,
void *  ptr = NULL 
)

Fill list box by appending items from newline separated strings.

FXint FX::FXListBox::insertItem ( FXint  index,
const FXString text,
FXIcon icon = NULL,
void *  ptr = NULL 
)

Insert a new item at index.

FXint FX::FXListBox::appendItem ( const FXString text,
FXIcon icon = NULL,
void *  ptr = NULL 
)

Add an item to the end of the list.

FXint FX::FXListBox::prependItem ( const FXString text,
FXIcon icon = NULL,
void *  ptr = NULL 
)

Prepend an item to the list.

FXint FX::FXListBox::moveItem ( FXint  newindex,
FXint  oldindex 
)

Move item from oldindex to newindex.

Extract item from list.

Remove this item from the list.

Remove all items from the list.

FXint FX::FXListBox::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::FXListBox::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.

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

Set text for specified item.

Get text for specified item.

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

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

Return icon of item at index.

void FX::FXListBox::setItemData ( FXint  index,
void *  ptr 
) const

Set data pointer for specified item.

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

Get data pointer for specified item.

Is the pane shown.

Sort items using current sort function.

void FX::FXListBox::setFont ( FXFont fnt)

Set text font.

Get text font.

virtual void FX::FXListBox::setBackColor ( FXColor  clr) [virtual]

Set window background color.

Reimplemented from FX::FXWindow.

Get background color.

Reimplemented from FX::FXWindow.

Change text color.

Return text color.

Change selected background color.

Return selected background color.

Change selected text color.

Return selected text color.

Return sort function.

Change sort function.

void FX::FXListBox::setHelpText ( const FXString txt)

Set the combobox help text.

Get the combobox help text.

void FX::FXListBox::setTipText ( const FXString txt)

Set the tool tip message for this combobox.

Get the tool tip message for this combobox.

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

Save combobox to a stream.

Reimplemented from FX::FXPacker.

Reimplemented in FX::FXDriveBox.

virtual void FX::FXListBox::load ( FXStream store) [virtual]

Load combobox from a stream.

Reimplemented from FX::FXPacker.

Reimplemented in FX::FXDriveBox.

Copyright © 1997-2005 Jeroen van der Zijp