Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

FXIconList Class Reference

Icon List Widget.

#include <FXIconList.h>

Inheritance diagram for FXIconList:

FXScrollArea FXComposite FXWindow FXDrawable FXId FXObject FXFileList List of all members.

Public Types

enum  {
  ID_SHOW_DETAILS = FXScrollArea::ID_LAST,
  ID_SHOW_MINI_ICONS,
  ID_SHOW_BIG_ICONS,
  ID_ARRANGE_BY_ROWS,
  ID_ARRANGE_BY_COLUMNS,
  ID_HEADER_CHANGE,
  ID_TIPTIMER,
  ID_LOOKUPTIMER,
  ID_SELECT_ALL,
  ID_DESELECT_ALL,
  ID_SELECT_INVERSE,
  ID_LAST
}

Public Methods

 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.

virtual void create ()
 Create server-side resources.

virtual void detach ()
 Detach server-side resources.

virtual void recalc ()
 Recalculate layout.

virtual FXint getContentWidth ()
 Compute and return content width.

virtual FXint getContentHeight ()
 Return content height.

virtual FXbool canFocus () const
 Icon list can receive focus.

virtual void setFocus ()
 Move the focus to this window.

virtual void killFocus ()
 Remove the focus from this window.

virtual FXint getViewportHeight ()
 Return viewport size.

virtual void moveContents (FXint x, FXint y)
 Move contents to the specified position.

virtual void resize (FXint w, FXint h)
 Resize this window to the specified width and height.

virtual void position (FXint x, FXint y, FXint w, FXint h)
 Move and resize this window in the parent's coordinates.

FXint getNumItems () const
 Return number of items.

FXint getNumRows () const
 Return number of rows.

FXint getNumCols () const
 Return number of columns.

FXHeadergetHeader () const
 Return header control.

void appendHeader (const FXString &text, FXIcon *icon=NULL, FXint size=1)
 Append header with given text and optional icon.

void removeHeader (FXint index)
 Remove header at index.

void setHeaderText (FXint index, const FXString &text)
 Change text of header at index.

FXString getHeaderText (FXint index) const
 Return text of header at index.

void setHeaderIcon (FXint index, FXIcon *icon)
 Change icon of header at index.

FXIcongetHeaderIcon (FXint index) const
 Return icon of header at index.

void setHeaderSize (FXint index, FXint size)
 Change size of header at index.

FXint getHeaderSize (FXint index) const
 Return width of header at index.

FXint getNumHeaders () const
 Return number of headers.

FXIconItemretrieveItem (FXint index) const
 Return the item at the given index.

FXint replaceItem (FXint index, FXIconItem *item, FXbool notify=FALSE)
 Replace the item with a [possibly subclassed] item.

FXint replaceItem (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 insertItem (FXint index, FXIconItem *item, FXbool notify=FALSE)
 Insert a new [possibly subclassed] item at the give index.

FXint 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 appendItem (FXIconItem *item, FXbool notify=FALSE)
 Append a [possibly subclassed] item to the end of the list.

FXint 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 prependItem (FXIconItem *item, FXbool notify=FALSE)
 Append a [possibly subclassed] item to the end of the list.

FXint prependItem (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.

void removeItem (FXint index, FXbool notify=FALSE)
 Remove item from list.

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

FXint getItemWidth () const
 Return item width.

FXint getItemHeight () const
 Return item height.

FXint getItemAt (FXint x, FXint y) const
 Return index of item at x,y, or -1 if none.

FXint findItem (const FXString &text, FXint start=-1, FXuint flags=SEARCH_FORWARD|SEARCH_WRAP) const
void makeItemVisible (FXint index)
 Scroll to make item at index visible.

void setItemText (FXint index, const FXString &text)
 Change item text.

FXString getItemText (FXint index) const
 Return item text.

void setItemBigIcon (FXint index, FXIcon *icon)
 Change item big icon.

FXIcongetItemBigIcon (FXint index) const
 Return big icon of item at index.

void setItemMiniIcon (FXint index, FXIcon *icon)
 Change item mini icon.

FXIcongetItemMiniIcon (FXint index) const
 Return mini icon of item at index.

void setItemData (FXint index, void *ptr)
 Change item user-data pointer.

void * getItemData (FXint index) const
 Return item user-data pointer.

FXbool isItemSelected (FXint index) const
 Return TRUE if item at index is selected.

FXbool isItemCurrent (FXint index) const
 Return TRUE if item at index is current.

FXbool isItemVisible (FXint index) const
 Return TRUE if item at index is visible.

FXbool isItemEnabled (FXint index) const
 Return TRUE if item at index is enabled.

FXint hitItem (FXint index, FXint x, FXint y, FXint ww=1, FXint hh=1) const
 Return item hit code: 0 outside, 1 icon, 2 text.

void updateItem (FXint index)
 Repaint item at index.

FXbool selectInRectangle (FXint x, FXint y, FXint w, FXint h, FXbool notify=FALSE)
 Select items in rectangle.

FXbool enableItem (FXint index)
 Enable item at index.

FXbool disableItem (FXint index)
 Disable item at index.

FXbool selectItem (FXint index, FXbool notify=FALSE)
 Select item at index.

FXbool deselectItem (FXint index, FXbool notify=FALSE)
 Deselect item at index.

FXbool toggleItem (FXint index, FXbool notify=FALSE)
 Toggle item at index.

void setCurrentItem (FXint index, FXbool notify=FALSE)
 Change current item index.

FXint getCurrentItem () const
 Return current item index, or -1 if none.

void setAnchorItem (FXint index)
 Change anchor item index.

FXint getAnchorItem () const
 Return anchor item index, or -1 if none.

FXint getCursorItem () const
 Return index of item under cursor, or -1 if none.

FXbool extendSelection (FXint index, FXbool notify=FALSE)
 Extend selection from anchor index to index.

FXbool killSelection (FXbool notify=FALSE)
 Deselect all items.

void sortItems ()
 Sort items.

void setFont (FXFont *fnt)
 Change text font.

FXFontgetFont () const
 Return text font.

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.

void setItemSpace (FXint s)
 Change maximum item space for each item.

FXint getItemSpace () const
 Return maximum item space.

FXIconListSortFunc getSortFunc () const
 Return sort function.

void setSortFunc (FXIconListSortFunc func)
 Change sort function.

FXuint getListStyle () const
 Get the current icon list style.

void setListStyle (FXuint style)
 Set the current icon list style.

void setHelpText (const FXString &text)
 Set the status line help text for this widget.

virtual void save (FXStream &store) const
 Save list to a stream.

virtual void load (FXStream &store)
 Load list from a stream.

virtual ~FXIconList ()
 Destructor.


Static Public Methods

FXint ascending (const FXIconItem *a, const FXIconItem *b)
FXint descending (const FXIconItem *a, const FXIconItem *b)

Public Attributes

FXString getHelpText () const
 Get the status line help text for this widget.


Member Function Documentation

FXint FXIconList::findItem const FXString   text,
FXint    start = -1,
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.