ROOT  6.07/01
Reference Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
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....

base_browser.png

Definition at line 41 of file TBrowser.h.

Public Types

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

 TBrowser (const char *name="Browser", const char *title="ROOT Object Browser", TBrowserImp *extimp=0, Option_t *opt="")
 
 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, 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, 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, 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, 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="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, 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, 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...
 
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 CheckObjectItem (TObject *obj, Bool_t check=kFALSE)
 Change status of checkbox for this item. More...
 
void RemoveCheckBox (TObject *obj)
 Remove 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...
 
void BrowseObject (TObject *obj)
 
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
 
void SetBrowserImp (TBrowserImp *i)
 
TContextMenuGetContextMenu () const
 
Bool_t GetRefreshFlag () const
 
TObjectGetSelected () const
 
void SetRefreshFlag (Bool_t flag)
 
void Iconify ()
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove obj from browser. More...
 
void Refresh ()
 Refresh browser contents. More...
 
void SetSelected (TObject *clickedObject)
 Assign the last selected object. More...
 
void Show ()
 
void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. 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 SetStatusText (const char *txt, Int_t col)
 
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 TString &name, const TString &title)
 
 TNamed (const TNamed &named)
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual ~TNamed ()
 
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 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...
 
TObjectoperator= (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 void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. 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 TObjectDrawClone (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 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 UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual Option_tGetOption () 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 IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). 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 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 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...
 
voidoperator new (size_t sz)
 
voidoperator new[] (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator 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...
 

Protected Attributes

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

Private Member Functions

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

Private Attributes

TObjectfLastSelectedObject
 

Additional Inherited Members

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

#include <TBrowser.h>

Inheritance diagram for TBrowser:
[legend]

Member Enumeration Documentation

anonymous enum
Enumerator
kNoHidden 

Definition at line 56 of file TBrowser.h.

Constructor & Destructor Documentation

TBrowser::TBrowser ( const TBrowser )
private

The last TObject selected by user.

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

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 119 of file TBrowser.cxx.

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 134 of file TBrowser.cxx.

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 152 of file TBrowser.cxx.

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 167 of file TBrowser.cxx.

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 183 of file TBrowser.cxx.

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 203 of file TBrowser.cxx.

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 219 of file TBrowser.cxx.

TBrowser::~TBrowser ( )
virtual

Delete the browser.

Definition at line 236 of file TBrowser.cxx.

Member Function Documentation

void TBrowser::Add ( TObject obj,
const char *  name = 0,
Int_t  check = -1 
)
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 278 of file TBrowser.cxx.

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

Add checkbox for this item.

Definition at line 292 of file TBrowser.cxx.

void TBrowser::BrowseObject ( TObject obj)
inline

Definition at line 94 of file TBrowser.h.

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

Change status of checkbox for this item.

Definition at line 302 of file TBrowser.cxx.

Referenced by TGeoVolume::SetVisibility().

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

Create the browser, called by the ctors.

Definition at line 322 of file TBrowser.cxx.

Referenced by TBrowser().

void TBrowser::Destructor ( )
virtual

Actual browser destructor.

Definition at line 244 of file TBrowser.cxx.

Referenced by TRootBrowserLite::ReallyDelete(), TRootBrowser::ReallyDelete(), and ~TBrowser().

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 110 of file TBrowser.h.

Referenced by TRootBrowser::CloneBrowser().

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 355 of file TBrowser.cxx.

Referenced by TSystemFile::Browse(), and TRemoteObject::Browse().

TBrowserImp* TBrowser::GetBrowserImp ( ) const
inline

Definition at line 96 of file TBrowser.h.

Referenced by TRootContextMenu::Dialog().

TContextMenu* TBrowser::GetContextMenu ( ) const
inline

Definition at line 98 of file TBrowser.h.

Referenced by TEveBrowser::MakeFileBrowser(), and TRootBrowserLite::ProcessMessage().

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 108 of file TBrowser.h.

Referenced by TVirtualBranchBrowsable::Browse(), TMultiGraph::Browse(), THStack::Browse(), TLeaf::Browse(), TGraph::Browse(), TBranch::Browse(), TCollectionPropertyBrowsable::Browse(), TBranchElement::Browse(), TH1::Browse(), ROOT::Internal::THnBaseBrowsable::Browse(), and TF1::Browse().

Bool_t TBrowser::GetRefreshFlag ( ) const
inline

Definition at line 99 of file TBrowser.h.

Referenced by TRemoteObject::Browse(), and TRootBrowserLite::Refresh().

TObject* TBrowser::GetSelected ( ) const
inline

Definition at line 100 of file TBrowser.h.

void TBrowser::Iconify ( )
inline

Definition at line 102 of file TBrowser.h.

TBrowser& TBrowser::operator= ( const TBrowser )
private
void TBrowser::RecursiveRemove ( TObject obj)
virtual

Recursively remove obj from browser.

Reimplemented from TObject.

Definition at line 364 of file TBrowser.cxx.

Referenced by TApplication::Close(), and TGeoManager::SetTopVolume().

void TBrowser::Refresh ( )

Refresh browser contents.

Definition at line 375 of file TBrowser.cxx.

Referenced by TContextMenu::Action(), TContextMenu::Execute(), and TGeoVolume::SetVisibility().

void TBrowser::RemoveCheckBox ( TObject obj)

Remove checkbox for this item.

Definition at line 312 of file TBrowser.cxx.

void TBrowser::SetBrowserImp ( TBrowserImp i)
inline

Definition at line 97 of file TBrowser.h.

Referenced by TEveBrowser::MakeFileBrowser().

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 107 of file TBrowser.h.

Referenced by TGFileBrowser::DoubleClicked(), TRootBrowserLite::ExecuteDefaultAction(), and TGFileBrowser::XXExecuteDefaultAction().

void TBrowser::SetRefreshFlag ( Bool_t  flag)
inline
void TBrowser::SetSelected ( TObject clickedObject)

Assign the last selected object.

Definition at line 385 of file TBrowser.cxx.

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

Definition at line 114 of file TBrowser.h.

void TBrowser::Show ( )
inline

Definition at line 106 of file TBrowser.h.

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

Definition at line 117 of file TBrowser.h.

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

Definition at line 120 of file TBrowser.h.

Member Data Documentation

TContextMenu* TBrowser::fContextMenu
protected

Browser's timer.

Definition at line 52 of file TBrowser.h.

Referenced by Create(), Destructor(), and GetContextMenu().

TBrowserImp* TBrowser::fImp
protected
TObject* TBrowser::fLastSelectedObject
private

Definition at line 44 of file TBrowser.h.

Referenced by GetSelected(), and SetSelected().

Bool_t TBrowser::fNeedRefresh
protected

Context menu pointer.

Definition at line 53 of file TBrowser.h.

Referenced by Create(), GetRefreshFlag(), RecursiveRemove(), Refresh(), and SetRefreshFlag().

TBrowserTimer* TBrowser::fTimer
protected

Window system specific browser implementation.

Definition at line 51 of file TBrowser.h.

Referenced by Create(), and Destructor().

Collaboration diagram for TBrowser:
[legend]

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