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

FX::FXComboBox Class Reference

#include <FXComboBox.h>

Inheritance diagram for FX::FXComboBox:
FX::FXPacker FX::FXComposite FX::FXWindow FX::FXDrawable FX::FXId FX::FXObject

List of all members.

Public Member Functions

 FXComboBox (FXComposite *p, FXint cols, FXObject *tgt=NULL, FXSelector sel=0, FXuint opts=COMBOBOX_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 enable ()
virtual void disable ()
virtual FXint getDefaultWidth ()
virtual FXint getDefaultHeight ()
virtual void layout ()
FXbool isEditable () const
void setEditable (FXbool edit=TRUE)
void setText (const FXString &text)
FXString getText () const
void setNumColumns (FXint cols)
FXint getNumColumns () const
void setJustify (FXuint mode)
FXuint getJustify () const
FXint getNumItems () const
FXint getNumVisible () const
void setNumVisible (FXint nvis)
FXbool isItemCurrent (FXint index) const
void setCurrentItem (FXint index, FXbool notify=FALSE)
FXint getCurrentItem () const
FXString getItem (FXint index) const
FXint setItem (FXint index, const FXString &text, void *ptr=NULL)
FXint fillItems (const FXchar **strings)
FXint fillItems (const FXString &strings)
FXint insertItem (FXint index, const FXString &text, void *ptr=NULL)
FXint appendItem (const FXString &text, void *ptr=NULL)
FXint prependItem (const FXString &text, void *ptr=NULL)
FXint moveItem (FXint newindex, FXint oldindex)
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 setItemData (FXint index, void *ptr) const
void * getItemData (FXint index) const
FXbool isPaneShown () const
void sortItems ()
void setFont (FXFont *fnt)
FXFontgetFont () const
void setComboStyle (FXuint mode)
FXuint getComboStyle () 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 ~FXComboBox ()

Detailed Description

A Combo Box provides a way to select a string from a list of strings.

Unless COMBOBOX_STATIC is passed, it also allows the user to enter a new string into the text field, for example if the desired entry is not in the list of strings. Passing COMBOBOX_REPLACE, COMBOBOX_INSERT_BEFORE, COMBOBOX_INSERT_AFTER, COMBOBOX_INSERT_FIRST, or COMBOBOX_INSERT_LAST causes a newly entered text to replace the current one in the list, or be added before or after the current entry, or to be added at the beginning or end of the list. Combo Box is intended to enter text; if you need to enter a choice from a list of options, it is recommended that the List Box widget is used instead. When the text in the field is changed, a SEL_COMMAND will be send to the target. The Combo Box can also receive ID_GETSTRINGVALUE and ID_SETSTRINGVALUE and so on, which will behave similar to Text Field in that they will retrieve or update the value of the field.

See also:


Constructor & Destructor Documentation

FX::FXComboBox::FXComboBox ( FXComposite p,
FXint  cols,
FXObject tgt = NULL,
FXSelector  sel = 0,
FXuint  opts = COMBOBOX_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 
)

Construct a Combo Box widget with room to display cols columns of text.

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

Destructor.


Member Function Documentation

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

Create server-side resources.

Reimplemented from FX::FXComposite.

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

Detach server-side resources.

Reimplemented from FX::FXComposite.

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

Destroy server-side resources.

Reimplemented from FX::FXComposite.

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

Enable combo box.

Reimplemented from FX::FXWindow.

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

Disable combo box.

Reimplemented from FX::FXWindow.

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

Return default width.

Reimplemented from FX::FXPacker.

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

Return default height.

Reimplemented from FX::FXPacker.

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

Perform layout.

Reimplemented from FX::FXPacker.

Return true if combobox is editable.

void FX::FXComboBox::setEditable ( FXbool  edit = TRUE)

Set editable state.

void FX::FXComboBox::setText ( const FXString text)

Set the text.

Get the text.

Set the number of columns.

Get the number of columns.

Change text justification mode; default is JUSTIFY_LEFT.

Return text justification mode.

Return the number of items in the list.

Return the number of visible items.

Set the number of visible items in the drop down list.

Return true if current item.

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

Set the current item (index is zero-based)

Get the current item's index.

Return the item at the given index.

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

Replace the item at index.

FXint FX::FXComboBox::fillItems ( const FXchar **  strings)

Fill combo box by appending items from array of strings.

Fill combo box by appending items from newline separated strings.

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

Insert a new item at index.

FXint FX::FXComboBox::appendItem ( const FXString text,
void *  ptr = NULL 
)

Append an item to the list.

FXint FX::FXComboBox::prependItem ( const FXString text,
void *  ptr = NULL 
)

Prepend an item to the list.

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

Move item from oldindex to newindex.

Remove this item from the list.

Remove all items from the list.

FXint FX::FXComboBox::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::FXComboBox::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::FXComboBox::setItemText ( FXint  index,
const FXString text 
)

Set text for specified item.

Get text for specified item.

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

Set data pointer for specified item.

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

Get data pointer for specified item.

Is the pane shown.

Sort items using current sort function.

Set text font.

Get text font.

Set the combobox style.

Get the combobox style.

virtual void FX::FXComboBox::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::FXComboBox::setHelpText ( const FXString txt)

Set the combobox help text.

Get the combobox help text.

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

Set the tool tip message for this combobox.

Get the tool tip message for this combobox.

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

Save combobox to a stream.

Reimplemented from FX::FXPacker.

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

Load combobox from a stream.

Reimplemented from FX::FXPacker.

Copyright © 1997-2005 Jeroen van der Zijp