![]() |
Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members
![]() |
#include <FXFoldingList.h>
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 folding list 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 folding 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 folding 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. The text in each item is a string separated by tabs for each column; in mini- or big-icon mode, only the text before the first tab is shown. In detail-mode, the text before the first tab is shown in the first column, the text between the first and second tab is shown in the second column, and so on.
See also:
FX::FXFoldingList::FXFoldingList | ( | FXComposite * | p, | |
FXObject * | tgt = NULL , |
|||
FXSelector | sel = 0 , |
|||
FXuint | opts = FOLDINGLIST_NORMAL , |
|||
FXint | x = 0 , |
|||
FXint | y = 0 , |
|||
FXint | w = 0 , |
|||
FXint | h = 0 | |||
) |
Construct a folding list; the folding list is initially empty.
virtual FX::FXFoldingList::~FXFoldingList | ( | ) | [virtual] |
Destructor.
static FXint FX::FXFoldingList::ascending | ( | const FXFoldingItem * | , | |
const FXFoldingItem * | ||||
) | [static] |
static FXint FX::FXFoldingList::descending | ( | const FXFoldingItem * | , | |
const FXFoldingItem * | ||||
) | [static] |
static FXint FX::FXFoldingList::ascendingCase | ( | const FXFoldingItem * | , | |
const FXFoldingItem * | ||||
) | [static] |
static FXint FX::FXFoldingList::descendingCase | ( | const FXFoldingItem * | , | |
const FXFoldingItem * | ||||
) | [static] |
virtual void FX::FXFoldingList::create | ( | ) | [virtual] |
virtual void FX::FXFoldingList::detach | ( | ) | [virtual] |
virtual void FX::FXFoldingList::layout | ( | ) | [virtual] |
virtual FXint FX::FXFoldingList::getDefaultWidth | ( | ) | [virtual] |
virtual FXint FX::FXFoldingList::getDefaultHeight | ( | ) | [virtual] |
virtual FXint FX::FXFoldingList::getVisibleY | ( | ) | const [virtual] |
virtual FXint FX::FXFoldingList::getVisibleHeight | ( | ) | const [virtual] |
virtual FXint FX::FXFoldingList::getContentWidth | ( | ) | [virtual] |
virtual FXint FX::FXFoldingList::getContentHeight | ( | ) | [virtual] |
virtual void FX::FXFoldingList::recalc | ( | ) | [virtual] |
virtual FXbool FX::FXFoldingList::canFocus | ( | ) | const [virtual] |
virtual void FX::FXFoldingList::setFocus | ( | ) | [virtual] |
virtual void FX::FXFoldingList::killFocus | ( | ) | [virtual] |
FXHeader* FX::FXFoldingList::getHeader | ( | ) | const [inline] |
Return header control.
Set headers from array of strings.
Set headers from newline separated strings.
void FX::FXFoldingList::appendHeader | ( | const FXString & | text, | |
FXIcon * | icon = NULL , |
|||
FXint | size = 1 | |||
) |
Append header with given text and optional icon.
void FX::FXFoldingList::removeHeader | ( | FXint | index | ) |
Remove header at index.
Change text of header at index.
Change icon of header at index.
FXint FX::FXFoldingList::getNumHeaders | ( | ) | const |
Return number of headers.
FXint FX::FXFoldingList::getNumItems | ( | ) | const |
Return number of items.
FXint FX::FXFoldingList::getNumVisible | ( | ) | const [inline] |
Return number of visible items.
void FX::FXFoldingList::setNumVisible | ( | FXint | nvis | ) |
Change number of visible items.
FXFoldingItem* FX::FXFoldingList::getFirstItem | ( | ) | const [inline] |
Return first root item.
FXFoldingItem* FX::FXFoldingList::getLastItem | ( | ) | const [inline] |
Return last root item.
FXint FX::FXFoldingList::fillItems | ( | FXFoldingItem * | father, | |
const FXchar ** | strings, | |||
FXIcon * | oi = NULL , |
|||
FXIcon * | ci = NULL , |
|||
void * | ptr = NULL , |
|||
FXbool | notify = false | |||
) |
Fill list by appending items from array of strings.
FXint FX::FXFoldingList::fillItems | ( | FXFoldingItem * | father, | |
const FXString & | strings, | |||
FXIcon * | oi = NULL , |
|||
FXIcon * | ci = NULL , |
|||
void * | ptr = NULL , |
|||
FXbool | notify = false | |||
) |
Fill list by appending items from newline separated strings.
FXFoldingItem* FX::FXFoldingList::insertItem | ( | FXFoldingItem * | other, | |
FXFoldingItem * | father, | |||
FXFoldingItem * | item, | |||
FXbool | notify = false | |||
) |
Insert [possibly subclassed] item under father before other item.
FXFoldingItem* FX::FXFoldingList::insertItem | ( | FXFoldingItem * | other, | |
FXFoldingItem * | 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.
FXFoldingItem* FX::FXFoldingList::appendItem | ( | FXFoldingItem * | father, | |
FXFoldingItem * | item, | |||
FXbool | notify = false | |||
) |
Append [possibly subclassed] item as last child of father.
FXFoldingItem* FX::FXFoldingList::appendItem | ( | FXFoldingItem * | 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.
FXFoldingItem* FX::FXFoldingList::prependItem | ( | FXFoldingItem * | father, | |
FXFoldingItem * | item, | |||
FXbool | notify = false | |||
) |
Prepend [possibly subclassed] item as first child of father.
FXFoldingItem* FX::FXFoldingList::prependItem | ( | FXFoldingItem * | 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.
FXFoldingItem* FX::FXFoldingList::moveItem | ( | FXFoldingItem * | other, | |
FXFoldingItem * | father, | |||
FXFoldingItem * | item | |||
) |
Move item under father before other item.
FXFoldingItem* FX::FXFoldingList::extractItem | ( | FXFoldingItem * | item, | |
FXbool | notify = false | |||
) |
Extract item.
void FX::FXFoldingList::removeItem | ( | FXFoldingItem * | item, | |
FXbool | notify = false | |||
) |
Remove item.
void FX::FXFoldingList::removeItems | ( | FXFoldingItem * | fm, | |
FXFoldingItem * | to, | |||
FXbool | notify = false | |||
) |
Remove items in range [fm, to] inclusively.
void FX::FXFoldingList::clearItems | ( | FXbool | notify = false |
) |
Remove all items from list.
FXint FX::FXFoldingList::getItemWidth | ( | const FXFoldingItem * | item | ) | const [inline] |
Return item width.
FXint FX::FXFoldingList::getItemHeight | ( | const FXFoldingItem * | item | ) | const [inline] |
Return item height.
virtual FXFoldingItem* FX::FXFoldingList::getItemAt | ( | FXint | x, | |
FXint | y | |||
) | const [virtual] |
Get item at x,y, if any.
FXFoldingItem* FX::FXFoldingList::findItem | ( | const FXString & | text, | |
FXFoldingItem * | 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.
FXFoldingItem* FX::FXFoldingList::findItemByData | ( | const void * | ptr, | |
FXFoldingItem * | 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::FXFoldingList::makeItemVisible | ( | FXFoldingItem * | item | ) | [virtual] |
Scroll to make item visible.
void FX::FXFoldingList::setItemText | ( | FXFoldingItem * | item, | |
const FXString & | text | |||
) |
Change item's text.
FXString FX::FXFoldingList::getItemText | ( | const FXFoldingItem * | item | ) | const |
Return item's text.
void FX::FXFoldingList::setItemOpenIcon | ( | FXFoldingItem * | item, | |
FXIcon * | icon, | |||
FXbool | owned = false | |||
) |
Change item's open icon, deleting old icon if it was owned.
FXIcon* FX::FXFoldingList::getItemOpenIcon | ( | const FXFoldingItem * | item | ) | const |
Return item's open icon.
void FX::FXFoldingList::setItemClosedIcon | ( | FXFoldingItem * | item, | |
FXIcon * | icon, | |||
FXbool | owned = false | |||
) |
Chance item's closed icon, deleting old icon if it was owned.
FXIcon* FX::FXFoldingList::getItemClosedIcon | ( | const FXFoldingItem * | item | ) | const |
Return item's closed icon.
void FX::FXFoldingList::setItemData | ( | FXFoldingItem * | item, | |
void * | ptr | |||
) | const |
Change item user-data pointer.
void* FX::FXFoldingList::getItemData | ( | const FXFoldingItem * | item | ) | const |
Return item user-data pointer.
FXbool FX::FXFoldingList::isItemSelected | ( | const FXFoldingItem * | item | ) | const |
Return true if item is selected.
FXbool FX::FXFoldingList::isItemCurrent | ( | const FXFoldingItem * | item | ) | const |
Return true if item is current.
FXbool FX::FXFoldingList::isItemVisible | ( | const FXFoldingItem * | item | ) | const |
Return true if item is visible.
FXbool FX::FXFoldingList::isItemOpened | ( | const FXFoldingItem * | item | ) | const |
Return true if item opened.
FXbool FX::FXFoldingList::isItemExpanded | ( | const FXFoldingItem * | item | ) | const |
Return true if item expanded.
FXbool FX::FXFoldingList::isItemLeaf | ( | const FXFoldingItem * | item | ) | const |
Return true if item is a leaf-item, i.e. has no children.
FXbool FX::FXFoldingList::isItemEnabled | ( | const FXFoldingItem * | item | ) | const |
Return true if item is enabled.
FXint FX::FXFoldingList::hitItem | ( | const FXFoldingItem * | item, | |
FXint | x, | |||
FXint | y | |||
) | const |
Return item hit code: 0 outside, 1 icon, 2 text, 3 box.
void FX::FXFoldingList::updateItem | ( | FXFoldingItem * | item | ) |
Repaint item.
virtual FXbool FX::FXFoldingList::enableItem | ( | FXFoldingItem * | item | ) | [virtual] |
Enable item.
virtual FXbool FX::FXFoldingList::disableItem | ( | FXFoldingItem * | item | ) | [virtual] |
Disable item.
virtual FXbool FX::FXFoldingList::selectItem | ( | FXFoldingItem * | item, | |
FXbool | notify = false | |||
) | [virtual] |
Select item.
virtual FXbool FX::FXFoldingList::deselectItem | ( | FXFoldingItem * | item, | |
FXbool | notify = false | |||
) | [virtual] |
Deselect item.
virtual FXbool FX::FXFoldingList::toggleItem | ( | FXFoldingItem * | item, | |
FXbool | notify = false | |||
) | [virtual] |
Toggle item selection.
virtual FXbool FX::FXFoldingList::extendSelection | ( | FXFoldingItem * | item, | |
FXbool | notify = false | |||
) | [virtual] |
Extend selection from anchor item to item.
Deselect all items.
virtual FXbool FX::FXFoldingList::openItem | ( | FXFoldingItem * | item, | |
FXbool | notify = false | |||
) | [virtual] |
Open item.
virtual FXbool FX::FXFoldingList::closeItem | ( | FXFoldingItem * | item, | |
FXbool | notify = false | |||
) | [virtual] |
Close item.
virtual FXbool FX::FXFoldingList::collapseTree | ( | FXFoldingItem * | tree, | |
FXbool | notify = false | |||
) | [virtual] |
Collapse tree.
virtual FXbool FX::FXFoldingList::expandTree | ( | FXFoldingItem * | tree, | |
FXbool | notify = false | |||
) | [virtual] |
Expand tree.
virtual void FX::FXFoldingList::setCurrentItem | ( | FXFoldingItem * | item, | |
FXbool | notify = false | |||
) | [virtual] |
Change current item.
FXFoldingItem* FX::FXFoldingList::getCurrentItem | ( | ) | const [inline] |
Return current item, if any.
void FX::FXFoldingList::setAnchorItem | ( | FXFoldingItem * | item | ) |
Change anchor item.
FXFoldingItem* FX::FXFoldingList::getAnchorItem | ( | ) | const [inline] |
Return anchor item, if any.
FXFoldingItem* FX::FXFoldingList::getCursorItem | ( | ) | const [inline] |
Return item under cursor, if any.
void FX::FXFoldingList::sortItems | ( | ) |
Sort all items recursively.
void FX::FXFoldingList::sortRootItems | ( | ) |
Sort root items.
void FX::FXFoldingList::sortChildItems | ( | FXFoldingItem * | item | ) |
Sort children of item.
FXFoldingListSortFunc FX::FXFoldingList::getSortFunc | ( | ) | const [inline] |
Return sort function.
void FX::FXFoldingList::setSortFunc | ( | FXFoldingListSortFunc | func | ) | [inline] |
Change sort function.
void FX::FXFoldingList::setFont | ( | FXFont * | fnt | ) |
Change text font.
FXFont* FX::FXFoldingList::getFont | ( | ) | const [inline] |
Return text font.
void FX::FXFoldingList::setIndent | ( | FXint | in | ) |
Change parent-child indent amount.
FXint FX::FXFoldingList::getIndent | ( | ) | const [inline] |
Return parent-child indent amount.
FXColor FX::FXFoldingList::getTextColor | ( | ) | const [inline] |
Return normal text color.
void FX::FXFoldingList::setTextColor | ( | FXColor | clr | ) |
Change normal text color.
FXColor FX::FXFoldingList::getSelBackColor | ( | ) | const [inline] |
Return selected text background.
void FX::FXFoldingList::setSelBackColor | ( | FXColor | clr | ) |
Change selected text background.
FXColor FX::FXFoldingList::getSelTextColor | ( | ) | const [inline] |
Return selected text color.
void FX::FXFoldingList::setSelTextColor | ( | FXColor | clr | ) |
Change selected text color.
FXColor FX::FXFoldingList::getLineColor | ( | ) | const [inline] |
Return line color.
void FX::FXFoldingList::setLineColor | ( | FXColor | clr | ) |
Change line color.
FXuint FX::FXFoldingList::getListStyle | ( | ) | const |
Return list style.
void FX::FXFoldingList::setListStyle | ( | FXuint | style | ) |
Change list style.
void FX::FXFoldingList::setHelpText | ( | const FXString & | text | ) |
Set the status line help text for this list.
const FXString& FX::FXFoldingList::getHelpText | ( | ) | const [inline] |
Get the status line help text for this list.
virtual void FX::FXFoldingList::save | ( | FXStream & | store | ) | const [virtual] |
virtual void FX::FXFoldingList::load | ( | FXStream & | store | ) | [virtual] |
![]() |