2005/5/9

--
down ACDK
down API Docs
down Namespaces
down acdk
down acdk::wx
down TreeCtrl
  down members
  down (wxWidgets)
See also:
  down TreeCtrl.cpp
  down TreeCtrl.h

(c) 2005 by
Roger Rene Kommer

Kindly hosted at:
SourceForge.net Logo

     
 

class TreeCtrl
artefaktur
Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   Namespace Members   Compound Members   Related Pages  

acdk::wx::TreeCtrl Class Reference

#include <TreeCtrl.h>

Inheritance diagram for acdk::wx::TreeCtrl:

acdk::wx::Window acdk::wx::EvtHandler acdk::wx::WxObject acdk::lang::Object acdk::lang::ObjectBase acdk::lang::dmi::StdDispatch acdk::tools::aunit::guitestrunner::TestTreeCtrl acdk::wx::ide::inspector::ClassTreeCtrl acdk::wx::ide::inspector::ObjectTreeCtrl List of all members.

Detailed Description

see wxTreeCtrl

Author:
Roger Rene Kommer (mailto:kommer@artefaktur.com)
Version:
Revision
1.22
Date:
Date
2005/03/11 11:11:50


Public Member Functions

 TreeCtrl ()
 TreeCtrl (IN(RWindow) parent, int id=-1, IN(RPoint) pos=Point::defaultPosition(), IN(RSize) size=Size::defaultSize(), int style=TrDefaultStyle, IN(RValidator) validator=Validator::defaultValidator(), IN(RString) name=treectrl)
int getCount () const
 get the total number of items in the control

int getIndent () const
 indent is the number of pixels the children are indented relative to the parents position.

void setIndent (int indent)
 Sets the indentation for the tree control.

int getSpacing () const
 spacing is the number of pixels between the start and the Text

void setSpacing (int spacing)
RImageList getImageList () const
RImageList getStateImageList () const
void setImageList (IN(RImageList) imageList)
void setStateImageList (IN(RImageList) imageList)
void assignImageList (IN(RImageList) imageList)
void assignStateImageList (IN(RImageList) imageList)
RString getItemText (IN(RTreeItemId) item) const
 retrieve item's label

int getItemImage (IN(RTreeItemId) item, TreeItemIcon which=TreeitemiconNormal) const
 get one of the images associated with the item (TreeitemiconNormal by default)

RTreeItemData getItemData (IN(RTreeItemId) item) const
acdk::lang::Object getItemDataObject (IN(RTreeItemId) item) const
RColour getItemTextColour (IN(RTreeItemId) item) const
RColour getItemBackgroundColour (IN(RTreeItemId) item) const
RFont getItemFont (IN(RTreeItemId) item) const
void setItemText (IN(RTreeItemId) item, IN(RString) text)
void setItemImage (IN(RTreeItemId) item, int image, TreeItemIcon which=TreeitemiconNormal)
void setItemData (IN(RTreeItemId) item, IN(RTreeItemData) data)
void setItemDataObject (IN(RTreeItemId) item, IN(acdk::lang::Object) data)
void setItemHasChildren (IN(RTreeItemId) item, bool has=true)
void setItemBold (IN(RTreeItemId) item, bool bold=true)
void setItemTextColour (IN(RTreeItemId) item, IN(RColour) col)
void setItemBackgroundColour (IN(RTreeItemId) item, IN(RColour) col)
void setItemFont (IN(RTreeItemId) item, IN(RFont) font)
virtual bool setFont (IN(RFont) font)
void setWindowStyle (int styles)
bool isVisible (IN(RTreeItemId) item) const
bool itemHasChildren (IN(RTreeItemId) item) const
bool isExpanded (IN(RTreeItemId) item) const
bool isSelected (IN(RTreeItemId) item) const
bool isBold (IN(RTreeItemId) item) const
int getChildrenCount (IN(RTreeItemId) item, bool recursively=true)
RTreeItemId getRootItem () const
RTreeItemId getSelection () const
int getSelections (IN(RTreeItemIdArray) tids) const
 expects an initialized != Nil Array

RTreeItemId getItemParent (IN(RTreeItemId) item) const
RTreeItemId getFirstChild (IN(RTreeItemId) item, OUT(jlong) cookie) const
RTreeItemId getNextChild (IN(RTreeItemId) item, jlong cookie) const
RTreeItemId getLastChild (IN(RTreeItemId) item) const
RTreeItemId getNextSibling (IN(RTreeItemId) item) const
RTreeItemId getPrevSibling (IN(RTreeItemId) item) const
RTreeItemId getFirstVisibleItem () const
RTreeItemId getNextVisible (IN(RTreeItemId) item) const
RTreeItemId getPrevVisible (IN(RTreeItemId) item) const
RTreeItemId addRoot (IN(RString) text, int image=-1, int selectedImage=-1, IN(RTreeItemData) data=Nil)
RTreeItemId prependItem (IN(RTreeItemId) parent, IN(RString) text, int image=-1, int selectedImage=-1, IN(RTreeItemData) data=Nil)
RTreeItemId insertItem (IN(RTreeItemId) parent, IN(RTreeItemId) idPrevious, IN(RString) text, int image=-1, int selectedImage=-1, IN(RTreeItemData) data=Nil)
RTreeItemId insertItem (IN(RTreeItemId) parent, int index, IN(RString) text, int image=-1, int selectedImage=-1, IN(RTreeItemData) data=Nil)
RTreeItemId appendItem (IN(RTreeItemId) parent, IN(RString) text, int image=-1, int selectedImage=-1, IN(RTreeItemData) data=Nil)
void deleteItem (IN(RTreeItemId) item)
void deleteChildren (IN(RTreeItemId) item)
void deleteAllItems ()
void expand (IN(RTreeItemId) item)
void collapse (IN(RTreeItemId) item)
void collapseAndReset (IN(RTreeItemId) item)
void toggle (IN(RTreeItemId) item)
void unselect ()
void unselectAll ()
void selectItem (IN(RTreeItemId) item)
void ensureVisible (IN(RTreeItemId) item)
void scrollTo (IN(RTreeItemId) item)
RTreeItemId hitTest (IN(RPoint) point)
RTreeItemId hitTest (IN(RPoint) point, OUT(int) flags)
bool getBoundingRect (IN(RTreeItemId) item, OUT(RRect) rect, bool textOnly=false) const
void editLabel (IN(RTreeItemId) item)
RTextCtrl getEditControl () const
virtual int onCompareItems (IN(RTreeItemId) item1, IN(RTreeItemId) item2)
void sortChildren (IN(RTreeItemId) item)

Constructor & Destructor Documentation

acdk::wx::TreeCtrl::TreeCtrl (   )  [inline]
 

acdk::wx::TreeCtrl::TreeCtrl (  IN(RWindow)  parent,
int  id = -1,
IN(RPoint)  pos = Point::defaultPosition(),
IN(RSize)  size = Size::defaultSize(),
int  style = TrDefaultStyle,
IN(RValidator)  validator = Validator::defaultValidator(),
IN(RString)  name = treectrl
)  [inline]
 

Member Function Documentation

RTreeItemId acdk::wx::TreeCtrl::addRoot (  IN(RString)  text,
int  image = -1,
int  selectedImage = -1,
IN(RTreeItemData)  data = Nil
)  [inline]
 

RTreeItemId acdk::wx::TreeCtrl::appendItem (  IN(RTreeItemId)  parent,
IN(RString)  text,
int  image = -1,
int  selectedImage = -1,
IN(RTreeItemData)  data = Nil
)  [inline]
 

void acdk::wx::TreeCtrl::assignImageList (  IN(RImageList)  imageList  )  [inline]
 

void acdk::wx::TreeCtrl::assignStateImageList (  IN(RImageList)  imageList  )  [inline]
 

void acdk::wx::TreeCtrl::collapse (  IN(RTreeItemId)  item  )  [inline]
 

void acdk::wx::TreeCtrl::collapseAndReset (  IN(RTreeItemId)  item  )  [inline]
 

void acdk::wx::TreeCtrl::deleteAllItems (   )  [inline]
 

void acdk::wx::TreeCtrl::deleteChildren (  IN(RTreeItemId)  item  )  [inline]
 

void acdk::wx::TreeCtrl::deleteItem (  IN(RTreeItemId)  item  )  [inline]
 

void acdk::wx::TreeCtrl::editLabel (  IN(RTreeItemId)  item  )  [inline]
 

void acdk::wx::TreeCtrl::ensureVisible (  IN(RTreeItemId)  item  )  [inline]
 

void acdk::wx::TreeCtrl::expand (  IN(RTreeItemId)  item  )  [inline]
 

bool acdk::wx::TreeCtrl::getBoundingRect (  IN(RTreeItemId)  item,
OUT(RRect)  rect,
bool  textOnly = false
)  const [inline]
 

int acdk::wx::TreeCtrl::getChildrenCount (  IN(RTreeItemId)  item,
bool  recursively = true
)  [inline]
 

int acdk::wx::TreeCtrl::getCount (   )  const [inline]
 

get the total number of items in the control

RTextCtrl acdk::wx::TreeCtrl::getEditControl (   )  const [inline]
 

RTreeItemId acdk::wx::TreeCtrl::getFirstChild (  IN(RTreeItemId)  item,
OUT(jlong)  cookie
)  const [inline]
 

RTreeItemId acdk::wx::TreeCtrl::getFirstVisibleItem (   )  const [inline]
 

RImageList acdk::wx::TreeCtrl::getImageList (   )  const [inline]
 

int acdk::wx::TreeCtrl::getIndent (   )  const [inline]
 

indent is the number of pixels the children are indented relative to the parents position.

SetIndent() also redraws the control immediately.

RColour acdk::wx::TreeCtrl::getItemBackgroundColour (  IN(RTreeItemId)  item  )  const [inline]
 

RTreeItemData acdk::wx::TreeCtrl::getItemData (  IN(RTreeItemId)  item  )  const [inline]
 

acdk::lang::Object acdk::wx::TreeCtrl::getItemDataObject (  IN(RTreeItemId)  item  )  const [inline]
 

RFont acdk::wx::TreeCtrl::getItemFont (  IN(RTreeItemId)  item  )  const [inline]
 

int acdk::wx::TreeCtrl::getItemImage (  IN(RTreeItemId)  item,
TreeItemIcon  which = TreeitemiconNormal
)  const [inline]
 

get one of the images associated with the item (TreeitemiconNormal by default)

RTreeItemId acdk::wx::TreeCtrl::getItemParent (  IN(RTreeItemId)  item  )  const [inline]
 

RString acdk::wx::TreeCtrl::getItemText (  IN(RTreeItemId)  item  )  const [inline]
 

retrieve item's label

RColour acdk::wx::TreeCtrl::getItemTextColour (  IN(RTreeItemId)  item  )  const [inline]
 

RTreeItemId acdk::wx::TreeCtrl::getLastChild (  IN(RTreeItemId)  item  )  const [inline]
 

RTreeItemId acdk::wx::TreeCtrl::getNextChild (  IN(RTreeItemId)  item,
jlong  cookie
)  const [inline]
 

RTreeItemId acdk::wx::TreeCtrl::getNextSibling (  IN(RTreeItemId)  item  )  const [inline]
 

RTreeItemId acdk::wx::TreeCtrl::getNextVisible (  IN(RTreeItemId)  item  )  const [inline]
 

RTreeItemId acdk::wx::TreeCtrl::getPrevSibling (  IN(RTreeItemId)  item  )  const [inline]
 

RTreeItemId acdk::wx::TreeCtrl::getPrevVisible (  IN(RTreeItemId)  item  )  const [inline]
 

RTreeItemId acdk::wx::TreeCtrl::getRootItem (   )  const [inline]
 

RTreeItemId acdk::wx::TreeCtrl::getSelection (   )  const [inline]
 

int acdk::wx::TreeCtrl::getSelections (  IN(RTreeItemIdArray)  tids  )  const [inline]
 

expects an initialized != Nil Array

int acdk::wx::TreeCtrl::getSpacing (   )  const [inline]
 

spacing is the number of pixels between the start and the Text

RImageList acdk::wx::TreeCtrl::getStateImageList (   )  const [inline]
 

RTreeItemId acdk::wx::TreeCtrl::hitTest (  IN(RPoint)  point,
OUT(int)  flags
)  [inline]
 

RTreeItemId acdk::wx::TreeCtrl::hitTest (  IN(RPoint)  point  )  [inline]
 

Reimplemented from acdk::wx::Window.

RTreeItemId acdk::wx::TreeCtrl::insertItem (  IN(RTreeItemId)  parent,
int  index,
IN(RString)  text,
int  image = -1,
int  selectedImage = -1,
IN(RTreeItemData)  data = Nil
)  [inline]
 

RTreeItemId acdk::wx::TreeCtrl::insertItem (  IN(RTreeItemId)  parent,
IN(RTreeItemId)  idPrevious,
IN(RString)  text,
int  image = -1,
int  selectedImage = -1,
IN(RTreeItemData)  data = Nil
)  [inline]
 

bool acdk::wx::TreeCtrl::isBold (  IN(RTreeItemId)  item  )  const [inline]
 

bool acdk::wx::TreeCtrl::isExpanded (  IN(RTreeItemId)  item  )  const [inline]
 

bool acdk::wx::TreeCtrl::isSelected (  IN(RTreeItemId)  item  )  const [inline]
 

bool acdk::wx::TreeCtrl::isVisible (  IN(RTreeItemId)  item  )  const [inline]
 

bool acdk::wx::TreeCtrl::itemHasChildren (  IN(RTreeItemId)  item  )  const [inline]
 

virtual int acdk::wx::TreeCtrl::onCompareItems (  IN(RTreeItemId)  item1,
IN(RTreeItemId)  item2
)  [inline, virtual]
 

RTreeItemId acdk::wx::TreeCtrl::prependItem (  IN(RTreeItemId)  parent,
IN(RString)  text,
int  image = -1,
int  selectedImage = -1,
IN(RTreeItemData)  data = Nil
)  [inline]
 

void acdk::wx::TreeCtrl::scrollTo (  IN(RTreeItemId)  item  )  [inline]
 

void acdk::wx::TreeCtrl::selectItem (  IN(RTreeItemId)  item  )  [inline]
 

virtual bool acdk::wx::TreeCtrl::setFont (  IN(RFont)  font  )  [inline, virtual]
 

Reimplemented from acdk::wx::Window.

void acdk::wx::TreeCtrl::setImageList (  IN(RImageList)  imageList  )  [inline]
 

void acdk::wx::TreeCtrl::setIndent (  int  indent  )  [inline]
 

Sets the indentation for the tree control.

void acdk::wx::TreeCtrl::setItemBackgroundColour (  IN(RTreeItemId)  item,
IN(RColour)  col
)  [inline]
 

void acdk::wx::TreeCtrl::setItemBold (  IN(RTreeItemId)  item,
bool  bold = true
)  [inline]
 

void acdk::wx::TreeCtrl::setItemData (  IN(RTreeItemId)  item,
IN(RTreeItemData)  data
)  [inline]
 

void acdk::wx::TreeCtrl::setItemDataObject (  IN(RTreeItemId)  item,
IN(acdk::lang::Object)  data
)  [inline]
 

void acdk::wx::TreeCtrl::setItemFont (  IN(RTreeItemId)  item,
IN(RFont)  font
)  [inline]
 

void acdk::wx::TreeCtrl::setItemHasChildren (  IN(RTreeItemId)  item,
bool  has = true
)  [inline]
 

void acdk::wx::TreeCtrl::setItemImage (  IN(RTreeItemId)  item,
int  image,
TreeItemIcon  which = TreeitemiconNormal
)  [inline]
 

void acdk::wx::TreeCtrl::setItemText (  IN(RTreeItemId)  item,
IN(RString)  text
)  [inline]
 

void acdk::wx::TreeCtrl::setItemTextColour (  IN(RTreeItemId)  item,
IN(RColour)  col
)  [inline]
 

void acdk::wx::TreeCtrl::setSpacing (  int  spacing  )  [inline]
 

void acdk::wx::TreeCtrl::setStateImageList (  IN(RImageList)  imageList  )  [inline]
 

void acdk::wx::TreeCtrl::setWindowStyle (  int  styles  )  [inline]
 

Reimplemented from acdk::wx::Window.

void acdk::wx::TreeCtrl::sortChildren (  IN(RTreeItemId)  item  )  [inline]
 

void acdk::wx::TreeCtrl::toggle (  IN(RTreeItemId)  item  )  [inline]
 

void acdk::wx::TreeCtrl::unselect (   )  [inline]
 

void acdk::wx::TreeCtrl::unselectAll (   )  [inline]