Using a TBrowser one can browse all ROOT objects.

Python interface

Functionality of constructor and Draw() methods were extended to support interactive work in the python scripts. If extra block parameter is True, script execution will be suspended until <space> key pressed by user. Simple example:

import ROOT
 
# block until space is pressed
br = ROOT.TBrowser(block = True)
 
# continue work to load new files
 
# block here again until space is pressed
br.Draw(block = True)
 
# continues after <space> is pressed

It shows in a list on the left side of the window all browsable ROOT classes. Selecting one of the classes displays, in the icon-box on the right side, all objects in the class. Selecting one of the objects in the icon-box, will place all browsable objects in a new list and draws the contents of the selected class in the icon-box. And so on....

Since: ROOT version 6.24/00

TBrowser invokes by default the Web-based ROOT file browser [RBrowser](ROOT::RBrowser) To change this behaviour, and invoke the standard TBrowser, one should put the following directive in the .rootrc file:

Browser.Name: TRootBrowser

TRootBrowser

This class creates a ROOT object browser, constituted by three main tabs.

Definition TRootBrowser.h:54

Definition at line 37 of file TBrowser.h.

Public Types
enum	{ kSingleKey = (1ULL << (0)) , kOverwrite = (1ULL << (1)) , kWriteDelete = (1ULL << (2)) }
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }
enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << (3)) }
enum	EStatusBits { kNoHidden = (1ULL << (9)) }

Public Member Functions
	TBrowser (const char name, const char title, Int_t x, Int_t y, UInt_t width, UInt_t height, TBrowserImp extimp=nullptr, Option_t opt="")
	Create a new browser with a name, title, position, width and height.
	TBrowser (const char name, const char title, UInt_t width, UInt_t height, TBrowserImp extimp=nullptr, Option_t opt="")
	Create a new browser with a name, title, width and height.
	TBrowser (const char name, TObject obj, const char title, Int_t x, Int_t y, UInt_t width, UInt_t height, Option_t opt="")
	Create a new browser with a name, title, width and height for TObject *obj.
	TBrowser (const char name, TObject obj, const char title, UInt_t width, UInt_t height, Option_t opt="")
	Create a new browser with a name, title, width and height for TObject *obj.
	TBrowser (const char name, TObject obj, const char title="ROOT Object Browser", Option_t opt="")
	Create a new browser with a name, title, width and height for TObject *obj.
	TBrowser (const char name, void obj, TClass cl, const char objname, const char title, Int_t x, Int_t y, UInt_t width, UInt_t height, Option_t opt="")
	Create a new browser with a name, title, width and height for TObject *obj.
	TBrowser (const char name, void obj, TClass cl, const char objname, const char title, UInt_t width, UInt_t height, Option_t opt="")
	Create a new browser with a name, title, width and height for TObject *obj.
	TBrowser (const char name, void obj, TClass cl, const char objname="", const char title="ROOT Foreign Browser", Option_t opt="")
	Create a new browser with a name, title, width and height for TObject *obj.
	TBrowser (const char name="Browser", const char title="ROOT Object Browser", TBrowserImp extimp=nullptr, Option_t opt="")
	Create a new browser with a name, title.
virtual	~TBrowser ()
	Delete the browser.
void	AbstractMethod (const char *method) const
	Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.
void	Add (TObject obj, const char name=nullptr, Int_t check=-1)
	Add object with name to browser.
void	Add (void obj, TClass cl, const char *name=nullptr, Int_t check=-1)
	Add foreign object with name to browser.
void	AddCheckBox (TObject *obj, Bool_t check=kFALSE)
	Add checkbox for this item.
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.
void	BrowseObject (TObject *obj)
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.
void	CheckObjectItem (TObject *obj, Bool_t check=kFALSE)
	Change status of checkbox for this item.
virtual const char *	ClassName () const
	Returns name of class to which the object belongs.
void	Clear (Option_t *option="") override
	Set name and title to empty strings ("").
TObject *	Clone (const char *newname="") const override
	Make a clone of an object using the Streamer facility.
Int_t	Compare (const TObject *obj) const override
	Compare two TNamed objects.
void	Copy (TObject &named) const override
	Copy this to obj.
virtual void	Create (TObject *obj=nullptr)
	Create the browser, called by the ctors.
virtual void	Delete (Option_t *option="")
	Delete this object.
virtual void	Destructor ()
	Actual browser destructor.
virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.
void	Draw (Option_t *option="") override
	Draw browser again if it was closed before If browser exists - just call Show method.
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 with: gROOT->SetSelectedPad(c1).
virtual void	Dump () const
	Dump contents of object on stdout.
virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.
Longptr_t	ExecPlugin (const char name=nullptr, const char fname=nullptr, const char *cmd=nullptr, Int_t pos=1, Int_t subpos=-1)
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.
virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)
	Execute method on this object with parameters stored in the TObjArray.
void	ExecuteDefaultAction (TObject *obj)
	Execute default action for selected object (action is specified in the $HOME/.root.mimes or $ROOTSYS/etc/root.mimes file).
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 void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer.
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.
TBrowserImp *	GetBrowserImp () const
TContextMenu *	GetContextMenu () const
Option_t *	GetDrawOption () const override
	Get option used by the graphics system to draw this object.
virtual const char *	GetIconName () const
	Returns mime type name of object.
const char *	GetName () const override
	Returns 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
Bool_t	GetRefreshFlag () const
TObject *	GetSelected () const
const char *	GetTitle () const override
	Returns title of object.
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.
ULong_t	Hash () const override
	Return hash value for this object.
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.
void	Iconify ()
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)
TClass *	IsA () const override
Bool_t	IsDestructed () const
	IsDestructed.
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).
Bool_t	IsOnHeap () const
Bool_t	IsSortable () const override
Bool_t	IsWeb () const
Bool_t	IsZombie () const
void	ls (Option_t *option="") const override
	List TNamed name and title.
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 (the base implementation is no-op).
void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.
void	operator delete (void *, size_t)
	Operator delete for sized deallocation.
void	operator delete (void *ptr)
	Operator delete.
void	operator delete (void ptr, void vp)
	Only called by placement new when throwing an exception.
void	operator delete[] (void *, size_t)
	Operator delete [] for sized deallocation.
void	operator delete[] (void *ptr)
	Operator delete [].
void	operator delete[] (void ptr, void vp)
	Only called by placement new[] when throwing an exception.
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)
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.
void	Print (Option_t *option="") const override
	Print TNamed name and title.
virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.
void	RecursiveRemove (TObject *obj) override
	Recursively remove obj from browser.
void	Refresh ()
	Refresh browser contents.
void	RemoveCheckBox (TObject *obj)
	Remove checkbox for this item.
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.
void	SetBrowserImp (TBrowserImp *i)
void	SetDrawOption (Option_t *option="") override
	Set drawing option for object.
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).
void	SetRefreshFlag (Bool_t flag)
void	SetSelected (TObject *clickedObject)
	Assign the last selected object.
void	SetStatusText (const char *txt, Int_t col)
virtual void	SetTitle (const char *title="")
	Set the title of the TNamed.
virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.
void	Show ()
virtual Int_t	Sizeof () const
	Return size of the TNamed part of the TObject.
void	StartEmbedding (Int_t pos, Int_t subpos)
void	StopEmbedding (const char *name="")
void	Streamer (TBuffer &) override
	Stream an object of class TObject.
void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.
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=nullptr, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.
virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Static Public Member Functions
static TClass *	Class ()
static const char *	Class_Name ()
static constexpr Version_t	Class_Version ()
static const char *	DeclFileName ()
static Longptr_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
enum	{ kOnlyPrepStep = (1ULL << (3)) }

Protected Member Functions
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).
Bool_t	InitGraphics ()
void	MakeZombie ()
void	SavePrimitiveNameTitle (std::ostream &out, const char *variable_name)
	Save object name and title into the output stream "out".

Static Protected Member Functions
static void	SavePrimitiveConstructor (std::ostream &out, TClass cl, const char variable_name, const char *constructor_agrs="", Bool_t empty_line=kTRUE)
	Save object constructor in the output stream "out".
static void	SavePrimitiveDraw (std::ostream &out, const char variable_name, Option_t option=nullptr)
	Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.
static TString	SavePrimitiveVector (std::ostream &out, const char prefix, Int_t len, Double_t arr, Int_t flag=0)
	Save array in the output stream "out" as vector.

Protected Attributes
TContextMenu *	fContextMenu {nullptr}
	!Context menu pointer
TBrowserImp *	fImp {nullptr}
	!Window system specific browser implementation
TString	fName
Bool_t	fNeedRefresh {kFALSE}
TBrowserTimer *	fTimer {nullptr}
	!Browser's timer
TString	fTitle

Private Member Functions
	TBrowser (const TBrowser &)=delete
TBrowser &	operator= (const TBrowser &)=delete

Static Private Member Functions
static void	AddToTObjectTable (TObject *)
	Private helper function which will dispatch to TObjectTable::AddObj.

Private Attributes
UInt_t	fBits
	bit field status word
TObject *	fLastSelectedObject {nullptr}
	!The last TObject selected by user
UInt_t	fUniqueID
	object unique identifier

Static Private Attributes
static Longptr_t	fgDtorOnly = 0
	object for which to call dtor only (i.e. no delete)
static Bool_t	fgObjectStat = kTRUE
	if true keep track of objects in TObjectTable

#include <TBrowser.h>

Inheritance diagram for TBrowser:

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protectedinherited

Enumerator

kOnlyPrepStep

Used to request that the class specific implementation of TObject::Write just prepare the objects to be ready to be written but do not actually write them into the TBuffer.

This is just for example by TBufferMerger to request that the TTree inside the file calls TTree::FlushBaskets (outside of the merging lock) and TBufferMerger will later ask for the write (inside the merging lock). To take advantage of this feature the class needs to overload TObject::Write and use this enum value accordingly. (See TTree::Write and TObject::Write) Do not use, this feature will be migrate to the Merge function (See TClass and TTree::Merge)

Definition at line 106 of file TObject.h.

◆ anonymous enum

anonymous enum

inherited

Enumerator
kSingleKey	write collection with single key
kOverwrite	overwrite existing object with same name
kWriteDelete	write object, then delete previous key with same name

Definition at line 99 of file TObject.h.

◆ anonymous enum

anonymous enum

inherited

Enumerator
kIsOnHeap	object is on heap
kNotDeleted	object has not been deleted
kZombie	object ctor failed
kInconsistent	class overload Hash but does call RecursiveRemove in destructor
kBitMask

Definition at line 89 of file TObject.h.

◆ EDeprecatedStatusBits

enum TObject::EDeprecatedStatusBits

inherited

Enumerator
kObjInCanvas	for backward compatibility only, use kMustCleanup

Definition at line 84 of file TObject.h.

◆ EStatusBits

enum TBrowser::EStatusBits

Enumerator
kNoHidden

Definition at line 54 of file TBrowser.h.

Constructor & Destructor Documentation

◆ TBrowser() [1/10]

TBrowser::TBrowser ( const TBrowser & )

privatedelete

◆ TBrowser() [2/10]

TBrowser::TBrowser	(	const char *	name = "Browser",
		const char *	title = "ROOT Object Browser",
		TBrowserImp *	extimp = nullptr,
		Option_t *	opt = "" )

Create a new browser with a name, title.

Width and height are by default set to 640x400 and (optionally) adjusted by the screen factor (depending on Rint.Canvas.UseScreenFactor to be true or false, default is true).

Definition at line 135 of file TBrowser.cxx.

◆ TBrowser() [3/10]

TBrowser::TBrowser	(	const char *	name,
		const char *	title,
		UInt_t	width,
		UInt_t	height,
		TBrowserImp *	extimp = nullptr,
		Option_t *	opt = "" )

Create a new browser with a name, title, width and height.

Definition at line 155 of file TBrowser.cxx.

◆ TBrowser() [4/10]

TBrowser::TBrowser	(	const char *	name,
		const char *	title,
		Int_t	x,
		Int_t	y,
		UInt_t	width,
		UInt_t	height,
		TBrowserImp *	extimp = nullptr,
		Option_t *	opt = "" )

Create a new browser with a name, title, position, width and height.

Definition at line 169 of file TBrowser.cxx.