TVirtualBranchBrowsable is a base class (not really abstract, but useless by itself) for helper objects that extend TBranch's browsing support.

Each registered derived class's generator method is called, which fills all created helper objects into a list which can then be browsed. For details of what these browser helper objects can do, see e.g. TMethodBrowsable, which allows methods to show up in the TBrowser.

Only registered helper objects are created. By default, only TMethodBrowsable, TNonSplitBrowsable, and TCollectionPropertyBrowsable are registered (see RegisterDefaultGenerators). You can prevent any of their objects to show up in the browser by unregistering the generator:

TMethodBrowsable::Unregister

static void Unregister()

Wrapper for the registration method.

Definition TBranchBrowsable.cxx:594

will stop creating browsable method helper objects from that call on. Note that these helper objects are cached (in TBranch::fBrowsables); already created (and thus cached) browsables will still appear in the browser even after unregistering the corresponding generator.

You can implement your own browsable objects and their generator; see e.g. the simple TCollectionPropertyBrowsable. Note that you will have to register your generator just like any other, and that you should implement the following methods for your own class, mainly for consistency reasons:

static void Register() {
  TVirtualBranchBrowsable::RegisterGenerator(GetBrowsables); }
static void Unregister() {
  TVirtualBranchBrowsable::UnregisterGenerator(GetBrowsables); }

where GetBrowsables is a static member function of your class, that creates the browsable helper objects, and has the signature

static Int_t GetBrowsables(TList& list, const TBranch* branch,

const TVirtualBranchBrowsable* parent=0);

TBranch

A TTree is a list of TBranches.

Definition TBranch.h:89

TList

A doubly linked list.

Definition TList.h:44

TVirtualBranchBrowsable

TVirtualBranchBrowsable is a base class (not really abstract, but useless by itself) for helper objec...

Definition TBranchBrowsable.h:29

int

It has to return the number of browsable helper objects for parent (or, if NULL, for branch) which are added to the list.

Definition at line 29 of file TBranchBrowsable.h.

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

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

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

const TBranch *	GetBranch () const
	return the parent branch (might be many levels up)

TClass *	GetClassType () const
	return the type of this browsable object

const char *	GetIconName () const override
	return icon shown when browsing a TVirtualBranchBrowsable

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

const TVirtualBranchBrowsable *	GetParent () const
	return the parent TVirtualBranchBrowsable

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

Bool_t	IsFolder () const override
	check whether we have sub-elements

Bool_t	TypeIsPointer () const
	return whether the type of this browsable object is a pointer

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	SetNameTitle (const char name, const char title)
	Set all the TNamed parameters (name and title).

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.

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	Execute (const char method, const char params, Int_t *error=0)
	Execute method on this object with the given parameter string, e.g.

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

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

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.

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

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 Member Functions
	TVirtualBranchBrowsable (const TBranch b, TClass type, Bool_t typeIsPointer, const TVirtualBranchBrowsable *parent=nullptr)
	Constructor setting all members according to parameters.

void	SetType (TClass *type)
	sets the type of this browsable object

void	SetTypeIsPointer (Bool_t set=kTRUE)
	sets whether the type of this browsable object is a pointer

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

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

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

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

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

Private Member Functions
	ClassDefOverride (TVirtualBranchBrowsable, 0)
	Base class for helper objects used for browsing.

Static Private Member Functions
static void	RegisterDefaultGenerators ()
	Adds the default generators.

Private Attributes
const TBranch *	fBranch {nullptr}
	pointer to the branch element representing the top object

TClass *	fClass {nullptr}
	pointer to TClass representing our type (i.e. return type for methods), 0 if basic type

TList *	fLeaves {nullptr}
	pointer to leaves

const TVirtualBranchBrowsable *	fParent {nullptr}
	parent method if this method is member of a returned class

Bool_t	fTypeIsPointer {kFALSE}
	return type is pointer to class

Static Private Attributes
static std::list< MethodCreateListOfBrowsables_t >	fgGenerators
	list of MethodCreateListOfBrowsables_t called by CreateListOfBrowsables

static Bool_t	fgGeneratorsSet =kFALSE
	have we set the generators yet? empty is not good enough - user might have removed them

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

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

#include <TBranchBrowsable.h>

Inheritance diagram for TVirtualBranchBrowsable:

[legend]

Member Typedef Documentation

◆ MethodCreateListOfBrowsables_t

typedef Int_t(* TVirtualBranchBrowsable::MethodCreateListOfBrowsables_t) (TList &, const TBranch *branch, const TVirtualBranchBrowsable *parent)

Definition at line 35 of file TBranchBrowsable.h.

Constructor & Destructor Documentation

◆ ~TVirtualBranchBrowsable()

TVirtualBranchBrowsable::~TVirtualBranchBrowsable ( )

Destructor. Delete our leaves.

Definition at line 97 of file TBranchBrowsable.cxx.

◆ TVirtualBranchBrowsable()

TVirtualBranchBrowsable::TVirtualBranchBrowsable	(	const TBranch *	b,
		TClass *	type,
		Bool_t	typeIsPointer,
		const TVirtualBranchBrowsable *	parent = `nullptr`
	)

protected

Constructor setting all members according to parameters.

Definition at line 84 of file TBranchBrowsable.cxx.

Member Function Documentation

◆ Browse()

void TVirtualBranchBrowsable::Browse ( TBrowser * b )

overridevirtual

Calls TTree::Draw on the method if return type is not a class; otherwise expands returned object's "folder".

Reimplemented from TObject.

Definition at line 106 of file TBranchBrowsable.cxx.

◆ ClassDefOverride()

TVirtualBranchBrowsable::ClassDefOverride	(	TVirtualBranchBrowsable	,
		0
	)

private

Base class for helper objects used for browsing.

◆ FillListOfBrowsables()

Int_t TVirtualBranchBrowsable::FillListOfBrowsables	(	TList &	li,
		const TBranch *	branch,
		const TVirtualBranchBrowsable *	parent = `nullptr`
	)

static

Askes all registered generators to fill their browsables into the list.

The browsables are generated for a given parent, or (if 0), for a given branch. The branch is passed down to leaves of TVirtualBranchBrowsable, too, as we need to access the branch's TTree to be able to traw.

Definition at line 138 of file TBranchBrowsable.cxx.

◆ GetBranch()

const TBranch * TVirtualBranchBrowsable::GetBranch ( ) const

inline

return the parent branch (might be many levels up)

Definition at line 60 of file TBranchBrowsable.h.

◆ GetClassType()

TClass * TVirtualBranchBrowsable::GetClassType ( ) const

inline

return the type of this browsable object

Definition at line 66 of file TBranchBrowsable.h.

◆ GetCollectionContainedType()

TClass * TVirtualBranchBrowsable::GetCollectionContainedType	(	const TBranch *	branch,
		const TVirtualBranchBrowsable *	parent,
		TClass *&	contained
	)

staticprotected

Check whether the branch (or the parent) contains a collection.

If it does, set "contained" to the contained type (if we can retrieve it) and return the TClass for the collection. Set "contained" to the branch's (or parent's) contained object's class for non-collections, returning 0.

Only one of "branch" or "parent" can ge given (depending on whether we are creating browsable objects for a branch or for another browsable object)

Definition at line 160 of file TBranchBrowsable.cxx.

◆ GetIconName()

const char * TVirtualBranchBrowsable::GetIconName ( ) const

inlineoverridevirtual

return icon shown when browsing a TVirtualBranchBrowsable

Reimplemented from TObject.

Definition at line 43 of file TBranchBrowsable.h.

◆ GetLeaves()

TList * TVirtualBranchBrowsable::GetLeaves ( ) const

Return list of leaves. If not set up yet we'll create them.

Definition at line 271 of file TBranchBrowsable.cxx.

◆ GetParent()

const TVirtualBranchBrowsable * TVirtualBranchBrowsable::GetParent ( ) const

inline

return the parent TVirtualBranchBrowsable

Definition at line 63 of file TBranchBrowsable.h.

◆ GetRegisteredGenerators()

std::list< TVirtualBranchBrowsable::MethodCreateListOfBrowsables_t > & TVirtualBranchBrowsable::GetRegisteredGenerators ( )

staticprotected

returns the list of registered generator methods

Definition at line 285 of file TBranchBrowsable.cxx.

◆ GetScope()

void TVirtualBranchBrowsable::GetScope ( TString & scope ) const

Returns the full name for TTree::Draw to draw *this.

Recursively appends, starting at the top TBranch, all method / object names with proper reference operators (->, .) depending on fTypeIsPointer.

Definition at line 296 of file TBranchBrowsable.cxx.

◆ IsFolder()

Bool_t TVirtualBranchBrowsable::IsFolder ( ) const

inlineoverridevirtual

check whether we have sub-elements

Reimplemented from TObject.

Definition at line 54 of file TBranchBrowsable.h.

◆ RegisterDefaultGenerators()

void TVirtualBranchBrowsable::RegisterDefaultGenerators ( )

staticprivate

Adds the default generators.

The user can remove any of them as follows:

TMethodBrowsable::Unregister();

which will cause the browser not to show any methods.

Definition at line 341 of file TBranchBrowsable.cxx.

◆ RegisterGenerator()

void TVirtualBranchBrowsable::RegisterGenerator ( MethodCreateListOfBrowsables_t generator )

staticprotected

Adds a generator to be called when browsing branches.

Called by the Register method, which should be implemented for all derived classes (see e.g. TMethodBrowsable::Register())

Definition at line 356 of file TBranchBrowsable.cxx.

◆ SetType()

void TVirtualBranchBrowsable::SetType ( TClass * type )

inlineprotected

sets the type of this browsable object

Definition at line 85 of file TBranchBrowsable.h.

◆ SetTypeIsPointer()

void TVirtualBranchBrowsable::SetTypeIsPointer ( Bool_t set = kTRUE )

inlineprotected

sets whether the type of this browsable object is a pointer

Definition at line 88 of file TBranchBrowsable.h.

◆ TypeIsPointer()

Bool_t TVirtualBranchBrowsable::TypeIsPointer ( ) const

inline

return whether the type of this browsable object is a pointer

Definition at line 69 of file TBranchBrowsable.h.

◆ UnregisterGenerator()

void TVirtualBranchBrowsable::UnregisterGenerator ( MethodCreateListOfBrowsables_t generator )

staticprotected

Removes a generator from the list of generators to be called when browsing branches.

The user can remove any of the generators as follows:

TMethodBrowsable::Unregister();

which will cause the browser not to show any methods.

Definition at line 372 of file TBranchBrowsable.cxx.

Member Data Documentation

◆ fBranch

const TBranch* TVirtualBranchBrowsable::fBranch {nullptr}

private

pointer to the branch element representing the top object

Definition at line 92 of file TBranchBrowsable.h.

◆ fClass

TClass* TVirtualBranchBrowsable::fClass {nullptr}

private

pointer to TClass representing our type (i.e. return type for methods), 0 if basic type

Definition at line 95 of file TBranchBrowsable.h.

◆ fgGenerators

std::list< TVirtualBranchBrowsable::MethodCreateListOfBrowsables_t > TVirtualBranchBrowsable::fgGenerators

staticprivate

list of MethodCreateListOfBrowsables_t called by CreateListOfBrowsables

Definition at line 97 of file TBranchBrowsable.h.

◆ fgGeneratorsSet

Bool_t TVirtualBranchBrowsable::fgGeneratorsSet =kFALSE

staticprivate

have we set the generators yet? empty is not good enough - user might have removed them

Definition at line 98 of file TBranchBrowsable.h.

◆ fLeaves

TList* TVirtualBranchBrowsable::fLeaves {nullptr}

private

pointer to leaves

Definition at line 94 of file TBranchBrowsable.h.

◆ fParent

const TVirtualBranchBrowsable* TVirtualBranchBrowsable::fParent {nullptr}

private

parent method if this method is member of a returned class

Definition at line 93 of file TBranchBrowsable.h.

◆ fTypeIsPointer

Bool_t TVirtualBranchBrowsable::fTypeIsPointer {kFALSE}

private

return type is pointer to class

Definition at line 96 of file TBranchBrowsable.h.

Libraries for TVirtualBranchBrowsable:

[legend]

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

tree/tree/inc/TBranchBrowsable.h
tree/tree/src/TBranchBrowsable.cxx

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ MethodCreateListOfBrowsables_t

Constructor & Destructor Documentation

◆ ~TVirtualBranchBrowsable()

◆ TVirtualBranchBrowsable()

Member Function Documentation

◆ Browse()

◆ ClassDefOverride()

◆ FillListOfBrowsables()

◆ GetBranch()

◆ GetClassType()

◆ GetCollectionContainedType()

◆ GetIconName()

◆ GetLeaves()

◆ GetParent()

◆ GetRegisteredGenerators()

◆ GetScope()

◆ IsFolder()

◆ RegisterDefaultGenerators()

◆ RegisterGenerator()

◆ SetType()

◆ SetTypeIsPointer()

◆ TypeIsPointer()

◆ UnregisterGenerator()

Member Data Documentation

◆ fBranch

◆ fClass

◆ fgGenerators

◆ fgGeneratorsSet

◆ fLeaves

◆ fParent

◆ fTypeIsPointer