FXIconList

class FXIconList

Icon List Widget

Inheritance:


Public Methods

[more] 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
[more]virtual void create()
Create server-side resources
[more]virtual void detach()
Detach server-side resources
[more]virtual void recalc()
Recalculate layout
[more]virtual FXint getContentWidth()
Compute and return content width
[more]virtual FXint getContentHeight()
Return content height
[more]virtual FXbool canFocus() const
Icon list can receive focus
[more]virtual void setFocus()
Move the focus to this window
[more]virtual void killFocus()
Remove the focus from this window
[more]virtual FXint getViewportHeight()
Return viewport size
[more]virtual void moveContents(FXint x, FXint y)
Move contents to the specified position
[more]virtual void resize(FXint w, FXint h)
Resize this window to the specified width and height
[more]virtual void position(FXint x, FXint y, FXint w, FXint h)
Move and resize this window in the parent's coordinates
[more]FXint getNumItems() const
Return number of items
[more]FXint getNumRows() const
Return number of rows
[more]FXint getNumCols() const
Return number of columns
[more]FXHeader* getHeader() const
Return header control
[more]void appendHeader(const FXString& text, FXIcon* icon=NULL, FXint size=1)
Append header with given text and optional icon
[more]void removeHeader(FXint index)
Remove header at index
[more]void setHeaderText(FXint index, const FXString& text)
Change text of header at index
[more]FXString getHeaderText(FXint index) const
Return text of header at index
[more]void setHeaderIcon(FXint index, FXIcon* icon)
Change icon of header at index
[more]FXIcon* getHeaderIcon(FXint index) const
Return icon of header at index
[more]void setHeaderSize(FXint index, FXint size)
Change size of header at index
[more]FXint getHeaderSize(FXint index) const
Return width of header at index
[more]FXint getNumHeaders() const
Return number of headers
[more]FXIconItem* retrieveItem(FXint index) const
Return the item at the given index
[more]FXint replaceItem(FXint index, FXIconItem* item, FXbool notify=FALSE)
Replace the item with a [possibly subclassed] item
[more]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
[more]FXint insertItem(FXint index, FXIconItem* item, FXbool notify=FALSE)
Insert a new [possibly subclassed] item at the give index
[more]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
[more]FXint appendItem(FXIconItem* item, FXbool notify=FALSE)
Append a [possibly subclassed] item to the end of the list
[more]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
[more]FXint prependItem(FXIconItem* item, FXbool notify=FALSE)
Append a [possibly subclassed] item to the end of the list
[more]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
[more]void removeItem(FXint index, FXbool notify=FALSE)
Remove item from list
[more]void clearItems(FXbool notify=FALSE)
Remove all items from list
[more]FXint getItemWidth() const
Return item width
[more]FXint getItemHeight() const
Return item height
[more]FXint getItemAt(FXint x, FXint y) const
Return index of item at x,y, or -1 if none
[more]FXint 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
[more]void makeItemVisible(FXint index)
Scroll to make item at index visible
[more]void setItemText(FXint index, const FXString& text)
Change item text
[more]FXString getItemText(FXint index) const
Return item text
[more]void setItemBigIcon(FXint index, FXIcon* icon)
Change item big icon
[more]FXIcon* getItemBigIcon(FXint index) const
Return big icon of item at index
[more]void setItemMiniIcon(FXint index, FXIcon* icon)
Change item mini icon
[more]FXIcon* getItemMiniIcon(FXint index) const
Return mini icon of item at index
[more]void setItemData(FXint index, void* ptr)
Change item user-data pointer
[more]void* getItemData(FXint index) const
Return item user-data pointer
[more]FXbool isItemSelected(FXint index) const
Return TRUE if item at index is selected
[more]FXbool isItemCurrent(FXint index) const
Return TRUE if item at index is current
[more]FXbool isItemVisible(FXint index) const
Return TRUE if item at index is visible
[more]FXbool isItemEnabled(FXint index) const
Return TRUE if item at index is enabled
[more]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
[more]void updateItem(FXint index)
Repaint item at index
[more]FXbool selectInRectangle(FXint x, FXint y, FXint w, FXint h, FXbool notify=FALSE)
Select items in rectangle
[more]FXbool enableItem(FXint index)
Enable item at index
[more]FXbool disableItem(FXint index)
Disable item at index
[more]FXbool selectItem(FXint index, FXbool notify=FALSE)
Select item at index
[more]FXbool deselectItem(FXint index, FXbool notify=FALSE)
Deselect item at index
[more]FXbool toggleItem(FXint index, FXbool notify=FALSE)
Toggle item at index
[more]void setCurrentItem(FXint index, FXbool notify=FALSE)
Change current item index
[more]FXint getCurrentItem() const
Return current item index, or -1 if none
[more]void setAnchorItem(FXint index)
Change anchor item index
[more]FXint getAnchorItem() const
Return anchor item index, or -1 if none
[more]FXint getCursorItem() const
Return index of item under cursor, or -1 if none
[more]FXbool extendSelection(FXint index, FXbool notify=FALSE)
Extend selection from anchor index to index
[more]FXbool killSelection(FXbool notify=FALSE)
Deselect all items
[more]void sortItems()
Sort items
[more]void setFont(FXFont* fnt)
Change text font
[more]FXFont* getFont() const
Return text font
[more]FXColor getTextColor() const
Return normal text color
[more]void setTextColor(FXColor clr)
Change normal text color
[more]FXColor getSelBackColor() const
Return selected text background
[more]void setSelBackColor(FXColor clr)
Change selected text background
[more]FXColor getSelTextColor() const
Return selected text color
[more]void setSelTextColor(FXColor clr)
Change selected text color
[more]void setItemSpace(FXint s)
Change maximum item space for each item
[more]FXint getItemSpace() const
Return maximum item space
[more]FXIconListSortFunc getSortFunc() const
Return sort function
[more]void setSortFunc(FXIconListSortFunc func)
Change sort function
[more]FXuint getListStyle() const
Get the current icon list style
[more]void setListStyle(FXuint style)
Set the current icon list style
[more]void setHelpText(const FXString& text)
Set the status line help text for this widget
[more]FXString getHelpText() const
Get the status line help text for this widget
[more]virtual void save(FXStream& store) const
Save list to a stream
[more]virtual void load(FXStream& store)
Load list from a stream
[more]virtual ~FXIconList()
Destructor


Inherited from FXScrollArea:

Public Methods

ovirtual FXint getDefaultWidth()
ovirtual FXint getDefaultHeight()
ovoid setScrollStyle(FXuint style)
oFXuint getScrollStyle() const
oFXbool isHorizontalScrollable() const
oFXbool isVerticalScrollable() const
oFXScrollbar* horizontalScrollbar() const
oFXScrollbar* verticalScrollbar() const
oFXint getXPosition() const
oFXint getYPosition() const
ovoid setPosition(FXint x, FXint y)
ovoid getPosition(FXint& x, FXint& y) const


Inherited from FXComposite:

Public Methods

ovirtual void destroy()
oFXint maxChildWidth() const
oFXint maxChildHeight() const
ovirtual FXbool isComposite() const


Inherited from FXWindow:

Public Methods

oFXWindow* getParent() const
oFXWindow* getOwner() const
oFXWindow* getShell() const
oFXWindow* getRoot() const
oFXWindow* getNext() const
oFXWindow* getPrev() const
oFXWindow* getFirst() const
oFXWindow* getLast() const
oFXWindow* getFocus() const
ovoid setKey(FXuint k)
oFXuint getKey() const
ovoid setTarget(FXObject* t)
oFXObject* getTarget() const
ovoid setSelector(FXSelector sel)
oFXSelector getSelector() const
oFXint getX() const
oFXint getY() const
ovirtual FXint getWidthForHeight(FXint givenheight)
ovirtual FXint getHeightForWidth(FXint givenwidth)
ovoid setX(FXint x)
ovoid setY(FXint y)
ovoid setWidth(FXint w)
ovoid setHeight(FXint h)
ovoid setLayoutHints(FXuint lout)
oFXuint getLayoutHints() const
oFXAccelTable* getAccelTable() const
ovoid setAccelTable(FXAccelTable* acceltable)
ovoid addHotKey(FXHotKey code)
ovoid remHotKey(FXHotKey code)
oFXbool isShell() const
oFXbool isChildOf(const FXWindow* window) const
oFXbool containsChild(const FXWindow* child) const
oFXWindow* getChildAt(FXint x, FXint y) const
oFXint numChildren() const
oFXint indexOfChild(const FXWindow* window) const
oFXWindow* childAtIndex(FXint index) const
ostatic FXWindow* commonAncestor(FXWindow* a, FXWindow* b)
ovoid setDefaultCursor(FXCursor* cur)
oFXCursor* getDefaultCursor() const
ovoid setDragCursor(FXCursor* cur)
oFXCursor* getDragCursor() const
oFXint getCursorPosition(FXint& x, FXint& y, FXuint& buttons) const
oFXint setCursorPosition(FXint x, FXint y)
oFXbool isEnabled() const
oFXbool isActive() const
oFXbool hasFocus() const
ovirtual void setDefault(FXbool enable=TRUE)
oFXbool isDefault() const
ovoid setInitial(FXbool enable=TRUE)
oFXbool isInitial() const
ovirtual void enable()
ovirtual void disable()
ovirtual void raise()
ovirtual void lower()
ovirtual void move(FXint x, FXint y)
ovoid forceRefresh()
ovirtual void reparent(FXWindow* newparent)
ovoid scroll(FXint x, FXint y, FXint w, FXint h, FXint dx, FXint dy)
ovoid update(FXint x, FXint y, FXint w, FXint h)
ovoid update()
ovoid repaint(FXint x, FXint y, FXint w, FXint h)
ovoid repaint()
ovoid grab()
ovoid ungrab()
oFXbool grabbed() const
ovoid grabKeyboard()
ovoid ungrabKeyboard()
oFXbool grabbedKeyboard() const
ovirtual void show()
ovirtual void hide()
oFXbool shown() const
oFXbool underCursor() const
oFXbool hasSelection() const
oFXbool acquireSelection(const FXDragType* types, FXuint numtypes)
oFXbool releaseSelection()
oFXbool hasClipboard() const
oFXbool acquireClipboard(const FXDragType* types, FXuint numtypes)
oFXbool releaseClipboard()
ovoid dropEnable()
ovoid dropDisable()
oFXbool isDropEnabled() const
oFXbool isDragging() const
oFXbool beginDrag(const FXDragType* types, FXuint numtypes)
oFXbool handleDrag(FXint x, FXint y, FXDragAction action=DRAG_COPY)
oFXbool endDrag(FXbool drop=TRUE)
oFXbool isDropTarget() const
ovoid setDragRectangle(FXint x, FXint y, FXint w, FXint h, FXbool wantupdates=TRUE)
ovoid clearDragRectangle()
ovoid acceptDrop(FXDragAction action=DRAG_ACCEPT)
oFXDragAction didAccept() const
oFXbool inquireDNDTypes(FXDNDOrigin origin, FXDragType*& types, FXuint& numtypes)
oFXbool offeredDNDType(FXDNDOrigin origin, FXDragType type)
oFXDragAction inquireDNDAction() const
oFXbool setDNDData(FXDNDOrigin origin, FXDragType type, FXuchar* data, FXuint size)
oFXbool getDNDData(FXDNDOrigin origin, FXDragType type, FXuchar*& data, FXuint& size)
ovirtual FXbool contains(FXint parentx, FXint parenty) const
ovoid translateCoordinatesFrom(FXint& tox, FXint& toy, const FXWindow* fromwindow, FXint fromx, FXint fromy) const
ovoid translateCoordinatesTo(FXint& tox, FXint& toy, const FXWindow* towindow, FXint fromx, FXint fromy) const
ovirtual void setBackColor(FXColor clr)
oFXColor getBackColor() const
ovoid linkBefore(FXWindow* sibling)
ovoid linkAfter(FXWindow* sibling)


Inherited from FXDrawable:

Public Methods

oFXint getWidth() const
oFXint getHeight() const
oFXVisual* getVisual() const
ovoid setVisual(FXVisual* vis)


Inherited from FXId:

Public Methods

oFXApp* getApp() const
oFXID id() const
ovoid setUserData(void* ptr)
ovoid* getUserData() const


Inherited from FXObject:

Public Methods

oconst FXchar* getClassName() const
oFXbool isMemberOf(const FXMetaClass* metaclass) const


Documentation

Icon List Widget
o 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

ovirtual void create()
Create server-side resources

ovirtual void detach()
Detach server-side resources

ovirtual void recalc()
Recalculate layout

ovirtual FXint getContentWidth()
Compute and return content width

ovirtual FXint getContentHeight()
Return content height

ovirtual FXbool canFocus() const
Icon list can receive focus

ovirtual void setFocus()
Move the focus to this window

ovirtual void killFocus()
Remove the focus from this window

ovirtual FXint getViewportHeight()
Return viewport size

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

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

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

oFXint getNumItems() const
Return number of items

oFXint getNumRows() const
Return number of rows

oFXint getNumCols() const
Return number of columns

oFXHeader* getHeader() const
Return header control

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

ovoid removeHeader(FXint index)
Remove header at index

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

oFXString getHeaderText(FXint index) const
Return text of header at index

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

oFXIcon* getHeaderIcon(FXint index) const
Return icon of header at index

ovoid setHeaderSize(FXint index, FXint size)
Change size of header at index

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

oFXint getNumHeaders() const
Return number of headers

oFXIconItem* retrieveItem(FXint index) const
Return the item at the given index

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

oFXint 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

oFXint insertItem(FXint index, FXIconItem* item, FXbool notify=FALSE)
Insert a new [possibly subclassed] item at the give index

oFXint 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

oFXint appendItem(FXIconItem* item, FXbool notify=FALSE)
Append a [possibly subclassed] item to the end of the list

oFXint 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

oFXint prependItem(FXIconItem* item, FXbool notify=FALSE)
Append a [possibly subclassed] item to the end of the list

oFXint 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

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

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

oFXint getItemWidth() const
Return item width

oFXint getItemHeight() const
Return item height

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

oFXint 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

ovoid makeItemVisible(FXint index)
Scroll to make item at index visible

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

oFXString getItemText(FXint index) const
Return item text

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

oFXIcon* getItemBigIcon(FXint index) const
Return big icon of item at index

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

oFXIcon* getItemMiniIcon(FXint index) const
Return mini icon of item at index

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

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

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

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

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

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

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

ovoid updateItem(FXint index)
Repaint item at index

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

oFXbool enableItem(FXint index)
Enable item at index

oFXbool disableItem(FXint index)
Disable item at index

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

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

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

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

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

ovoid setAnchorItem(FXint index)
Change anchor item index

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

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

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

oFXbool killSelection(FXbool notify=FALSE)
Deselect all items

ovoid sortItems()
Sort items

ovoid setFont(FXFont* fnt)
Change text font

oFXFont* getFont() const
Return text font

oFXColor getTextColor() const
Return normal text color

ovoid setTextColor(FXColor clr)
Change normal text color

oFXColor getSelBackColor() const
Return selected text background

ovoid setSelBackColor(FXColor clr)
Change selected text background

oFXColor getSelTextColor() const
Return selected text color

ovoid setSelTextColor(FXColor clr)
Change selected text color

ovoid setItemSpace(FXint s)
Change maximum item space for each item

oFXint getItemSpace() const
Return maximum item space

oFXIconListSortFunc getSortFunc() const
Return sort function

ovoid setSortFunc(FXIconListSortFunc func)
Change sort function

oFXuint getListStyle() const
Get the current icon list style

ovoid setListStyle(FXuint style)
Set the current icon list style

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

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

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

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

ovirtual ~FXIconList()
Destructor


Direct child classes:
FXFileList

Alphabetic index HTML hierarchy of classes or Java



This page was generated with the help of DOC++.