FX::FXIconList Class Reference

#include <FXIconList.h>

Inheritance diagram for FX::FXIconList:

[legend]

Detailed Description

A Icon List Widget displays a list of items, each with a text and optional icon. 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.


Public Types
enum	{ ID_SHOW_DETAILS, ID_SHOW_MINI_ICONS, ID_SHOW_BIG_ICONS, ID_ARRANGE_BY_ROWS, ID_ARRANGE_BY_COLUMNS, ID_HEADER_CHANGE, ID_LOOKUPTIMER, ID_SELECT_ALL, ID_DESELECT_ALL, ID_SELECT_INVERSE, ID_LAST }
enum	{ ID_NONE, ID_HIDE, ID_SHOW, ID_TOGGLESHOWN, ID_LOWER, ID_RAISE, ID_DELETE, ID_DISABLE, ID_ENABLE, ID_TOGGLEENABLED, ID_UNCHECK, ID_CHECK, ID_UNKNOWN, ID_UPDATE, ID_AUTOSCROLL, ID_TIPTIMER, ID_HSCROLLED, ID_VSCROLLED, ID_SETVALUE, ID_SETINTVALUE, ID_SETREALVALUE, ID_SETSTRINGVALUE, ID_SETICONVALUE, ID_SETINTRANGE, ID_SETREALRANGE, ID_GETINTVALUE, ID_GETREALVALUE, ID_GETSTRINGVALUE, ID_GETICONVALUE, ID_GETINTRANGE, ID_GETREALRANGE, ID_SETHELPSTRING, ID_GETHELPSTRING, ID_SETTIPSTRING, ID_GETTIPSTRING, ID_QUERY_MENU, ID_HOTKEY, ID_ACCEL, ID_UNPOST, ID_POST, ID_MDI_TILEHORIZONTAL, ID_MDI_TILEVERTICAL, ID_MDI_CASCADE, ID_MDI_MAXIMIZE, ID_MDI_MINIMIZE, ID_MDI_RESTORE, ID_MDI_CLOSE, ID_MDI_WINDOW, ID_MDI_MENUWINDOW, ID_MDI_MENUMINIMIZE, ID_MDI_MENURESTORE, ID_MDI_MENUCLOSE, ID_MDI_NEXT, ID_MDI_PREV, ID_LAST }
Public Member Functions
long	onPaint (FXObject , FXSelector, void )
long	onEnter (FXObject , FXSelector, void )
long	onLeave (FXObject , FXSelector, void )
long	onUngrabbed (FXObject , FXSelector, void )
long	onKeyPress (FXObject , FXSelector, void )
long	onKeyRelease (FXObject , FXSelector, void )
long	onLeftBtnPress (FXObject , FXSelector, void )
long	onLeftBtnRelease (FXObject , FXSelector, void )
long	onRightBtnPress (FXObject , FXSelector, void )
long	onRightBtnRelease (FXObject , FXSelector, void )
long	onMotion (FXObject , FXSelector, void )
long	onQueryTip (FXObject , FXSelector, void )
long	onQueryHelp (FXObject , FXSelector, void )
long	onTipTimer (FXObject , FXSelector, void )
long	onCmdSelectAll (FXObject , FXSelector, void )
long	onCmdDeselectAll (FXObject , FXSelector, void )
long	onCmdSelectInverse (FXObject , FXSelector, void )
long	onCmdArrangeByRows (FXObject , FXSelector, void )
long	onUpdArrangeByRows (FXObject , FXSelector, void )
long	onCmdArrangeByColumns (FXObject , FXSelector, void )
long	onUpdArrangeByColumns (FXObject , FXSelector, void )
long	onCmdShowDetails (FXObject , FXSelector, void )
long	onUpdShowDetails (FXObject , FXSelector, void )
long	onCmdShowBigIcons (FXObject , FXSelector, void )
long	onUpdShowBigIcons (FXObject , FXSelector, void )
long	onCmdShowMiniIcons (FXObject , FXSelector, void )
long	onUpdShowMiniIcons (FXObject , FXSelector, void )
long	onHeaderChanged (FXObject , FXSelector, void )
long	onHeaderResize (FXObject , FXSelector, void )
long	onFocusIn (FXObject , FXSelector, void )
long	onFocusOut (FXObject , FXSelector, void )
long	onClicked (FXObject , FXSelector, void )
long	onDoubleClicked (FXObject , FXSelector, void )
long	onTripleClicked (FXObject , FXSelector, void )
long	onCommand (FXObject , FXSelector, void )
long	onAutoScroll (FXObject , FXSelector, void )
long	onLookupTimer (FXObject , FXSelector, void )
long	onCmdSetValue (FXObject , FXSelector, void )
long	onCmdGetIntValue (FXObject , FXSelector, void )
long	onCmdSetIntValue (FXObject , FXSelector, void )
	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	getContentWidth ()
virtual FXint	getContentHeight ()
virtual bool	canFocus () const
virtual void	setFocus ()
virtual void	killFocus ()
virtual FXint	getViewportHeight ()
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 ()
long	onHMouseWheel (FXObject , FXSelector, void )
long	onVMouseWheel (FXObject , FXSelector, void )
long	onHScrollerChanged (FXObject , FXSelector, void )
long	onVScrollerChanged (FXObject , FXSelector, void )
long	onHScrollerDragged (FXObject , FXSelector, void )
long	onVScrollerDragged (FXObject , FXSelector, void )
virtual FXint	getDefaultWidth ()
virtual FXint	getDefaultHeight ()
virtual FXint	getViewportWidth ()
void	setScrollStyle (FXuint style)
FXuint	getScrollStyle () const
FXbool	isHorizontalScrollable () const
FXbool	isVerticalScrollable () const
FXScrollBar *	horizontalScrollBar () const
FXScrollBar *	verticalScrollBar () const
FXint	getXPosition () const
FXint	getYPosition () const
void	setPosition (FXint x, FXint y)
void	getPosition (FXint &x, FXint &y) const
long	onFocusNext (FXObject , FXSelector, void )
long	onFocusPrev (FXObject , FXSelector, void )
long	onCmdUpdate (FXObject , FXSelector, void )
virtual void	destroy ()
FXint	maxChildWidth () const
FXint	maxChildHeight () const
virtual bool	isComposite () const
long	onMap (FXObject , FXSelector, void )
long	onUnmap (FXObject , FXSelector, void )
long	onConfigure (FXObject , FXSelector, void )
long	onUpdate (FXObject , FXSelector, void )
long	onMouseWheel (FXObject , FXSelector, void )
long	onMiddleBtnPress (FXObject , FXSelector, void )
long	onMiddleBtnRelease (FXObject , FXSelector, void )
long	onBeginDrag (FXObject , FXSelector, void )
long	onEndDrag (FXObject , FXSelector, void )
long	onDragged (FXObject , FXSelector, void )
long	onDestroy (FXObject , FXSelector, void )
long	onFocusSelf (FXObject , FXSelector, void )
long	onSelectionLost (FXObject , FXSelector, void )
long	onSelectionGained (FXObject , FXSelector, void )
long	onSelectionRequest (FXObject , FXSelector, void )
long	onClipboardLost (FXObject , FXSelector, void )
long	onClipboardGained (FXObject , FXSelector, void )
long	onClipboardRequest (FXObject , FXSelector, void )
long	onDNDEnter (FXObject , FXSelector, void )
long	onDNDLeave (FXObject , FXSelector, void )
long	onDNDMotion (FXObject , FXSelector, void )
long	onDNDDrop (FXObject , FXSelector, void )
long	onDNDRequest (FXObject , FXSelector, void )
long	onCmdShow (FXObject , FXSelector, void )
long	onCmdHide (FXObject , FXSelector, void )
long	onUpdToggleShown (FXObject , FXSelector, void )
long	onCmdToggleShown (FXObject , FXSelector, void )
long	onCmdRaise (FXObject , FXSelector, void )
long	onCmdLower (FXObject , FXSelector, void )
long	onCmdEnable (FXObject , FXSelector, void )
long	onCmdDisable (FXObject , FXSelector, void )
long	onUpdToggleEnabled (FXObject , FXSelector, void )
long	onCmdToggleEnabled (FXObject , FXSelector, void )
long	onUpdYes (FXObject , FXSelector, void )
long	onCmdDelete (FXObject , FXSelector, void )
FXWindow *	getParent () const
FXWindow *	getOwner () const
FXWindow *	getShell () const
FXWindow *	getRoot () const
FXWindow *	getNext () const
FXWindow *	getPrev () const
FXWindow *	getFirst () const
FXWindow *	getLast () const
FXWindow *	getFocus () const
void	setKey (FXuint k)
FXuint	getKey () const
void	setTarget (FXObject *t)
FXObject *	getTarget () const
void	setSelector (FXSelector sel)
FXSelector	getSelector () const
FXint	getX () const
FXint	getY () const
virtual FXint	getWidthForHeight (FXint givenheight)
virtual FXint	getHeightForWidth (FXint givenwidth)
void	setX (FXint x)
void	setY (FXint y)
void	setWidth (FXint w)
void	setHeight (FXint h)
void	setLayoutHints (FXuint lout)
FXuint	getLayoutHints () const
FXAccelTable *	getAccelTable () const
void	setAccelTable (FXAccelTable *acceltable)
void	addHotKey (FXHotKey code)
void	remHotKey (FXHotKey code)
void	setHelpTag (const FXString &text)
const FXString &	getHelpTag () const
bool	isShell () const
bool	isPopup () const
bool	isOwnerOf (const FXWindow *window) const
bool	isChildOf (const FXWindow *window) const
bool	containsChild (const FXWindow *child) const
FXWindow *	getChildAt (FXint x, FXint y) const
FXint	numChildren () const
FXint	indexOfChild (const FXWindow *window) const
FXWindow *	childAtIndex (FXint index) const
FXComposeContext *	getComposeContext () const
void	createComposeContext ()
void	destroyComposeContext ()
void	setDefaultCursor (FXCursor *cur)
FXCursor *	getDefaultCursor () const
void	setSavedCursor (FXCursor *cur)
FXCursor *	getSavedCursor () const
void	setDragCursor (FXCursor *cur)
FXCursor *	getDragCursor () const
FXint	getCursorPosition (FXint &x, FXint &y, FXuint &buttons) const
FXint	setCursorPosition (FXint x, FXint y)
bool	isEnabled () const
bool	isActive () const
bool	hasFocus () const
bool	inFocusChain () const
virtual void	changeFocus (FXWindow *child)
virtual void	setDefault (FXbool enable=TRUE)
bool	isDefault () const
void	setInitial (bool enable=true)
bool	isInitial () const
virtual void	enable ()
virtual void	disable ()
virtual void	attach (FXID w)
virtual void	setShape (const FXRegion &region)
virtual void	setShape (FXBitmap *bitmap)
virtual void	setShape (FXIcon *icon)
virtual void	clearShape ()
virtual void	raise ()
virtual void	lower ()
virtual void	move (FXint x, FXint y)
void	forceRefresh ()
virtual void	reparent (FXWindow father, FXWindow other=NULL)
void	scroll (FXint x, FXint y, FXint w, FXint h, FXint dx, FXint dy) const
void	update (FXint x, FXint y, FXint w, FXint h) const
void	update () const
void	repaint (FXint x, FXint y, FXint w, FXint h) const
void	repaint () const
void	grab ()
void	ungrab ()
bool	grabbed () const
void	grabKeyboard ()
void	ungrabKeyboard ()
bool	grabbedKeyboard () const
virtual void	show ()
virtual void	hide ()
bool	shown () const
bool	underCursor () const
bool	hasSelection () const
bool	acquireSelection (const FXDragType *types, FXuint numtypes)
bool	releaseSelection ()
bool	hasClipboard () const
bool	acquireClipboard (const FXDragType *types, FXuint numtypes)
bool	releaseClipboard ()
virtual void	dropEnable ()
virtual void	dropDisable ()
bool	isDropEnabled () const
bool	isDragging () const
bool	beginDrag (const FXDragType *types, FXuint numtypes)
bool	handleDrag (FXint x, FXint y, FXDragAction action=DRAG_COPY)
FXDragAction	endDrag (bool drop=true)
bool	isDropTarget () const
void	setDragRectangle (FXint x, FXint y, FXint w, FXint h, bool wantupdates=true) const
void	clearDragRectangle () const
void	acceptDrop (FXDragAction action=DRAG_ACCEPT) const
FXDragAction	didAccept () const
void	dropFinished (FXDragAction action=DRAG_REJECT) const
bool	inquireDNDTypes (FXDNDOrigin origin, FXDragType *&types, FXuint &numtypes) const
bool	offeredDNDType (FXDNDOrigin origin, FXDragType type) const
FXDragAction	inquireDNDAction () const
bool	setDNDData (FXDNDOrigin origin, FXDragType type, FXuchar *data, FXuint size) const
bool	setDNDData (FXDNDOrigin origin, FXDragType type, const FXString &string) const
bool	getDNDData (FXDNDOrigin origin, FXDragType type, FXuchar *&data, FXuint &size) const
bool	getDNDData (FXDNDOrigin origin, FXDragType type, FXString &string) const
virtual bool	contains (FXint parentx, FXint parenty) const
void	translateCoordinatesFrom (FXint &tox, FXint &toy, const FXWindow *fromwindow, FXint fromx, FXint fromy) const
void	translateCoordinatesTo (FXint &tox, FXint &toy, const FXWindow *towindow, FXint fromx, FXint fromy) const
virtual void	setBackColor (FXColor clr)
FXColor	getBackColor () const
virtual bool	doesSaveUnder () const
FXint	getWidth () const
FXint	getHeight () const
FXVisual *	getVisual () const
void	setVisual (FXVisual *vis)
FXApp *	getApp () const
FXEventLoop *	getEventLoop () const
FXID	id () const
void	setUserData (void *ptr)
void *	getUserData () const
virtual long	onDefault (FXObject , FXSelector, void )
const FXchar *	getClassName () const
bool	isMemberOf (const FXMetaClass *metaclass) const
virtual long	tryHandle (FXObject sender, FXSelector sel, void ptr)
QTransString	tr (const char text, const char hint=0)
virtual void *	getPythonObject () const
virtual void	decouplePythonObject () const
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)
static FXuint	userHandednessLayout ()
static FXuint	defaultPadding ()
static FXuint	defaultSpacing ()
static FXuint	scaleLayoutValue (FXuint value)
static FXWindow *	commonAncestor (FXWindow a, FXWindow b)
static bool	before (const FXWindow a, const FXWindow b)
static bool	after (const FXWindow a, const FXWindow b)
Static Public Attributes
static FXDragType	octetType
static FXDragType	deleteType
static FXDragType	textType
static FXDragType	utf8Type
static FXDragType	utf16Type
static FXDragType	colorType
static FXDragType	urilistType
static const FXDragType	stringType
static const FXDragType	imageType
static const FXchar *	octetTypeName
static const FXchar *	deleteTypeName
static const FXchar *	textTypeName
static const FXchar *	colorTypeName
static const FXchar *	urilistTypeName
static const FXchar *	utf8TypeName
static const FXchar *	utf16TypeName
Protected Types
enum	{ FLAG_SHOWN, FLAG_ENABLED, FLAG_UPDATE, FLAG_DROPTARGET, FLAG_FOCUSED, FLAG_DIRTY, FLAG_RECALC, FLAG_TIP, FLAG_HELP, FLAG_DEFAULT, FLAG_INITIAL, FLAG_SHELL, FLAG_ACTIVE, FLAG_PRESSED, FLAG_KEY, FLAG_CARET, FLAG_CHANGED, FLAG_LASSO, FLAG_TRYDRAG, FLAG_DODRAG, FLAG_SCROLLINSIDE, FLAG_SCROLLING, FLAG_OWNED, FLAG_POPUP }
Protected Member Functions
void	recompute ()
void	getrowscols (FXint &nr, FXint &nc, FXint w, FXint h) const
void	drawLasso (FXint x0, FXint y0, FXint x1, FXint y1)
void	lassoChanged (FXint ox, FXint oy, FXint ow, FXint oh, FXint nx, FXint ny, FXint nw, FXint nh, FXbool notify)
virtual void	moveContents (FXint x, FXint y)
virtual FXIconItem *	createItem (const FXString &text, FXIcon big, FXIcon mini, void *ptr)
FXbool	startAutoScroll (FXEvent *event, FXbool onlywheninside=FALSE)
void	stopAutoScroll ()
virtual bool	doesOverrideRedirect () const
void	addColormapWindows ()
void	remColormapWindows ()
Static Protected Member Functions
static FXint	compareSection (const FXchar p, const FXchar q, FXint s)
static FXint	compareSectionCase (const FXchar p, const FXchar q, FXint s)
static FXWindow *	findDefault (FXWindow *window)
static FXWindow *	findInitial (FXWindow *window)
Protected Attributes
FXHeader *	header
FXIconItemList	items
FXint	nrows
FXint	ncols
FXint	anchor
FXint	current
FXint	extent
FXint	cursor
FXint	viewable
FXFont *	font
FXIconListSortFunc	sortfunc
FXColor	textColor
FXColor	selbackColor
FXColor	seltextColor
FXint	itemWidth
FXint	itemHeight
FXint	itemSpace
FXint	anchorx
FXint	anchory
FXint	currentx
FXint	currenty
FXint	grabx
FXint	graby
FXString	lookup
FXString	help
FXbool	state
FXScrollBar *	horizontal
FXScrollBar *	vertical
FXScrollCorner *	corner
FXint	viewport_w
FXint	viewport_h
FXint	pos_x
FXint	pos_y
FXComposeContext *	composeContext
FXCursor *	defaultCursor
FXCursor *	savedCursor
FXCursor *	dragCursor
FXAccelTable *	accelTable
FXObject *	target
FXSelector	message
FXint	xpos
FXint	ypos
FXColor	backColor
FXString	tag
FXuint	flags
FXuint	options
FXVisual *	visual
FXint	width
FXint	height
FXID	xid

Constructor & Destructor Documentation

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.

Member Function Documentation

virtual void FX::FXIconList::create ( ) [virtual]

Create server-side resources.

Reimplemented from FX::FXComposite.

Reimplemented in FX::FXFileList.

virtual void FX::FXIconList::detach ( ) [virtual]

Detach server-side resources.

Reimplemented from FX::FXComposite.

Reimplemented in FX::FXFileList.

virtual void FX::FXIconList::recalc ( ) [virtual]

Recalculate layout.

Reimplemented from FX::FXWindow.

virtual void FX::FXIconList::layout ( ) [virtual]

Perform layout.

Reimplemented from FX::FXScrollArea.

virtual FXint FX::FXIconList::getContentWidth ( ) [virtual]

Compute and return content width.

Reimplemented from FX::FXScrollArea.

virtual FXint FX::FXIconList::getContentHeight ( ) [virtual]

Return content height.

Reimplemented from FX::FXScrollArea.

virtual bool FX::FXIconList::canFocus ( ) const [virtual]

Icon list can receive focus.

Reimplemented from FX::FXWindow.

virtual void FX::FXIconList::setFocus ( ) [virtual]

Move the focus to this window.

Reimplemented from FX::FXWindow.

virtual void FX::FXIconList::killFocus ( ) [virtual]

Remove the focus from this window.

Reimplemented from FX::FXWindow.

virtual FXint FX::FXIconList::getViewportHeight ( ) [virtual]

Return viewport size.

Reimplemented from FX::FXScrollArea.

virtual void FX::FXIconList::resize	(	FXint	w,
		FXint	h
	)			`[virtual]`

Resize this window to the specified width and height.

Reimplemented from FX::FXWindow.

virtual void FX::FXIconList::position	(	FXint	x,
		FXint	y,
		FXint	w,
		FXint	h
	)			`[virtual]`

Move and resize this window in the parent's coordinates.

Reimplemented from FX::FXWindow.

FXint FX::FXIconList::getNumItems ( ) const [inline]

Return number of items.

FXint FX::FXIconList::getNumRows ( ) const [inline]

Return number of rows.

FXint FX::FXIconList::getNumCols ( ) const [inline]

Return number of columns.

FXHeader* FX::FXIconList::getHeader ( ) const [inline]

Return header control.

void FX::FXIconList::setHeaders	(	const FXchar **	strings,
		FXint	size = `1`
	)

Set headers from array of strings.

void FX::FXIconList::setHeaders	(	const FXString &	strings,
		FXint	size = `1`
	)

Set headers from newline separated strings.

void FX::FXIconList::appendHeader	(	const FXString &	text,
		FXIcon *	icon = `NULL`,
		FXint	size = `1`
	)

Append header with given text and optional icon.

void FX::FXIconList::removeHeader ( FXint index )

Remove header at index.

void FX::FXIconList::setHeaderText	(	FXint	index,
		const FXString &	text
	)

Change text of header at index.

FXString FX::FXIconList::getHeaderText ( FXint index ) const

Return text of header at index.

void FX::FXIconList::setHeaderIcon	(	FXint	index,
		FXIcon *	icon
	)

Change icon of header at index.

FXIcon* FX::FXIconList::getHeaderIcon ( FXint index ) const

Return icon of header at index.

void FX::FXIconList::setHeaderSize	(	FXint	index,
		FXint	size
	)

Change size of header at index.

FXint FX::FXIconList::getHeaderSize ( FXint index ) const

Return width 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.

FXint FX::FXIconList::moveItem	(	FXint	newindex,
		FXint	oldindex,
		FXbool	notify = `FALSE`
	)

Move item from oldindex to newindex.

FXIconItem* FX::FXIconList::extractItem	(	FXint	index,
		FXbool	notify = `FALSE`
	)

Extract item from list.

void FX::FXIconList::removeItem	(	FXint	index,
		FXbool	notify = `FALSE`
	)

Remove 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.

virtual FXint FX::FXIconList::getItemAt	(	FXint	x,
		FXint	y
	)			const `[virtual]`

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.

void FX::FXIconList::setItemText	(	FXint	index,
		const FXString &	text
	)

Change item text.

FXString FX::FXIconList::getItemText ( FXint index ) const

Return item text.

void FX::FXIconList::setItemBigIcon	(	FXint	index,
		FXIcon *	icon,
		FXbool	owned = `FALSE`
	)

Change item big icon.

FXIcon* FX::FXIconList::getItemBigIcon ( FXint index ) const

Return big icon of item at index.

void FX::FXIconList::setItemMiniIcon	(	FXint	index,
		FXIcon *	icon,
		FXbool	owned = `FALSE`
	)

Change item mini icon.

FXIcon* FX::FXIconList::getItemMiniIcon ( FXint index ) const

Return mini icon of item at index.

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.

FXbool FX::FXIconList::isItemSelected ( FXint index ) const

Return TRUE if item at index is selected.

FXbool FX::FXIconList::isItemCurrent ( FXint index ) const

Return TRUE if item at index is current.

FXbool FX::FXIconList::isItemVisible ( FXint index ) const

Return TRUE if item at index is visible.

FXbool FX::FXIconList::isItemEnabled ( FXint index ) const

Return TRUE if item at index is enabled.

FXint FX::FXIconList::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 FX::FXIconList::updateItem ( FXint index ) const

Repaint item at index.

virtual FXbool FX::FXIconList::enableItem ( FXint index ) [virtual]

Enable item at index.

virtual FXbool FX::FXIconList::disableItem ( FXint index ) [virtual]

Disable item at index.

virtual FXbool FX::FXIconList::selectItem	(	FXint	index,
		FXbool	notify = `FALSE`
	)			`[virtual]`

Select item at index.

virtual FXbool FX::FXIconList::deselectItem	(	FXint	index,
		FXbool	notify = `FALSE`
	)			`[virtual]`

Deselect item at index.

virtual FXbool FX::FXIconList::toggleItem	(	FXint	index,
		FXbool	notify = `FALSE`
	)			`[virtual]`

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.

virtual FXbool FX::FXIconList::extendSelection	(	FXint	index,
		FXbool	notify = `FALSE`
	)			`[virtual]`

Extend selection from anchor index to index.

virtual FXbool FX::FXIconList::killSelection ( FXbool notify = FALSE ) [virtual]

Deselect all items.

virtual void FX::FXIconList::setCurrentItem	(	FXint	index,
		FXbool	notify = `FALSE`
	)			`[virtual]`

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]

Save list to a stream.

Reimplemented from FX::FXWindow.

Reimplemented in FX::FXFileList.

virtual void FX::FXIconList::load ( FXStream & store ) [virtual]

Load list from a stream.

Reimplemented from FX::FXWindow.

Reimplemented in FX::FXFileList.

virtual FXint FX::FXScrollArea::getDefaultWidth ( ) [virtual, inherited]

Return default width.

Reimplemented from FX::FXComposite.

Reimplemented in FX::FXFoldingList, FX::FXList, FX::FXTable, FX::FXText, and FX::FXTreeList.

virtual FXint FX::FXScrollArea::getDefaultHeight ( ) [virtual, inherited]

Return default height.

Reimplemented from FX::FXComposite.

Reimplemented in FX::FXFoldingList, FX::FXList, FX::FXTable, FX::FXText, and FX::FXTreeList.

virtual FXint FX::FXScrollArea::getViewportWidth ( ) [virtual, inherited]

Return viewport width.

Reimplemented in FX::FXRulerView.

void FX::FXScrollArea::setScrollStyle ( FXuint style ) [inherited]

Change scroll style.

FXuint FX::FXScrollArea::getScrollStyle ( ) const [inherited]

Return scroll style.

FXbool FX::FXScrollArea::isHorizontalScrollable ( ) const [inherited]

Return TRUE if horizontally scrollable.

FXbool FX::FXScrollArea::isVerticalScrollable ( ) const [inherited]

Return TRUE if vertically scrollable.

FXScrollBar* FX::FXScrollArea::horizontalScrollBar ( ) const [inline, inherited]

Return a pointer to the horizontal scrollbar.

FXScrollBar* FX::FXScrollArea::verticalScrollBar ( ) const [inline, inherited]

Return a pointer to the vertical scrollbar.

FXint FX::FXScrollArea::getXPosition ( ) const [inline, inherited]

Return the current x-position.

FXint FX::FXScrollArea::getYPosition ( ) const [inline, inherited]

Return the current y-position.

void FX::FXScrollArea::setPosition	(	FXint	x,
		FXint	y
	)			`[inherited]`

Set the current position.

void FX::FXScrollArea::getPosition	(	FXint &	x,
		FXint &	y
	)			const `[inline, inherited]`

Get the current position.

virtual void FX::FXComposite::destroy ( ) [virtual, inherited]

Destroy server-side resources.

Reimplemented from FX::FXWindow.

Reimplemented in FX::FXComboBox, FX::FXDirBox, FX::FXDirList, FX::FXDriveBox, FX::FXFileList, FX::FXListBox, FX::FXRootWindow, FX::FXTopWindow, and FX::FXTreeListBox.

FXint FX::FXComposite::maxChildWidth ( ) const [inherited]

Return the width of the widest child window.

FXint FX::FXComposite::maxChildHeight ( ) const [inherited]

Return the height of the tallest child window.

virtual bool FX::FXComposite::isComposite ( ) const [virtual, inherited]

Overrides this virtual function to return TRUE.

Reimplemented from FX::FXWindow.

static FXuint FX::FXWindow::userHandednessLayout ( ) [inline, static, inherited]

Returns LAYOUT_RIGHT or LAYOUT_LEFT suitable for the current user's handedness.

References FX::FXProcess::userHandedness().

static FXuint FX::FXWindow::defaultPadding ( ) [inline, static, inherited]

Returns the default padding quantity.

References FX::FXProcess::screenScale().

static FXuint FX::FXWindow::defaultSpacing ( ) [inline, static, inherited]

Returns the default child spacing quantity.

References FX::FXProcess::screenScale().

static FXuint FX::FXWindow::scaleLayoutValue ( FXuint value ) [inline, static, inherited]

Scales a layout value by a factor.

References FX::FXProcess::screenScale().

FXWindow* FX::FXWindow::getParent ( ) const [inline, inherited]

Return a pointer to the parent window.

FXWindow* FX::FXWindow::getOwner ( ) const [inline, inherited]

Return a pointer to the owner window.

FXWindow* FX::FXWindow::getShell ( ) const [inherited]

Return a pointer to the shell window.

FXWindow* FX::FXWindow::getRoot ( ) const [inherited]

Return a pointer to the root window.

FXWindow* FX::FXWindow::getNext ( ) const [inline, inherited]

Return a pointer to the next (sibling) window, if any.

FXWindow* FX::FXWindow::getPrev ( ) const [inline, inherited]

Return a pointer to the previous (sibling) window , if any.

FXWindow* FX::FXWindow::getFirst ( ) const [inline, inherited]

Return a pointer to this window's first child window , if any.

FXWindow* FX::FXWindow::getLast ( ) const [inline, inherited]

Return a pointer to this window's last child window, if any.

FXWindow* FX::FXWindow::getFocus ( ) const [inline, inherited]

Return a pointer to the currently focused child window.

void FX::FXWindow::setKey ( FXuint k ) [inline, inherited]

Change window key.

FXuint FX::FXWindow::getKey ( ) const [inline, inherited]

Return window key.

void FX::FXWindow::setTarget ( FXObject * t ) [inline, inherited]

Set the message target object for this window.

FXObject* FX::FXWindow::getTarget ( ) const [inline, inherited]

Get the message target object for this window, if any.

void FX::FXWindow::setSelector ( FXSelector sel ) [inline, inherited]

Set the message identifier for this window.

FXSelector FX::FXWindow::getSelector ( ) const [inline, inherited]

Get the message identifier for this window.

FXint FX::FXWindow::getX ( ) const [inline, inherited]

Get this window's x-coordinate, in the parent's coordinate system.

FXint FX::FXWindow::getY ( ) const [inline, inherited]

Get this window's y-coordinate, in the parent's coordinate system.

virtual FXint FX::FXWindow::getWidthForHeight ( FXint givenheight ) [virtual, inherited]

Return width for given height.

Reimplemented in FX::FXDockSite.

virtual FXint FX::FXWindow::getHeightForWidth ( FXint givenwidth ) [virtual, inherited]

Return height for given width.

Reimplemented in FX::FXDockSite.

void FX::FXWindow::setX ( FXint x ) [inherited]

Set this window's x-coordinate, in the parent's coordinate system.

void FX::FXWindow::setY ( FXint y ) [inherited]

Set this window's y-coordinate, in the parent's coordinate system.

void FX::FXWindow::setWidth ( FXint w ) [inherited]

Set the window width; and flag the widget as being in need of layout by its parent. This does not immediately update the server- side representation of the widget.

void FX::FXWindow::setHeight ( FXint h ) [inherited]

Set the window height; and flag the widget as being in need of layout by its parent. This does not immediately update the server- side representation of the widget.

void FX::FXWindow::setLayoutHints ( FXuint lout ) [inherited]

Set layout hints for this window.

FXuint FX::FXWindow::getLayoutHints ( ) const [inherited]

Get layout hints for this window.

FXAccelTable* FX::FXWindow::getAccelTable ( ) const [inline, inherited]

Return a pointer to the accelerator table.

void FX::FXWindow::setAccelTable ( FXAccelTable * acceltable ) [inline, inherited]

Set the accelerator table.

void FX::FXWindow::addHotKey ( FXHotKey code ) [inherited]

Add a hot key.

void FX::FXWindow::remHotKey ( FXHotKey code ) [inherited]

Remove a hot key.

void FX::FXWindow::setHelpTag ( const FXString & text ) [inline, inherited]

Change help tag for this widget.

const FXString& FX::FXWindow::getHelpTag ( ) const [inline, inherited]

Get the help tag for this widget.

bool FX::FXWindow::isShell ( ) const [inherited]

Return true if window is a shell window.

bool FX::FXWindow::isPopup ( ) const [inherited]

Return true if window is a popup window.

bool FX::FXWindow::isOwnerOf ( const FXWindow * window ) const [inherited]

Return true if specified window is owned by this window.

bool FX::FXWindow::isChildOf ( const FXWindow * window ) const [inherited]

Return true if specified window is ancestor of this window.

bool FX::FXWindow::containsChild ( const FXWindow * child ) const [inherited]

Return true if this window contains child in its subtree.

FXWindow* FX::FXWindow::getChildAt	(	FXint	x,
		FXint	y
	)			const `[inherited]`

Return the child window at specified coordinates.

FXint FX::FXWindow::numChildren ( ) const [inherited]

Return the number of child windows for this window.

FXint FX::FXWindow::indexOfChild ( const FXWindow * window ) const [inherited]

Return the index (starting from zero) of the specified child window, or -1 if the window is not a child or NULL

FXWindow* FX::FXWindow::childAtIndex ( FXint index ) const [inherited]

Return the child window at specified index, or NULL if the index is negative or out of range

static FXWindow* FX::FXWindow::commonAncestor	(	FXWindow *	a,
		FXWindow *	b
	)			`[static, inherited]`

Return the common ancestor of window a and window b.

static bool FX::FXWindow::before	(	const FXWindow *	a,
		const FXWindow *	b
	)			`[static, inherited]`

Return TRUE if sibling a <= sibling b in list.

static bool FX::FXWindow::after	(	const FXWindow *	a,
		const FXWindow *	b
	)			`[static, inherited]`

Return TRUE if sibling a >= sibling b in list.

FXComposeContext* FX::FXWindow::getComposeContext ( ) const [inline, inherited]

Return compose context.

void FX::FXWindow::createComposeContext ( ) [inherited]

Create compose context.

void FX::FXWindow::destroyComposeContext ( ) [inherited]

Destroy compose context.

void FX::FXWindow::setDefaultCursor ( FXCursor * cur ) [inherited]

Set the default cursor for this window.

FXCursor* FX::FXWindow::getDefaultCursor ( ) const [inline, inherited]

Return the default cursor for this window.

void FX::FXWindow::setSavedCursor ( FXCursor * cur ) [inline, inherited]

Set the saved cursor for this window.

FXCursor* FX::FXWindow::getSavedCursor ( ) const [inline, inherited]

Return the saved cursor for this window.

void FX::FXWindow::setDragCursor ( FXCursor * cur ) [inherited]

Set the drag cursor for this window.

FXCursor* FX::FXWindow::getDragCursor ( ) const [inline, inherited]

Return the drag cursor for this window.

FXint FX::FXWindow::getCursorPosition	(	FXint &	x,
		FXint &	y,
		FXuint &	buttons
	)			const `[inherited]`

Return the cursor position and mouse button-state.

FXint FX::FXWindow::setCursorPosition	(	FXint	x,
		FXint	y
	)			`[inherited]`

Warp the cursor to the new position.

bool FX::FXWindow::isEnabled ( ) const [inherited]

Return true if this window is able to receive mouse and keyboard events.

bool FX::FXWindow::isActive ( ) const [inherited]

Return true if the window is active.

bool FX::FXWindow::hasFocus ( ) const [inherited]

Return true if this window has the focus.

bool FX::FXWindow::inFocusChain ( ) const [inherited]

Return true if this window is in focus chain.

virtual void FX::FXWindow::changeFocus ( FXWindow * child ) [virtual, inherited]

Notification that focus moved to new child.

Reimplemented in FX::FXTable.

virtual void FX::FXWindow::setDefault ( FXbool enable = TRUE ) [virtual, inherited]

This changes the default window which responds to the Return key in a dialog. If enable is TRUE, this window becomes the default window; when enable is FALSE, this window will be no longer the default window. Finally, when enable is MAYBE, the default window will revert to the initial default window.

Reimplemented in FX::FXButton.

bool FX::FXWindow::isDefault ( ) const [inherited]

Return true if this is the default window.

void FX::FXWindow::setInitial ( bool enable = true ) [inherited]

Make this window the initial default window.

bool FX::FXWindow::isInitial ( ) const [inherited]

Return true if this is the initial default window.

virtual void FX::FXWindow::enable ( ) [virtual, inherited]

Enable the window to receive mouse and keyboard events.

Reimplemented in FX::FXArrowButton, FX::FXComboBox, FX::FXGroupBox, FX::FXKnob, FX::FXLabel, FX::FXListBox, FX::FXMenuCaption, FX::FXRealSlider, FX::FXRealSpinner, FX::FXScrollCorner, FX::FXSlider, FX::FXSpinner, FX::FXText, FX::FXTextField, FX::FXToolBarTab, and FX::FXTreeListBox.

virtual void FX::FXWindow::disable ( ) [virtual, inherited]

Disable the window from receiving mouse and keyboard events.

Reimplemented in FX::FXArrowButton, FX::FXComboBox, FX::FXGroupBox, FX::FXKnob, FX::FXLabel, FX::FXListBox, FX::FXMenuCaption, FX::FXRealSlider, FX::FXRealSpinner, FX::FXScrollCorner, FX::FXSlider, FX::FXSpinner, FX::FXText, FX::FXTextField, FX::FXToolBarTab, and FX::FXTreeListBox.

virtual void FX::FXWindow::attach ( FXID w ) [virtual, inherited]

Attach foreign window handle to this window.

virtual void FX::FXWindow::setShape ( const FXRegion & region ) [virtual, inherited]

Set window shape by means of region.

virtual void FX::FXWindow::setShape ( FXBitmap * bitmap ) [virtual, inherited]

Set window shape by means of bitmap.

virtual void FX::FXWindow::setShape ( FXIcon * icon ) [virtual, inherited]

Set window shape by means of icon.

virtual void FX::FXWindow::clearShape ( ) [virtual, inherited]

Clear window shape.

virtual void FX::FXWindow::raise ( ) [virtual, inherited]

Raise this window to the top of the stacking order.

Reimplemented in FX::FXTopWindow.

virtual void FX::FXWindow::lower ( ) [virtual, inherited]

Lower this window to the bottom of the stacking order.

virtual void FX::FXWindow::move	(	FXint	x,
		FXint	y
	)			`[virtual, inherited]`

Move the window immediately, in the parent's coordinate system. Update the server representation as well if the window is realized. Perform layout of the children when necessary.

Reimplemented in FX::FXMDIChild, FX::FXRootWindow, and FX::FXTopWindow.

void FX::FXWindow::forceRefresh ( ) [inherited]

Generate a SEL_UPDATE message for the window and its children.

virtual void FX::FXWindow::reparent	(	FXWindow *	father,
		FXWindow *	other = `NULL`
	)			`[virtual, inherited]`

Reparent this window under new father before other.

void FX::FXWindow::scroll	(	FXint	x,
		FXint	y,
		FXint	w,
		FXint	h,
		FXint	dx,
		FXint	dy
	)			const `[inherited]`

Scroll rectangle x,y,w,h by a shift of dx,dy.

void FX::FXWindow::update	(	FXint	x,
		FXint	y,
		FXint	w,
		FXint	h
	)			const `[inherited]`

Mark the specified rectangle to be repainted later.

void FX::FXWindow::update ( ) const [inherited]

Mark the entire window to be repainted later.

void FX::FXWindow::repaint	(	FXint	x,
		FXint	y,
		FXint	w,
		FXint	h
	)			const `[inherited]`

Process any outstanding repaint messages immediately, for the given rectangle.

void FX::FXWindow::repaint ( ) const [inherited]

Process any outstanding repaint messages immediately.

void FX::FXWindow::grab ( ) [inherited]

Grab the mouse to this window; future mouse events will be reported to this window even while the cursor goes outside of this window

void FX::FXWindow::ungrab ( ) [inherited]

Release the mouse grab.

bool FX::FXWindow::grabbed ( ) const [inherited]

Return true if the window has been grabbed.

void FX::FXWindow::grabKeyboard ( ) [inherited]

Grab keyboard device.

void FX::FXWindow::ungrabKeyboard ( ) [inherited]

Ungrab keyboard device.

bool FX::FXWindow::grabbedKeyboard ( ) const [inherited]

Return true if active grab is in effect.

virtual void FX::FXWindow::show ( ) [virtual, inherited]

Show this window.

Reimplemented in FX::FXPopup, FX::FXScrollPane, FX::FXSplashWindow, FX::FXToolTip, and FX::FXTopWindow.

virtual void FX::FXWindow::hide ( ) [virtual, inherited]

Hide this window.

Reimplemented in FX::FXDirDialog, FX::FXFileDialog, FX::FXPopup, FX::FXSplashWindow, and FX::FXTopWindow.

bool FX::FXWindow::shown ( ) const [inherited]

Return true if the window is shown.

bool FX::FXWindow::underCursor ( ) const [inherited]

Return true if the window is under the cursor.

bool FX::FXWindow::hasSelection ( ) const [inherited]

Return true if this window owns the primary selection.

bool FX::FXWindow::acquireSelection	(	const FXDragType *	types,
		FXuint	numtypes
	)			`[inherited]`

Try to acquire the primary selection, given a list of drag types.

bool FX::FXWindow::releaseSelection ( ) [inherited]

Release the primary selection.

bool FX::FXWindow::hasClipboard ( ) const [inherited]

Return true if this window owns the clipboard.

bool FX::FXWindow::acquireClipboard	(	const FXDragType *	types,
		FXuint	numtypes
	)			`[inherited]`

Try to acquire the clipboard, given a list of drag types.

bool FX::FXWindow::releaseClipboard ( ) [inherited]

Release the clipboard.

virtual void FX::FXWindow::dropEnable ( ) [virtual, inherited]

Enable this window to receive drops.

virtual void FX::FXWindow::dropDisable ( ) [virtual, inherited]

Disable this window from receiving drops.

bool FX::FXWindow::isDropEnabled ( ) const [inherited]

Return true if this window is able to receive drops.

bool FX::FXWindow::isDragging ( ) const [inherited]

Return true if a drag operaion has been initiated from this window.

bool FX::FXWindow::beginDrag	(	const FXDragType *	types,
		FXuint	numtypes
	)			`[inherited]`

Initiate a drag operation with a list of previously registered drag types.

bool FX::FXWindow::handleDrag	(	FXint	x,
		FXint	y,
		FXDragAction	action = `DRAG_COPY`
	)			`[inherited]`

When dragging, inform the drop-target of the new position and the drag action

FXDragAction FX::FXWindow::endDrag ( bool drop = true ) [inherited]

Terminate the drag operation with or without actually dropping the data Returns the action performed by the target

bool FX::FXWindow::isDropTarget ( ) const [inherited]

Return true if this window is the target of a drop.

void FX::FXWindow::setDragRectangle	(	FXint	x,
		FXint	y,
		FXint	w,
		FXint	h,
		bool	wantupdates = `true`
	)			const `[inherited]`

When being dragged over, indicate that no further SEL_DND_MOTION messages are required while the cursor is inside the given rectangle

void FX::FXWindow::clearDragRectangle ( ) const [inherited]

When being dragged over, indicate we want to receive SEL_DND_MOTION messages every time the cursor moves

void FX::FXWindow::acceptDrop ( FXDragAction action = DRAG_ACCEPT ) const [inherited]

When being dragged over, indicate acceptance or rejection of the dragged data.

FXDragAction FX::FXWindow::didAccept ( ) const [inherited]

The target accepted our drop.

void FX::FXWindow::dropFinished ( FXDragAction action = DRAG_REJECT ) const [inherited]

Sent by the drop target in response to SEL_DND_DROP. The drag action should be the same as the action the drop target reported to the drag source in reponse to the SEL_DND_MOTION message. This function notifies the drag source that its part of the drop transaction is finished, and that it is free to release any resources involved in the drag operation. Calling dropFinished() is advisable in cases where the drop target needs to perform complex processing on the data received from the drag source, prior to returning from the SEL_DND_DROP message handler.

bool FX::FXWindow::inquireDNDTypes	(	FXDNDOrigin	origin,
		FXDragType *&	types,
		FXuint &	numtypes
	)			const `[inherited]`

When being dragged over, inquire the drag types which are being offered.

bool FX::FXWindow::offeredDNDType	(	FXDNDOrigin	origin,
		FXDragType	type
	)			const `[inherited]`

When being dragged over, return true if we are offered the given drag type.

FXDragAction FX::FXWindow::inquireDNDAction ( ) const [inherited]

When being dragged over, return the drag action.

bool FX::FXWindow::setDNDData	(	FXDNDOrigin	origin,
		FXDragType	type,
		FXuchar *	data,
		FXuint	size
	)			const `[inherited]`

Set DND data; the array must be allocated with FXMALLOC and ownership is transferred to the system

bool FX::FXWindow::setDNDData	(	FXDNDOrigin	origin,
		FXDragType	type,
		const FXString &	string
	)			const `[inherited]`

Set DND data from string value.

bool FX::FXWindow::getDNDData	(	FXDNDOrigin	origin,
		FXDragType	type,
		FXuchar *&	data,
		FXuint &	size
	)			const `[inherited]`

Get DND data; the caller becomes the owner of the array and must free it with FXFREE

bool FX::FXWindow::getDNDData	(	FXDNDOrigin	origin,
		FXDragType	type,
		FXString &	string
	)			const `[inherited]`

Get DND data into string value.

virtual bool FX::FXWindow::contains	(	FXint	parentx,
		FXint	parenty
	)			const `[virtual, inherited]`

Return true if window logically contains the given point.

Reimplemented in FX::FXMenuBar, FX::FXMenuButton, FX::FXMenuCascade, FX::FXMenuPane, FX::FXMenuTitle, and FX::FXOptionMenu.

void FX::FXWindow::translateCoordinatesFrom	(	FXint &	tox,
		FXint &	toy,
		const FXWindow *	fromwindow,
		FXint	fromx,
		FXint	fromy
	)			const `[inherited]`

Translate coordinates from fromwindow's coordinate space to this window's coordinate space.

void FX::FXWindow::translateCoordinatesTo	(	FXint &	tox,
		FXint &	toy,
		const FXWindow *	towindow,
		FXint	fromx,
		FXint	fromy
	)			const `[inherited]`

Translate coordinates from this window's coordinate space to towindow's coordinate space.

virtual void FX::FXWindow::setBackColor ( FXColor clr ) [virtual, inherited]

Set window background color.

Reimplemented in FX::FXComboBox, and FX::FXListBox.

FXColor FX::FXWindow::getBackColor ( ) const [inline, inherited]

Get background color.

Reimplemented in FX::FXComboBox, and FX::FXListBox.

FXint FX::FXDrawable::getWidth ( ) const [inline, inherited]

Width of drawable.

FXint FX::FXDrawable::getHeight ( ) const [inline, inherited]

Height of drawable.

FXVisual* FX::FXDrawable::getVisual ( ) const [inline, inherited]

Get the visual.

void FX::FXDrawable::setVisual ( FXVisual * vis ) [inherited]

Change visual.

FXApp* FX::FXId::getApp ( ) const [inline, inherited]

Get application.

FXEventLoop* FX::FXId::getEventLoop ( ) const [inline, inherited]

Get event loop which owns this.

FXID FX::FXId::id ( ) const [inline, inherited]

Get XID handle.

void FX::FXId::setUserData ( void * ptr ) [inline, inherited]

Set user data pointer.

void* FX::FXId::getUserData ( ) const [inline, inherited]

Get user data pointer.

virtual long FX::FXObject::onDefault	(	FXObject *	,
		FXSelector	,
		void *
	)			`[virtual, inherited]`

Called for unhandled messages.

Reimplemented in FX::FXDelegator, FX::FXGLViewer, FX::FXMDIChild, and FX::FXMDIClient.

const FXchar* FX::FXObject::getClassName ( ) const [inherited]

Get class name of some object.

bool FX::FXObject::isMemberOf ( const FXMetaClass * metaclass ) const [inherited]

Check if object is member of metaclass.

virtual long FX::FXObject::tryHandle	(	FXObject *	sender,
		FXSelector	sel,
		void *	ptr
	)			`[virtual, inherited]`

Try handle message safely.

QTransString FX::FXObject::tr	(	const char *	text,
		const char *	hint = `0`
	)			`[inherited]`

Returns a human translated version of the text to the locale language (warning: uses a virtual method call, so can't use before construction)

virtual void* FX::FXObject::getPythonObject ( ) const [inline, virtual, inherited]

Returns the python object representing this instance (if created in python).

virtual void FX::FXObject::decouplePythonObject ( ) const [inline, virtual, inherited]

Causes decoupling of python object from this object (deletes self).

The documentation for this class was generated from the following file:

FXIconList.h

FX::FXIconList Class Reference

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation