The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page

VCF::ListControl Class Reference

A base class that provides a consistent interface and implementation for any control class that deals with a list of data held in a ListModel and a collection of ListItems. More...

#include <vcf/ApplicationKit/ListControl.h>

Inheritance diagram for VCF::ListControl:

List of all members.

Public Member Functions
	ListControl ()
ListModel *	getListModel ()
void	setListModel (ListModel *model)
ImageList *	getSmallImageList ()
ImageList *	getLargeImageList ()
ImageList *	getStateImageList ()
virtual void	setLargeImageList (ImageList *imageList)
virtual void	setSmallImageList (ImageList *imageList)
virtual void	setStateImageList (ImageList *imageList)
ListItem *	addItem (const String &caption, const uint32 imageIndex=0)
ListItem *	insertItem (const uint32 &index, const String &caption, const uint32 imageIndex=0)
bool	itemExists (const uint32 &index)
ListItem *	getItem (const uint32 &index)
void	setItem (const uint32 &index, ListItem *item)
virtual Rect	getItemImageRect (const uint32 &index)
virtual void	selectItem (const uint32 &index)
virtual Enumerator< uint32 > *	getSelectedItemsByIndex ()
virtual void	rangeSelect (const Rect &selectionRect)
virtual uint32	getFocusedItem ()
virtual uint32	getSelectedItem ()
virtual bool	allowsMultiSelect ()
virtual void	setAllowsMultiSelect (const bool &allowsMultiSelect)
void	sort (ItemSort *itemSortFunctor)
virtual uint32	hitTest (const Point &point)
virtual Rect	getItemRect (ListItem *item)
virtual void	insertItemSubItem (ListItem *item, const uint32 &index, ListSubItem *subItem)
virtual void	removeItemSubItem (ListItem *item, ListSubItem *subItem)
virtual bool	getItemSubItems (ListItem *item, std::vector< ListSubItem * > &subItems)
virtual ListSubItem *	getItemSubItem (ListItem *item, const uint32 &index)
virtual uint32	getItemSubItemIndex (ListItem *item, ListSubItem *subItem)
virtual uint32	getItemSubItemCount (ListItem *item)
virtual void	itemSelected (ListItem *item)
virtual void	modelChanged (Model *oldModel, Model *newModel)
virtual void	handleEvent (Event *event)
	This gets called by the ControlPeer for any windowing system mouse events, as well as for any windowing system keyboard events and for any windowing system events like size changes, position changes, etc.
virtual void	paintItem (GraphicsContext *ctx, const Rect &itemRect, const uint32 &index, const DrawUIState &state)
Public Attributes
VCF::Delegate	ItemDelegate
	ItemSelectionChanged
Protected Member Functions
virtual void	onItemAdded (ListModelEvent *event)
virtual void	onItemDeleted (ListModelEvent *event)
virtual void	removeSubItemsForItem (ListItem *item)
Protected Attributes
ImageList *	smallImageList_
ImageList *	largeImageList_
ImageList *	stateImageList_
ListItem *	selectedItem_
Array< ListItem * >	items_
ListPeer *	listPeer_
bool	internalModelChange_
bool	inCallbackChange_

---

Detailed Description

A base class that provides a consistent interface and implementation for any control class that deals with a list of data held in a ListModel and a collection of ListItems.

See also:

ListModel

ListItem

ListController

---

Constructor & Destructor Documentation

VCF::ListControl::ListControl (   )

---

Member Function Documentation

ListItem* VCF::ListControl::addItem (  const String &  caption, const uint32  imageIndex = 0 )

Reimplemented in VCF::ListViewControl.

virtual bool VCF::ListControl::allowsMultiSelect (   )  [virtual]

Reimplemented in VCF::ListBoxControl.

virtual uint32 VCF::ListControl::getFocusedItem (   )  [virtual]

Reimplemented in VCF::ListBoxControl.

ListItem* VCF::ListControl::getItem (  const uint32 &  index  )

Reimplemented in VCF::ListViewControl.

virtual Rect VCF::ListControl::getItemImageRect (  const uint32 &  index  )  [virtual]

Reimplemented in VCF::ListBoxControl.

virtual Rect VCF::ListControl::getItemRect (  ListItem *  item  )  [virtual]

Implements VCF::ListController. Reimplemented in VCF::ListBoxControl.

virtual ListSubItem* VCF::ListControl::getItemSubItem (  ListItem *  item, const uint32 &  index )  [inline, virtual]

Implements VCF::ListController. Reimplemented in VCF::ListViewControl.

virtual uint32 VCF::ListControl::getItemSubItemCount (  ListItem *  item  )  [inline, virtual]

Implements VCF::ListController. Reimplemented in VCF::ListViewControl.

virtual uint32 VCF::ListControl::getItemSubItemIndex (  ListItem *  item, ListSubItem *  subItem )  [inline, virtual]

Implements VCF::ListController. Reimplemented in VCF::ListViewControl.

virtual bool VCF::ListControl::getItemSubItems (  ListItem *  item, std::vector< ListSubItem * > &  subItems )  [inline, virtual]

Implements VCF::ListController. Reimplemented in VCF::ListViewControl.

ImageList* VCF::ListControl::getLargeImageList (   )  [inline]

ListModel* VCF::ListControl::getListModel (   )

virtual uint32 VCF::ListControl::getSelectedItem (   )  [virtual]

Reimplemented in VCF::ListBoxControl.

virtual Enumerator<uint32>* VCF::ListControl::getSelectedItemsByIndex (   )  [virtual]

Reimplemented in VCF::ListBoxControl.

ImageList* VCF::ListControl::getSmallImageList (   )  [inline]

ImageList* VCF::ListControl::getStateImageList (   )  [inline]

Reimplemented in VCF::ListViewControl.

virtual void VCF::ListControl::handleEvent (  Event *  event  )  [virtual]

This gets called by the ControlPeer for any windowing system mouse events, as well as for any windowing system keyboard events and for any windowing system events like size changes, position changes, etc. Once inside the event the Control determines the type, and behaves accordingly, as well as notifying any appropriate listeners. Reimplemented from VCF::Control. Reimplemented in VCF::ListBoxControl, and VCF::ListViewControl.

virtual uint32 VCF::ListControl::hitTest (  const Point &  point  )  [virtual]

Reimplemented in VCF::ListBoxControl.

ListItem* VCF::ListControl::insertItem (  const uint32 &  index, const String &  caption, const uint32  imageIndex = 0 )

Reimplemented in VCF::ListViewControl.

virtual void VCF::ListControl::insertItemSubItem (  ListItem *  item, const uint32 &  index, ListSubItem *  subItem )  [inline, virtual]

Implements VCF::ListController. Reimplemented in VCF::ListViewControl.

bool VCF::ListControl::itemExists (  const uint32 &  index  )

virtual void VCF::ListControl::itemSelected (  ListItem *  item  )  [virtual]

Implements VCF::ListController.

virtual void VCF::ListControl::modelChanged (  Model *  oldModel, Model *  newModel )  [virtual]

Reimplemented from VCF::Control.

virtual void VCF::ListControl::onItemAdded (  ListModelEvent *  event  )  [protected, virtual]

Reimplemented in VCF::ListBoxControl.

virtual void VCF::ListControl::onItemDeleted (  ListModelEvent *  event  )  [protected, virtual]

Reimplemented in VCF::ListBoxControl.

virtual void VCF::ListControl::paintItem (  GraphicsContext *  ctx, const Rect &  itemRect, const uint32 &  index, const DrawUIState &  state )  [inline, virtual]

virtual void VCF::ListControl::rangeSelect (  const Rect &  selectionRect  )  [virtual]

Reimplemented in VCF::ListBoxControl.

virtual void VCF::ListControl::removeItemSubItem (  ListItem *  item, ListSubItem *  subItem )  [inline, virtual]

Implements VCF::ListController. Reimplemented in VCF::ListViewControl.

virtual void VCF::ListControl::removeSubItemsForItem (  ListItem *  item  )  [protected, virtual]

Reimplemented in VCF::ListViewControl.

virtual void VCF::ListControl::selectItem (  const uint32 &  index  )  [virtual]

Reimplemented in VCF::ListBoxControl.

virtual void VCF::ListControl::setAllowsMultiSelect (  const bool &  allowsMultiSelect  )  [virtual]

Reimplemented in VCF::ListBoxControl.

void VCF::ListControl::setItem (  const uint32 &  index, ListItem *  item )

Reimplemented in VCF::ListViewControl.

virtual void VCF::ListControl::setLargeImageList (  ImageList *  imageList  )  [virtual]

Reimplemented in VCF::ListBoxControl.

void VCF::ListControl::setListModel (  ListModel *  model  )

virtual void VCF::ListControl::setSmallImageList (  ImageList *  imageList  )  [virtual]

Reimplemented in VCF::ListBoxControl.

virtual void VCF::ListControl::setStateImageList (  ImageList *  imageList  )  [virtual]

Reimplemented in VCF::ListBoxControl, and VCF::ListViewControl.

void VCF::ListControl::sort (  ItemSort *  itemSortFunctor  )

---

Member Data Documentation

bool VCF::ListControl::inCallbackChange_ [protected]

bool VCF::ListControl::internalModelChange_ [protected]

VCF::Delegate VCF::ListControl::ItemDelegate

Reimplemented in VCF::ListBoxControl.

Array<ListItem*> VCF::ListControl::items_ [protected]

VCF::ListControl::ItemSelectionChanged

ImageList* VCF::ListControl::largeImageList_ [protected]

ListPeer* VCF::ListControl::listPeer_ [protected]

ListItem* VCF::ListControl::selectedItem_ [protected]

ImageList* VCF::ListControl::smallImageList_ [protected]

ImageList* VCF::ListControl::stateImageList_ [protected]

---

The documentation for this class was generated from the following file:

• vcf/ApplicationKit/ListControl.h

Comments or Suggestions?    License Information