![]() |
Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members
![]() |
#include <FXIconList.h>
Public Member Functions | |
FXIconList (FXComposite *p, FXObject *tgt=NULL, FXSelector sel=0, FXuint opts=ICONLIST_NORMAL, FXint x=0, FXint y=0, FXint w=0, FXint h=0) | |
virtual void | create () |
virtual void | detach () |
virtual void | recalc () |
virtual void | layout () |
virtual FXint | getVisibleY () const |
virtual FXint | getVisibleHeight () const |
virtual FXint | getContentWidth () |
virtual FXint | getContentHeight () |
virtual FXbool | canFocus () const |
virtual void | setFocus () |
virtual void | killFocus () |
virtual void | resize (FXint w, FXint h) |
virtual void | position (FXint x, FXint y, FXint w, FXint h) |
FXint | getNumItems () const |
FXint | getNumRows () const |
FXint | getNumCols () const |
FXHeader * | getHeader () const |
void | setHeaders (const FXchar **strings, FXint size=1) |
void | setHeaders (const FXString &strings, FXint size=1) |
void | appendHeader (const FXString &text, FXIcon *icon=NULL, FXint size=1) |
void | removeHeader (FXint index) |
void | setHeaderText (FXint index, const FXString &text) |
FXString | getHeaderText (FXint index) const |
void | setHeaderIcon (FXint index, FXIcon *icon) |
FXIcon * | getHeaderIcon (FXint index) const |
void | setHeaderSize (FXint index, FXint size) |
FXint | getHeaderSize (FXint index) const |
FXint | getNumHeaders () const |
FXIconItem * | getItem (FXint index) const |
FXint | setItem (FXint index, FXIconItem *item, FXbool notify=false) |
FXint | setItem (FXint index, const FXString &text, FXIcon *big=NULL, FXIcon *mini=NULL, void *ptr=NULL, FXbool notify=false) |
FXint | fillItems (const FXchar **strings, FXIcon *big=NULL, FXIcon *mini=NULL, void *ptr=NULL, FXbool notify=false) |
FXint | fillItems (const FXString &strings, FXIcon *big=NULL, FXIcon *mini=NULL, void *ptr=NULL, FXbool notify=false) |
FXint | insertItem (FXint index, FXIconItem *item, FXbool notify=false) |
FXint | insertItem (FXint index, const FXString &text, FXIcon *big=NULL, FXIcon *mini=NULL, void *ptr=NULL, FXbool notify=false) |
FXint | appendItem (FXIconItem *item, FXbool notify=false) |
FXint | appendItem (const FXString &text, FXIcon *big=NULL, FXIcon *mini=NULL, void *ptr=NULL, FXbool notify=false) |
FXint | prependItem (FXIconItem *item, FXbool notify=false) |
FXint | prependItem (const FXString &text, FXIcon *big=NULL, FXIcon *mini=NULL, void *ptr=NULL, FXbool notify=false) |
FXint | moveItem (FXint newindex, FXint oldindex, FXbool notify=false) |
FXIconItem * | extractItem (FXint index, FXbool notify=false) |
void | removeItem (FXint index, FXbool notify=false) |
void | clearItems (FXbool notify=false) |
FXint | getItemWidth () const |
FXint | getItemHeight () const |
virtual FXint | getItemAt (FXint x, FXint y) const |
FXint | findItem (const FXString &text, FXint start=-1, FXuint flags=SEARCH_FORWARD|SEARCH_WRAP) const |
FXint | findItemByData (const void *ptr, FXint start=-1, FXuint flags=SEARCH_FORWARD|SEARCH_WRAP) const |
virtual void | makeItemVisible (FXint index) |
void | setItemText (FXint index, const FXString &text) |
FXString | getItemText (FXint index) const |
void | setItemBigIcon (FXint index, FXIcon *icon, FXbool owned=false) |
FXIcon * | getItemBigIcon (FXint index) const |
void | setItemMiniIcon (FXint index, FXIcon *icon, FXbool owned=false) |
FXIcon * | getItemMiniIcon (FXint index) const |
void | setItemData (FXint index, void *ptr) |
void * | getItemData (FXint index) const |
FXbool | isItemSelected (FXint index) const |
FXbool | isItemCurrent (FXint index) const |
FXbool | isItemVisible (FXint index) const |
FXbool | isItemEnabled (FXint index) const |
FXint | hitItem (FXint index, FXint x, FXint y, FXint ww=1, FXint hh=1) const |
void | updateItem (FXint index) const |
virtual FXbool | enableItem (FXint index) |
virtual FXbool | disableItem (FXint index) |
virtual FXbool | selectItem (FXint index, FXbool notify=false) |
virtual FXbool | deselectItem (FXint index, FXbool notify=false) |
virtual FXbool | toggleItem (FXint index, FXbool notify=false) |
virtual FXbool | selectInRectangle (FXint x, FXint y, FXint w, FXint h, FXbool notify=false) |
virtual FXbool | extendSelection (FXint index, FXbool notify=false) |
virtual FXbool | killSelection (FXbool notify=false) |
virtual void | setCurrentItem (FXint index, FXbool notify=false) |
FXint | getCurrentItem () const |
void | setAnchorItem (FXint index) |
FXint | getAnchorItem () const |
FXint | getCursorItem () const |
void | sortItems () |
FXIconListSortFunc | getSortFunc () const |
void | setSortFunc (FXIconListSortFunc func) |
void | setFont (FXFont *fnt) |
FXFont * | getFont () const |
FXColor | getTextColor () const |
void | setTextColor (FXColor clr) |
FXColor | getSelBackColor () const |
void | setSelBackColor (FXColor clr) |
FXColor | getSelTextColor () const |
void | setSelTextColor (FXColor clr) |
void | setItemSpace (FXint s) |
FXint | getItemSpace () const |
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 | ~FXIconList () |
Static Public Member Functions | |
static FXint | ascending (const FXIconItem *a, const FXIconItem *b) |
static FXint | descending (const FXIconItem *a, const FXIconItem *b) |
static FXint | ascendingCase (const FXIconItem *a, const FXIconItem *b) |
static FXint | descendingCase (const FXIconItem *a, const FXIconItem *b) |
Icon List can display its items in essentially three different ways; in big-icon mode, the bigger of the two icons is used for each item, and the text is placed underneath the icon. In mini- icon mode, the icons are listed in rows and columns, with the smaller icon preceding the text. Finally, in detail mode the icons are listed in a single column, and all fields of the text are shown under a header control with one button for each subfield. When an item's selected state changes, the icon list sends a SEL_SELECTED or SEL_DESELECTED message. A change of the current item is signified by the SEL_CHANGED message. The icon 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, replaced, or removed, the icon list sends messages of the type SEL_INSERTED, SEL_REPLACED, or SEL_DELETED. In each of these cases, the index 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::FXIconList::FXIconList | ( | FXComposite * | p, | |
FXObject * | tgt = NULL , |
|||
FXSelector | sel = 0 , |
|||
FXuint | opts = ICONLIST_NORMAL , |
|||
FXint | x = 0 , |
|||
FXint | y = 0 , |
|||
FXint | w = 0 , |
|||
FXint | h = 0 | |||
) |
Construct icon list with no items in it initially.
virtual FX::FXIconList::~FXIconList | ( | ) | [virtual] |
Destructor.
static FXint FX::FXIconList::ascending | ( | const FXIconItem * | a, | |
const FXIconItem * | b | |||
) | [static] |
Reimplemented in FX::FXFileList.
static FXint FX::FXIconList::descending | ( | const FXIconItem * | a, | |
const FXIconItem * | b | |||
) | [static] |
Reimplemented in FX::FXFileList.
static FXint FX::FXIconList::ascendingCase | ( | const FXIconItem * | a, | |
const FXIconItem * | b | |||
) | [static] |
Reimplemented in FX::FXFileList.
static FXint FX::FXIconList::descendingCase | ( | const FXIconItem * | a, | |
const FXIconItem * | b | |||
) | [static] |
Reimplemented in FX::FXFileList.
virtual void FX::FXIconList::create | ( | ) | [virtual] |
virtual void FX::FXIconList::detach | ( | ) | [virtual] |
virtual void FX::FXIconList::recalc | ( | ) | [virtual] |
virtual void FX::FXIconList::layout | ( | ) | [virtual] |
virtual FXint FX::FXIconList::getVisibleY | ( | ) | const [virtual] |
virtual FXint FX::FXIconList::getVisibleHeight | ( | ) | const [virtual] |
virtual FXint FX::FXIconList::getContentWidth | ( | ) | [virtual] |
virtual FXint FX::FXIconList::getContentHeight | ( | ) | [virtual] |
virtual FXbool FX::FXIconList::canFocus | ( | ) | const [virtual] |
virtual void FX::FXIconList::setFocus | ( | ) | [virtual] |
virtual void FX::FXIconList::killFocus | ( | ) | [virtual] |
FXint FX::FXIconList::getNumItems | ( | ) | const [inline] |
Return number of items.
FXint FX::FXIconList::getNumRows | ( | ) | const [inline] |
FXint FX::FXIconList::getNumCols | ( | ) | const [inline] |
Return number of columns.
FXHeader* FX::FXIconList::getHeader | ( | ) | const [inline] |
Return header control.
Set headers from array of strings.
Set headers from newline separated strings.
Append header with given text and optional icon.
void FX::FXIconList::removeHeader | ( | FXint | index | ) |
Remove header at index.
Change text of header at index.
FXint FX::FXIconList::getNumHeaders | ( | ) | const |
Return number of headers.
FXIconItem* FX::FXIconList::getItem | ( | FXint | index | ) | const |
Return the item at the given index.
FXint FX::FXIconList::setItem | ( | FXint | index, | |
FXIconItem * | item, | |||
FXbool | notify = false | |||
) |
Replace the item with a [possibly subclassed] item.
FXint FX::FXIconList::setItem | ( | FXint | index, | |
const FXString & | text, | |||
FXIcon * | big = NULL , |
|||
FXIcon * | mini = NULL , |
|||
void * | ptr = NULL , |
|||
FXbool | notify = false | |||
) |
Replace items text, icons, and user-data pointer.
FXint FX::FXIconList::fillItems | ( | const FXchar ** | strings, | |
FXIcon * | big = NULL , |
|||
FXIcon * | mini = NULL , |
|||
void * | ptr = NULL , |
|||
FXbool | notify = false | |||
) |
Fill list by appending items from array of strings.
FXint FX::FXIconList::fillItems | ( | const FXString & | strings, | |
FXIcon * | big = NULL , |
|||
FXIcon * | mini = NULL , |
|||
void * | ptr = NULL , |
|||
FXbool | notify = false | |||
) |
Fill list by appending items from newline separated strings.
FXint FX::FXIconList::insertItem | ( | FXint | index, | |
FXIconItem * | item, | |||
FXbool | notify = false | |||
) |
Insert a new [possibly subclassed] item at the give index.
FXint FX::FXIconList::insertItem | ( | FXint | index, | |
const FXString & | text, | |||
FXIcon * | big = NULL , |
|||
FXIcon * | mini = NULL , |
|||
void * | ptr = NULL , |
|||
FXbool | notify = false | |||
) |
Insert item at index with given text, icons, and user-data pointer.
FXint FX::FXIconList::appendItem | ( | FXIconItem * | item, | |
FXbool | notify = false | |||
) |
Append a [possibly subclassed] item to the end of the list.
FXint FX::FXIconList::appendItem | ( | const FXString & | text, | |
FXIcon * | big = NULL , |
|||
FXIcon * | mini = NULL , |
|||
void * | ptr = NULL , |
|||
FXbool | notify = false | |||
) |
Append new item with given text and optional icons, and user-data pointer.
FXint FX::FXIconList::prependItem | ( | FXIconItem * | item, | |
FXbool | notify = false | |||
) |
Prepend a [possibly subclassed] item to the end of the list.
FXint FX::FXIconList::prependItem | ( | const FXString & | text, | |
FXIcon * | big = NULL , |
|||
FXIcon * | mini = NULL , |
|||
void * | ptr = NULL , |
|||
FXbool | notify = false | |||
) |
Prepend new item with given text and optional icons, and user-data pointer.
Move item from oldindex to newindex.
FXIconItem* FX::FXIconList::extractItem | ( | FXint | index, | |
FXbool | notify = false | |||
) |
Extract item from list.
void FX::FXIconList::clearItems | ( | FXbool | notify = false |
) |
Remove all items from list.
FXint FX::FXIconList::getItemWidth | ( | ) | const [inline] |
Return item width.
FXint FX::FXIconList::getItemHeight | ( | ) | const [inline] |
Return item height.
Return index of item at x,y, or -1 if none.
FXint FX::FXIconList::findItem | ( | const FXString & | text, | |
FXint | start = -1 , |
|||
FXuint | flags = SEARCH_FORWARD|SEARCH_WRAP | |||
) | const |
Search items by name, beginning from item start.
If the start item is -1 the search will start at the first 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 -1 if no matching item is found.
FXint FX::FXIconList::findItemByData | ( | const void * | ptr, | |
FXint | start = -1 , |
|||
FXuint | flags = SEARCH_FORWARD|SEARCH_WRAP | |||
) | const |
Search items by associated user data, beginning from item start.
If the start item is -1 the search will start at the first 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::FXIconList::makeItemVisible | ( | FXint | index | ) | [virtual] |
Scroll to make item at index visible.
Change item big icon.
Change item mini icon.
void FX::FXIconList::setItemData | ( | FXint | index, | |
void * | ptr | |||
) |
Change item user-data pointer.
void* FX::FXIconList::getItemData | ( | FXint | index | ) | const |
Return item user-data pointer.
Return true if item at index is selected.
Return item hit code: 0 outside, 1 icon, 2 text.
void FX::FXIconList::updateItem | ( | FXint | index | ) | const |
Repaint item at index.
Select item at index.
Deselect item at index.
Toggle item at index.
virtual FXbool FX::FXIconList::selectInRectangle | ( | FXint | x, | |
FXint | y, | |||
FXint | w, | |||
FXint | h, | |||
FXbool | notify = false | |||
) | [virtual] |
Select items in rectangle.
Extend selection from anchor index to index.
Deselect all items.
Change current item index.
FXint FX::FXIconList::getCurrentItem | ( | ) | const [inline] |
Return current item index, or -1 if none.
void FX::FXIconList::setAnchorItem | ( | FXint | index | ) |
Change anchor item index.
FXint FX::FXIconList::getAnchorItem | ( | ) | const [inline] |
Return anchor item index, or -1 if none.
FXint FX::FXIconList::getCursorItem | ( | ) | const [inline] |
Return index of item under cursor, or -1 if none.
void FX::FXIconList::sortItems | ( | ) |
Sort items.
FXIconListSortFunc FX::FXIconList::getSortFunc | ( | ) | const [inline] |
Return sort function.
void FX::FXIconList::setSortFunc | ( | FXIconListSortFunc | func | ) | [inline] |
Change sort function.
void FX::FXIconList::setFont | ( | FXFont * | fnt | ) |
Change text font.
FXFont* FX::FXIconList::getFont | ( | ) | const [inline] |
Return text font.
FXColor FX::FXIconList::getTextColor | ( | ) | const [inline] |
Return normal text color.
void FX::FXIconList::setTextColor | ( | FXColor | clr | ) |
Change normal text color.
FXColor FX::FXIconList::getSelBackColor | ( | ) | const [inline] |
Return selected text background.
void FX::FXIconList::setSelBackColor | ( | FXColor | clr | ) |
Change selected text background.
FXColor FX::FXIconList::getSelTextColor | ( | ) | const [inline] |
Return selected text color.
void FX::FXIconList::setSelTextColor | ( | FXColor | clr | ) |
Change selected text color.
void FX::FXIconList::setItemSpace | ( | FXint | s | ) |
Change maximum item space for each item.
FXint FX::FXIconList::getItemSpace | ( | ) | const [inline] |
Return maximum item space.
FXuint FX::FXIconList::getListStyle | ( | ) | const |
Get the current icon list style.
void FX::FXIconList::setListStyle | ( | FXuint | style | ) |
Set the current icon list style.
void FX::FXIconList::setHelpText | ( | const FXString & | text | ) |
Set the status line help text for this widget.
const FXString& FX::FXIconList::getHelpText | ( | ) | const [inline] |
Get the status line help text for this widget.
virtual void FX::FXIconList::save | ( | FXStream & | store | ) | const [virtual] |
virtual void FX::FXIconList::load | ( | FXStream & | store | ) | [virtual] |
![]() |