This class provides an interface to context sensitive popup menus.

These menus pop up when the user hits the right mouse button, and are destroyed when the menu pops downs.

Context Menus are automatically generated by ROOT using the following convention: if the string // *MENU* is found in the comment field of a member function. This function will be added to the list of items in the menu.

The picture below shows a canvas with a pop-up menu.

The picture below shows a canvas with a pop-up menu and a dialog box.

Definition at line 44 of file TContextMenu.h.

Public Member Functions
	TContextMenu (const char name, const char title="Context sensitive popup menu")
	Create a context menu.

virtual	~TContextMenu ()
	Destroy a context menu.

virtual void	Action (TClassMenuItem *classmenuitem)
	Action to be performed when this menu item is selected.

void	Action (TMethod *method)

virtual void	Action (TObject object, TMethod method)
	Action to be performed when this menu item is selected.

virtual void	Action (TObject object, TToggle toggle)
	Action to be performed when this toggle menu item is selected.

void	Action (TToggle *toggle)

virtual const char *	CreateArgumentTitle (TMethodArg *argument)
	Create string describing argument (for use in dialog box).

virtual const char *	CreateDialogTitle (TObject object, TFunction method)
	Create title for dialog box retrieving argument values.

virtual const char *	CreatePopupTitle (TObject *object)
	Create title for popup menu.

virtual void	Execute (const char method, const char params, Int_t *error=nullptr)
	Execute method on this object with the given parameter string, e.g.

void	Execute (const char *params)

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)
	Execute method on this object with parameters stored in the TObjArray.

void	Execute (TObjArray *params)

virtual void	Execute (TObject object, TFunction method, const char *params)
	Execute method with specified arguments for specified object.

virtual void	Execute (TObject object, TFunction method, TObjArray *params)
	Execute method with specified arguments for specified object.

virtual TBrowser *	GetBrowser ()

virtual TObject *	GetCalledObject ()

virtual TContextMenuImp *	GetContextMenuImp ()

virtual TVirtualPad *	GetSelectedCanvas ()

virtual TClassMenuItem *	GetSelectedMenuItem ()

virtual TFunction *	GetSelectedMethod ()

virtual TObject *	GetSelectedObject ()

virtual TVirtualPad *	GetSelectedPad ()

virtual void	Popup (Int_t x, Int_t y, TObject obj, TBrowser b)
	Popup context menu at given location in browser b for selected object.

virtual void	Popup (Int_t x, Int_t y, TObject obj, TVirtualPad c=nullptr, TVirtualPad *p=nullptr)
	Popup context menu at given location in canvas c and pad p for selected object.

virtual void	SetBrowser (TBrowser *b)

virtual void	SetCalledObject (TObject *o)

virtual void	SetCanvas (TVirtualPad *c)

virtual void	SetMethod (TFunction *m)

virtual void	SetNameTitle (const char name, const char title)
	Set all the TNamed parameters (name and title).

virtual void	SetObject (TObject *o)

virtual void	SetPad (TVirtualPad *p)

virtual void	SetSelectedMenuItem (TClassMenuItem *mi)

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TNamed &named)
	TNamed copy ctor.

	TNamed (const TString &name, const TString &title)

virtual	~TNamed ()
	TNamed destructor.

virtual void	Clear (Option_t *option="")
	Set name and title to empty strings ("").

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.

virtual Int_t	Compare (const TObject *obj) const
	Compare two TNamed objects.

virtual void	Copy (TObject &named) const
	Copy this to obj.

virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer.

virtual const char *	GetName () const
	Returns name of object.

virtual const char *	GetTitle () const
	Returns title of object.

virtual ULong_t	Hash () const
	Return hash value for this object.

virtual Bool_t	IsSortable () const

virtual void	ls (Option_t *option="") const
	List TNamed name and title.

TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator.

virtual void	Print (Option_t *option="") const
	Print TNamed name and title.

virtual void	SetName (const char *name)
	Set the name of the TNamed.

virtual void	SetTitle (const char *title="")
	Set the title of the TNamed.

virtual Int_t	Sizeof () const
	Return size of the TNamed part of the TObject.

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual void	Delete (Option_t *option="")
	Delete this object.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad for instance with: `gROOT->SetSelectedPad(gPad)`.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

void	InvertBit (UInt_t f)

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification.

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete[] (void *ptr)
	Operator delete [].

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator.

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Protected Member Functions
virtual void	DisplayPopUp (Int_t x, Int_t y)
	Display popup.

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).

void	MakeZombie ()

Protected Attributes
TBrowser *	fBrowser

TObject *	fCalledObject

TContextMenuImp *	fContextMenuImp

TVirtualPad *	fSelectedCanvas

TClassMenuItem *	fSelectedMenuItem

TFunction *	fSelectedMethod
	Context menu system specific implementation.

TObject *	fSelectedObject

TVirtualPad *	fSelectedPad

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Private Member Functions
	TContextMenu ()

	TContextMenu (const TContextMenu &)=delete

TContextMenu &	operator= (const TContextMenu &)=delete

Friends
class	TContextMenuImp

Additional Inherited Members
Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) }

enum	EDeprecatedStatusBits { kObjInCanvas = BIT(3) }

enum	EStatusBits { kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) , kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13) }

Static Public Member Functions inherited from TObject
static Long_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = BIT(3) }

#include <TContextMenu.h>

Inheritance diagram for TContextMenu:

[legend]

Constructor & Destructor Documentation

◆ TContextMenu() [1/3]

TContextMenu::TContextMenu ( const TContextMenu & )

privatedelete

◆ TContextMenu() [2/3]

TContextMenu::TContextMenu ( )

private

◆ TContextMenu() [3/3]

TContextMenu::TContextMenu	(	const char *	name,
		const char *	title = `"Context sensitive popup menu"`
	)

Create a context menu.

Definition at line 59 of file TContextMenu.cxx.

◆ ~TContextMenu()

TContextMenu::~TContextMenu ( )

virtual

Destroy a context menu.

Definition at line 76 of file TContextMenu.cxx.

Member Function Documentation

◆ Action() [1/5]

void TContextMenu::Action ( TClassMenuItem * menuitem )

virtual

Action to be performed when this menu item is selected.

If the selected method requires arguments we popup an automatically generated dialog, otherwise the method is directly executed.

Definition at line 116 of file TContextMenu.cxx.

◆ Action() [2/5]

void TContextMenu::Action ( TMethod * method )

inline

Definition at line 74 of file TContextMenu.h.

◆ Action() [3/5]

void TContextMenu::Action	(	TObject *	object,
		TMethod *	method
	)

virtual

Action to be performed when this menu item is selected.

If the selected method requires arguments we popup an automatically generated dialog, otherwise the method is directly executed.

Definition at line 93 of file TContextMenu.cxx.

◆ Action() [4/5]

void TContextMenu::Action	(	TObject *	object,
		TToggle *	toggle
	)

virtual

Action to be performed when this toggle menu item is selected.

Definition at line 209 of file TContextMenu.cxx.

◆ Action() [5/5]

void TContextMenu::Action ( TToggle * toggle )

inline

Definition at line 75 of file TContextMenu.h.

◆ CreateArgumentTitle()

const char * TContextMenu::CreateArgumentTitle ( TMethodArg * argument )

virtual

Create string describing argument (for use in dialog box).

Definition at line 246 of file TContextMenu.cxx.

◆ CreateDialogTitle()

const char * TContextMenu::CreateDialogTitle	(	TObject *	object,
		TFunction *	method
	)

virtual

Create title for dialog box retrieving argument values.

Definition at line 266 of file TContextMenu.cxx.

◆ CreatePopupTitle()

const char * TContextMenu::CreatePopupTitle ( TObject * object )

virtual

Create title for popup menu.

Definition at line 283 of file TContextMenu.cxx.

◆ DisplayPopUp()

void TContextMenu::DisplayPopUp	(	Int_t	x,
		Int_t	y
	)

protectedvirtual

Display popup.

Definition at line 310 of file TContextMenu.cxx.

◆ Execute() [1/6]

virtual void TContextMenu::Execute	(	const char *	method,
		const char *	params,
		Int_t *	error = `nullptr`
	)

inlinevirtual

Execute method on this object with the given parameter string, e.g.

"3.14,1,\"text\"".

Reimplemented from TObject.

Definition at line 79 of file TContextMenu.h.

◆ Execute() [2/6]

void TContextMenu::Execute ( const char * params )

inline

Definition at line 83 of file TContextMenu.h.

◆ Execute() [3/6]

virtual void TContextMenu::Execute	(	TMethod *	method,
		TObjArray *	params,
		Int_t *	error = `nullptr`
	)

inlinevirtual

Execute method on this object with parameters stored in the TObjArray.

The TObjArray should contain an argv vector like:

argv[0] ... argv[n] = the list of TObjString parameters

TObjString

Collectable string class.

Definition TObjString.h:28

n

const Int_t n

Definition legend1.C:16

Reimplemented from TObject.

Definition at line 80 of file TContextMenu.h.

◆ Execute() [4/6]

void TContextMenu::Execute ( TObjArray * params )

inline

Definition at line 84 of file TContextMenu.h.

◆ Execute() [5/6]

void TContextMenu::Execute	(	TObject *	object,
		TFunction *	method,
		const char *	params
	)

virtual

Execute method with specified arguments for specified object.

Definition at line 320 of file TContextMenu.cxx.

◆ Execute() [6/6]

void TContextMenu::Execute	(	TObject *	object,
		TFunction *	method,
		TObjArray *	params
	)

virtual

Execute method with specified arguments for specified object.

Definition at line 362 of file TContextMenu.cxx.

◆ GetBrowser()

virtual TBrowser * TContextMenu::GetBrowser ( )

inlinevirtual

Definition at line 85 of file TContextMenu.h.

◆ GetCalledObject()

virtual TObject * TContextMenu::GetCalledObject ( )

inlinevirtual

Definition at line 90 of file TContextMenu.h.

◆ GetContextMenuImp()

virtual TContextMenuImp * TContextMenu::GetContextMenuImp ( )

inlinevirtual

Definition at line 86 of file TContextMenu.h.

◆ GetSelectedCanvas()

virtual TVirtualPad * TContextMenu::GetSelectedCanvas ( )

inlinevirtual

Definition at line 87 of file TContextMenu.h.

◆ GetSelectedMenuItem()

virtual TClassMenuItem * TContextMenu::GetSelectedMenuItem ( )

inlinevirtual

Definition at line 91 of file TContextMenu.h.

◆ GetSelectedMethod()

virtual TFunction * TContextMenu::GetSelectedMethod ( )

inlinevirtual

Definition at line 88 of file TContextMenu.h.

◆ GetSelectedObject()

virtual TObject * TContextMenu::GetSelectedObject ( )

inlinevirtual

Definition at line 89 of file TContextMenu.h.

◆ GetSelectedPad()

virtual TVirtualPad * TContextMenu::GetSelectedPad ( )

inlinevirtual

Definition at line 92 of file TContextMenu.h.

◆ operator=()

TContextMenu & TContextMenu::operator= ( const TContextMenu & )

privatedelete

◆ Popup() [1/2]

void TContextMenu::Popup	(	Int_t	x,
		Int_t	y,
		TObject *	obj,
		TBrowser *	b
	)

virtual

Popup context menu at given location in browser b for selected object.

Definition at line 424 of file TContextMenu.cxx.

◆ Popup() [2/2]

void TContextMenu::Popup	(	Int_t	x,
		Int_t	y,
		TObject *	obj,
		TVirtualPad *	c = `nullptr`,
		TVirtualPad *	p = `nullptr`
	)

virtual

Popup context menu at given location in canvas c and pad p for selected object.

Definition at line 411 of file TContextMenu.cxx.

◆ SetBrowser()

virtual void TContextMenu::SetBrowser ( TBrowser * b )

inlinevirtual

Definition at line 96 of file TContextMenu.h.

◆ SetCalledObject()

virtual void TContextMenu::SetCalledObject ( TObject * o )

inlinevirtual

Definition at line 98 of file TContextMenu.h.

◆ SetCanvas()

virtual void TContextMenu::SetCanvas ( TVirtualPad * c )

inlinevirtual

Definition at line 95 of file TContextMenu.h.

◆ SetMethod()

virtual void TContextMenu::SetMethod ( TFunction * m )

inlinevirtual

Definition at line 97 of file TContextMenu.h.

◆ SetNameTitle()

virtual void TContextMenu::SetNameTitle	(	const char *	name,
		const char *	title
	)

inlinevirtual

Set all the TNamed parameters (name and title).

WARNING: if the name is changed and the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented from TNamed.

Definition at line 100 of file TContextMenu.h.

◆ SetObject()

virtual void TContextMenu::SetObject ( TObject * o )

inlinevirtual

Definition at line 101 of file TContextMenu.h.

◆ SetPad()

virtual void TContextMenu::SetPad ( TVirtualPad * p )

inlinevirtual

Definition at line 102 of file TContextMenu.h.

◆ SetSelectedMenuItem()

virtual void TContextMenu::SetSelectedMenuItem ( TClassMenuItem * mi )

inlinevirtual

Definition at line 99 of file TContextMenu.h.

Friends And Related Symbol Documentation

◆ TContextMenuImp

friend class TContextMenuImp

friend

Definition at line 46 of file TContextMenu.h.

Member Data Documentation

◆ fBrowser

TBrowser* TContextMenu::fBrowser

protected

Definition at line 60 of file TContextMenu.h.

◆ fCalledObject

TObject* TContextMenu::fCalledObject

protected

Definition at line 56 of file TContextMenu.h.

◆ fContextMenuImp

TContextMenuImp* TContextMenu::fContextMenuImp

protected

Definition at line 53 of file TContextMenu.h.

◆ fSelectedCanvas

TVirtualPad* TContextMenu::fSelectedCanvas

protected

Definition at line 58 of file TContextMenu.h.

◆ fSelectedMenuItem

TClassMenuItem* TContextMenu::fSelectedMenuItem

protected

Definition at line 57 of file TContextMenu.h.

◆ fSelectedMethod

TFunction* TContextMenu::fSelectedMethod

protected

Context menu system specific implementation.

Definition at line 54 of file TContextMenu.h.

◆ fSelectedObject

TObject* TContextMenu::fSelectedObject

protected

Definition at line 55 of file TContextMenu.h.

◆ fSelectedPad

TVirtualPad* TContextMenu::fSelectedPad

protected

Definition at line 59 of file TContextMenu.h.

core/gui/inc/TContextMenu.h

core/gui/src/TContextMenu.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ TContextMenu() [1/3]

◆ TContextMenu() [2/3]

◆ TContextMenu() [3/3]

◆ ~TContextMenu()

Member Function Documentation

◆ Action() [1/5]

◆ Action() [2/5]

◆ Action() [3/5]

◆ Action() [4/5]

◆ Action() [5/5]

◆ CreateArgumentTitle()

◆ CreateDialogTitle()

◆ CreatePopupTitle()

◆ DisplayPopUp()

◆ Execute() [1/6]

◆ Execute() [2/6]

◆ Execute() [3/6]

◆ Execute() [4/6]

◆ Execute() [5/6]

◆ Execute() [6/6]

◆ GetBrowser()

◆ GetCalledObject()

◆ GetContextMenuImp()

◆ GetSelectedCanvas()

◆ GetSelectedMenuItem()

◆ GetSelectedMethod()

◆ GetSelectedObject()

◆ GetSelectedPad()

◆ operator=()

◆ Popup() [1/2]

◆ Popup() [2/2]

◆ SetBrowser()

◆ SetCalledObject()

◆ SetCanvas()

◆ SetMethod()

◆ SetNameTitle()

◆ SetObject()

◆ SetPad()

◆ SetSelectedMenuItem()

Friends And Related Symbol Documentation

◆ TContextMenuImp

Member Data Documentation

◆ fBrowser

◆ fCalledObject

◆ fContextMenuImp

◆ fSelectedCanvas

◆ fSelectedMenuItem

◆ fSelectedMethod

◆ fSelectedObject

◆ fSelectedPad