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:

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 thier 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);

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 33 of file TBranchBrowsable.h.

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

Public Types inherited from TObject
enum	EStatusBits { kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13) }

enum	{ kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }

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

Public Member Functions
	~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 char *	GetIconName () const
	Returns mime type name of object. More...

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

const TBranch *	GetBranch () const

const TVirtualBranchBrowsable *	GetParent () const

TClass *	GetClassType () const

Bool_t	TypeIsPointer () const

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

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 &	operator= (const TNamed &rhs)
	TNamed assignment operator. More...

virtual	~TNamed ()

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	SetName (const char *name)
	Change (i.e. More...

virtual void	SetNameTitle (const char name, const char title)
	Change (i.e. set) all the TNamed parameters (name and title). More...

virtual void	SetTitle (const char *title="")
	Change (i.e. set) the title of the TNamed. More...

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

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

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

Public Member Functions inherited from TObject
	TObject ()

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

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

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

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad. 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 pad. More...

virtual void	Dump () const
	Dump contents of object on stdout. 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 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 UInt_t	GetUniqueID () const
	Return the unique object id. More...

virtual Option_t *	GetOption () const

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

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out. 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...

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

Bool_t	IsOnHeap () const

Bool_t	IsZombie () const

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification. 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...

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

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	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. 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...

void *	operator new (size_t sz)

void *	operator new[] (size_t sz)

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

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

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

void	operator delete[] (void *ptr)
	Operator delete []. 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)

void	ResetBit (UInt_t f)

Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

void	InvertBit (UInt_t f)

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

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

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

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

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message. 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...

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

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

Static Public Member Functions
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 void	SetDtorOnly (void *obj)
	Set destructor only flag. More...

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

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

Protected Member Functions
	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
void	MakeZombie ()

virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected). More...

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. 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 Member Functions
	ClassDef (TVirtualBranchBrowsable, 0)

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

Private Attributes
const TBranch *	fBranch

const TVirtualBranchBrowsable *	fParent

TList *	fLeaves

TClass *	fClass

Bool_t	fTypeIsPointer

Static Private Attributes
static std::list< MethodCreateListOfBrowsables_t >	fgGenerators

static Bool_t	fgGeneratorsSet =kFALSE

Additional Inherited Members
Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

#include <TBranchBrowsable.h>

Inheritance diagram for TVirtualBranchBrowsable:

Collaboration diagram for TVirtualBranchBrowsable:

Member Typedef Documentation

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

Definition at line 40 of file TBranchBrowsable.h.

Constructor & Destructor Documentation

TVirtualBranchBrowsable::~TVirtualBranchBrowsable ( )

Destructor. Delete our leaves.

Definition at line 95 of file TBranchBrowsable.cxx.

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

protected

Constructor setting all members according to parameters.

Definition at line 82 of file TBranchBrowsable.cxx.

Member Function Documentation

void TVirtualBranchBrowsable::Browse ( TBrowser * b )

virtual

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

Reimplemented from TObject.

Reimplemented in TCollectionPropertyBrowsable.

Definition at line 104 of file TBranchBrowsable.cxx.

TVirtualBranchBrowsable::ClassDef	(	TVirtualBranchBrowsable	,
		0
	)

private

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

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 136 of file TBranchBrowsable.cxx.

Referenced by TBranch::GetBrowsables(), and GetLeaves().

const TBranch* TVirtualBranchBrowsable::GetBranch ( ) const

inline

Definition at line 58 of file TBranchBrowsable.h.

Referenced by TCollectionPropertyBrowsable::Browse(), TNonSplitBrowsable::GetBrowsables(), TCollectionPropertyBrowsable::GetBrowsables(), and GetLeaves().

TClass* TVirtualBranchBrowsable::GetClassType ( ) const

inline

Definition at line 64 of file TBranchBrowsable.h.

Referenced by 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 158 of file TBranchBrowsable.cxx.

Referenced by TMethodBrowsable::GetBrowsables(), TNonSplitBrowsable::GetBrowsables(), TCollectionPropertyBrowsable::GetBrowsables(), and TCollectionMethodBrowsable::GetBrowsables().

const char* TVirtualBranchBrowsable::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 TObject.

Reimplemented in TMethodBrowsable.

Definition at line 45 of file TBranchBrowsable.h.

TList * TVirtualBranchBrowsable::GetLeaves ( ) const

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