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

VCF::TreeListControl Class Reference

#include <TreeListControl.h>

Inheritance diagram for VCF::TreeListControl:

List of all members.

Public Member Functions
	TreeListControl ()
virtual	~TreeListControl ()
ColumnWidthChanged double	getColumnWidth (const uint32 &index)
void	setColumnWidth (const uint32 &index, const double &width)
ColumnItem *	addColumn (const String &caption)
ColumnItem *	addColumn (const String &caption, const double &width)
virtual ColumnItem *	getColumnItem (const uint32 &index)
void	setColumnItem (const uint32 &index, ColumnItem *item)
void	setHeaderVisible (const bool &val)
bool	isHeaderVisible ()
void	showHierarchyLines (const bool &show)
bool	hierarchyLinesVisible ()
void	showRowLines (const bool &show)
bool	rowLinesVisible ()
void	showColumnLines (const bool &show)
bool	columnLinesVisible ()
void	showFullRowSelection (const bool &show)
bool	fullRowSelectionVisible ()
ImageList *	getHeaderImageList ()
void	setHeaderImageList (ImageList *imageList)
virtual void	insertItemSubItem (TreeItem *item, const uint32 &index, TreeSubItem *subItem)
virtual void	removeItemSubItem (TreeItem *item, TreeSubItem *subItem)
virtual bool	getItemSubItems (TreeItem *item, std::vector< TreeSubItem * > &subItems)
virtual TreeSubItem *	getItemSubItem (TreeItem *item, const uint32 &index)
virtual uint32	getItemSubItemIndex (TreeItem *item, TreeSubItem *subItem)
virtual uint32	getItemSubItemCount (TreeItem *item)
virtual bool	subItemExists (const TreeModel::Key &key, const uint32 &subItemIndex)
virtual double	getItemWidth (ColumnItem *item)
virtual void	setItemWidth (ColumnItem *item, const double &val)
virtual TextAlignmentType	getItemTextAlignment (ColumnItem *item)
virtual void	setItemTextAlignment (ColumnItem *item, const TextAlignmentType &val)
virtual void	mouseDown (MouseEvent *event)
	Called when one (or more) of the mouse buttons are held down.
virtual void	keyDown (KeyboardEvent *e)
	called when the user presses the key down
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.
int	hitTestForEditColumn (const Point &pt)
Rect	getBoundsForEdit (TreeItem *item, int column)
Public Attributes
VCF::Delegate	MouseDelegate
ColumnItemClicked VCF::Delegate	ItemDelegate
Protected Types
typedef std::multimap< TreeItem *, TreeSubItem * >	SubItemMap
typedef std::pair< SubItemMap::iterator, SubItemMap::iterator >	SubItemIteratorPair
typedef SubItemMap::value_type	SubItemPair
Protected Member Functions
void	onColumnItemAdded (ListModelEvent *event)
void	onColumnItemDeleted (ListModelEvent *event)
void	onEditingControlKeyPressed (KeyboardEvent *event)
void	onEditorFocusLost (Event *e)
void	postFinishedEditing (Event *e)
void	cancelEditing ()
void	finishEditing (bool applyEdit=true)
void	editItem (TreeItem *item, Point *point)
virtual void	finishEditingItem (TreeItem *item, Control *editControl)
	this is a no-op - sub classes need to derive this
virtual Control *	createEditor (TreeItem *item, int column)
	this is a no-op - sub classes need to derive this
virtual bool	finishEditingFromFocusLoss (Control *lostFocusCtrl, Control *currentFocusedCtrl)
	virtual function to control whether or not to allow an edit to finish due to focus loss.
Protected Attributes
bool	allowLabelEditing_
int	currentEditColumn_
Control *	currentEditingControl_
SubItemMap	subItems_
Array< ColumnItem * >	columnItems_
ImageList *	headerImageList_

---

Member Typedef Documentation

typedef std::pair<SubItemMap::iterator,SubItemMap::iterator> VCF::TreeListControl::SubItemIteratorPair [protected]

typedef std::multimap<TreeItem*,TreeSubItem*> VCF::TreeListControl::SubItemMap [protected]

typedef SubItemMap::value_type VCF::TreeListControl::SubItemPair [protected]

---

Constructor & Destructor Documentation

VCF::TreeListControl::TreeListControl (   )

virtual VCF::TreeListControl::~TreeListControl (   )  [virtual]

---

Member Function Documentation

ColumnItem* VCF::TreeListControl::addColumn (  const String &  caption, const double &  width )

ColumnItem* VCF::TreeListControl::addColumn (  const String &  caption  )

void VCF::TreeListControl::cancelEditing (   )  [protected]

bool VCF::TreeListControl::columnLinesVisible (   )

virtual Control* VCF::TreeListControl::createEditor (  TreeItem *  item, int  column )  [inline, protected, virtual]

this is a no-op - sub classes need to derive this

void VCF::TreeListControl::editItem (  TreeItem *  item, Point *  point )  [protected]

void VCF::TreeListControl::finishEditing (  bool  applyEdit = true  )  [protected]

virtual bool VCF::TreeListControl::finishEditingFromFocusLoss (  Control *  lostFocusCtrl, Control *  currentFocusedCtrl )  [protected, virtual]

virtual function to control whether or not to allow an edit to finish due to focus loss. Returns: bool return true to enable the edit session to finish, otherwise return false.

virtual void VCF::TreeListControl::finishEditingItem (  TreeItem *  item, Control *  editControl )  [inline, protected, virtual]

this is a no-op - sub classes need to derive this

bool VCF::TreeListControl::fullRowSelectionVisible (   )

Rect VCF::TreeListControl::getBoundsForEdit (  TreeItem *  item, int  column )

virtual ColumnItem* VCF::TreeListControl::getColumnItem (  const uint32 &  index  )  [virtual]

Reimplemented from VCF::TreeControl.

ColumnWidthChanged double VCF::TreeListControl::getColumnWidth (  const uint32 &  index  )

ImageList* VCF::TreeListControl::getHeaderImageList (   )

virtual TreeSubItem* VCF::TreeListControl::getItemSubItem (  TreeItem *  item, const uint32 &  index )  [virtual]

Reimplemented from VCF::TreeControl.

virtual uint32 VCF::TreeListControl::getItemSubItemCount (  TreeItem *  item  )  [virtual]

Reimplemented from VCF::TreeControl.

virtual uint32 VCF::TreeListControl::getItemSubItemIndex (  TreeItem *  item, TreeSubItem *  subItem )  [virtual]

Reimplemented from VCF::TreeControl.

virtual bool VCF::TreeListControl::getItemSubItems (  TreeItem *  item, std::vector< TreeSubItem * > &  subItems )  [virtual]

Reimplemented from VCF::TreeControl.

virtual TextAlignmentType VCF::TreeListControl::getItemTextAlignment (  ColumnItem *  item  )  [virtual]

Implements VCF::ColumnController.

virtual double VCF::TreeListControl::getItemWidth (  ColumnItem *  item  )  [virtual]

Implements VCF::ColumnController.

virtual void VCF::TreeListControl::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::TreeControl.

bool VCF::TreeListControl::hierarchyLinesVisible (   )

int VCF::TreeListControl::hitTestForEditColumn (  const Point &  pt  )

virtual void VCF::TreeListControl::insertItemSubItem (  TreeItem *  item, const uint32 &  index, TreeSubItem *  subItem )  [virtual]

Reimplemented from VCF::TreeControl.

bool VCF::TreeListControl::isHeaderVisible (   )

virtual void VCF::TreeListControl::keyDown (  KeyboardEvent *  e  )  [virtual]

called when the user presses the key down Reimplemented from VCF::Control.

virtual void VCF::TreeListControl::mouseDown (  MouseEvent *  event  )  [virtual]

Called when one (or more) of the mouse buttons are held down. override this to provide specific behaviours when the mouse buttons are held down Reimplemented from VCF::Control.

void VCF::TreeListControl::onColumnItemAdded (  ListModelEvent *  event  )  [protected]

void VCF::TreeListControl::onColumnItemDeleted (  ListModelEvent *  event  )  [protected]

void VCF::TreeListControl::onEditingControlKeyPressed (  KeyboardEvent *  event  )  [protected]

void VCF::TreeListControl::onEditorFocusLost (  Event *  e  )  [protected]

void VCF::TreeListControl::postFinishedEditing (  Event *  e  )  [protected]

virtual void VCF::TreeListControl::removeItemSubItem (  TreeItem *  item, TreeSubItem *  subItem )  [virtual]

Reimplemented from VCF::TreeControl.

bool VCF::TreeListControl::rowLinesVisible (   )

void VCF::TreeListControl::setColumnItem (  const uint32 &  index, ColumnItem *  item )

void VCF::TreeListControl::setColumnWidth (  const uint32 &  index, const double &  width )

void VCF::TreeListControl::setHeaderImageList (  ImageList *  imageList  )

void VCF::TreeListControl::setHeaderVisible (  const bool &  val  )

virtual void VCF::TreeListControl::setItemTextAlignment (  ColumnItem *  item, const TextAlignmentType &  val )  [virtual]

Implements VCF::ColumnController.

virtual void VCF::TreeListControl::setItemWidth (  ColumnItem *  item, const double &  val )  [virtual]

Implements VCF::ColumnController.

void VCF::TreeListControl::showColumnLines (  const bool &  show  )

void VCF::TreeListControl::showFullRowSelection (  const bool &  show  )

void VCF::TreeListControl::showHierarchyLines (  const bool &  show  )

void VCF::TreeListControl::showRowLines (  const bool &  show  )

virtual bool VCF::TreeListControl::subItemExists (  const TreeModel::Key &  key, const uint32 &  subItemIndex )  [virtual]

Reimplemented from VCF::TreeControl.

---

Member Data Documentation

bool VCF::TreeListControl::allowLabelEditing_ [protected]

Array<ColumnItem*> VCF::TreeListControl::columnItems_ [protected]

int VCF::TreeListControl::currentEditColumn_ [protected]

Control* VCF::TreeListControl::currentEditingControl_ [protected]

ImageList* VCF::TreeListControl::headerImageList_ [protected]

ColumnItemClicked VCF::Delegate VCF::TreeListControl::ItemDelegate

Reimplemented from VCF::TreeControl.

VCF::Delegate VCF::TreeListControl::MouseDelegate

Event Delegate: MouseDoubleClicked fires an MouseEvent, with a type set to Control::MOUSE_DBLCLICK. Fired whenever the control receives a double click from the mouse. This is triggered by the underlying windowing system. event class: MouseEvent event type: Control::MOUSE_DBLCLICK Reimplemented from VCF::Control.

SubItemMap VCF::TreeListControl::subItems_ [protected]

---

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

• vcf/ApplicationKit/TreeListControl.h

Comments or Suggestions?    License Information