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

FX::FXTreeListBox Class Reference

#include <FXTreeListBox.h>

Inheritance diagram for FX::FXTreeListBox:

FX::FXPacker FX::FXComposite FX::FXWindow FX::FXDrawable FX::FXId FX::FXObject FX::FXDirBox List of all members.

Public Types

enum  {
  ID_TREE = FXPacker::ID_LAST,
  ID_FIELD,
  ID_LAST
}

Public Methods

 FXTreeListBox (FXComposite *p, FXint nvis, FXObject *tgt=NULL, FXSelector sel=0, FXuint opts=FRAME_SUNKEN|FRAME_THICK|TREELISTBOX_NORMAL, FXint x=0, FXint y=0, FXint w=0, FXint h=0, FXint pl=DEFAULT_PAD, FXint pr=DEFAULT_PAD, FXint pt=DEFAULT_PAD, FXint pb=DEFAULT_PAD)
 Construct tree list box.

virtual void create ()
 Create server-side resources.

virtual void detach ()
 Detach server-side resources.

virtual void destroy ()
 Destroy server-side resources.

virtual void enable ()
 Enable widget.

virtual void disable ()
 Disable widget.

virtual FXint getDefaultWidth ()
 Return default with.

virtual FXint getDefaultHeight ()
 Return default height.

FXint getNumItems () const
 Return number of items.

FXint getNumVisible () const
 Return number of visible items.

void setNumVisible (FXint nvis)
 Set number of visible items to determine default height.

FXTreeItemgetFirstItem () const
 Return first top-level item.

FXTreeItemgetLastItem () const
 Return last top-level item.

FXTreeItemaddItemFirst (FXTreeItem *p, FXTreeItem *item)
 Add item as first child of parent p.

FXTreeItemaddItemLast (FXTreeItem *p, FXTreeItem *item)
 Add item as last child after parent p.

FXTreeItemaddItemAfter (FXTreeItem *other, FXTreeItem *item)
 Add item after other item.

FXTreeItemaddItemBefore (FXTreeItem *other, FXTreeItem *item)
 Add item before other item.

FXTreeItemaddItemFirst (FXTreeItem *p, const FXString &text, FXIcon *oi=NULL, FXIcon *ci=NULL, void *ptr=NULL)
 Add item as first child of parent p.

FXTreeItemaddItemLast (FXTreeItem *p, const FXString &text, FXIcon *oi=NULL, FXIcon *ci=NULL, void *ptr=NULL)
 Add item as last child of parent p.

FXTreeItemaddItemAfter (FXTreeItem *other, const FXString &text, FXIcon *oi=NULL, FXIcon *ci=NULL, void *ptr=NULL)
 Add item after other item.

FXTreeItemaddItemBefore (FXTreeItem *other, const FXString &text, FXIcon *oi=NULL, FXIcon *ci=NULL, void *ptr=NULL)
 Add item before other item.

void removeItem (FXTreeItem *item)
 Remove item.

void removeItems (FXTreeItem *fm, FXTreeItem *to)
 Remove all items in range [fm...to].

void clearItems ()
 Remove all items from list.

FXTreeItemfindItem (const FXString &text, FXTreeItem *start=NULL, FXuint flags=SEARCH_FORWARD|SEARCH_WRAP) const
FXbool isItemCurrent (const FXTreeItem *item) const
 Return TRUE if item is the current item.

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

void sortChildItems (FXTreeItem *item)
 Sort child items of item.

void sortItems ()
 Sort the toplevel items with the sort function.

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

FXTreeItemgetCurrentItem () const
 Return current item.

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

FXString getItemText (const FXTreeItem *item) const
 Return item label.

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)
 Change item's closed icon.

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

void setItemData (FXTreeItem *item, void *ptr) const
 Change item's user data.

void * getItemData (const FXTreeItem *item) const
 Return item's user data.

FXTreeListSortFunc getSortFunc () const
 Return item sort function.

void setSortFunc (FXTreeListSortFunc func)
 Change item sort function.

FXbool isPaneShown () const
 Is the pane shown.

void setFont (FXFont *fnt)
 Change font.

FXFontgetFont () const
 Return font.

FXuint getListStyle () const
 Return list style.

void setListStyle (FXuint style)
 Change list style.

void setHelpText (const FXString &txt)
 Change help text.

const FXStringgetHelpText () const
 Return help text.

void setTipText (const FXString &txt)
 Change tip text.

const FXStringgetTipText () const
 Return tip text.

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

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

virtual ~FXTreeListBox ()
 Destructor.


Detailed Description

Tree List Box

See also:


Member Function Documentation

FXTreeItem * FX::FXTreeListBox::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.