Logo ROOT  
Reference Guide
TBrowser Class Reference

Using a TBrowser one can browse all ROOT objects.

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

Definition at line 37 of file TBrowser.h.

Public Types

enum  EStatusBits { kNoHidden = BIT(9) }
 
- 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

 TBrowser (const char *name, const char *title, Int_t x, Int_t y, UInt_t width, UInt_t height, TBrowserImp *extimp=0, Option_t *opt="")
 Create a new browser with a name, title, position, width and height. More...
 
 TBrowser (const char *name, const char *title, UInt_t width, UInt_t height, TBrowserImp *extimp=0, Option_t *opt="")
 Create a new browser with a name, title, width and height. More...
 
 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. More...
 
 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. More...
 
 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. More...
 
 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. More...
 
 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. More...
 
 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. More...
 
 TBrowser (const char *name="Browser", const char *title="ROOT Object Browser", TBrowserImp *extimp=0, Option_t *opt="")
 Create a new browser with a name, title. More...
 
virtual ~TBrowser ()
 Delete the browser. More...
 
void Add (TObject *obj, const char *name=0, Int_t check=-1)
 Add object with name to browser. More...
 
void Add (void *obj, TClass *cl, const char *name=0, Int_t check=-1)
 Add foreign object with name to browser. More...
 
void AddCheckBox (TObject *obj, Bool_t check=kFALSE)
 Add checkbox for this item. More...
 
void BrowseObject (TObject *obj)
 
void CheckObjectItem (TObject *obj, Bool_t check=kFALSE)
 Change status of checkbox for this item. More...
 
virtual void Create (TObject *obj=0)
 Create the browser, called by the ctors. More...
 
virtual void Destructor ()
 Actual browser destructor. More...
 
Long_t ExecPlugin (const char *name=0, const char *fname=0, const char *cmd=0, Int_t pos=1, Int_t subpos=-1)
 
void ExecuteDefaultAction (TObject *obj)
 Execute default action for selected object (action is specified in the $HOME/.root.mimes or $ROOTSYS/etc/root.mimes file). More...
 
TBrowserImpGetBrowserImp () const
 
TContextMenuGetContextMenu () const
 
Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
Bool_t GetRefreshFlag () const
 
TObjectGetSelected () const
 
void Iconify ()
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove obj from browser. More...
 
void Refresh ()
 Refresh browser contents. More...
 
void RemoveCheckBox (TObject *obj)
 Remove checkbox for this item. More...
 
void SetBrowserImp (TBrowserImp *i)
 
void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
void SetRefreshFlag (Bool_t flag)
 
void SetSelected (TObject *clickedObject)
 Assign the last selected object. More...
 
void SetStatusText (const char *txt, Int_t col)
 
void Show ()
 
void StartEmbedding (Int_t pos, Int_t subpos)
 
void StopEmbedding (const char *name="")
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor. More...
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual TObjectClone (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...
 
TNamedoperator= (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...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
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. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. 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 TObjectDrawClone (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 TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of 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_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
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...
 
virtual ULong_t Hash () const
 Return hash value for this object. 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...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. 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...
 
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...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (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 void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. 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)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. 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 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...
 

Protected Attributes

TContextMenufContextMenu
 Browser's timer. More...
 
TBrowserImpfImp
 
Bool_t fNeedRefresh
 Context menu pointer. More...
 
TBrowserTimer * fTimer
 Window system specific browser implementation. More...
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

Private Member Functions

 TBrowser (const TBrowser &)=delete
 The last TObject selected by user. More...
 
TBrowseroperator= (const TBrowser &)=delete
 

Private Attributes

TObjectfLastSelectedObject
 

Additional Inherited Members

- 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 Types inherited from TObject
enum  { kOnlyPrepStep = BIT(3) }
 
- 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 ()
 

#include <TBrowser.h>

Inheritance diagram for TBrowser:
[legend]

Member Enumeration Documentation

◆ EStatusBits

Enumerator
kNoHidden 

Definition at line 52 of file TBrowser.h.

Constructor & Destructor Documentation

◆ TBrowser() [1/10]

TBrowser::TBrowser ( const TBrowser )
privatedelete

The last TObject selected by user.

◆ TBrowser() [2/10]

TBrowser::TBrowser ( const char *  name = "Browser",
const char *  title = "ROOT Object Browser",
TBrowserImp extimp = 0,
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 84 of file TBrowser.cxx.

◆ TBrowser() [3/10]

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

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

Definition at line 106 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 = 0,
Option_t opt = "" 
)

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

Definition at line 121 of file TBrowser.cxx.

◆ TBrowser() [5/10]

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

Definition at line 136 of file TBrowser.cxx.

◆ TBrowser() [6/10]

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

Definition at line 154 of file TBrowser.cxx.

◆ TBrowser() [7/10]

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

Definition at line 169 of file TBrowser.cxx.

◆ TBrowser() [8/10]

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

Definition at line 185 of file TBrowser.cxx.

◆ TBrowser() [9/10]

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

Definition at line 205 of file TBrowser.cxx.

◆ TBrowser() [10/10]

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

Definition at line 221 of file TBrowser.cxx.

◆ ~TBrowser()

TBrowser::~TBrowser ( )
virtual

Delete the browser.

Definition at line 238 of file TBrowser.cxx.

Member Function Documentation

◆ Add() [1/2]

void TBrowser::Add ( TObject obj,
const char *  name = 0,
Int_t  check = -1 
)

Add object with name to browser.

If name not set the objects GetName() is used. If check < 0 (default) no check box is drawn, if 0 then unchecked checkbox is added, if 1 checked checkbox is added.

Definition at line 261 of file TBrowser.cxx.

◆ Add() [2/2]

void TBrowser::Add ( void obj,
TClass cl,
const char *  name = 0,
Int_t  check = -1 
)

Add foreign object with name to browser.

'cl' is the type use to store the value of obj. So literally the following pseudo code should be correct:

`cl->GetName()` * ptr = (`cl->GetName()`*) obj;

and the value of obj is not necessarily the start of the object. If check < 0 (default) no check box is drawn, if 0 then unchecked checkbox is added, if 1 checked checkbox is added.

Definition at line 280 of file TBrowser.cxx.

◆ AddCheckBox()

void TBrowser::AddCheckBox ( TObject obj,
Bool_t  check = kFALSE 
)

Add checkbox for this item.

Definition at line 294 of file TBrowser.cxx.

◆ BrowseObject()

void TBrowser::BrowseObject ( TObject obj)
inline

Definition at line 90 of file TBrowser.h.

◆ CheckObjectItem()

void TBrowser::CheckObjectItem ( TObject obj,
Bool_t  check = kFALSE 
)

Change status of checkbox for this item.

Definition at line 304 of file TBrowser.cxx.

◆ Create()

void TBrowser::Create ( TObject obj = 0)
virtual

Create the browser, called by the ctors.

Definition at line 324 of file TBrowser.cxx.

◆ Destructor()

void TBrowser::Destructor ( )
virtual

Actual browser destructor.

Definition at line 246 of file TBrowser.cxx.

◆ ExecPlugin()

Long_t TBrowser::ExecPlugin ( const char *  name = 0,
const char *  fname = 0,
const char *  cmd = 0,
Int_t  pos = 1,
Int_t  subpos = -1 
)
inline

Definition at line 106 of file TBrowser.h.

◆ ExecuteDefaultAction()

void TBrowser::ExecuteDefaultAction ( TObject obj)

Execute default action for selected object (action is specified in the $HOME/.root.mimes or $ROOTSYS/etc/root.mimes file).

Definition at line 357 of file TBrowser.cxx.

◆ GetBrowserImp()

TBrowserImp * TBrowser::GetBrowserImp ( ) const
inline

Definition at line 92 of file TBrowser.h.

◆ GetContextMenu()

TContextMenu * TBrowser::GetContextMenu ( ) const
inline

Definition at line 94 of file TBrowser.h.

◆ GetDrawOption()

Option_t * TBrowser::GetDrawOption ( ) const
inlinevirtual

Get option used by the graphics system to draw this object.

Note that before calling object.GetDrawOption(), you must have called object.Draw(..) before in the current pad.

Reimplemented from TObject.

Definition at line 104 of file TBrowser.h.

◆ GetRefreshFlag()

Bool_t TBrowser::GetRefreshFlag ( ) const
inline

Definition at line 95 of file TBrowser.h.

◆ GetSelected()

TObject * TBrowser::GetSelected ( ) const
inline

Definition at line 96 of file TBrowser.h.

◆ Iconify()

void TBrowser::Iconify ( )
inline

Definition at line 98 of file TBrowser.h.

◆ operator=()

TBrowser & TBrowser::operator= ( const TBrowser )
privatedelete

◆ RecursiveRemove()

void TBrowser::RecursiveRemove ( TObject obj)
virtual

Recursively remove obj from browser.

Reimplemented from TObject.

Definition at line 366 of file TBrowser.cxx.

◆ Refresh()

void TBrowser::Refresh ( )

Refresh browser contents.

Definition at line 377 of file TBrowser.cxx.

◆ RemoveCheckBox()

void TBrowser::RemoveCheckBox ( TObject obj)

Remove checkbox for this item.

Definition at line 314 of file TBrowser.cxx.

◆ SetBrowserImp()

void TBrowser::SetBrowserImp ( TBrowserImp i)
inline

Definition at line 93 of file TBrowser.h.

◆ SetDrawOption()

void TBrowser::SetDrawOption ( Option_t option = "")
inlinevirtual

Set drawing option for object.

This option only affects the drawing style and is stored in the option field of the TObjOptLink supporting a TPad's primitive list (TList). Note that it does not make sense to call object.SetDrawOption(option) before having called object.Draw().

Reimplemented from TObject.

Definition at line 103 of file TBrowser.h.

◆ SetRefreshFlag()

void TBrowser::SetRefreshFlag ( Bool_t  flag)
inline

Definition at line 97 of file TBrowser.h.

◆ SetSelected()

void TBrowser::SetSelected ( TObject clickedObject)

Assign the last selected object.

Definition at line 387 of file TBrowser.cxx.

◆ SetStatusText()

void TBrowser::SetStatusText ( const char *  txt,
Int_t  col 
)
inline

Definition at line 110 of file TBrowser.h.

◆ Show()

void TBrowser::Show ( )
inline

Definition at line 102 of file TBrowser.h.

◆ StartEmbedding()

void TBrowser::StartEmbedding ( Int_t  pos,
Int_t  subpos 
)
inline

Definition at line 113 of file TBrowser.h.

◆ StopEmbedding()

void TBrowser::StopEmbedding ( const char *  name = "")
inline

Definition at line 116 of file TBrowser.h.

Member Data Documentation

◆ fContextMenu

TContextMenu* TBrowser::fContextMenu
protected

Browser's timer.

Definition at line 48 of file TBrowser.h.

◆ fImp

TBrowserImp* TBrowser::fImp
protected

Definition at line 46 of file TBrowser.h.

◆ fLastSelectedObject

TObject* TBrowser::fLastSelectedObject
private

Definition at line 40 of file TBrowser.h.

◆ fNeedRefresh

Bool_t TBrowser::fNeedRefresh
protected

Context menu pointer.

Definition at line 49 of file TBrowser.h.

◆ fTimer

TBrowserTimer* TBrowser::fTimer
protected

Window system specific browser implementation.

Definition at line 47 of file TBrowser.h.


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