#include <MFXMenuCheckIcon.h>

Inheritance diagram for MFXMenuCheckIcon:

Collaboration diagram for MFXMenuCheckIcon:

Public Member Functions
FXColor	getBoxColor () const
	Get the box background color.

FXbool	getCheck () const
	Get check state (TRUE, FALSE or MAYBE)

virtual FXint	getDefaultHeight ()
	Return default height.

virtual FXint	getDefaultWidth ()
	Return default width.

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

	MFXMenuCheckIcon (FXComposite p, const std::string &text, const std::string &shortcut, const std::string &info, const FXIcon icon, FXObject *tgt=NULL, FXSelector sel=0, FXuint opts=0)
	FOX-declaration.

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

void	setBoxColor (FXColor clr)
	Set the box background color.

void	setCheck (FXbool s=TRUE)
	Set check state (TRUE, FALSE or MAYBE)

void	toggleCheck ()
	Toggle current check state.

FOX calls
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 )

Protected Member Functions
	MFXMenuCheckIcon ()
	default constructor

Protected Attributes
FXColor	myBoxColor
	Box color.

FXuchar	myCheck
	State of menu.

const FXIcon *	myIcon
	Icon.

Private Member Functions
	MFXMenuCheckIcon (const MFXMenuCheckIcon &)=delete
	Invalidated copy constructor.

MFXMenuCheckIcon &	operator= (const MFXMenuCheckIcon &)=delete
	Invalidated assignment operator.

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.

Definition at line 36 of file MFXMenuCheckIcon.h.

Constructor & Destructor Documentation

◆ MFXMenuCheckIcon() [1/3]

MFXMenuCheckIcon::MFXMenuCheckIcon	(	FXComposite *	p,
		const std::string &	text,
		const std::string &	shortcut,
		const std::string &	info,
		const FXIcon *	icon,
		FXObject *	tgt = `NULL`,
		FXSelector	sel = `0`,
		FXuint	opts = `0`
	)

FOX-declaration.

Construct a menu check

Definition at line 61 of file MFXMenuCheckIcon.cpp.

◆ MFXMenuCheckIcon() [2/3]

MFXMenuCheckIcon::MFXMenuCheckIcon ( )

protected

default constructor

Definition at line 431 of file MFXMenuCheckIcon.cpp.

◆ MFXMenuCheckIcon() [3/3]

MFXMenuCheckIcon::MFXMenuCheckIcon ( const MFXMenuCheckIcon & )

privatedelete

Invalidated copy constructor.

Member Function Documentation

◆ getBoxColor()

FXColor MFXMenuCheckIcon::getBoxColor ( ) const

Get the box background color.

Definition at line 129 of file MFXMenuCheckIcon.cpp.

References myBoxColor.

◆ getCheck()

FXbool MFXMenuCheckIcon::getCheck ( ) const

Get check state (TRUE, FALSE or MAYBE)

Definition at line 123 of file MFXMenuCheckIcon.cpp.

References myCheck.

Referenced by onCmdGetIntValue(), GNEApplicationWindow::onCmdToggleComputeNetworkData(), and GNEViewNetHelper::LockManager::updateFlags().

Here is the caller graph for this function:

◆ getDefaultHeight()

FXint MFXMenuCheckIcon::getDefaultHeight ( )

virtual

Return default height.

Definition at line 92 of file MFXMenuCheckIcon.cpp.

◆ getDefaultWidth()

FXint MFXMenuCheckIcon::getDefaultWidth ( )

virtual

Return default width.

Definition at line 70 of file MFXMenuCheckIcon.cpp.

References LEADSPACE, myIcon, and TRAILSPACE.

◆ load()

void MFXMenuCheckIcon::load ( FXStream & store )

virtual

Load menu from a stream.

Definition at line 424 of file MFXMenuCheckIcon.cpp.

References myBoxColor, and myCheck.

◆ onButtonPress()

long MFXMenuCheckIcon::onButtonPress	(	FXObject *	,
		FXSelector	,
		void *
	)

Definition at line 177 of file MFXMenuCheckIcon.cpp.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onButtonRelease()

long MFXMenuCheckIcon::onButtonRelease	(	FXObject *	,
		FXSelector	,
		void *
	)

Definition at line 186 of file MFXMenuCheckIcon.cpp.

References myCheck, and setCheck().

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onCheck()

long MFXMenuCheckIcon::onCheck	(	FXObject *	,
		FXSelector	,
		void *
	)

Definition at line 135 of file MFXMenuCheckIcon.cpp.

References setCheck().

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onCmdAccel()

long MFXMenuCheckIcon::onCmdAccel	(	FXObject *	,
		FXSelector	,
		void *
	)

Definition at line 263 of file MFXMenuCheckIcon.cpp.

References myCheck, and setCheck().

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onCmdGetIntValue()

long MFXMenuCheckIcon::onCmdGetIntValue	(	FXObject *	,
		FXSelector	,
		void *	ptr
	)

Definition at line 170 of file MFXMenuCheckIcon.cpp.

References getCheck().

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onCmdSetIntValue()

long MFXMenuCheckIcon::onCmdSetIntValue	(	FXObject *	,
		FXSelector	,
		void *	ptr
	)

Definition at line 163 of file MFXMenuCheckIcon.cpp.

References setCheck().

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onCmdSetValue()

long MFXMenuCheckIcon::onCmdSetValue	(	FXObject *	,
		FXSelector	,
		void *	ptr
	)

Definition at line 156 of file MFXMenuCheckIcon.cpp.

References setCheck().

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onHotKeyPress()

long MFXMenuCheckIcon::onHotKeyPress	(	FXObject *	,
		FXSelector	,
		void *	ptr
	)

Definition at line 237 of file MFXMenuCheckIcon.cpp.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onHotKeyRelease()

long MFXMenuCheckIcon::onHotKeyRelease	(	FXObject *	,
		FXSelector	,
		void *
	)

Definition at line 248 of file MFXMenuCheckIcon.cpp.

References myCheck, and setCheck().

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onKeyPress()

long MFXMenuCheckIcon::onKeyPress	(	FXObject *	,
		FXSelector	,
		void *	ptr
	)

Definition at line 204 of file MFXMenuCheckIcon.cpp.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onKeyRelease()

long MFXMenuCheckIcon::onKeyRelease	(	FXObject *	,
		FXSelector	,
		void *	ptr
	)

Definition at line 218 of file MFXMenuCheckIcon.cpp.

References myCheck, and setCheck().

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onPaint()

long MFXMenuCheckIcon::onPaint	(	FXObject *	,
		FXSelector	,
		void *	ptr
	)

Definition at line 276 of file MFXMenuCheckIcon.cpp.

References LEADSPACE, myBoxColor, myCheck, myIcon, and TRAILSPACE.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onUncheck()

long MFXMenuCheckIcon::onUncheck	(	FXObject *	,
		FXSelector	,
		void *
	)

Definition at line 142 of file MFXMenuCheckIcon.cpp.

References setCheck().

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onUnknown()

long MFXMenuCheckIcon::onUnknown	(	FXObject *	,
		FXSelector	,
		void *
	)

Definition at line 149 of file MFXMenuCheckIcon.cpp.

References setCheck().

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ operator=()

MFXMenuCheckIcon & MFXMenuCheckIcon::operator= ( const MFXMenuCheckIcon & )

privatedelete

Invalidated assignment operator.

◆ save()

void MFXMenuCheckIcon::save ( FXStream & store ) const

virtual

Save menu to a stream.

Definition at line 417 of file MFXMenuCheckIcon.cpp.

References myBoxColor, and myCheck.

◆ setBoxColor()

void MFXMenuCheckIcon::setBoxColor ( FXColor clr )

Set the box background color.

Definition at line 408 of file MFXMenuCheckIcon.cpp.

References myBoxColor.

◆ setCheck()

void MFXMenuCheckIcon::setCheck ( FXbool s = TRUE )

Set check state (TRUE, FALSE or MAYBE)

Definition at line 102 of file MFXMenuCheckIcon.cpp.

References myCheck.

Referenced by onButtonRelease(), onCheck(), onCmdAccel(), onCmdSetIntValue(), onCmdSetValue(), onHotKeyRelease(), onKeyRelease(), onUncheck(), onUnknown(), GNEApplicationWindow::onUpdToggleViewOption(), toggleCheck(), and GNEViewNetHelper::LockManager::updateLockMenuBar().

Here is the caller graph for this function:

◆ toggleCheck()

void MFXMenuCheckIcon::toggleCheck ( )

Toggle current check state.

Definition at line 111 of file MFXMenuCheckIcon.cpp.

References myCheck, and setCheck().

Referenced by GNEApplicationWindow::onCmdLockElements().

Here is the caller graph for this function:

Field Documentation

◆ myBoxColor

FXColor MFXMenuCheckIcon::myBoxColor

protected

Box color.

Definition at line 100 of file MFXMenuCheckIcon.h.

Referenced by getBoxColor(), load(), onPaint(), save(), and setBoxColor().

◆ myCheck

FXuchar MFXMenuCheckIcon::myCheck

protected

State of menu.

Definition at line 97 of file MFXMenuCheckIcon.h.

Referenced by getCheck(), load(), onButtonRelease(), onCmdAccel(), onHotKeyRelease(), onKeyRelease(), onPaint(), save(), setCheck(), and toggleCheck().

◆ myIcon

const FXIcon* MFXMenuCheckIcon::myIcon

protected

Icon.

Definition at line 94 of file MFXMenuCheckIcon.h.

Referenced by getDefaultWidth(), and onPaint().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ MFXMenuCheckIcon() [1/3]

◆ MFXMenuCheckIcon() [2/3]

◆ MFXMenuCheckIcon() [3/3]

Member Function Documentation

◆ getBoxColor()

◆ getCheck()

◆ getDefaultHeight()

◆ getDefaultWidth()

◆ load()

◆ onButtonPress()

◆ onButtonRelease()

◆ onCheck()

◆ onCmdAccel()

◆ onCmdGetIntValue()

◆ onCmdSetIntValue()

◆ onCmdSetValue()

◆ onHotKeyPress()

◆ onHotKeyRelease()

◆ onKeyPress()

◆ onKeyRelease()

◆ onPaint()

◆ onUncheck()

◆ onUnknown()

◆ operator=()

◆ save()

◆ setBoxColor()

◆ setCheck()

◆ toggleCheck()

Field Documentation

◆ myBoxColor

◆ myCheck

◆ myIcon