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

Public Member Functions | Static Public Member Functions | List of all members
FX::FXTreeList Class Reference

#include <FXTreeList.h>

Inheritance diagram for FX::FXTreeList:
FX::FXScrollArea FX::FXComposite FX::FXWindow FX::FXDrawable FX::FXId FX::FXObject FX::FXDirList

Public Member Functions

 FXTreeList (FXComposite *p, FXObject *tgt=NULL, FXSelector sel=0, FXuint opts=TREELIST_NORMAL, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
 
virtual void create ()
 
virtual void detach ()
 
virtual void layout ()
 
virtual FXint getDefaultWidth ()
 
virtual FXint getDefaultHeight ()
 
virtual FXint getContentWidth ()
 
virtual FXint getContentHeight ()
 
virtual void recalc ()
 
virtual bool canFocus () const
 
virtual void setFocus ()
 
virtual void killFocus ()
 
FXint getNumItems () const
 
FXint getNumVisible () const
 
void setNumVisible (FXint nvis)
 
FXTreeItem * getFirstItem () const
 
FXTreeItem * getLastItem () const
 
FXint fillItems (FXTreeItem *father, const FXchar **strings, FXIcon *oi=NULL, FXIcon *ci=NULL, void *ptr=NULL, FXbool notify=FALSE)
 
FXint fillItems (FXTreeItem *father, const FXString &strings, FXIcon *oi=NULL, FXIcon *ci=NULL, void *ptr=NULL, FXbool notify=FALSE)
 
FXTreeItem * insertItem (FXTreeItem *other, FXTreeItem *father, FXTreeItem *item, FXbool notify=FALSE)
 
FXTreeItem * insertItem (FXTreeItem *other, FXTreeItem *father, const FXString &text, FXIcon *oi=NULL, FXIcon *ci=NULL, void *ptr=NULL, FXbool notify=FALSE)
 
FXTreeItem * appendItem (FXTreeItem *father, FXTreeItem *item, FXbool notify=FALSE)
 
FXTreeItem * appendItem (FXTreeItem *father, const FXString &text, FXIcon *oi=NULL, FXIcon *ci=NULL, void *ptr=NULL, FXbool notify=FALSE)
 
FXTreeItem * prependItem (FXTreeItem *father, FXTreeItem *item, FXbool notify=FALSE)
 
FXTreeItem * prependItem (FXTreeItem *father, const FXString &text, FXIcon *oi=NULL, FXIcon *ci=NULL, void *ptr=NULL, FXbool notify=FALSE)
 
FXTreeItem * moveItem (FXTreeItem *other, FXTreeItem *father, FXTreeItem *item)
 
FXTreeItem * extractItem (FXTreeItem *item, FXbool notify=FALSE)
 
void removeItem (FXTreeItem *item, FXbool notify=FALSE)
 
void removeItems (FXTreeItem *fm, FXTreeItem *to, FXbool notify=FALSE)
 
void clearItems (FXbool notify=FALSE)
 
FXint getItemWidth (const FXTreeItem *item) const
 
FXint getItemHeight (const FXTreeItem *item) const
 
virtual FXTreeItem * getItemAt (FXint x, FXint y) const
 
FXTreeItem * findItem (const FXString &name, FXTreeItem *start=NULL, FXuint flags=SEARCH_FORWARD|SEARCH_WRAP) const
 
FXTreeItem * findItemByData (const void *ptr, FXTreeItem *start=NULL, FXuint flags=SEARCH_FORWARD|SEARCH_WRAP) const
 
virtual void makeItemVisible (FXTreeItem *item)
 
void setItemText (FXTreeItem *item, const FXString &text)
 
FXString getItemText (const FXTreeItem *item) const
 
void setItemOpenIcon (FXTreeItem *item, FXIcon *icon, FXbool owned=FALSE)
 
FXIcon * getItemOpenIcon (const FXTreeItem *item) const
 
void setItemClosedIcon (FXTreeItem *item, FXIcon *icon, FXbool owned=FALSE)
 
FXIcon * getItemClosedIcon (const FXTreeItem *item) const
 
void setItemData (FXTreeItem *item, void *ptr) const
 
void * getItemData (const FXTreeItem *item) const
 
FXbool isItemSelected (const FXTreeItem *item) const
 
FXbool isItemCurrent (const FXTreeItem *item) const
 
FXbool isItemVisible (const FXTreeItem *item) const
 
FXbool isItemOpened (const FXTreeItem *item) const
 
FXbool isItemExpanded (const FXTreeItem *item) const
 
FXbool isItemLeaf (const FXTreeItem *item) const
 
FXbool isItemEnabled (const FXTreeItem *item) const
 
FXint hitItem (const FXTreeItem *item, FXint x, FXint y) const
 
void updateItem (FXTreeItem *item) const
 
virtual FXbool enableItem (FXTreeItem *item)
 
virtual FXbool disableItem (FXTreeItem *item)
 
virtual FXbool selectItem (FXTreeItem *item, FXbool notify=FALSE)
 
virtual FXbool deselectItem (FXTreeItem *item, FXbool notify=FALSE)
 
virtual FXbool toggleItem (FXTreeItem *item, FXbool notify=FALSE)
 
virtual FXbool extendSelection (FXTreeItem *item, FXbool notify=FALSE)
 
virtual FXbool killSelection (FXbool notify=FALSE)
 
virtual FXbool openItem (FXTreeItem *item, FXbool notify=FALSE)
 
virtual FXbool closeItem (FXTreeItem *item, FXbool notify=FALSE)
 
virtual FXbool collapseTree (FXTreeItem *tree, FXbool notify=FALSE)
 
virtual FXbool expandTree (FXTreeItem *tree, FXbool notify=FALSE)
 
virtual void setCurrentItem (FXTreeItem *item, FXbool notify=FALSE)
 
FXTreeItem * getCurrentItem () const
 
void setAnchorItem (FXTreeItem *item)
 
FXTreeItem * getAnchorItem () const
 
FXTreeItem * getCursorItem () const
 
void sortItems ()
 
void sortRootItems ()
 
void sortChildItems (FXTreeItem *item)
 
FXTreeListSortFunc getSortFunc () const
 
void setSortFunc (FXTreeListSortFunc func)
 
void setFont (FXFont *fnt)
 
FXFont * getFont () const
 
void setIndent (FXint in)
 
FXint getIndent () const
 
FXColor getTextColor () const
 
void setTextColor (FXColor clr)
 
FXColor getSelBackColor () const
 
void setSelBackColor (FXColor clr)
 
FXColor getSelTextColor () const
 
void setSelTextColor (FXColor clr)
 
FXColor getLineColor () const
 
void setLineColor (FXColor clr)
 
FXuint getListStyle () const
 
void setListStyle (FXuint style)
 
void setHelpText (const FXString &text)
 
const FXString & getHelpText () const
 
virtual void save (FXStream &store) const
 
virtual void load (FXStream &store)
 
virtual ~FXTreeList ()
 
- Public Member Functions inherited from FX::FXScrollArea
virtual FXint getViewportHeight ()
 
virtual FXint getViewportWidth ()
 
void setScrollStyle (FXuint style)
 
FXuint getScrollStyle () const
 
FXbool isHorizontalScrollable () const
 
FXbool isVerticalScrollable () const
 
FXScrollBar * horizontalScrollBar () const
 
FXScrollBar * verticalScrollBar () const
 
FXint getXPosition () const
 
FXint getYPosition () const
 
void setPosition (FXint x, FXint y)
 
void getPosition (FXint &x, FXint &y) const
 
virtual ~FXScrollArea ()
 
- Public Member Functions inherited from FX::FXComposite
 FXComposite (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
 
virtual void destroy ()
 
FXint maxChildWidth () const
 
FXint maxChildHeight () const
 
virtual bool isComposite () const
 
virtual ~FXComposite ()
 
- Public Member Functions inherited from FX::FXWindow
 FXWindow (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
 
FXWindow * getParent () const
 
FXWindow * getOwner () const
 
FXWindow * getShell () const
 
FXWindow * getRoot () const
 
FXWindow * getNext () const
 
FXWindow * getPrev () const
 
FXWindow * getFirst () const
 
FXWindow * getLast () const
 
FXWindow * getFocus () const
 
void setKey (FXuint k)
 
FXuint getKey () const
 
void setTarget (FXObject *t)
 
FXObject * getTarget () const
 
void setSelector (FXSelector sel)
 
FXSelector getSelector () const
 
FXint getX () const
 
FXint getY () const
 
virtual FXint getWidthForHeight (FXint givenheight)
 
virtual FXint getHeightForWidth (FXint givenwidth)
 
void setX (FXint x)
 
void setY (FXint y)
 
void setWidth (FXint w)
 
void setHeight (FXint h)
 
void setLayoutHints (FXuint lout)
 
FXuint getLayoutHints () const
 
FXAccelTable * getAccelTable () const
 
void setAccelTable (FXAccelTable *acceltable)
 
void addHotKey (FXHotKey code)
 
void remHotKey (FXHotKey code)
 
void setHelpTag (const FXString &text)
 
const FXString & getHelpTag () const
 
bool isShell () const
 
bool isOwnerOf (const FXWindow *window) const
 
bool isChildOf (const FXWindow *window) const
 
bool containsChild (const FXWindow *child) const
 
FXWindow * getChildAt (FXint x, FXint y) const
 
FXint numChildren () const
 
FXint indexOfChild (const FXWindow *window) const
 
FXWindow * childAtIndex (FXint index) const
 
FXComposeContext * getComposeContext () const
 
void createComposeContext ()
 
void destroyComposeContext ()
 
void setDefaultCursor (FXCursor *cur)
 
FXCursor * getDefaultCursor () const
 
void setDragCursor (FXCursor *cur)
 
FXCursor * getDragCursor () const
 
FXint getCursorPosition (FXint &x, FXint &y, FXuint &buttons) const
 
FXint setCursorPosition (FXint x, FXint y)
 
bool isEnabled () const
 
bool isActive () const
 
bool hasFocus () const
 
bool inFocusChain () const
 
virtual void changeFocus (FXWindow *child)
 
virtual void setDefault (FXbool enable=TRUE)
 
bool isDefault () const
 
void setInitial (bool enable=true)
 
bool isInitial () const
 
virtual void enable ()
 
virtual void disable ()
 
virtual void attach (FXID w)
 
virtual void setShape (const FXRegion &region)
 
virtual void setShape (FXBitmap *bitmap)
 
virtual void setShape (FXIcon *icon)
 
virtual void clearShape ()
 
virtual void raise ()
 
virtual void lower ()
 
virtual void move (FXint x, FXint y)
 
virtual void resize (FXint w, FXint h)
 
virtual void position (FXint x, FXint y, FXint w, FXint h)
 
void forceRefresh ()
 
virtual void reparent (FXWindow *father, FXWindow *other=NULL)
 
void scroll (FXint x, FXint y, FXint w, FXint h, FXint dx, FXint dy) const
 
void update (FXint x, FXint y, FXint w, FXint h) const
 
void update () const
 
void repaint (FXint x, FXint y, FXint w, FXint h) const
 
void repaint () const
 
void grab ()
 
void ungrab ()
 
bool grabbed () const
 
void grabKeyboard ()
 
void ungrabKeyboard ()
 
bool grabbedKeyboard () const
 
virtual void show ()
 
virtual void hide ()
 
bool shown () const
 
bool underCursor () const
 
bool hasSelection () const
 
bool acquireSelection (const FXDragType *types, FXuint numtypes)
 
bool releaseSelection ()
 
bool hasClipboard () const
 
bool acquireClipboard (const FXDragType *types, FXuint numtypes)
 
bool releaseClipboard ()
 
virtual void dropEnable ()
 
virtual void dropDisable ()
 
bool isDropEnabled () const
 
bool isDragging () const
 
bool beginDrag (const FXDragType *types, FXuint numtypes)
 
bool handleDrag (FXint x, FXint y, FXDragAction action=DRAG_COPY)
 
FXDragAction endDrag (bool drop=true)
 
bool isDropTarget () const
 
void setDragRectangle (FXint x, FXint y, FXint w, FXint h, bool wantupdates=true) const
 
void clearDragRectangle () const
 
void acceptDrop (FXDragAction action=DRAG_ACCEPT) const
 
FXDragAction didAccept () const
 
void dropFinished (FXDragAction action=DRAG_REJECT) const
 
bool inquireDNDTypes (FXDNDOrigin origin, FXDragType *&types, FXuint &numtypes) const
 
bool offeredDNDType (FXDNDOrigin origin, FXDragType type) const
 
FXDragAction inquireDNDAction () const
 
bool setDNDData (FXDNDOrigin origin, FXDragType type, FXuchar *data, FXuint size) const
 
bool setDNDData (FXDNDOrigin origin, FXDragType type, const FXString &string) const
 
bool getDNDData (FXDNDOrigin origin, FXDragType type, FXuchar *&data, FXuint &size) const
 
bool getDNDData (FXDNDOrigin origin, FXDragType type, FXString &string) const
 
virtual bool contains (FXint parentx, FXint parenty) const
 
void translateCoordinatesFrom (FXint &tox, FXint &toy, const FXWindow *fromwindow, FXint fromx, FXint fromy) const
 
void translateCoordinatesTo (FXint &tox, FXint &toy, const FXWindow *towindow, FXint fromx, FXint fromy) const
 
virtual void setBackColor (FXColor clr)
 
FXColor getBackColor () const
 
virtual bool doesSaveUnder () const
 
virtual const FXchar * tr (const FXchar *message, const FXchar *hint=NULL) const
 
virtual ~FXWindow ()
 
- Public Member Functions inherited from FX::FXDrawable
FXint getWidth () const
 
FXint getHeight () const
 
FXVisual * getVisual () const
 
void setVisual (FXVisual *vis)
 
virtual ~FXDrawable ()
 
- Public Member Functions inherited from FX::FXId
FXApp * getApp () const
 
FXID id () const
 
void setUserData (void *ptr)
 
void * getUserData () const
 
virtual ~FXId ()
 
- Public Member Functions inherited from FX::FXObject
virtual long onDefault (FXObject *, FXSelector, void *)
 
const FXchar * getClassName () const
 
bool isMemberOf (const FXMetaClass *metaclass) const
 
virtual long tryHandle (FXObject *sender, FXSelector sel, void *ptr)
 
virtual ~FXObject ()
 

Static Public Member Functions

static FXint ascending (const FXTreeItem *, const FXTreeItem *)
 
static FXint descending (const FXTreeItem *, const FXTreeItem *)
 
static FXint ascendingCase (const FXTreeItem *, const FXTreeItem *)
 
static FXint descendingCase (const FXTreeItem *, const FXTreeItem *)
 
- Static Public Member Functions inherited from FX::FXWindow
static FXWindow * commonAncestor (FXWindow *a, FXWindow *b)
 
static bool before (const FXWindow *a, const FXWindow *b)
 
static bool after (const FXWindow *a, const FXWindow *b)
 

Additional Inherited Members

- Public Types inherited from FX::FXWindow
enum  {
  ID_NONE,
  ID_HIDE,
  ID_SHOW,
  ID_TOGGLESHOWN,
  ID_LOWER,
  ID_RAISE,
  ID_DELETE,
  ID_DISABLE,
  ID_ENABLE,
  ID_TOGGLEENABLED,
  ID_UNCHECK,
  ID_CHECK,
  ID_UNKNOWN,
  ID_UPDATE,
  ID_AUTOSCROLL,
  ID_TIPTIMER,
  ID_HSCROLLED,
  ID_VSCROLLED,
  ID_SETVALUE,
  ID_SETINTVALUE,
  ID_SETREALVALUE,
  ID_SETSTRINGVALUE,
  ID_SETICONVALUE,
  ID_SETINTRANGE,
  ID_SETREALRANGE,
  ID_GETINTVALUE,
  ID_GETREALVALUE,
  ID_GETSTRINGVALUE,
  ID_GETICONVALUE,
  ID_GETINTRANGE,
  ID_GETREALRANGE,
  ID_SETHELPSTRING,
  ID_GETHELPSTRING,
  ID_SETTIPSTRING,
  ID_GETTIPSTRING,
  ID_QUERY_MENU,
  ID_HOTKEY,
  ID_ACCEL,
  ID_UNPOST,
  ID_POST,
  ID_MDI_TILEHORIZONTAL,
  ID_MDI_TILEVERTICAL,
  ID_MDI_CASCADE,
  ID_MDI_MAXIMIZE,
  ID_MDI_MINIMIZE,
  ID_MDI_RESTORE,
  ID_MDI_CLOSE,
  ID_MDI_WINDOW,
  ID_MDI_MENUWINDOW,
  ID_MDI_MENUMINIMIZE,
  ID_MDI_MENURESTORE,
  ID_MDI_MENUCLOSE,
  ID_MDI_NEXT,
  ID_MDI_PREV,
  ID_LAST
}
 
- Static Public Attributes inherited from FX::FXWindow
static FXDragType octetType
 
static FXDragType deleteType
 
static FXDragType textType
 
static FXDragType utf8Type
 
static FXDragType utf16Type
 
static FXDragType colorType
 
static FXDragType urilistType
 
static const FXDragType stringType
 
static const FXDragType imageType
 
static const FXchar octetTypeName []
 
static const FXchar deleteTypeName []
 
static const FXchar textTypeName []
 
static const FXchar colorTypeName []
 
static const FXchar urilistTypeName []
 
static const FXchar utf8TypeName []
 
static const FXchar utf16TypeName []
 

Detailed Description

A Tree List Widget organizes items in a hierarchical, tree-like fashion.

Subtrees can be collapsed or expanded by double-clicking on an item or by clicking on the optional plus button in front of the item. Each item may have a text and optional open-icon as well as a closed-icon. The items may be connected by optional lines to show the hierarchical relationship. When an item's selected state changes, the treelist emits a SEL_SELECTED or SEL_DESELECTED message. If an item is opened or closed, a message of type SEL_OPENED or SEL_CLOSED is sent. When the subtree under an item is expanded, a SEL_EXPANDED or SEL_COLLAPSED message is issued. A change of the current item is signified by the SEL_CHANGED message. In addition, the tree list sends SEL_COMMAND messages when the user clicks on an item, and SEL_CLICKED, SEL_DOUBLECLICKED, and SEL_TRIPLECLICKED when the user clicks once, twice, or thrice, respectively. When items are added or removed, the tree list sends messages of the type SEL_INSERTED or SEL_DELETED. In each of these cases, a pointer to the item, if any, is passed in the 3rd argument of the message.

See also:

Constructor & Destructor Documentation

FX::FXTreeList::FXTreeList ( FXComposite *  p,
FXObject *  tgt = NULL,
FXSelector  sel = 0,
FXuint  opts = TREELIST_NORMAL,
FXint  x = 0,
FXint  y = 0,
FXint  w = 0,
FXint  h = 0 
)

Construct a new, initially empty tree list.

virtual FX::FXTreeList::~FXTreeList ( )
virtual

Destructor.

Member Function Documentation

static FXint FX::FXTreeList::ascending ( const FXTreeItem *  ,
const FXTreeItem *   
)
static
static FXint FX::FXTreeList::descending ( const FXTreeItem *  ,
const FXTreeItem *   
)
static
static FXint FX::FXTreeList::ascendingCase ( const FXTreeItem *  ,
const FXTreeItem *   
)
static
static FXint FX::FXTreeList::descendingCase ( const FXTreeItem *  ,
const FXTreeItem *   
)
static
virtual void FX::FXTreeList::create ( )
virtual

Create server-side resources.

Reimplemented from FX::FXComposite.

Reimplemented in FX::FXDirList.

virtual void FX::FXTreeList::detach ( )
virtual

Detach server-side resources.

Reimplemented from FX::FXComposite.

Reimplemented in FX::FXDirList.

virtual void FX::FXTreeList::layout ( )
virtual

Perform layout.

Reimplemented from FX::FXScrollArea.

virtual FXint FX::FXTreeList::getDefaultWidth ( )
virtual

Return default width.

Reimplemented from FX::FXScrollArea.

virtual FXint FX::FXTreeList::getDefaultHeight ( )
virtual

Return default height.

Reimplemented from FX::FXScrollArea.

virtual FXint FX::FXTreeList::getContentWidth ( )
virtual

Compute and return content width.

Reimplemented from FX::FXScrollArea.

virtual FXint FX::FXTreeList::getContentHeight ( )
virtual

Return content height.

Reimplemented from FX::FXScrollArea.

virtual void FX::FXTreeList::recalc ( )
virtual

Recalculate layout.

Reimplemented from FX::FXWindow.

virtual bool FX::FXTreeList::canFocus ( ) const
virtual

Tree list can receive focus.

Reimplemented from FX::FXWindow.

virtual void FX::FXTreeList::setFocus ( )
virtual

Move the focus to this window.

Reimplemented from FX::FXWindow.

virtual void FX::FXTreeList::killFocus ( )
virtual

Remove the focus from this window.

Reimplemented from FX::FXWindow.

FXint FX::FXTreeList::getNumItems ( ) const

Return number of items.

FXint FX::FXTreeList::getNumVisible ( ) const
inline

Return number of visible items.

void FX::FXTreeList::setNumVisible ( FXint  nvis)

Change number of visible items.

FXTreeItem* FX::FXTreeList::getFirstItem ( ) const
inline

Return first root item.

FXTreeItem* FX::FXTreeList::getLastItem ( ) const
inline

Return last root item.

FXint FX::FXTreeList::fillItems ( FXTreeItem *  father,
const FXchar **  strings,
FXIcon *  oi = NULL,
FXIcon *  ci = NULL,
void *  ptr = NULL,
FXbool  notify = FALSE 
)

Fill tree list by appending items from array of strings.

FXint FX::FXTreeList::fillItems ( FXTreeItem *  father,
const FXString &  strings,
FXIcon *  oi = NULL,
FXIcon *  ci = NULL,
void *  ptr = NULL,
FXbool  notify = FALSE 
)

Fill tree list by appending items from newline separated strings.

FXTreeItem* FX::FXTreeList::insertItem ( FXTreeItem *  other,
FXTreeItem *  father,
FXTreeItem *  item,
FXbool  notify = FALSE 
)

Insert [possibly subclassed] item under father before other item.

FXTreeItem* FX::FXTreeList::insertItem ( FXTreeItem *  other,
FXTreeItem *  father,
const FXString &  text,
FXIcon *  oi = NULL,
FXIcon *  ci = NULL,
void *  ptr = NULL,
FXbool  notify = FALSE 
)

Insert item with given text and optional icons, and user-data pointer under father before other item.

FXTreeItem* FX::FXTreeList::appendItem ( FXTreeItem *  father,
FXTreeItem *  item,
FXbool  notify = FALSE 
)

Append [possibly subclassed] item as last child of father.

FXTreeItem* FX::FXTreeList::appendItem ( FXTreeItem *  father,
const FXString &  text,
FXIcon *  oi = NULL,
FXIcon *  ci = NULL,
void *  ptr = NULL,
FXbool  notify = FALSE 
)

Append item with given text and optional icons, and user-data pointer as last child of father.

FXTreeItem* FX::FXTreeList::prependItem ( FXTreeItem *  father,
FXTreeItem *  item,
FXbool  notify = FALSE 
)

Prepend [possibly subclassed] item as first child of father.

FXTreeItem* FX::FXTreeList::prependItem ( FXTreeItem *  father,
const FXString &  text,
FXIcon *  oi = NULL,
FXIcon *  ci = NULL,
void *  ptr = NULL,
FXbool  notify = FALSE 
)

Prepend item with given text and optional icons, and user-data pointer as first child of father.

FXTreeItem* FX::FXTreeList::moveItem ( FXTreeItem *  other,
FXTreeItem *  father,
FXTreeItem *  item 
)

Move item under father before other item.

FXTreeItem* FX::FXTreeList::extractItem ( FXTreeItem *  item,
FXbool  notify = FALSE 
)

Extract item.

void FX::FXTreeList::removeItem ( FXTreeItem *  item,
FXbool  notify = FALSE 
)

Remove item.

void FX::FXTreeList::removeItems ( FXTreeItem *  fm,
FXTreeItem *  to,
FXbool  notify = FALSE 
)

Remove items in range [fm, to] inclusively.

void FX::FXTreeList::clearItems ( FXbool  notify = FALSE)

Remove all items from list.

FXint FX::FXTreeList::getItemWidth ( const FXTreeItem *  item) const
inline

Return item width.

References FX::FXTreeItem::getWidth().

FXint FX::FXTreeList::getItemHeight ( const FXTreeItem *  item) const
inline

Return item height.

References FX::FXTreeItem::getHeight().

virtual FXTreeItem* FX::FXTreeList::getItemAt ( FXint  x,
FXint  y 
) const
virtual

Get item at x,y, if any.

FXTreeItem* FX::FXTreeList::findItem ( const FXString &  name,
FXTreeItem *  start = NULL,
FXuint  flags = SEARCH_FORWARD|SEARCH_WRAP 
) const

Search items by name, beginning from item start.

If the start item is NULL the search will start at the first, top-most item in the list. Flags may be SEARCH_FORWARD or SEARCH_BACKWARD to control the search direction; this can be combined with SEARCH_NOWRAP or SEARCH_WRAP to control whether the search wraps at the start or end of the list. The option SEARCH_IGNORECASE causes a case-insensitive match. Finally, passing SEARCH_PREFIX causes searching for a prefix of the item name. Return NULL if no matching item is found.

FXTreeItem* FX::FXTreeList::findItemByData ( const void *  ptr,
FXTreeItem *  start = NULL,
FXuint  flags = SEARCH_FORWARD|SEARCH_WRAP 
) const

Search items by associated user data, beginning from item start.

If the start item is NULL the search will start at the first, top-most item in the list. Flags may be SEARCH_FORWARD or SEARCH_BACKWARD to control the search direction; this can be combined with SEARCH_NOWRAP or SEARCH_WRAP to control whether the search wraps at the start or end of the list.

virtual void FX::FXTreeList::makeItemVisible ( FXTreeItem *  item)
virtual

Scroll to make item visible.

void FX::FXTreeList::setItemText ( FXTreeItem *  item,
const FXString &  text 
)

Change item's text.

FXString FX::FXTreeList::getItemText ( const FXTreeItem *  item) const

Return item's text.

void FX::FXTreeList::setItemOpenIcon ( FXTreeItem *  item,
FXIcon *  icon,
FXbool  owned = FALSE 
)

Change item's open icon.

FXIcon* FX::FXTreeList::getItemOpenIcon ( const FXTreeItem *  item) const

Return item's open icon, deleting the old icon if it was owned.

void FX::FXTreeList::setItemClosedIcon ( FXTreeItem *  item,
FXIcon *  icon,
FXbool  owned = FALSE 
)

Chance item's closed icon, deleting the old icon if it was owned.

FXIcon* FX::FXTreeList::getItemClosedIcon ( const FXTreeItem *  item) const

Return item's closed icon.

void FX::FXTreeList::setItemData ( FXTreeItem *  item,
void *  ptr 
) const

Change item user-data pointer.

void* FX::FXTreeList::getItemData ( const FXTreeItem *  item) const

Return item user-data pointer.

FXbool FX::FXTreeList::isItemSelected ( const FXTreeItem *  item) const

Return TRUE if item is selected.

FXbool FX::FXTreeList::isItemCurrent ( const FXTreeItem *  item) const

Return TRUE if item is current.

FXbool FX::FXTreeList::isItemVisible ( const FXTreeItem *  item) const

Return TRUE if item is visible.

FXbool FX::FXTreeList::isItemOpened ( const FXTreeItem *  item) const

Return TRUE if item opened.

FXbool FX::FXTreeList::isItemExpanded ( const FXTreeItem *  item) const

Return TRUE if item expanded.

FXbool FX::FXTreeList::isItemLeaf ( const FXTreeItem *  item) const

Return TRUE if item is a leaf-item, i.e. has no children.

FXbool FX::FXTreeList::isItemEnabled ( const FXTreeItem *  item) const

Return TRUE if item is enabled.

FXint FX::FXTreeList::hitItem ( const FXTreeItem *  item,
FXint  x,
FXint  y 
) const

Return item hit code: 0 outside, 1 icon, 2 text, 3 box.

void FX::FXTreeList::updateItem ( FXTreeItem *  item) const

Repaint item.

virtual FXbool FX::FXTreeList::enableItem ( FXTreeItem *  item)
virtual

Enable item.

virtual FXbool FX::FXTreeList::disableItem ( FXTreeItem *  item)
virtual

Disable item.

virtual FXbool FX::FXTreeList::selectItem ( FXTreeItem *  item,
FXbool  notify = FALSE 
)
virtual

Select item.

virtual FXbool FX::FXTreeList::deselectItem ( FXTreeItem *  item,
FXbool  notify = FALSE 
)
virtual

Deselect item.

virtual FXbool FX::FXTreeList::toggleItem ( FXTreeItem *  item,
FXbool  notify = FALSE 
)
virtual

Toggle item selection.

virtual FXbool FX::FXTreeList::extendSelection ( FXTreeItem *  item,
FXbool  notify = FALSE 
)
virtual

Extend selection from anchor item to item.

virtual FXbool FX::FXTreeList::killSelection ( FXbool  notify = FALSE)
virtual

Deselect all items.

virtual FXbool FX::FXTreeList::openItem ( FXTreeItem *  item,
FXbool  notify = FALSE 
)
virtual

Open item.

virtual FXbool FX::FXTreeList::closeItem ( FXTreeItem *  item,
FXbool  notify = FALSE 
)
virtual

Close item.

virtual FXbool FX::FXTreeList::collapseTree ( FXTreeItem *  tree,
FXbool  notify = FALSE 
)
virtual

Collapse tree.

Reimplemented in FX::FXDirList.

virtual FXbool FX::FXTreeList::expandTree ( FXTreeItem *  tree,
FXbool  notify = FALSE 
)
virtual

Expand tree.

Reimplemented in FX::FXDirList.

virtual void FX::FXTreeList::setCurrentItem ( FXTreeItem *  item,
FXbool  notify = FALSE 
)
virtual

Change current item.

FXTreeItem* FX::FXTreeList::getCurrentItem ( ) const
inline

Return current item, if any.

void FX::FXTreeList::setAnchorItem ( FXTreeItem *  item)

Change anchor item.

FXTreeItem* FX::FXTreeList::getAnchorItem ( ) const
inline

Return anchor item, if any.

FXTreeItem* FX::FXTreeList::getCursorItem ( ) const
inline

Return item under cursor, if any.

void FX::FXTreeList::sortItems ( )

Sort all items recursively.

void FX::FXTreeList::sortRootItems ( )

Sort root items.

void FX::FXTreeList::sortChildItems ( FXTreeItem *  item)

Sort children of item.

FXTreeListSortFunc FX::FXTreeList::getSortFunc ( ) const
inline

Return sort function.

void FX::FXTreeList::setSortFunc ( FXTreeListSortFunc  func)
inline

Change sort function.

void FX::FXTreeList::setFont ( FXFont *  fnt)

Change text font.

FXFont* FX::FXTreeList::getFont ( ) const
inline

Return text font.

void FX::FXTreeList::setIndent ( FXint  in)

Change parent-child indent amount.

FXint FX::FXTreeList::getIndent ( ) const
inline

Return parent-child indent amount.

FXColor FX::FXTreeList::getTextColor ( ) const
inline

Return normal text color.

void FX::FXTreeList::setTextColor ( FXColor  clr)

Change normal text color.

FXColor FX::FXTreeList::getSelBackColor ( ) const
inline

Return selected text background.

void FX::FXTreeList::setSelBackColor ( FXColor  clr)

Change selected text background.

FXColor FX::FXTreeList::getSelTextColor ( ) const
inline

Return selected text color.

void FX::FXTreeList::setSelTextColor ( FXColor  clr)

Change selected text color.

FXColor FX::FXTreeList::getLineColor ( ) const
inline

Return line color.

void FX::FXTreeList::setLineColor ( FXColor  clr)

Change line color.

FXuint FX::FXTreeList::getListStyle ( ) const

Return list style.

void FX::FXTreeList::setListStyle ( FXuint  style)

Change list style.

void FX::FXTreeList::setHelpText ( const FXString &  text)

Set the status line help text for this list.

const FXString& FX::FXTreeList::getHelpText ( ) const
inline

Get the status line help text for this list.

virtual void FX::FXTreeList::save ( FXStream &  store) const
virtual

Save object to a stream.

Reimplemented from FX::FXWindow.

Reimplemented in FX::FXDirList.

virtual void FX::FXTreeList::load ( FXStream &  store)
virtual

Load object from a stream.

Reimplemented from FX::FXWindow.

Reimplemented in FX::FXDirList.

Copyright © 1997-2005 Jeroen van der Zijp