FXTreeList

class FXTreeList

Tree list Widget

Inheritance:

Public Methods

[more] 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
[more]virtual void create()
Create server-side resources
[more]virtual void detach()
Detach server-side resources
[more]virtual FXint getDefaultWidth()
Return default width
[more]virtual FXint getDefaultHeight()
Return default height
[more]virtual FXint getContentWidth()
Compute and return content width
[more]virtual FXint getContentHeight()
Return content height
[more]virtual void recalc()
Recalculate layout
[more]virtual FXbool canFocus() const
Tree list can receive focus
[more]virtual void setFocus()
Move the focus to this window
[more]virtual void killFocus()
Remove the focus from this window
[more]FXint getNumItems() const
Return number of items
[more]FXint getNumVisible() const
Return number of visible items
[more]void setNumVisible(FXint nvis)
Change number of visible items
[more]FXTreeItem* getFirstItem() const
REturn first root item
[more]FXTreeItem* getLastItem() const
Return last root item
[more]FXTreeItem* addItemFirst(FXTreeItem* p, FXTreeItem* item, FXbool notify=FALSE)
Prepend new [possibly subclassed] item as first child of p
[more]FXTreeItem* addItemFirst(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
[more]FXTreeItem* addItemLast(FXTreeItem* p, FXTreeItem* item, FXbool notify=FALSE)
Append new [possibly subclassed] item as last child of p
[more]FXTreeItem* addItemLast(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
[more]FXTreeItem* addItemAfter(FXTreeItem* other, FXTreeItem* item, FXbool notify=FALSE)
Append new [possibly subclassed] item after to other item
[more]FXTreeItem* addItemAfter(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
[more]FXTreeItem* addItemBefore(FXTreeItem* other, FXTreeItem* item, FXbool notify=FALSE)
Prepend new [possibly subclassed] item prior to other item
[more]FXTreeItem* addItemBefore(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
[more]void removeItem(FXTreeItem* item, FXbool notify=FALSE)
Remove item
[more]void removeItems(FXTreeItem* fm, FXTreeItem* to, FXbool notify=FALSE)
Remove items in range [fm, to] inclusively
[more]void clearItems(FXbool notify=FALSE)
Remove all items from list
[more]FXint getItemWidth(const FXTreeItem* item) const
Return item width
[more]FXint getItemHeight(const FXTreeItem* item) const
Return item height
[more]virtual FXTreeItem* getItemAt(FXint x, FXint y) const
Get item at x,y, if any
[more]FXTreeItem* 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
[more]void makeItemVisible(FXTreeItem* item)
Scroll to make item visible
[more]void setItemText(FXTreeItem* item, const FXString& text)
Change item's text
[more]FXString getItemText(const FXTreeItem* item) const
Return item's text
[more]void setItemOpenIcon(FXTreeItem* item, FXIcon* icon)
Change item's open icon
[more]FXIcon* getItemOpenIcon(const FXTreeItem* item) const
Return item's open icon
[more]void setItemClosedIcon(FXTreeItem* item, FXIcon* icon)
Chance item's closed icon
[more]FXIcon* getItemClosedIcon(const FXTreeItem* item) const
Return item's closed icon
[more]void setItemData(FXTreeItem* item, void* ptr) const
Change item user-data pointer
[more]void* getItemData(const FXTreeItem* item) const
Return item user-data pointer
[more]FXbool isItemSelected(const FXTreeItem* item) const
Return TRUE if item is selected
[more]FXbool isItemCurrent(const FXTreeItem* item) const
Return TRUE if item is current
[more]FXbool isItemVisible(const FXTreeItem* item) const
Return TRUE if item is visible
[more]FXbool isItemOpened(const FXTreeItem* item) const
Return TRUE if item opened
[more]FXbool isItemExpanded(const FXTreeItem* item) const
Return TRUE if item expanded
[more]FXbool isItemLeaf(const FXTreeItem* item) const
Return TRUE if item is a leaf-item, ie.
[more]FXbool isItemEnabled(const FXTreeItem* item) const
Return TRUE if item is enabled
[more]FXint hitItem(const FXTreeItem* item, FXint x, FXint y) const
Return item hit code: 0 outside, 1 icon, 2 text, 3 box
[more]void updateItem(FXTreeItem* item)
Repaint item
[more]FXbool enableItem(FXTreeItem* item)
Enable item
[more]FXbool disableItem(FXTreeItem* item)
Disable item
[more]FXbool selectItem(FXTreeItem* item, FXbool notify=FALSE)
Select item
[more]FXbool deselectItem(FXTreeItem* item, FXbool notify=FALSE)
Deselect item
[more]FXbool toggleItem(FXTreeItem* item, FXbool notify=FALSE)
Toggle item selection
[more]FXbool openItem(FXTreeItem* item, FXbool notify=FALSE)
Open item
[more]FXbool closeItem(FXTreeItem* item, FXbool notify=FALSE)
Close item
[more]FXbool collapseTree(FXTreeItem* tree, FXbool notify=FALSE)
Collapse tree
[more]FXbool expandTree(FXTreeItem* tree, FXbool notify=FALSE)
Expand tree
[more]void reparentItem(FXTreeItem* item, FXTreeItem* p)
Reparent item under parent p
[more]void setCurrentItem(FXTreeItem* item, FXbool notify=FALSE)
Change current item
[more]FXTreeItem* getCurrentItem() const
Return current item, if any
[more]void setAnchorItem(FXTreeItem* item)
Change anchor item
[more]FXTreeItem* getAnchorItem() const
Return anchor item, if any
[more]FXTreeItem* getCursorItem() const
Return item under cursor, if any
[more]FXbool extendSelection(FXTreeItem* item, FXbool notify=FALSE)
Extend selection from anchor item to item
[more]FXbool killSelection(FXbool notify=FALSE)
Deselect all items
[more]void sortItems()
Sort root items
[more]void sortChildItems(FXTreeItem* item)
Sort children of item
[more]void setFont(FXFont* fnt)
Change text font
[more]FXFont* getFont() const
Return text font
[more]void setIndent(FXint in)
Change parent-child indent amount
[more]FXint getIndent() const
Return parent-child indent amount
[more]FXColor getTextColor() const
Return normal text color
[more]void setTextColor(FXColor clr)
Change normal text color
[more]FXColor getSelBackColor() const
Return selected text background
[more]void setSelBackColor(FXColor clr)
Change selected text background
[more]FXColor getSelTextColor() const
Return selected text color
[more]void setSelTextColor(FXColor clr)
Change selected text color
[more]FXColor getLineColor() const
Return line color
[more]void setLineColor(FXColor clr)
Change line color
[more]FXTreeListSortFunc getSortFunc() const
Return sort function
[more]void setSortFunc(FXTreeListSortFunc func)
Change sort function
[more]FXuint getListStyle() const
Return list style
[more]void setListStyle(FXuint style)
Change list style
[more]void setHelpText(const FXString& text)
Set the status line help text for this list
[more]FXString getHelpText() const
Get the status line help text for this list
[more]virtual void save(FXStream& store) const
Save object to a stream
[more]virtual void load(FXStream& store)
Load object from a stream
[more]virtual ~FXTreeList()
Destructor

Inherited from FXScrollArea:

Public Methods

ovirtual FXint getViewportHeight()
ovoid setScrollStyle(FXuint style)
oFXuint getScrollStyle() const
oFXbool isHorizontalScrollable() const
oFXbool isVerticalScrollable() const
oFXScrollbar* horizontalScrollbar() const
oFXScrollbar* verticalScrollbar() const
oFXint getXPosition() const
oFXint getYPosition() const
ovoid setPosition(FXint x, FXint y)
ovoid getPosition(FXint& x, FXint& y) const
ovirtual void moveContents(FXint x, FXint y)

Inherited from FXComposite:

Public Methods

ovirtual void destroy()
oFXint maxChildWidth() const
oFXint maxChildHeight() const
ovirtual FXbool isComposite() const

Inherited from FXWindow:

Public Methods

oFXWindow* getParent() const
oFXWindow* getOwner() const
oFXWindow* getShell() const
oFXWindow* getRoot() const
oFXWindow* getNext() const
oFXWindow* getPrev() const
oFXWindow* getFirst() const
oFXWindow* getLast() const
oFXWindow* getFocus() const
ovoid setKey(FXuint k)
oFXuint getKey() const
ovoid setTarget(FXObject* t)
oFXObject* getTarget() const
ovoid setSelector(FXSelector sel)
oFXSelector getSelector() const
oFXint getX() const
oFXint getY() const
ovirtual FXint getWidthForHeight(FXint givenheight)
ovirtual FXint getHeightForWidth(FXint givenwidth)
ovoid setX(FXint x)
ovoid setY(FXint y)
ovoid setWidth(FXint w)
ovoid setHeight(FXint h)
ovoid setLayoutHints(FXuint lout)
oFXuint getLayoutHints() const
oFXAccelTable* getAccelTable() const
ovoid setAccelTable(FXAccelTable* acceltable)
ovoid addHotKey(FXHotKey code)
ovoid remHotKey(FXHotKey code)
oFXbool isShell() const
oFXbool isChildOf(const FXWindow* window) const
oFXbool containsChild(const FXWindow* child) const
oFXWindow* getChildAt(FXint x, FXint y) const
oFXint numChildren() const
oFXint indexOfChild(const FXWindow* window) const
oFXWindow* childAtIndex(FXint index) const
ostatic FXWindow* commonAncestor(FXWindow* a, FXWindow* b)
ovoid setDefaultCursor(FXCursor* cur)
oFXCursor* getDefaultCursor() const
ovoid setDragCursor(FXCursor* cur)
oFXCursor* getDragCursor() const
oFXint getCursorPosition(FXint& x, FXint& y, FXuint& buttons) const
oFXint setCursorPosition(FXint x, FXint y)
oFXbool isEnabled() const
oFXbool isActive() const
oFXbool hasFocus() const
ovirtual void setDefault(FXbool enable=TRUE)
oFXbool isDefault() const
ovoid setInitial(FXbool enable=TRUE)
oFXbool isInitial() const
ovirtual void enable()
ovirtual void disable()
ovirtual void raise()
ovirtual void lower()
ovirtual void move(FXint x, FXint y)
ovirtual void resize(FXint w, FXint h)
ovirtual void position(FXint x, FXint y, FXint w, FXint h)
ovoid forceRefresh()
ovirtual void reparent(FXWindow* newparent)
ovoid scroll(FXint x, FXint y, FXint w, FXint h, FXint dx, FXint dy)
ovoid update(FXint x, FXint y, FXint w, FXint h)
ovoid update()
ovoid repaint(FXint x, FXint y, FXint w, FXint h)
ovoid repaint()
ovoid grab()
ovoid ungrab()
oFXbool grabbed() const
ovoid grabKeyboard()
ovoid ungrabKeyboard()
oFXbool grabbedKeyboard() const
ovirtual void show()
ovirtual void hide()
oFXbool shown() const
oFXbool underCursor() const
oFXbool hasSelection() const
oFXbool acquireSelection(const FXDragType* types, FXuint numtypes)
oFXbool releaseSelection()
oFXbool hasClipboard() const
oFXbool acquireClipboard(const FXDragType* types, FXuint numtypes)
oFXbool releaseClipboard()
ovoid dropEnable()
ovoid dropDisable()
oFXbool isDropEnabled() const
oFXbool isDragging() const
oFXbool beginDrag(const FXDragType* types, FXuint numtypes)
oFXbool handleDrag(FXint x, FXint y, FXDragAction action=DRAG_COPY)
oFXbool endDrag(FXbool drop=TRUE)
oFXbool isDropTarget() const
ovoid setDragRectangle(FXint x, FXint y, FXint w, FXint h, FXbool wantupdates=TRUE)
ovoid clearDragRectangle()
ovoid acceptDrop(FXDragAction action=DRAG_ACCEPT)
oFXDragAction didAccept() const
oFXbool inquireDNDTypes(FXDNDOrigin origin, FXDragType*& types, FXuint& numtypes)
oFXbool offeredDNDType(FXDNDOrigin origin, FXDragType type)
oFXDragAction inquireDNDAction() const
oFXbool setDNDData(FXDNDOrigin origin, FXDragType type, FXuchar* data, FXuint size)
oFXbool getDNDData(FXDNDOrigin origin, FXDragType type, FXuchar*& data, FXuint& size)
ovirtual FXbool contains(FXint parentx, FXint parenty) const
ovoid translateCoordinatesFrom(FXint& tox, FXint& toy, const FXWindow* fromwindow, FXint fromx, FXint fromy) const
ovoid translateCoordinatesTo(FXint& tox, FXint& toy, const FXWindow* towindow, FXint fromx, FXint fromy) const
ovirtual void setBackColor(FXColor clr)
oFXColor getBackColor() const
ovoid linkBefore(FXWindow* sibling)
ovoid linkAfter(FXWindow* sibling)

Inherited from FXDrawable:

Public Methods

oFXint getWidth() const
oFXint getHeight() const
oFXVisual* getVisual() const
ovoid setVisual(FXVisual* vis)

Inherited from FXId:

Public Methods

oFXApp* getApp() const
oFXID id() const
ovoid setUserData(void* ptr)
ovoid* getUserData() const

Inherited from FXObject:

Public Methods

oconst FXchar* getClassName() const
oFXbool isMemberOf(const FXMetaClass* metaclass) const

Documentation

Tree list Widget
o 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

ovirtual void create()
Create server-side resources

ovirtual void detach()
Detach server-side resources

ovirtual FXint getDefaultWidth()
Return default width

ovirtual FXint getDefaultHeight()
Return default height

ovirtual FXint getContentWidth()
Compute and return content width

ovirtual FXint getContentHeight()
Return content height

ovirtual void recalc()
Recalculate layout

ovirtual FXbool canFocus() const
Tree list can receive focus

ovirtual void setFocus()
Move the focus to this window

ovirtual void killFocus()
Remove the focus from this window

oFXint getNumItems() const
Return number of items

oFXint getNumVisible() const
Return number of visible items

ovoid setNumVisible(FXint nvis)
Change number of visible items

oFXTreeItem* getFirstItem() const
REturn first root item

oFXTreeItem* getLastItem() const
Return last root item

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

oFXTreeItem* addItemFirst(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

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

oFXTreeItem* addItemLast(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

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

oFXTreeItem* addItemAfter(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

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

oFXTreeItem* addItemBefore(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

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

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

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

oFXint getItemWidth(const FXTreeItem* item) const
Return item width

oFXint getItemHeight(const FXTreeItem* item) const
Return item height

ovirtual FXTreeItem* getItemAt(FXint x, FXint y) const
Get item at x,y, if any

oFXTreeItem* 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

ovoid makeItemVisible(FXTreeItem* item)
Scroll to make item visible

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

oFXString getItemText(const FXTreeItem* item) const
Return item's text

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

oFXIcon* getItemOpenIcon(const FXTreeItem* item) const
Return item's open icon

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

oFXIcon* getItemClosedIcon(const FXTreeItem* item) const
Return item's closed icon

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

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

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

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

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

oFXbool isItemOpened(const FXTreeItem* item) const
Return TRUE if item opened

oFXbool isItemExpanded(const FXTreeItem* item) const
Return TRUE if item expanded

oFXbool isItemLeaf(const FXTreeItem* item) const
Return TRUE if item is a leaf-item, ie. has no children

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

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

ovoid updateItem(FXTreeItem* item)
Repaint item

oFXbool enableItem(FXTreeItem* item)
Enable item

oFXbool disableItem(FXTreeItem* item)
Disable item

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

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

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

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

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

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

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

ovoid reparentItem(FXTreeItem* item, FXTreeItem* p)
Reparent item under parent p

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

oFXTreeItem* getCurrentItem() const
Return current item, if any

ovoid setAnchorItem(FXTreeItem* item)
Change anchor item

oFXTreeItem* getAnchorItem() const
Return anchor item, if any

oFXTreeItem* getCursorItem() const
Return item under cursor, if any

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

oFXbool killSelection(FXbool notify=FALSE)
Deselect all items

ovoid sortItems()
Sort root items

ovoid sortChildItems(FXTreeItem* item)
Sort children of item

ovoid setFont(FXFont* fnt)
Change text font

oFXFont* getFont() const
Return text font

ovoid setIndent(FXint in)
Change parent-child indent amount

oFXint getIndent() const
Return parent-child indent amount

oFXColor getTextColor() const
Return normal text color

ovoid setTextColor(FXColor clr)
Change normal text color

oFXColor getSelBackColor() const
Return selected text background

ovoid setSelBackColor(FXColor clr)
Change selected text background

oFXColor getSelTextColor() const
Return selected text color

ovoid setSelTextColor(FXColor clr)
Change selected text color

oFXColor getLineColor() const
Return line color

ovoid setLineColor(FXColor clr)
Change line color

oFXTreeListSortFunc getSortFunc() const
Return sort function

ovoid setSortFunc(FXTreeListSortFunc func)
Change sort function

oFXuint getListStyle() const
Return list style

ovoid setListStyle(FXuint style)
Change list style

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

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

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

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

ovirtual ~FXTreeList()
Destructor

Direct child classes:
FXDirList

Alphabetic index HTML hierarchy of classes or Java


This page was generated with the help of DOC++.