![]() |
Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members
![]() |
#include <FXTreeListBox.h>
Public Types | |
enum | { ID_TREE = FXPacker::ID_LAST, ID_FIELD, ID_LAST } |
Public Member Functions | |
FXTreeListBox (FXComposite *p, 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) | |
virtual void | create () |
virtual void | detach () |
virtual void | destroy () |
virtual void | layout () |
virtual void | enable () |
virtual void | disable () |
virtual FXint | getDefaultWidth () |
virtual FXint | getDefaultHeight () |
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) |
FXint | fillItems (FXTreeItem *father, const FXString &strings, FXIcon *oi=NULL, FXIcon *ci=NULL, void *ptr=NULL) |
FXTreeItem * | insertItem (FXTreeItem *other, FXTreeItem *father, FXTreeItem *item) |
FXTreeItem * | insertItem (FXTreeItem *other, FXTreeItem *father, const FXString &text, FXIcon *oi=NULL, FXIcon *ci=NULL, void *ptr=NULL) |
FXTreeItem * | appendItem (FXTreeItem *father, FXTreeItem *item) |
FXTreeItem * | appendItem (FXTreeItem *father, const FXString &text, FXIcon *oi=NULL, FXIcon *ci=NULL, void *ptr=NULL) |
FXTreeItem * | prependItem (FXTreeItem *father, FXTreeItem *item) |
FXTreeItem * | prependItem (FXTreeItem *father, const FXString &text, FXIcon *oi=NULL, FXIcon *ci=NULL, void *ptr=NULL) |
FXTreeItem * | moveItem (FXTreeItem *other, FXTreeItem *father, FXTreeItem *item) |
FXTreeItem * | extractItem (FXTreeItem *item) |
void | removeItem (FXTreeItem *item) |
void | removeItems (FXTreeItem *fm, FXTreeItem *to) |
void | clearItems () |
FXTreeItem * | findItem (const FXString &text, 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 |
FXbool | isItemCurrent (const FXTreeItem *item) const |
FXbool | isItemLeaf (const FXTreeItem *item) const |
void | sortRootItems () |
void | sortItems () |
void | sortChildItems (FXTreeItem *item) |
virtual void | setCurrentItem (FXTreeItem *item, FXbool notify=FALSE) |
FXTreeItem * | getCurrentItem () const |
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 |
FXTreeListSortFunc | getSortFunc () const |
void | setSortFunc (FXTreeListSortFunc func) |
FXbool | isPaneShown () const |
void | setFont (FXFont *fnt) |
FXFont * | getFont () const |
FXuint | getListStyle () const |
void | setListStyle (FXuint style) |
void | setHelpText (const FXString &txt) |
const FXString & | getHelpText () const |
void | setTipText (const FXString &txt) |
const FXString & | getTipText () const |
virtual void | save (FXStream &store) const |
virtual void | load (FXStream &store) |
virtual | ~FXTreeListBox () |
When an item is selected it issues a SEL_COMMAND message with the pointer to the item. While manipulating the tree list, it may send SEL_CHANGED messages to indicate which item the cursor is hovering over.
See also:
FX::FXTreeListBox::FXTreeListBox | ( | FXComposite * | p, | |
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 FX::FXTreeListBox::~FXTreeListBox | ( | ) | [virtual] |
Destructor.
virtual void FX::FXTreeListBox::create | ( | ) | [virtual] |
virtual void FX::FXTreeListBox::detach | ( | ) | [virtual] |
virtual void FX::FXTreeListBox::destroy | ( | ) | [virtual] |
virtual void FX::FXTreeListBox::layout | ( | ) | [virtual] |
virtual void FX::FXTreeListBox::enable | ( | ) | [virtual] |
virtual void FX::FXTreeListBox::disable | ( | ) | [virtual] |
virtual FXint FX::FXTreeListBox::getDefaultWidth | ( | ) | [virtual] |
virtual FXint FX::FXTreeListBox::getDefaultHeight | ( | ) | [virtual] |
FXint FX::FXTreeListBox::getNumItems | ( | ) | const |
Return number of items.
FXint FX::FXTreeListBox::getNumVisible | ( | ) | const |
Return number of visible items.
void FX::FXTreeListBox::setNumVisible | ( | FXint | nvis | ) |
Set number of visible items to determine default height.
FXTreeItem* FX::FXTreeListBox::getFirstItem | ( | ) | const |
Return first top-level item.
FXTreeItem* FX::FXTreeListBox::getLastItem | ( | ) | const |
Return last top-level item.
FXint FX::FXTreeListBox::fillItems | ( | FXTreeItem * | father, | |
const FXchar ** | strings, | |||
FXIcon * | oi = NULL , |
|||
FXIcon * | ci = NULL , |
|||
void * | ptr = NULL | |||
) |
Fill tree list box by appending items from array of strings.
FXint FX::FXTreeListBox::fillItems | ( | FXTreeItem * | father, | |
const FXString & | strings, | |||
FXIcon * | oi = NULL , |
|||
FXIcon * | ci = NULL , |
|||
void * | ptr = NULL | |||
) |
Fill tree list box by appending items from newline separated strings.
FXTreeItem* FX::FXTreeListBox::insertItem | ( | FXTreeItem * | other, | |
FXTreeItem * | father, | |||
FXTreeItem * | item | |||
) |
Insert [possibly subclassed] item under father before other item.
FXTreeItem* FX::FXTreeListBox::insertItem | ( | FXTreeItem * | other, | |
FXTreeItem * | father, | |||
const FXString & | text, | |||
FXIcon * | oi = NULL , |
|||
FXIcon * | ci = NULL , |
|||
void * | ptr = NULL | |||
) |
Insert item with given text and optional icons, and user-data pointer under father before other item.
FXTreeItem* FX::FXTreeListBox::appendItem | ( | FXTreeItem * | father, | |
FXTreeItem * | item | |||
) |
Append [possibly subclassed] item as last child of father.
FXTreeItem* FX::FXTreeListBox::appendItem | ( | FXTreeItem * | father, | |
const FXString & | text, | |||
FXIcon * | oi = NULL , |
|||
FXIcon * | ci = NULL , |
|||
void * | ptr = NULL | |||
) |
Append item with given text and optional icons, and user-data pointer as last child of father.
FXTreeItem* FX::FXTreeListBox::prependItem | ( | FXTreeItem * | father, | |
FXTreeItem * | item | |||
) |
Prepend [possibly subclassed] item as first child of father.
FXTreeItem* FX::FXTreeListBox::prependItem | ( | FXTreeItem * | father, | |
const FXString & | text, | |||
FXIcon * | oi = NULL , |
|||
FXIcon * | ci = NULL , |
|||
void * | ptr = NULL | |||
) |
Prepend item with given text and optional icons, and user-data pointer as first child of father.
FXTreeItem* FX::FXTreeListBox::moveItem | ( | FXTreeItem * | other, | |
FXTreeItem * | father, | |||
FXTreeItem * | item | |||
) |
Move item under father before other item.
FXTreeItem* FX::FXTreeListBox::extractItem | ( | FXTreeItem * | item | ) |
Extract item.
void FX::FXTreeListBox::removeItem | ( | FXTreeItem * | item | ) |
Remove item.
void FX::FXTreeListBox::removeItems | ( | FXTreeItem * | fm, | |
FXTreeItem * | to | |||
) |
Remove all items in range [fm...to].
void FX::FXTreeListBox::clearItems | ( | ) |
Remove all items from list.
FXTreeItem* FX::FXTreeListBox::findItem | ( | const FXString & | text, | |
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::FXTreeListBox::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.
FXbool FX::FXTreeListBox::isItemCurrent | ( | const FXTreeItem * | item | ) | const |
Return TRUE if item is the current item.
FXbool FX::FXTreeListBox::isItemLeaf | ( | const FXTreeItem * | item | ) | const |
Return TRUE if item is leaf-item, i.e. has no children.
void FX::FXTreeListBox::sortRootItems | ( | ) |
Sort the toplevel items with the sort function.
void FX::FXTreeListBox::sortItems | ( | ) |
Sort all items recursively.
void FX::FXTreeListBox::sortChildItems | ( | FXTreeItem * | item | ) |
Sort child items of item.
virtual void FX::FXTreeListBox::setCurrentItem | ( | FXTreeItem * | item, | |
FXbool | notify = FALSE | |||
) | [virtual] |
Change current item.
FXTreeItem* FX::FXTreeListBox::getCurrentItem | ( | ) | const |
Return current item.
void FX::FXTreeListBox::setItemText | ( | FXTreeItem * | item, | |
const FXString & | text | |||
) |
Change item label.
FXString FX::FXTreeListBox::getItemText | ( | const FXTreeItem * | item | ) | const |
Return item label.
void FX::FXTreeListBox::setItemOpenIcon | ( | FXTreeItem * | item, | |
FXIcon * | icon, | |||
FXbool | owned = FALSE | |||
) |
Change item's open icon, delete old one if it was owned.
FXIcon* FX::FXTreeListBox::getItemOpenIcon | ( | const FXTreeItem * | item | ) | const |
Return item's open icon.
void FX::FXTreeListBox::setItemClosedIcon | ( | FXTreeItem * | item, | |
FXIcon * | icon, | |||
FXbool | owned = FALSE | |||
) |
Change item's closed icon, delete old one if it was owned.
FXIcon* FX::FXTreeListBox::getItemClosedIcon | ( | const FXTreeItem * | item | ) | const |
Return item's closed icon.
void FX::FXTreeListBox::setItemData | ( | FXTreeItem * | item, | |
void * | ptr | |||
) | const |
Change item's user data.
void* FX::FXTreeListBox::getItemData | ( | const FXTreeItem * | item | ) | const |
Return item's user data.
FXTreeListSortFunc FX::FXTreeListBox::getSortFunc | ( | ) | const |
Return item sort function.
void FX::FXTreeListBox::setSortFunc | ( | FXTreeListSortFunc | func | ) |
Change item sort function.
FXbool FX::FXTreeListBox::isPaneShown | ( | ) | const |
Is the pane shown.
void FX::FXTreeListBox::setFont | ( | FXFont * | fnt | ) |
Change font.
FXFont* FX::FXTreeListBox::getFont | ( | ) | const |
Return font.
FXuint FX::FXTreeListBox::getListStyle | ( | ) | const |
Return list style.
void FX::FXTreeListBox::setListStyle | ( | FXuint | style | ) |
Change list style.
void FX::FXTreeListBox::setHelpText | ( | const FXString & | txt | ) |
Change help text.
const FXString& FX::FXTreeListBox::getHelpText | ( | ) | const |
Return help text.
void FX::FXTreeListBox::setTipText | ( | const FXString & | txt | ) |
Change tip text.
const FXString& FX::FXTreeListBox::getTipText | ( | ) | const |
Return tip text.
virtual void FX::FXTreeListBox::save | ( | FXStream & | store | ) | const [virtual] |
virtual void FX::FXTreeListBox::load | ( | FXStream & | store | ) | [virtual] |
![]() |