Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

FXTreeList Class Reference

Tree list Widget.

#include <FXTreeList.h>

Inheritance diagram for FXTreeList:

FXScrollArea FXComposite FXWindow FXDrawable FXId FXObject FXDirList List of all members.

Public Types

enum  {
  ID_TIPTIMER = FXScrollArea::ID_LAST,
  ID_LOOKUPTIMER,
  ID_LAST
}

Public Methods

 FXTreeList (FXComposite *p, FXint nvis, FXObject *tgt=NULL, FXSelector sel=0, FXuint opts=TREELIST_NORMAL, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
 Construct a tree list with nvis visible items; the tree list is initially empty.

virtual void create ()
 Create server-side resources.

virtual void detach ()
 Detach server-side resources.

virtual FXint getDefaultWidth ()
 Return default width.

virtual FXint getDefaultHeight ()
 Return default height.

virtual FXint getContentWidth ()
 Compute and return content width.

virtual FXint getContentHeight ()
 Return content height.

virtual void recalc ()
 Recalculate layout.

virtual FXbool canFocus () const
 Tree list can receive focus.

virtual void setFocus ()
 Move the focus to this window.

virtual void killFocus ()
 Remove the focus from this window.

FXint getNumItems () const
 Return number of items.

FXint getNumVisible () const
 Return number of visible items.

void setNumVisible (FXint nvis)
 Change number of visible items.

FXTreeItemgetFirstItem () const
 REturn first root item.

FXTreeItemgetLastItem () const
 Return last root item.

FXTreeItemaddItemFirst (FXTreeItem *p, FXTreeItem *item, FXbool notify=FALSE)
 Prepend new [possibly subclassed] item as first child of p.

FXTreeItemaddItemFirst (FXTreeItem *p, const FXString &text, FXIcon *oi=NULL, FXIcon *ci=NULL, void *ptr=NULL, FXbool notify=FALSE)
 Prepend new item with given text and optional icon, and user-data pointer as first child of p.

FXTreeItemaddItemLast (FXTreeItem *p, FXTreeItem *item, FXbool notify=FALSE)
 Append new [possibly subclassed] item as last child of p.

FXTreeItemaddItemLast (FXTreeItem *p, const FXString &text, FXIcon *oi=NULL, FXIcon *ci=NULL, void *ptr=NULL, FXbool notify=FALSE)
 Append new item with given text and optional icon, and user-data pointer as last child of p.

FXTreeItemaddItemAfter (FXTreeItem *other, FXTreeItem *item, FXbool notify=FALSE)
 Append new [possibly subclassed] item after to other item.

FXTreeItemaddItemAfter (FXTreeItem *other, const FXString &text, FXIcon *oi=NULL, FXIcon *ci=NULL, void *ptr=NULL, FXbool notify=FALSE)
 Append new item with given text and optional icon, and user-data pointer after to other item.

FXTreeItemaddItemBefore (FXTreeItem *other, FXTreeItem *item, FXbool notify=FALSE)
 Prepend new [possibly subclassed] item prior to other item.

FXTreeItemaddItemBefore (FXTreeItem *other, const FXString &text, FXIcon *oi=NULL, FXIcon *ci=NULL, void *ptr=NULL, FXbool notify=FALSE)
 Prepend new item with given text and optional icon, and user-data pointer prior to other item.

void removeItem (FXTreeItem *item, FXbool notify=FALSE)
 Remove item.

void removeItems (FXTreeItem *fm, FXTreeItem *to, FXbool notify=FALSE)
 Remove items in range [fm, to] inclusively.

void clearItems (FXbool notify=FALSE)
 Remove all items from list.

FXint getItemWidth (const FXTreeItem *item) const
 Return item width.

FXint getItemHeight (const FXTreeItem *item) const
 Return item height.

virtual FXTreeItemgetItemAt (FXint x, FXint y) const
 Get item at x,y, if any.

FXTreeItemfindItem (const FXString &text, FXTreeItem *start=NULL, FXuint flags=SEARCH_FORWARD|SEARCH_WRAP) const
void makeItemVisible (FXTreeItem *item)
 Scroll to make item visible.

void setItemText (FXTreeItem *item, const FXString &text)
 Change item's text.

FXString getItemText (const FXTreeItem *item) const
 Return item's text.

void setItemOpenIcon (FXTreeItem *item, FXIcon *icon)
 Change item's open icon.

FXIcongetItemOpenIcon (const FXTreeItem *item) const
 Return item's open icon.

void setItemClosedIcon (FXTreeItem *item, FXIcon *icon)
 Chance item's closed icon.

FXIcongetItemClosedIcon (const FXTreeItem *item) const
 Return item's closed icon.

void setItemData (FXTreeItem *item, void *ptr) const
 Change item user-data pointer.

void * getItemData (const FXTreeItem *item) const
 Return item user-data pointer.

FXbool isItemSelected (const FXTreeItem *item) const
 Return TRUE if item is selected.

FXbool isItemCurrent (const FXTreeItem *item) const
 Return TRUE if item is current.

FXbool isItemVisible (const FXTreeItem *item) const
 Return TRUE if item is visible.

FXbool isItemOpened (const FXTreeItem *item) const
 Return TRUE if item opened.

FXbool isItemExpanded (const FXTreeItem *item) const
 Return TRUE if item expanded.

FXbool isItemLeaf (const FXTreeItem *item) const
 Return TRUE if item is a leaf-item, i.e. has no children.

FXbool isItemEnabled (const FXTreeItem *item) const
 Return TRUE if item is enabled.

FXint hitItem (const FXTreeItem *item, FXint x, FXint y) const
 Return item hit code: 0 outside, 1 icon, 2 text, 3 box.

void updateItem (FXTreeItem *item)
 Repaint item.

FXbool enableItem (FXTreeItem *item)
 Enable item.

FXbool disableItem (FXTreeItem *item)
 Disable item.

FXbool selectItem (FXTreeItem *item, FXbool notify=FALSE)
 Select item.

FXbool deselectItem (FXTreeItem *item, FXbool notify=FALSE)
 Deselect item.

FXbool toggleItem (FXTreeItem *item, FXbool notify=FALSE)
 Toggle item selection.

FXbool openItem (FXTreeItem *item, FXbool notify=FALSE)
 Open item.

FXbool closeItem (FXTreeItem *item, FXbool notify=FALSE)
 Close item.

FXbool collapseTree (FXTreeItem *tree, FXbool notify=FALSE)
 Collapse tree.

FXbool expandTree (FXTreeItem *tree, FXbool notify=FALSE)
 Expand tree.

void reparentItem (FXTreeItem *item, FXTreeItem *p)
 Reparent item under parent p.

void setCurrentItem (FXTreeItem *item, FXbool notify=FALSE)
 Change current item.

FXTreeItemgetCurrentItem () const
 Return current item, if any.

void setAnchorItem (FXTreeItem *item)
 Change anchor item.

FXTreeItemgetAnchorItem () const
 Return anchor item, if any.

FXTreeItemgetCursorItem () const
 Return item under cursor, if any.

FXbool extendSelection (FXTreeItem *item, FXbool notify=FALSE)
 Extend selection from anchor item to item.

FXbool killSelection (FXbool notify=FALSE)
 Deselect all items.

void sortItems ()
 Sort root items.

void sortChildItems (FXTreeItem *item)
 Sort children of item.

void setFont (FXFont *fnt)
 Change text font.

FXFontgetFont () const
 Return text font.

void setIndent (FXint in)
 Change parent-child indent amount.

FXint getIndent () const
 Return parent-child indent amount.

FXColor getTextColor () const
 Return normal text color.

void setTextColor (FXColor clr)
 Change normal text color.

FXColor getSelBackColor () const
 Return selected text background.

void setSelBackColor (FXColor clr)
 Change selected text background.

FXColor getSelTextColor () const
 Return selected text color.

void setSelTextColor (FXColor clr)
 Change selected text color.

FXColor getLineColor () const
 Return line color.

void setLineColor (FXColor clr)
 Change line color.

FXTreeListSortFunc getSortFunc () const
 Return sort function.

void setSortFunc (FXTreeListSortFunc func)
 Change sort function.

FXuint getListStyle () const
 Return list style.

void setListStyle (FXuint style)
 Change list style.

void setHelpText (const FXString &text)
 Set the status line help text for this list.

virtual void save (FXStream &store) const
 Save object to a stream.

virtual void load (FXStream &store)
 Load object from a stream.

virtual ~FXTreeList ()
 Destructor.


Static Public Methods

FXint ascending (const FXTreeItem *a, const FXTreeItem *b)
FXint descending (const FXTreeItem *a, const FXTreeItem *b)

Public Attributes

FXString getHelpText () const
 Get the status line help text for this list.


Member Function Documentation

FXTreeItem * FXTreeList::findItem const FXString   text,
FXTreeItem   start = NULL,
FXuint    flags = SEARCH_FORWARD|SEARCH_WRAP
const
 

Search items for item by name, starting from start item; the flags argument controls the search direction, and case sensitivity.