class MASKING_DLL_DECLSPEC ListBox

The ListBox widget.

Inheritance:

ListBox - CompoundWidget - Dialog - Widget - Rect

Public Methods

void HandleEvent(Widget& obj, int msg, int arg1=0, int arg2=0)

ListBox event handler.

void SetMultiSelect(bool m)

Selects either the multiselect or normal mode.

int Size()

Returns the number of items in the list

bool Selected(int i)

void Select(int i)

void Deselect(int i)

int Selection()

void ScrollToSelection()

int Focus()

void SetFocus(int i)

void InsertItem(ListItem* item, int i=0)

ListItem* GetItem(int i)

ListItem* GetFocusedItem()

ListItem* GetSelectedItem()

void DeleteItem(int i)

void DeleteAllItems()

void Sort()

bool GetSingleClick()

void SetSingleClick(bool single=false)

void Sort(bool (*cmp)(const ListItem* , const ListItem* ))

These a are basically just wrappers for functions with the same names in ListView

Protected Fields

Panel box

The underlaying panel widget

Scroller vScroller

The underlaying vertical scroller used to scroll the main list view

ListView* list

The underlaying ListView object

Protected Methods

void MsgInitSkin()

Initializes the widget with the default bitmaps, fonts and colours

void UpdateSize()

Updates the size and position of the underlaying widgets when the listbox itself is resized

Documentation

The ListBox widget. A ListBox is a widget for displaying lists of items. If there are too many items to display they can be scrolled vertically. The ListBox can operate in two modes: in normal mode only one item can be selected at any time and in multiselect mode more than one item can be selected. Every time the selection (or focus) changes the ListBox sends MSG_SCROLL to the parent dialog with the index of the focus item as the first argument and when an item is clicked or space or enter is pressed it sends MSG_ACTIVATE with the index of the selected item as the first argument.

Note: deprectated in favour of ListBoxEx.

Panel box

The underlaying panel widget

Scroller vScroller

The underlaying vertical scroller used to scroll the main list view

ListView* list

The underlaying ListView object

void MsgInitSkin()

Initializes the widget with the default bitmaps, fonts and colours

void UpdateSize()

Updates the size and position of the underlaying widgets when the listbox itself is resized

void HandleEvent(Widget& obj, int msg, int arg1=0, int arg2=0)

ListBox event handler. Handles events such as scrollbar scrolls and clicks in the list view.

void SetMultiSelect(bool m)

Selects either the multiselect or normal mode. In multiselect mode more than one item can be selected at once while in normal mode only one can be selected. Default is normal mode.

int Size()

Returns the number of items in the list

bool Selected(int i)

void Select(int i)

void Deselect(int i)

int Selection()

void ScrollToSelection()

int Focus()

void SetFocus(int i)

void InsertItem(ListItem* item, int i=0)

ListItem* GetItem(int i)

ListItem* GetFocusedItem()

ListItem* GetSelectedItem()

void DeleteItem(int i)

void DeleteAllItems()

void Sort()

bool GetSingleClick()

void SetSingleClick(bool single=false)

void Sort(bool (*cmp)(const ListItem* , const ListItem* ))

These a are basically just wrappers for functions with the same names in ListView

This class has no child classes.

Friends:

class MASKING_DLL_DECLSPEC ComboBox

See Also:

ListItem, ListItemString, ListView

Alphabetic index Hierarchy of classes