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

Public Member Functions | List of all 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

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)
 
FXListItem * extractItem (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)
 
FXIcon * getItemIcon (FXint index) const
 
void setItemData (FXint index, void *ptr) const
 
void * getItemData (FXint index) const
 
FXbool isPaneShown () const
 
void sortItems ()
 
void setFont (FXFont *fnt)
 
FXFont * getFont () 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 FXString & getHelpText () const
 
void setTipText (const FXString &txt)
 
const FXString & getTipText () const
 
virtual void save (FXStream &store) const
 
virtual void load (FXStream &store)
 
virtual ~FXListBox ()
 
- Public Member Functions inherited from FX::FXPacker
 FXPacker (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0, FXint pl=DEFAULT_SPACING, FXint pr=DEFAULT_SPACING, FXint pt=DEFAULT_SPACING, FXint pb=DEFAULT_SPACING, FXint hs=DEFAULT_SPACING, FXint vs=DEFAULT_SPACING)
 
void setFrameStyle (FXuint style)
 
FXuint getFrameStyle () const
 
void setPackingHints (FXuint ph)
 
FXuint getPackingHints () const
 
FXint getBorderWidth () const
 
void setPadTop (FXint pt)
 
FXint getPadTop () const
 
void setPadBottom (FXint pb)
 
FXint getPadBottom () const
 
void setPadLeft (FXint pl)
 
FXint getPadLeft () const
 
void setPadRight (FXint pr)
 
FXint getPadRight () const
 
void setHiliteColor (FXColor clr)
 
FXColor getHiliteColor () const
 
void setShadowColor (FXColor clr)
 
FXColor getShadowColor () const
 
void setBorderColor (FXColor clr)
 
FXColor getBorderColor () const
 
void setBaseColor (FXColor clr)
 
FXColor getBaseColor () const
 
void setHSpacing (FXint hs)
 
FXint getHSpacing () const
 
void setVSpacing (FXint vs)
 
FXint getVSpacing () const
 
- Public Member Functions inherited from FX::FXComposite
 FXComposite (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
 
FXint maxChildWidth () const
 
FXint maxChildHeight () const
 
virtual bool isComposite () const
 
virtual ~FXComposite ()
 
- Public Member Functions inherited from FX::FXWindow
 FXWindow (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
 
FXWindow * getParent () const
 
FXWindow * getOwner () const
 
FXWindow * getShell () const
 
FXWindow * getRoot () const
 
FXWindow * getNext () const
 
FXWindow * getPrev () const
 
FXWindow * getFirst () const
 
FXWindow * getLast () const
 
FXWindow * getFocus () const
 
void setKey (FXuint k)
 
FXuint getKey () const
 
void setTarget (FXObject *t)
 
FXObject * getTarget () const
 
void setSelector (FXSelector sel)
 
FXSelector getSelector () const
 
FXint getX () const
 
FXint getY () const
 
virtual FXint getWidthForHeight (FXint givenheight)
 
virtual FXint getHeightForWidth (FXint givenwidth)
 
void setX (FXint x)
 
void setY (FXint y)
 
void setWidth (FXint w)
 
void setHeight (FXint h)
 
void setLayoutHints (FXuint lout)
 
FXuint getLayoutHints () const
 
FXAccelTable * getAccelTable () const
 
void setAccelTable (FXAccelTable *acceltable)
 
void addHotKey (FXHotKey code)
 
void remHotKey (FXHotKey code)
 
void setHelpTag (const FXString &text)
 
const FXString & getHelpTag () const
 
bool isShell () const
 
bool isOwnerOf (const FXWindow *window) const
 
bool isChildOf (const FXWindow *window) const
 
bool containsChild (const FXWindow *child) const
 
FXWindow * getChildAt (FXint x, FXint y) const
 
FXint numChildren () const
 
FXint indexOfChild (const FXWindow *window) const
 
FXWindow * childAtIndex (FXint index) const
 
FXComposeContext * getComposeContext () const
 
void createComposeContext ()
 
void destroyComposeContext ()
 
void setDefaultCursor (FXCursor *cur)
 
FXCursor * getDefaultCursor () const
 
void setDragCursor (FXCursor *cur)
 
FXCursor * getDragCursor () const
 
FXint getCursorPosition (FXint &x, FXint &y, FXuint &buttons) const
 
FXint setCursorPosition (FXint x, FXint y)
 
bool isEnabled () const
 
bool isActive () const
 
virtual bool canFocus () const
 
bool hasFocus () const
 
bool inFocusChain () const
 
virtual void setFocus ()
 
virtual void killFocus ()
 
virtual void changeFocus (FXWindow *child)
 
virtual void setDefault (FXbool enable=TRUE)
 
bool isDefault () const
 
void setInitial (bool enable=true)
 
bool isInitial () const
 
virtual void attach (FXID w)
 
virtual void setShape (const FXRegion &region)
 
virtual void setShape (FXBitmap *bitmap)
 
virtual void setShape (FXIcon *icon)
 
virtual void clearShape ()
 
virtual void raise ()
 
virtual void lower ()
 
virtual void move (FXint x, FXint y)
 
virtual void resize (FXint w, FXint h)
 
virtual void position (FXint x, FXint y, FXint w, FXint h)
 
virtual void recalc ()
 
void forceRefresh ()
 
virtual void reparent (FXWindow *father, FXWindow *other=NULL)
 
void scroll (FXint x, FXint y, FXint w, FXint h, FXint dx, FXint dy) const
 
void update (FXint x, FXint y, FXint w, FXint h) const
 
void update () const
 
void repaint (FXint x, FXint y, FXint w, FXint h) const
 
void repaint () const
 
void grab ()
 
void ungrab ()
 
bool grabbed () const
 
void grabKeyboard ()
 
void ungrabKeyboard ()
 
bool grabbedKeyboard () const
 
virtual void show ()
 
virtual void hide ()
 
bool shown () const
 
bool underCursor () const
 
bool hasSelection () const
 
bool acquireSelection (const FXDragType *types, FXuint numtypes)
 
bool releaseSelection ()
 
bool hasClipboard () const
 
bool acquireClipboard (const FXDragType *types, FXuint numtypes)
 
bool releaseClipboard ()
 
virtual void dropEnable ()
 
virtual void dropDisable ()
 
bool isDropEnabled () const
 
bool isDragging () const
 
bool beginDrag (const FXDragType *types, FXuint numtypes)
 
bool handleDrag (FXint x, FXint y, FXDragAction action=DRAG_COPY)
 
FXDragAction endDrag (bool drop=true)
 
bool isDropTarget () const
 
void setDragRectangle (FXint x, FXint y, FXint w, FXint h, bool wantupdates=true) const
 
void clearDragRectangle () const
 
void acceptDrop (FXDragAction action=DRAG_ACCEPT) const
 
FXDragAction didAccept () const
 
void dropFinished (FXDragAction action=DRAG_REJECT) const
 
bool inquireDNDTypes (FXDNDOrigin origin, FXDragType *&types, FXuint &numtypes) const
 
bool offeredDNDType (FXDNDOrigin origin, FXDragType type) const
 
FXDragAction inquireDNDAction () const
 
bool setDNDData (FXDNDOrigin origin, FXDragType type, FXuchar *data, FXuint size) const
 
bool setDNDData (FXDNDOrigin origin, FXDragType type, const FXString &string) const
 
bool getDNDData (FXDNDOrigin origin, FXDragType type, FXuchar *&data, FXuint &size) const
 
bool getDNDData (FXDNDOrigin origin, FXDragType type, FXString &string) const
 
virtual bool contains (FXint parentx, FXint parenty) const
 
void translateCoordinatesFrom (FXint &tox, FXint &toy, const FXWindow *fromwindow, FXint fromx, FXint fromy) const
 
void translateCoordinatesTo (FXint &tox, FXint &toy, const FXWindow *towindow, FXint fromx, FXint fromy) const
 
FXColor getBackColor () const
 
virtual bool doesSaveUnder () const
 
virtual const FXchar * tr (const FXchar *message, const FXchar *hint=NULL) const
 
virtual ~FXWindow ()
 
- Public Member Functions inherited from FX::FXDrawable
FXint getWidth () const
 
FXint getHeight () const
 
FXVisual * getVisual () const
 
void setVisual (FXVisual *vis)
 
virtual ~FXDrawable ()
 
- Public Member Functions inherited from FX::FXId
FXApp * getApp () const
 
FXID id () const
 
void setUserData (void *ptr)
 
void * getUserData () const
 
virtual ~FXId ()
 
- Public Member Functions inherited from FX::FXObject
virtual long onDefault (FXObject *, FXSelector, void *)
 
const FXchar * getClassName () const
 
bool isMemberOf (const FXMetaClass *metaclass) const
 
virtual long tryHandle (FXObject *sender, FXSelector sel, void *ptr)
 
virtual ~FXObject ()
 

Additional Inherited Members

- Public Types inherited from FX::FXWindow
enum  {
  ID_NONE,
  ID_HIDE,
  ID_SHOW,
  ID_TOGGLESHOWN,
  ID_LOWER,
  ID_RAISE,
  ID_DELETE,
  ID_DISABLE,
  ID_ENABLE,
  ID_TOGGLEENABLED,
  ID_UNCHECK,
  ID_CHECK,
  ID_UNKNOWN,
  ID_UPDATE,
  ID_AUTOSCROLL,
  ID_TIPTIMER,
  ID_HSCROLLED,
  ID_VSCROLLED,
  ID_SETVALUE,
  ID_SETINTVALUE,
  ID_SETREALVALUE,
  ID_SETSTRINGVALUE,
  ID_SETICONVALUE,
  ID_SETINTRANGE,
  ID_SETREALRANGE,
  ID_GETINTVALUE,
  ID_GETREALVALUE,
  ID_GETSTRINGVALUE,
  ID_GETICONVALUE,
  ID_GETINTRANGE,
  ID_GETREALRANGE,
  ID_SETHELPSTRING,
  ID_GETHELPSTRING,
  ID_SETTIPSTRING,
  ID_GETTIPSTRING,
  ID_QUERY_MENU,
  ID_HOTKEY,
  ID_ACCEL,
  ID_UNPOST,
  ID_POST,
  ID_MDI_TILEHORIZONTAL,
  ID_MDI_TILEVERTICAL,
  ID_MDI_CASCADE,
  ID_MDI_MAXIMIZE,
  ID_MDI_MINIMIZE,
  ID_MDI_RESTORE,
  ID_MDI_CLOSE,
  ID_MDI_WINDOW,
  ID_MDI_MENUWINDOW,
  ID_MDI_MENUMINIMIZE,
  ID_MDI_MENURESTORE,
  ID_MDI_MENUCLOSE,
  ID_MDI_NEXT,
  ID_MDI_PREV,
  ID_LAST
}
 
- Static Public Member Functions inherited from FX::FXWindow
static FXWindow * commonAncestor (FXWindow *a, FXWindow *b)
 
static bool before (const FXWindow *a, const FXWindow *b)
 
static bool after (const FXWindow *a, const FXWindow *b)
 
- Static Public Attributes inherited from FX::FXWindow
static FXDragType octetType
 
static FXDragType deleteType
 
static FXDragType textType
 
static FXDragType utf8Type
 
static FXDragType utf16Type
 
static FXDragType colorType
 
static FXDragType urilistType
 
static const FXDragType stringType
 
static const FXDragType imageType
 
static const FXchar octetTypeName []
 
static const FXchar deleteTypeName []
 
static const FXchar textTypeName []
 
static const FXchar colorTypeName []
 
static const FXchar urilistTypeName []
 
static const FXchar utf8TypeName []
 
static const FXchar utf16TypeName []
 

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.

FXint FX::FXListBox::getNumItems ( ) const

Return the number of items in the list.

FXint FX::FXListBox::getNumVisible ( ) const

Return the number of visible items.

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

Set the number of visible items.

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

Return true if current item.

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

Set the current item (index is zero-based)

FXint FX::FXListBox::getCurrentItem ( ) const

Get the current item's index.

FXString FX::FXListBox::getItem ( FXint  index) const

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.

FXListItem* FX::FXListBox::extractItem ( FXint  index)

Extract item from list.

void FX::FXListBox::removeItem ( FXint  index)

Remove this item from the list.

void FX::FXListBox::clearItems ( )

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.

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

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.

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

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.

FXbool FX::FXListBox::isPaneShown ( ) const

Is the pane shown.

void FX::FXListBox::sortItems ( )

Sort items using current sort function.

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

Set text font.

FXFont* FX::FXListBox::getFont ( ) const

Get text font.

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

Set window background color.

Reimplemented from FX::FXWindow.

FXColor FX::FXListBox::getBackColor ( ) const

Get background color.

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

Change text color.

FXColor FX::FXListBox::getTextColor ( ) const

Return text color.

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

Change selected background color.

FXColor FX::FXListBox::getSelBackColor ( ) const

Return selected background color.

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

Change selected text color.

FXColor FX::FXListBox::getSelTextColor ( ) const

Return selected text color.

FXListSortFunc FX::FXListBox::getSortFunc ( ) const

Return sort function.

void FX::FXListBox::setSortFunc ( FXListSortFunc  func)

Change sort function.

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

Set the combobox help text.

const FXString& FX::FXListBox::getHelpText ( ) const

Get the combobox help text.

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

Set the tool tip message for this combobox.

const FXString& FX::FXListBox::getTipText ( ) const

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