![]() |
Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members
![]() |
#include <FXComboBox.h>
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:
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 |
Destructor.
|
virtual |
Create server-side resources.
Reimplemented from FX::FXComposite.
|
virtual |
Detach server-side resources.
Reimplemented from FX::FXComposite.
|
virtual |
Destroy server-side resources.
Reimplemented from FX::FXComposite.
|
virtual |
Enable combo box.
Reimplemented from FX::FXWindow.
|
virtual |
Disable combo box.
Reimplemented from FX::FXWindow.
|
virtual |
Return default width.
Reimplemented from FX::FXPacker.
|
virtual |
Return default height.
Reimplemented from FX::FXPacker.
|
virtual |
Perform layout.
Reimplemented from FX::FXPacker.
FXbool FX::FXComboBox::isEditable | ( | ) | const |
Return true if combobox is editable.
void FX::FXComboBox::setText | ( | const FXString & | text | ) |
Set the text.
FXString FX::FXComboBox::getText | ( | ) | const |
Get the text.
void FX::FXComboBox::setNumColumns | ( | FXint | cols | ) |
Set the number of columns.
FXint FX::FXComboBox::getNumColumns | ( | ) | const |
Get the number of columns.
void FX::FXComboBox::setJustify | ( | FXuint | mode | ) |
Change text justification mode; default is JUSTIFY_LEFT.
FXuint FX::FXComboBox::getJustify | ( | ) | const |
Return text justification mode.
FXint FX::FXComboBox::getNumItems | ( | ) | const |
Return the number of items in the list.
FXint FX::FXComboBox::getNumVisible | ( | ) | const |
Return the number of visible items.
void FX::FXComboBox::setNumVisible | ( | FXint | nvis | ) |
Set the number of visible items in the drop down list.
Set the current item (index is zero-based)
FXint FX::FXComboBox::getCurrentItem | ( | ) | const |
Get the current item's index.
Replace the item at index.
Fill combo box by appending items from array of strings.
Fill combo box by appending items from newline separated strings.
Insert a new item at index.
Append an item to the list.
Prepend an item to the list.
Move item from oldindex to newindex.
void FX::FXComboBox::removeItem | ( | FXint | index | ) |
Remove this item from the list.
void FX::FXComboBox::clearItems | ( | ) |
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.
Set 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.
FXbool FX::FXComboBox::isPaneShown | ( | ) | const |
Is the pane shown.
void FX::FXComboBox::sortItems | ( | ) |
Sort items using current sort function.
void FX::FXComboBox::setFont | ( | FXFont * | fnt | ) |
Set text font.
FXFont* FX::FXComboBox::getFont | ( | ) | const |
Get text font.
void FX::FXComboBox::setComboStyle | ( | FXuint | mode | ) |
Set the combobox style.
FXuint FX::FXComboBox::getComboStyle | ( | ) | const |
Get the combobox style.
|
virtual |
Set window background color.
Reimplemented from FX::FXWindow.
FXColor FX::FXComboBox::getBackColor | ( | ) | const |
Get background color.
void FX::FXComboBox::setTextColor | ( | FXColor | clr | ) |
Change text color.
FXColor FX::FXComboBox::getTextColor | ( | ) | const |
Return text color.
void FX::FXComboBox::setSelBackColor | ( | FXColor | clr | ) |
Change selected background color.
FXColor FX::FXComboBox::getSelBackColor | ( | ) | const |
Return selected background color.
void FX::FXComboBox::setSelTextColor | ( | FXColor | clr | ) |
Change selected text color.
FXColor FX::FXComboBox::getSelTextColor | ( | ) | const |
Return selected text color.
FXListSortFunc FX::FXComboBox::getSortFunc | ( | ) | const |
Return sort function.
void FX::FXComboBox::setSortFunc | ( | FXListSortFunc | func | ) |
Change sort function.
void FX::FXComboBox::setHelpText | ( | const FXString & | txt | ) |
Set the combobox help text.
const FXString& FX::FXComboBox::getHelpText | ( | ) | const |
Get the combobox help text.
void FX::FXComboBox::setTipText | ( | const FXString & | txt | ) |
Set the tool tip message for this combobox.
const FXString& FX::FXComboBox::getTipText | ( | ) | const |
Get the tool tip message for this combobox.
|
virtual |
Save combobox to a stream.
Reimplemented from FX::FXPacker.
|
virtual |
Load combobox from a stream.
Reimplemented from FX::FXPacker.
![]() |