Tree list Widget
Inheritance:
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
-
FXTreeItem* getFirstItem() const
- REturn first root item
-
FXTreeItem* getLastItem() const
- Return last root item
-
FXTreeItem* addItemFirst(FXTreeItem* p, FXTreeItem* item, FXbool notify=FALSE)
- Prepend new [possibly subclassed] item as first child of p
-
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
-
FXTreeItem* addItemLast(FXTreeItem* p, FXTreeItem* item, FXbool notify=FALSE)
- Append new [possibly subclassed] item as last child of p
-
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
-
FXTreeItem* addItemAfter(FXTreeItem* other, FXTreeItem* item, FXbool notify=FALSE)
- Append new [possibly subclassed] item after to other item
-
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
-
FXTreeItem* addItemBefore(FXTreeItem* other, FXTreeItem* item, FXbool notify=FALSE)
- Prepend new [possibly subclassed] item prior to other item
-
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
-
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 FXTreeItem* getItemAt(FXint x, FXint y) const
- Get item at x,y, if any
-
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
-
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
-
FXIcon* getItemOpenIcon(const FXTreeItem* item) const
- Return item's open icon
-
void setItemClosedIcon(FXTreeItem* item, FXIcon* icon)
- Chance item's closed icon
-
FXIcon* getItemClosedIcon(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, ie.
-
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
-
FXTreeItem* getCurrentItem() const
- Return current item, if any
-
void setAnchorItem(FXTreeItem* item)
- Change anchor item
-
FXTreeItem* getAnchorItem() const
- Return anchor item, if any
-
FXTreeItem* getCursorItem() 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
-
FXFont* getFont() 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
-
FXString getHelpText() const
- Get 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
Public Methods
-
virtual FXint getViewportHeight()
-
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 void moveContents(FXint x, FXint y)
Public Methods
-
virtual void destroy()
-
FXint maxChildWidth() const
-
FXint maxChildHeight() const
-
virtual FXbool isComposite() const
Public Methods
-
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)
-
FXbool isShell() const
-
FXbool isChildOf(const FXWindow* window) const
-
FXbool 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
-
static FXWindow* commonAncestor(FXWindow* a, FXWindow* b)
-
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)
-
FXbool isEnabled() const
-
FXbool isActive() const
-
FXbool hasFocus() const
-
virtual void setDefault(FXbool enable=TRUE)
-
FXbool isDefault() const
-
void setInitial(FXbool enable=TRUE)
-
FXbool isInitial() const
-
virtual void enable()
-
virtual void disable()
-
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* newparent)
-
void scroll(FXint x, FXint y, FXint w, FXint h, FXint dx, FXint dy)
-
void update(FXint x, FXint y, FXint w, FXint h)
-
void update()
-
void repaint(FXint x, FXint y, FXint w, FXint h)
-
void repaint()
-
void grab()
-
void ungrab()
-
FXbool grabbed() const
-
void grabKeyboard()
-
void ungrabKeyboard()
-
FXbool grabbedKeyboard() const
-
virtual void show()
-
virtual void hide()
-
FXbool shown() const
-
FXbool underCursor() const
-
FXbool hasSelection() const
-
FXbool acquireSelection(const FXDragType* types, FXuint numtypes)
-
FXbool releaseSelection()
-
FXbool hasClipboard() const
-
FXbool acquireClipboard(const FXDragType* types, FXuint numtypes)
-
FXbool releaseClipboard()
-
void dropEnable()
-
void dropDisable()
-
FXbool isDropEnabled() const
-
FXbool isDragging() const
-
FXbool beginDrag(const FXDragType* types, FXuint numtypes)
-
FXbool handleDrag(FXint x, FXint y, FXDragAction action=DRAG_COPY)
-
FXbool endDrag(FXbool drop=TRUE)
-
FXbool isDropTarget() const
-
void setDragRectangle(FXint x, FXint y, FXint w, FXint h, FXbool wantupdates=TRUE)
-
void clearDragRectangle()
-
void acceptDrop(FXDragAction action=DRAG_ACCEPT)
-
FXDragAction didAccept() const
-
FXbool inquireDNDTypes(FXDNDOrigin origin, FXDragType*& types, FXuint& numtypes)
-
FXbool offeredDNDType(FXDNDOrigin origin, FXDragType type)
-
FXDragAction inquireDNDAction() const
-
FXbool setDNDData(FXDNDOrigin origin, FXDragType type, FXuchar* data, FXuint size)
-
FXbool getDNDData(FXDNDOrigin origin, FXDragType type, FXuchar*& data, FXuint& size)
-
virtual FXbool 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
-
void linkBefore(FXWindow* sibling)
-
void linkAfter(FXWindow* sibling)
Public Methods
-
FXint getWidth() const
-
FXint getHeight() const
-
FXVisual* getVisual() const
-
void setVisual(FXVisual* vis)
Inherited from FXId:
Public Methods
-
FXApp* getApp() const
-
FXID id() const
-
void setUserData(void* ptr)
-
void* getUserData() const
Public Methods
-
const FXchar* getClassName() const
-
FXbool isMemberOf(const FXMetaClass* metaclass) const
Documentation
Tree list Widget
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
FXTreeItem* getFirstItem() const
- REturn first root item
FXTreeItem* getLastItem() const
- Return last root item
FXTreeItem* addItemFirst(FXTreeItem* p, FXTreeItem* item, FXbool notify=FALSE)
- Prepend new [possibly subclassed] item as first child of p
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
FXTreeItem* addItemLast(FXTreeItem* p, FXTreeItem* item, FXbool notify=FALSE)
- Append new [possibly subclassed] item as last child of p
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
FXTreeItem* addItemAfter(FXTreeItem* other, FXTreeItem* item, FXbool notify=FALSE)
- Append new [possibly subclassed] item after to other item
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
FXTreeItem* addItemBefore(FXTreeItem* other, FXTreeItem* item, FXbool notify=FALSE)
- Prepend new [possibly subclassed] item prior to other item
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
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 FXTreeItem* getItemAt(FXint x, FXint y) const
- Get item at x,y, if any
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
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
FXIcon* getItemOpenIcon(const FXTreeItem* item) const
- Return item's open icon
void setItemClosedIcon(FXTreeItem* item, FXIcon* icon)
- Chance item's closed icon
FXIcon* getItemClosedIcon(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, ie. 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
FXTreeItem* getCurrentItem() const
- Return current item, if any
void setAnchorItem(FXTreeItem* item)
- Change anchor item
FXTreeItem* getAnchorItem() const
- Return anchor item, if any
FXTreeItem* getCursorItem() 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
FXFont* getFont() 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
FXString getHelpText() const
- Get 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
- Direct child classes:
- FXDirList
Alphabetic index HTML hierarchy of classes or Java
This page was generated with the help of DOC++.