class MASKING_DLL_DECLSPEC ListView

An internal helper widget for the ListBox.

Inheritance:

ListView - Widget - Rect

Public Methods

int TotalItems()

Returns the number of items in the list

int VisibleItems()

Returns the number of items the list can display on one screen

bool Selected(int i)

Tests if item i is selected or not

void Select(int i)

Selects item i.

void Deselect(int i)

Deselects item i

int Selection()

Returns the index of the firs selected item in the list, 0 if none are selected

void ScrollToSelection()

Attempts to scroll the list to the first selected item

int Focus()

Returns the index of the focused item.

void SetFocus(int i)

Moves focus to item i.

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

Inserts a new item to the list at index i

ListItem* GetItem(int i)

Returns a pointer to the item with index i

ListItem* GetFocusedItem()

Returns a pointer to the focused item.

ListItem* GetSelectedItem()

Returns a pointer to the first selected item in the list.

void DeleteItem(int i)

Deletes item i from the list

void DeleteAllItems()

Clears the list

int Offset()

Returns how far the list has scrolled

void Sort()

Sorts the list in ascending order according to the list item text regardless of case

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

Sorts the list by using the given comparison function.

bool GetSingleClick()

Returns whether the list is in single click mode or not

void SetSingleClick(bool single=false)

Sets the single click mode for the list on or off

Protected Fields

std::vector<ListItem *> items

The actual list (vector actually) of list items

int offset

Stores how far the list has scrolled

int focus

The index of the item with the focus (the item under the mouse)

bool multiSelect

True when the list is in multiselect mode.

bool singleClick

If true then the listbox responds to single clicks on the list as activation

Protected Methods

void MsgInitSkin()

Initilizes the list view with the default bitmaps, fonts and font colours as defined by the skin

void Draw(Bitmap &canvas)

Draws the list view by drawing all the list items

bool MsgWantfocus()

A list view takes focus so this function returns true

bool MsgChar(int c)

Handles keyboard input.

void MsgLPress()

Handles mouse input.

void MsgLRelease()

Issues a MsgDClick() in case the singleClick flag is set

void MsgDClick()

Sends MSG_ACTIVATE to the parent dialog

void MsgMousemove(const Point& d)

Makes sure the focus follows the mouse

void DeselectAllItems()

A helper function for deselecting all items

int FindMouseItem()

Returns the index of the item the mouse is on top of.

Documentation

An internal helper widget for the ListBox.

This is the core of a ListBox. It contains a list of list items, it provides an inteface for working with this list, it draws the background and the items and it handles mouse clicks, mouse moves and keyboard input.

std::vector<ListItem *> items

The actual list (vector actually) of list items

int offset

Stores how far the list has scrolled

int focus

The index of the item with the focus (the item under the mouse)

bool multiSelect

True when the list is in multiselect mode. In this mode more than one item can be selected at once while in normal mode only one can be selected.

bool singleClick

If true then the listbox responds to single clicks on the list as activation

void MsgInitSkin()

Initilizes the list view with the default bitmaps, fonts and font colours as defined by the skin

void Draw(Bitmap &canvas)

Draws the list view by drawing all the list items

bool MsgWantfocus()

A list view takes focus so this function returns true

bool MsgChar(int c)

Handles keyboard input. The list can be navigated with the cursor keys, home, end, page up and page down. In multiselect mode items can be selected and deselected with spacebar. If enter is pressed (or space in normal mode) the list sends MSG_ACTIVATE to the parent dialog.

void MsgLPress()

Handles mouse input. Whenever the left mouse button is pressed the item with the mouse is either selected (normal mode) or toggled (multiselect mode).

void MsgLRelease()

Issues a MsgDClick() in case the singleClick flag is set

void MsgDClick()

Sends MSG_ACTIVATE to the parent dialog

void MsgMousemove(const Point& d)

Makes sure the focus follows the mouse

void DeselectAllItems()

A helper function for deselecting all items

int FindMouseItem()

Returns the index of the item the mouse is on top of. If no item is found this function returns -1.

int TotalItems()

Returns the number of items in the list

int VisibleItems()

Returns the number of items the list can display on one screen

bool Selected(int i)

Tests if item i is selected or not

void Select(int i)

Selects item i. If multiselect mode is off this will first deselect the previously selected item.

void Deselect(int i)

Deselects item i

int Selection()

Returns the index of the firs selected item in the list, 0 if none are selected

void ScrollToSelection()

Attempts to scroll the list to the first selected item

int Focus()

Returns the index of the focused item. In normal mode focused and selected items are one and the same.

void SetFocus(int i)

Moves focus to item i. In normal mode this also selects item i.

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

Inserts a new item to the list at index i

ListItem* GetItem(int i)

Returns a pointer to the item with index i

ListItem* GetFocusedItem()

Returns a pointer to the focused item. If no item has focus it returns NULL!

ListItem* GetSelectedItem()

Returns a pointer to the first selected item in the list. In normal mode this is the same as the focused item. If no item is selected it returns NULL!

void DeleteItem(int i)

Deletes item i from the list

void DeleteAllItems()

Clears the list

int Offset()

Returns how far the list has scrolled

void Sort()

Sorts the list in ascending order according to the list item text regardless of case

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

Sorts the list by using the given comparison function. The function should compare two items and return true if the first item is smaller than the second one.

bool GetSingleClick()

Returns whether the list is in single click mode or not

void SetSingleClick(bool single=false)

Sets the single click mode for the list on or off

This class has no child classes.

Friends:

class MASKING_DLL_DECLSPEC ListBox

See Also:

ListItem, ListBox

Alphabetic index Hierarchy of classes