FX::FXMenuCheck Class Reference

The menu check widget is used to change a state in the application from a menu. More...

#include <FXMenuCheck.h>

Inheritance diagram for FX::FXMenuCheck:

List of all members.

Public Member Functions
long	onPaint (FXObject *, FXSelector, void *)
long	onButtonPress (FXObject *, FXSelector, void *)
long	onButtonRelease (FXObject *, FXSelector, void *)
long	onKeyPress (FXObject *, FXSelector, void *)
long	onKeyRelease (FXObject *, FXSelector, void *)
long	onHotKeyPress (FXObject *, FXSelector, void *)
long	onHotKeyRelease (FXObject *, FXSelector, void *)
long	onCheck (FXObject *, FXSelector, void *)
long	onUncheck (FXObject *, FXSelector, void *)
long	onUnknown (FXObject *, FXSelector, void *)
long	onCmdSetValue (FXObject *, FXSelector, void *)
long	onCmdSetIntValue (FXObject *, FXSelector, void *)
long	onCmdGetIntValue (FXObject *, FXSelector, void *)
long	onCmdAccel (FXObject *, FXSelector, void *)
	FXMenuCheck (FXComposite *p, const FXString &text, FXObject *tgt=NULL, FXSelector sel=0, FXuint opts=0)
	Construct a menu check.
virtual FXint	getDefaultWidth ()
	Return default width.
virtual FXint	getDefaultHeight ()
	Return default height.
void	setCheck (FXuchar s=TRUE)
	Set check state (TRUE, FALSE or MAYBE)
FXuchar	getCheck () const
	Get check state (TRUE, FALSE or MAYBE)
FXColor	getBoxColor () const
	Get the box background color.
void	setBoxColor (FXColor clr)
	Set the box background color.
virtual void	save (FXStream &store) const
	Save menu to a stream.
virtual void	load (FXStream &store)
	Load menu from a stream.
Public Member Functions inherited from FX::FXMenuCommand
long	onEnter (FXObject *, FXSelector, void *)
long	onLeave (FXObject *, FXSelector, void *)
	FXMenuCommand (FXComposite *p, const FXString &text, FXIcon *ic=NULL, FXObject *tgt=NULL, FXSelector sel=0, FXuint opts=0)
	Construct a menu command.
virtual FXbool	canFocus () const
	Yes it can receive the focus.
virtual void	setFocus ()
	Move the focus to this window.
virtual void	killFocus ()
	Remove the focus from this window.
void	setAccelText (const FXString &text, FXbool acc=false)
	Set accelerator text; update accelerator if acc is true.
FXString	getAccelText () const
	Return accelarator text.
virtual	~FXMenuCommand ()
	Destructor.
Public Member Functions inherited from FX::FXMenuCaption
long	onUpdate (FXObject *, FXSelector, void *)
long	onCmdGetStringValue (FXObject *, FXSelector, void *)
long	onCmdSetStringValue (FXObject *, FXSelector, void *)
long	onCmdSetIconValue (FXObject *, FXSelector, void *)
long	onCmdGetIconValue (FXObject *, FXSelector, void *)
long	onCmdSetHelp (FXObject *, FXSelector, void *)
long	onCmdGetHelp (FXObject *, FXSelector, void *)
long	onCmdSetTip (FXObject *, FXSelector, void *)
long	onCmdGetTip (FXObject *, FXSelector, void *)
long	onQueryHelp (FXObject *, FXSelector, void *)
long	onQueryTip (FXObject *, FXSelector, void *)
	FXMenuCaption (FXComposite *p, const FXString &text, FXIcon *ic=NULL, FXuint opts=0)
	Construct a menu caption.
virtual void	create ()
	Create server-side resources.
virtual void	detach ()
	Detach server-side resources.
virtual void	enable ()
	Enable the menu.
virtual void	disable ()
	Disable the menu.
void	setText (const FXString &text)
	Set the text for this menu.
FXString	getText () const
	Get the text for this menu.
void	setIcon (FXIcon *ic)
	Set the icon for this menu.
FXIcon *	getIcon () const
	Get the icon for this menu.
void	setFont (FXFont *fnt)
	Set the text font.
FXFont *	getFont () const
	Return the text font.
void	setMenuStyle (FXuint style)
	Set menu caption style.
FXuint	getMenuStyle () const
	Get menu caption style.
void	setTextColor (FXColor clr)
	Return the current text color.
FXColor	getTextColor () const
	Get the current text color.
void	setSelBackColor (FXColor clr)
	Return the selection background color.
FXColor	getSelBackColor () const
	Return the selection background color.
void	setSelTextColor (FXColor clr)
	Return the selection text color.
FXColor	getSelTextColor () const
	Return the selection text color.
void	setHiliteColor (FXColor clr)
	Change highlight color.
FXColor	getHiliteColor () const
	Get highlight color.
void	setShadowColor (FXColor clr)
	Change shadow color.
FXColor	getShadowColor () const
	Get shadow color.
void	setHelpText (const FXString &text)
	Set the status line help text for this menu.
const FXString &	getHelpText () const
	Get the status line help text for this menu.
void	setTipText (const FXString &text)
	Set the tool tip message for this menu.
const FXString &	getTipText () const
	Get the tool tip message for this menu.
virtual	~FXMenuCaption ()
	Destructor.
Public Member Functions inherited from FX::FXWindow
long	onMap (FXObject *, FXSelector, void *)
long	onUnmap (FXObject *, FXSelector, void *)
long	onConfigure (FXObject *, FXSelector, void *)
long	onMotion (FXObject *, FXSelector, void *)
long	onMouseWheel (FXObject *, FXSelector, void *)
long	onLeftBtnPress (FXObject *, FXSelector, void *)
long	onLeftBtnRelease (FXObject *, FXSelector, void *)
long	onMiddleBtnPress (FXObject *, FXSelector, void *)
long	onMiddleBtnRelease (FXObject *, FXSelector, void *)
long	onRightBtnPress (FXObject *, FXSelector, void *)
long	onRightBtnRelease (FXObject *, FXSelector, void *)
long	onSpaceBallMotion (FXObject *, FXSelector, void *)
long	onSpaceBallButtonPress (FXObject *, FXSelector, void *)
long	onSpaceBallButtonRelease (FXObject *, FXSelector, void *)
long	onBeginDrag (FXObject *, FXSelector, void *)
long	onEndDrag (FXObject *, FXSelector, void *)
long	onDragged (FXObject *, FXSelector, void *)
long	onUngrabbed (FXObject *, FXSelector, void *)
long	onDestroy (FXObject *, FXSelector, void *)
long	onFocusSelf (FXObject *, FXSelector, void *)
long	onFocusIn (FXObject *, FXSelector, void *)
long	onFocusOut (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	onCmdUpdate (FXObject *, FXSelector, void *)
long	onUpdYes (FXObject *, FXSelector, void *)
long	onCmdDelete (FXObject *, FXSelector, void *)
	FXWindow (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
	Constructor.
FXWindow *	getParent () const
	Return a pointer to the parent window.
FXWindow *	getOwner () const
	Return a pointer to the owner window.
FXWindow *	getShell () const
	Return a pointer to the shell window.
FXWindow *	getRoot () const
	Return a pointer to the root window.
FXWindow *	getNext () const
	Return a pointer to the next (sibling) window, if any.
FXWindow *	getPrev () const
	Return a pointer to the previous (sibling) window , if any.
FXWindow *	getFirst () const
	Return a pointer to this window's first child window , if any.
FXWindow *	getLast () const
	Return a pointer to this window's last child window, if any.
FXWindow *	getFocus () const
	Return a pointer to the currently focused child window.
virtual WindowClass	getWindowClass () const
	Get window class.
void	setKey (FXuint k)
	Change window key.
FXuint	getKey () const
	Return window key.
FXWindow *	getChildWithKey (FXuint k) const
	Return child window with given window key.
void	setTarget (FXObject *t)
	Set the message target object for this window.
FXObject *	getTarget () const
	Get the message target object for this window, if any.
void	setSelector (FXSelector sel)
	Set the message identifier for this window.
FXSelector	getSelector () const
	Get the message identifier for this window.
FXint	getX () const
	Get this window's x-coordinate, in the parent's coordinate system.
FXint	getY () const
	Get this window's y-coordinate, in the parent's coordinate system.
virtual FXint	getWidthForHeight (FXint givenheight)
	Return width for given height.
virtual FXint	getHeightForWidth (FXint givenwidth)
	Return height for given width.
void	setX (FXint x)
	Set this window's x-coordinate, in the parent's coordinate system.
void	setY (FXint y)
	Set this window's y-coordinate, in the parent's coordinate system.
void	setWidth (FXint w)
	Set the window width; and flag the widget as being in need of layout by its parent.
void	setHeight (FXint h)
	Set the window height; and flag the widget as being in need of layout by its parent.
void	setLayoutHints (FXuint lout)
	Set layout hints for this window.
FXuint	getLayoutHints () const
	Get layout hints for this window.
FXAccelTable *	getAccelTable () const
	Return a pointer to the accelerator table.
void	setAccelTable (FXAccelTable *acceltable)
	Set the accelerator table.
void	addHotKey (FXHotKey code)
	Add a hot key.
void	remHotKey (FXHotKey code)
	Remove a hot key.
void	setHelpTag (const FXString &text)
	Change help tag for this widget.
const FXString &	getHelpTag () const
	Get the help tag for this widget.
FXbool	isShell () const
	Return true if window is a shell window.
FXbool	isOwnerOf (const FXWindow *window) const
	Return true if specified window is owned by this window.
FXbool	isChildOf (const FXWindow *window) const
	Return true if specified window is ancestor of this window.
FXbool	containsChild (const FXWindow *child) const
	Return true if this window contains child in its subtree.
FXWindow *	getChildAt (FXint x, FXint y) const
	Return the child window at specified coordinates.
FXint	numChildren () const
	Return the number of child windows for this window.
FXint	indexOfChild (const FXWindow *window) const
	Return the index (starting from zero) of the specified child window, or -1 if the window is not a child or NULL.
FXWindow *	childAtIndex (FXint index) const
	Return the child window at specified index, or NULL if the index is negative or out of range.
FXComposeContext *	getComposeContext () const
	Return compose context.
void	createComposeContext ()
	Create compose context.
void	destroyComposeContext ()
	Destroy compose context.
FXbool	cursorShown () const
	Is cursor shown.
void	showCursor (FXbool flag=true)
	Show or hide the cursor.
void	setDefaultCursor (FXCursor *cur)
	Set the default cursor for this window.
FXCursor *	getDefaultCursor () const
	Return the default cursor for this window.
void	setDragCursor (FXCursor *cur)
	Set the drag cursor for this window.
FXCursor *	getDragCursor () const
	Return the drag cursor for this window.
FXbool	getCursorPosition (FXint &x, FXint &y, FXuint &buttons) const
	Return the cursor position and mouse button-state.
FXbool	setCursorPosition (FXint x, FXint y)
	Warp the cursor to the new position.
FXbool	isActive () const
	Return true if the window is active.
FXbool	hasFocus () const
	Return true if this window has the focus.
FXbool	inFocusChain () const
	Return true if this window is in focus chain.
virtual void	changeFocus (FXWindow *child)
	Notification that focus moved to new child.
FXbool	isDefault () const
	Return true if this is the default window.
virtual void	setDefault (FXuchar flag=TRUE)
	This changes the default window which responds to the Return key in a dialog.
FXWindow *	findDefault () const
	Find default window among this window's children.
FXbool	isInitial () const
	Return true if this is the initial default window.
void	setInitial (FXbool flag=true)
	Make this window the initial default window.
FXWindow *	findInitial () const
	Find inital default window among this window's children.
FXbool	isEnabled () const
	Return true if this window is able to receive mouse and keyboard events.
virtual void	attach (FXID w)
	Attach foreign window handle to this window.
virtual void	destroy ()
	Destroy the server-side resources for this window.
virtual void	setShape (const FXRegion &region)
	Set window shape by means of region.
virtual void	setShape (FXBitmap *bitmap)
	Set window shape by means of bitmap.
virtual void	setShape (FXIcon *icon)
	Set window shape by means of icon.
virtual void	clearShape ()
	Clear window shape.
virtual void	raise ()
	Raise this window to the top of the stacking order.
virtual void	lower ()
	Lower this window to the bottom of the stacking order.
virtual void	move (FXint x, FXint y)
	Move the window immediately, in the parent's coordinate system.
virtual void	resize (FXint w, FXint h)
	Resize the window to the specified width and height immediately, updating the server representation as well, if the window was realized.
virtual void	position (FXint x, FXint y, FXint w, FXint h)
	Move and resize the window immediately, in the parent's coordinate system.
virtual void	recalc ()
	Mark this window's layout as dirty for later layout.
virtual void	layout ()
	Perform layout immediately.
void	forceRefresh ()
	Generate a SEL_UPDATE message for the window and its children.
virtual void	reparent (FXWindow *father, FXWindow *other=NULL)
	Reparent this window under new father before other.
void	scroll (FXint x, FXint y, FXint w, FXint h, FXint dx, FXint dy) const
	Scroll rectangle x,y,w,h by a shift of dx,dy.
void	update (FXint x, FXint y, FXint w, FXint h) const
	Mark the specified rectangle to be repainted later.
void	update () const
	Mark the entire window to be repainted later.
void	repaint (FXint x, FXint y, FXint w, FXint h) const
	Process any outstanding repaint messages immediately, for the given rectangle.
void	repaint () const
	Process any outstanding repaint messages immediately.
FXbool	grabbed () const
	Return true if the window has been grabbed.
void	grab ()
	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	ungrab ()
	Release the mouse grab.
FXbool	grabbedKeyboard () const
	Return true if active grab is in effect.
void	grabKeyboard ()
	Grab keyboard device.
void	ungrabKeyboard ()
	Ungrab keyboard device.
FXbool	shown () const
	Return true if the window is shown.
virtual void	show ()
	Show this window.
virtual void	hide ()
	Hide this window.
virtual FXbool	isComposite () const
	Return true if the window is composite.
FXbool	underCursor () const
	Return true if the window is under the cursor.
FXbool	hasSelection () const
	Return true if this window owns the primary selection.
FXbool	acquireSelection (const FXDragType *types, FXuint numtypes)
	Try to acquire the primary selection, given a list of drag types.
FXbool	releaseSelection ()
	Release the primary selection.
FXbool	hasClipboard () const
	Return true if this window owns the clipboard.
FXbool	acquireClipboard (const FXDragType *types, FXuint numtypes)
	Try to acquire the clipboard, given a list of drag types.
FXbool	releaseClipboard ()
	Release the clipboard.
FXbool	isDropEnabled () const
	Return true if this window is able to receive drops.
virtual void	dropEnable ()
	Enable this window to receive drops.
virtual void	dropDisable ()
	Disable this window from receiving drops.
FXbool	isDragging () const
	Return true if a drag operaion has been initiated from this window.
FXbool	beginDrag (const FXDragType *types, FXuint numtypes)
	Initiate a drag operation with a list of previously registered drag types.
FXbool	handleDrag (FXint x, FXint y, FXDragAction action=DRAG_COPY)
	When dragging, inform the drop-target of the new position and the drag action.
FXDragAction	endDrag (FXbool drop=true)
	Terminate the drag operation with or without actually dropping the data Returns the action performed by the target.
FXbool	isDropTarget () const
	Return true if this window is the target of a drop.
void	setDragRectangle (FXint x, FXint y, FXint w, FXint h, FXbool wantupdates=true) const
	When being dragged over, indicate that no further SEL_DND_MOTION messages are required while the cursor is inside the given rectangle.
void	clearDragRectangle () const
	When being dragged over, indicate we want to receive SEL_DND_MOTION messages every time the cursor moves.
void	acceptDrop (FXDragAction action=DRAG_ACCEPT) const
	When being dragged over, indicate acceptance or rejection of the dragged data.
FXDragAction	didAccept () const
	The target accepted our drop.
void	dropFinished (FXDragAction action=DRAG_REJECT) const
	Sent by the drop target in response to SEL_DND_DROP.
FXbool	inquireDNDTypes (FXDNDOrigin origin, FXDragType *&types, FXuint &numtypes) const
	When being dragged over, inquire the drag types which are being offered.
FXbool	offeredDNDType (FXDNDOrigin origin, FXDragType type) const
	When being dragged over, return true if we are offered the given drag type.
FXDragAction	inquireDNDAction () const
	When being dragged over, return the drag action.
FXbool	setDNDData (FXDNDOrigin origin, FXDragType type, FXuchar *data, FXuint size) const
	Set DND data; the array must be allocated with FXMALLOC and ownership is transferred to the system.
FXbool	setDNDData (FXDNDOrigin origin, FXDragType type, const FXString &string) const
	Set DND data from string value.
FXbool	getDNDData (FXDNDOrigin origin, FXDragType type, FXuchar *&data, FXuint &size) const
	Get DND data; the caller becomes the owner of the array and must free it with FXFREE.
FXbool	getDNDData (FXDNDOrigin origin, FXDragType type, FXString &string) const
	Get DND data into string value.
virtual FXbool	contains (FXint parentx, FXint parenty) const
	Return true if window logically contains the given point.
void	translateCoordinatesFrom (FXint &tox, FXint &toy, const FXWindow *fromwindow, FXint fromx, FXint fromy) const
	Translate coordinates from fromwindow's coordinate space to this window's coordinate space.
void	translateCoordinatesTo (FXint &tox, FXint &toy, const FXWindow *towindow, FXint fromx, FXint fromy) const
	Translate coordinates from this window's coordinate space to towindow's coordinate space.
virtual void	setBackColor (FXColor clr)
	Set window background color.
FXColor	getBackColor () const
	Get background color.
virtual FXbool	doesSaveUnder () const
	Does save-unders.
virtual const FXchar *	tr (const FXchar *text, const FXchar *hint=NULL, FXint count=-1) const FX_FORMAT(2)
	Translate message for localization; using the current FXTranslator, an attempt is made to translate the given message into the current language.
virtual	~FXWindow ()
	Destroy window.
Public Member Functions inherited from FX::FXDrawable
FXVisual *	getVisual () const
	Get the visual.
FXint	getWidth () const
	Width of drawable.
FXint	getHeight () const
	Height of drawable.
void	setVisual (FXVisual *vis)
	Change visual.
virtual	~FXDrawable ()
	Cleanup.
Public Member Functions inherited from FX::FXId
FXApp *	getApp () const
	Get application.
FXID	id () const
	Get XID handle.
void	setUserData (FXptr ptr)
	Set user data pointer.
FXptr	getUserData () const
	Get user data pointer.
virtual	~FXId ()
	Destructor.
Public Member Functions inherited from FX::FXObject
const FXchar *	getClassName () const
	Get class name of some object.
FXbool	isMemberOf (const FXMetaClass *metaclass) const
	Check if object is member of metaclass.
virtual long	tryHandle (FXObject *sender, FXSelector sel, void *ptr)
	Try handle message safely, catching certain exceptions.
virtual long	onDefault (FXObject *, FXSelector, void *)
	Called for unhandled messages.
virtual	~FXObject ()
	Virtual destructor.

Protected Attributes
FXColor	boxColor
FXuchar	check
Protected Attributes inherited from FX::FXMenuCommand
FXString	accel
FXHotKey	acckey
Protected Attributes inherited from FX::FXMenuCaption
FXString	label
FXString	help
FXString	tip
FXIcon *	icon
FXFont *	font
FXint	hotoff
FXHotKey	hotkey
FXColor	textColor
FXColor	selbackColor
FXColor	seltextColor
FXColor	hiliteColor
FXColor	shadowColor
Protected Attributes inherited from FX::FXWindow
FXComposeContext *	composeContext
FXCursor *	defaultCursor
FXCursor *	dragCursor
FXAccelTable *	accelTable
FXObject *	target
FXSelector	message
FXint	xpos
FXint	ypos
FXColor	backColor
FXString	tag
FXuint	flags
FXuint	options
Protected Attributes inherited from FX::FXDrawable
FXVisual *	visual
FXint	width
FXint	height
Protected Attributes inherited from FX::FXId
FXID	xid

Additional Inherited Members

---

Detailed Description

The menu check widget is used to change a state in the application from a menu.

Menu checks may reflect the state of the application by graying out, becoming hidden, or by a check mark. When activated, a menu check sends a SEL_COMMAND to its target; the void* argument of the message contains the new state.

---

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

• /home/jeroen/FOX/fox/fox-1.7.39/include/FXMenuCheck.h