This helper object allows the browsing of methods of objects stored in branches.

They will be depicted by a leaf (or a branch, in case the method returns an object) with a red exclamation mark. Only a subset of all methods will be shown in the browser (see IsMethodBrowsable for the criteria a method has to satisfy).

Obviously, methods are only available if the library is loaded which contains the dictionary for the class to be browsed!

If a branch contains a collection, TMethodBrowsable tries to find out what the contained element is (it will only create methods for the contained elements, but never for the collection). If it fails to extract the type of the contained elements, or if there is no guarantee that the type has any other common denominator than TObject (e.g. in the case of a TObjArray, which can hold any object deriving from TObject) no methods will be added.

Definition at line 99 of file TBranchBrowsable.h.

Public Member Functions
	~TMethodBrowsable ()

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

Public Member Functions inherited from TVirtualBranchBrowsable
	~TVirtualBranchBrowsable ()
	Destructor. Delete our leaves. More...

void	Browse (TBrowser *b)
	Calls TTree::Draw on the method if return type is not a class; otherwise expands returned object's "folder". More...

const TBranch *	GetBranch () const

TClass *	GetClassType () const

TList *	GetLeaves () const
	Return list of leaves. If not set up yet we'll create them. More...

const TVirtualBranchBrowsable *	GetParent () const

void	GetScope (TString &scope) const
	Returns the full name for TTree::Draw to draw *this. More...

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

Bool_t	TypeIsPointer () const

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

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

	TNamed (const TNamed &named)
	TNamed copy ctor. More...

virtual	~TNamed ()
	TNamed destructor. More...

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

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

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

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

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

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

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

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

virtual Bool_t	IsSortable () const

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

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

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

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

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

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

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

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

	TObject (const TObject &object)
	TObject copy ctor. More...

virtual	~TObject ()
	TObject destructor. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual Option_t *	GetOption () const

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

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

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

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

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

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

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

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). More...

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). More...

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

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

void	operator delete (void *ptr)
	Operator delete. More...

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

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

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

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

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

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

void	ResetBit (UInt_t f)

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

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

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

void	SetBit (UInt_t f)

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

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

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

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

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

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

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

Static Public Member Functions
static Int_t	GetBrowsables (TList &list, const TBranch branch, const TVirtualBranchBrowsable parent=0)
	This methods fills list with TMethodBrowsables for the branch's or parent's class and its base classes, and returns the number of added elements. More...

static Bool_t	IsMethodBrowsable (const TMethod *m)
	A TMethod is browsable if it is const, public and not pure virtual, if does not have any parameter without default value, and if it has a (non-void) return value. More...

static void	Register ()
	Wrapper for the registration method. More...

static void	Unregister ()
	Wrapper for the registration method. More...

Static Public Member Functions inherited from TVirtualBranchBrowsable
static Int_t	FillListOfBrowsables (TList &list, const TBranch branch, const TVirtualBranchBrowsable parent=0)
	Askes all registered generators to fill their browsables into the list. More...

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

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

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

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

Protected Member Functions
	TMethodBrowsable (const TBranch branch, TMethod m, const TVirtualBranchBrowsable *parent=0)
	Constructor. More...

Protected Member Functions inherited from TVirtualBranchBrowsable
	TVirtualBranchBrowsable (const TBranch b, TClass type, Bool_t typeIsPointer, const TVirtualBranchBrowsable *parent=0)
	Constructor setting all members according to parameters. More...

void	SetType (TClass *type)

void	SetTypeIsPointer (Bool_t set=kTRUE)

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). More...

void	MakeZombie ()

Static Protected Member Functions
static void	GetBrowsableMethodsForClass (TClass *cl, TList &list)
	Given a class, this methods fills list with TMethodBrowsables for the class and its base classes, and returns the number of added elements. More...

Static Protected Member Functions inherited from TVirtualBranchBrowsable
static TClass *	GetCollectionContainedType (const TBranch b, const TVirtualBranchBrowsable parent, TClass *&contained)
	Check whether the branch (or the parent) contains a collection. More...

static std::list< MethodCreateListOfBrowsables_t > &	GetRegisteredGenerators ()
	returns the list of registered generator methods More...

static void	RegisterGenerator (MethodCreateListOfBrowsables_t generator)
	Adds a generator to be called when browsing branches. More...

static void	UnregisterGenerator (MethodCreateListOfBrowsables_t generator)
	Removes a generator from the list of generators to be called when browsing branches. More...

Private Attributes
TMethod *	fMethod

Additional Inherited Members
Public Types inherited from TVirtualBranchBrowsable
typedef Int_t(*	MethodCreateListOfBrowsables_t) (TList &, const TBranch branch, const TVirtualBranchBrowsable parent)

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) }

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

#include <TBranchBrowsable.h>

Inheritance diagram for TMethodBrowsable:

[legend]

Constructor & Destructor Documentation

◆ ~TMethodBrowsable()

TMethodBrowsable::~TMethodBrowsable ( )

inline

Definition at line 101 of file TBranchBrowsable.h.

◆ TMethodBrowsable()

TMethodBrowsable::TMethodBrowsable	(	const TBranch *	branch,
		TMethod *	m,
		const TVirtualBranchBrowsable *	parent = `0`
	)

protected

Constructor.

Links a TBranchElement to a TMethod, allowing the TBrowser to browse simple methods.

The c'tor sets the name for a method "Class::Method(params) const" to "Method(params)", title to TMethod::GetPrototype

Definition at line 408 of file TBranchBrowsable.cxx.

Member Function Documentation

◆ GetBrowsableMethodsForClass()

void TMethodBrowsable::GetBrowsableMethodsForClass	(	TClass *	cl,
		TList &	li
	)

staticprotected

Given a class, this methods fills list with TMethodBrowsables for the class and its base classes, and returns the number of added elements.

If called from a TBranch::Browse overload, "branch" should be set to the calling TBranch, otherwise "parent" should be set to the TVirtualBranchBrowsable being browsed, and branch should be the branch of the parent.

Definition at line 443 of file TBranchBrowsable.cxx.

◆ GetBrowsables()

Int_t TMethodBrowsable::GetBrowsables	(	TList &	li,
		const TBranch *	branch,
		const TVirtualBranchBrowsable *	parent = `0`
	)

static

This methods fills list with TMethodBrowsables for the branch's or parent's class and its base classes, and returns the number of added elements.

If called from a TBranch::Browse overload, "branch" should be set to the calling TBranch, otherwise "parent" should be set to the TVirtualBranchBrowsable being browsed.

Definition at line 500 of file TBranchBrowsable.cxx.

◆ GetIconName()

const char* TMethodBrowsable::GetIconName ( ) const

inlinevirtual

Returns mime type name of object.

Used by the TBrowser (via TGMimeTypes class). Override for class of which you would like to have different icons for objects of the same class.

Reimplemented from TVirtualBranchBrowsable.

Definition at line 105 of file TBranchBrowsable.h.

◆ IsMethodBrowsable()

Bool_t TMethodBrowsable::IsMethodBrowsable ( const TMethod * m )

static

A TMethod is browsable if it is const, public and not pure virtual, if does not have any parameter without default value, and if it has a (non-void) return value.

A method called *, Get*, or get* will not be browsable if there is a persistent data member called f*, _*, or m*, as data member access is faster than method access. Examples: if one of fX, _X, or mX is a persistent data member, the methods GetX(), getX(), and X() will not be browsable.

Definition at line 529 of file TBranchBrowsable.cxx.

◆ Register()

void TMethodBrowsable::Register ( )

static

Wrapper for the registration method.

Needed against MSVC, which assigned different addr to the same method, depending on what translation unit you're in...

Definition at line 583 of file TBranchBrowsable.cxx.

◆ Unregister()

void TMethodBrowsable::Unregister ( )

static

Wrapper for the registration method.

Needed against MSVC, which assigned different addr to the same method, depending on what translation unit you're in...

Definition at line 593 of file TBranchBrowsable.cxx.

Member Data Documentation

◆ fMethod

TMethod* TMethodBrowsable::fMethod

private

Definition at line 119 of file TBranchBrowsable.h.

Libraries for TMethodBrowsable:

[legend]

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ ~TMethodBrowsable()

◆ TMethodBrowsable()

Member Function Documentation

◆ GetBrowsableMethodsForClass()

◆ GetBrowsables()

◆ GetIconName()

◆ IsMethodBrowsable()

◆ Register()

◆ Unregister()

Member Data Documentation

◆ fMethod