Logo ROOT   6.16/01
Reference Guide
TBranchBrowsable.h
Go to the documentation of this file.
1// @(#)root/tree:$Id$
2// Author: Axel Naumann 14/10/2004
3
4/*************************************************************************
5 * Copyright (C) 1995-2004, Rene Brun and Fons Rademakers. *
6 * All rights reserved. *
7 * *
8 * For the licensing terms see $ROOTSYS/LICENSE. *
9 * For the list of contributors see $ROOTSYS/README/CREDITS. *
10 *************************************************************************/
11
12#ifndef ROOT_TBranchBrowsable
13#define ROOT_TBranchBrowsable
14
15#include "TNamed.h"
16
17#include "TList.h"
18
19#include <list>
20
21class TMethod;
22class TBowser;
23class TClass;
24class TBranch;
25class TBranchElement;
26class TString;
28
30public:
31
32 // these methods are registered in RegisterGenerator, and
33 // called to create the list of browsables. See e.g.
34 // TMethodBrowsable::Register
36 (TList&, const TBranch* branch, const TVirtualBranchBrowsable* parent);
37
39
40 void Browse(TBrowser *b);
41 const char *GetIconName() const {
42 // return icon shown when browsing a TVirtualBranchBrowsable
43 if (IsFolder()) return "TBranchElement-folder";
44 else return "TBranchElement-leaf";
45 }
46 void GetScope(TString & scope) const;
47 Bool_t IsFolder() const {
48 // check whether we have sub-elements
49 return (GetLeaves() && GetLeaves()->GetSize()); }
50
51 static Int_t FillListOfBrowsables(TList& list, const TBranch* branch,
52 const TVirtualBranchBrowsable* parent=0);
53
54 const TBranch* GetBranch() const {
55 // return the parent branch (might be many levels up)
56 return fBranch; }
58 // return the parent TVirtualBranchBrowsable
59 return fParent; }
61 // return the type of this browsable object
62 return fClass; }
64 // return whether the type of this browsable object is a pointer
65 return fTypeIsPointer; }
66 TList* GetLeaves() const;
67
68 // static void Register() has to be implemented for all derived classes!
69 // static void Unregister() has to be implemented for all derived classes!
70
71protected:
72 TVirtualBranchBrowsable(const TBranch* b, TClass* type, Bool_t typeIsPointer,
73 const TVirtualBranchBrowsable* parent=0);
75 const TVirtualBranchBrowsable* parent, TClass* &contained);
76 static std::list<MethodCreateListOfBrowsables_t>& GetRegisteredGenerators();
80 // sets the type of this browsable object
81 fClass=type; }
83 // sets whether the type of this browsable object is a pointer
84 fTypeIsPointer=set; }
85
86private:
87 static void RegisterDefaultGenerators();
88 const TBranch *fBranch; ///< pointer to the branch element representing the top object
89 const TVirtualBranchBrowsable *fParent; ///< parent method if this method is member of a returned class
90 TList *fLeaves; ///< pointer to leaves
91 TClass *fClass; ///< pointer to TClass representing our type (i.e. return type for methods), 0 if basic type
92 Bool_t fTypeIsPointer; ///< return type is pointer to class
93 static std::list<MethodCreateListOfBrowsables_t> fgGenerators; ///< list of MethodCreateListOfBrowsables_t called by CreateListOfBrowsables
94 static Bool_t fgGeneratorsSet; ///< have we set the generators yet? empty is not good enough - user might have removed them
95 ClassDef(TVirtualBranchBrowsable, 0); ///< Base class for helper objects used for browsing
96};
97
98
100public:
102
103 static Int_t GetBrowsables(TList& list, const TBranch* branch,
104 const TVirtualBranchBrowsable* parent=0);
105 const char *GetIconName() const {
106 // return our special icons
107 if (IsFolder()) return "TMethodBrowsable-branch";
108 return "TMethodBrowsable-leaf";}
109 static Bool_t IsMethodBrowsable(const TMethod* m);
110 static void Register();
111 static void Unregister();
112
113protected:
114 static void GetBrowsableMethodsForClass(TClass* cl, TList& list);
115 TMethodBrowsable(const TBranch* branch, TMethod* m,
116 const TVirtualBranchBrowsable* parent=0);
117
118private:
119 TMethod *fMethod; // pointer to a method
120 ClassDef(TMethodBrowsable,0); // Helper object to browse methods
121};
122
123
125public:
127
128 static Int_t GetBrowsables(TList& list, const TBranch* branch,
129 const TVirtualBranchBrowsable* parent=0);
130 static void Register();
131 static void Unregister();
132
133protected:
134 TNonSplitBrowsable(const TStreamerElement* element, const TBranch* branch,
135 const TVirtualBranchBrowsable* parent=0);
136
137private:
138 ClassDef(TNonSplitBrowsable, 0); // Helper object to browse unsplit objects
139};
140
141
143public:
145
146 void Browse(TBrowser *b);
147 static Int_t GetBrowsables(TList& list, const TBranch* branch,
148 const TVirtualBranchBrowsable* parent=0);
149 const char* GetDraw() const {
150 // return the string passed to TTree::Draw
151 return fDraw.Data(); }
152 static void Register();
153 static void Unregister();
154
155protected:
156 TCollectionPropertyBrowsable(const char* name, const char* title,
157 const char* draw, const TBranch* branch, const TVirtualBranchBrowsable* parent=0):
158 TVirtualBranchBrowsable(branch, 0, kFALSE, parent), fDraw(draw) {
159 // constructor, which sets the name and title according to the parameters
160 // (and thus differently than our base class TVirtualBranchBrowsable)
161 SetNameTitle(name, title);
162 }
163
164private:
165 TString fDraw; // string to send to TTree::Draw(), NOT by GetScope()!
166 ClassDef(TCollectionPropertyBrowsable, 0); // Helper object to add browsable collection properties
167};
168
170public:
172
173 static Int_t GetBrowsables(TList& list, const TBranch* branch,
174 const TVirtualBranchBrowsable* parent=0);
175 static void Register();
176 static void Unregister();
177
178protected:
180 const TVirtualBranchBrowsable* parent=0);
181
182 ClassDef(TCollectionMethodBrowsable,0); // Helper object to browse a collection's methods
183};
184
185#endif // defined ROOT_TBranchBrowsable
#define b(i)
Definition: RSha256.hxx:100
int Int_t
Definition: RtypesCore.h:41
const Bool_t kFALSE
Definition: RtypesCore.h:88
bool Bool_t
Definition: RtypesCore.h:59
const Bool_t kTRUE
Definition: RtypesCore.h:87
#define ClassDef(name, id)
Definition: Rtypes.h:324
int type
Definition: TGX11.cxx:120
A Branch for the case of an object.
A TTree is a list of TBranches.
Definition: TBranch.h:64
Using a TBrowser one can browse all ROOT objects.
Definition: TBrowser.h:37
The ROOT global object gROOT contains a list of all defined classes.
Definition: TClass.h:75
TCollectionMethodBrowsable extends TCollectionPropertyBrowsable by showing all methods of the collect...
static void Register()
Wrapper for the registration method.
static void Unregister()
Wrapper for the registration method.
TCollectionMethodBrowsable(const TBranch *branch, TMethod *m, const TVirtualBranchBrowsable *parent=0)
Contructor, see TMethodBrowsable's constructor.
static Int_t GetBrowsables(TList &list, const TBranch *branch, const TVirtualBranchBrowsable *parent=0)
This methods fills list with TMethodBrowsables for the branch's or parent's collection class and its ...
A tiny browser helper object (and its generator) for adding a virtual (as in "not actually part of th...
static void Register()
Wrapper for the registration method.
static Int_t GetBrowsables(TList &list, const TBranch *branch, const TVirtualBranchBrowsable *parent=0)
If the element to browse (given by either parent of branch) contains a collection (TClonesArray or so...
void Browse(TBrowser *b)
Browses a TCollectionPropertyBrowsable.
static void Unregister()
Wrapper for the registration method.
TCollectionPropertyBrowsable(const char *name, const char *title, const char *draw, const TBranch *branch, const TVirtualBranchBrowsable *parent=0)
const char * GetDraw() const
A doubly linked list.
Definition: TList.h:44
This helper object allows the browsing of methods of objects stored in branches.
TMethodBrowsable(const TBranch *branch, TMethod *m, const TVirtualBranchBrowsable *parent=0)
Constructor.
static void GetBrowsableMethodsForClass(TClass *cl, TList &list)
Given a class, this methods fills list with TMethodBrowsables for the class and its base classes,...
static Bool_t IsMethodBrowsable(const TMethod *m)
A TMethod is browsable if it is const, public and not pure virtual, if does not have any parameter wi...
const char * GetIconName() const
Returns mime type name of object.
static void Unregister()
Wrapper for the registration method.
static void Register()
Wrapper for the registration method.
static Int_t GetBrowsables(TList &list, const TBranch *branch, const TVirtualBranchBrowsable *parent=0)
This methods fills list with TMethodBrowsables for the branch's or parent's class and its base classe...
Each ROOT class (see TClass) has a linked list of methods.
Definition: TMethod.h:38
The TNamed class is the base class for all named ROOT classes.
Definition: TNamed.h:29
virtual void SetNameTitle(const char *name, const char *title)
Set all the TNamed parameters (name and title).
Definition: TNamed.cxx:154
Allows a TBrowser to browse non-split branches as if they were split.
static Int_t GetBrowsables(TList &list, const TBranch *branch, const TVirtualBranchBrowsable *parent=0)
Given either a branch "branch" or a "parent" TVirtualBranchBrowsable, we fill "list" with objects of ...
static void Unregister()
Wrapper for the registration method.
TNonSplitBrowsable(const TStreamerElement *element, const TBranch *branch, const TVirtualBranchBrowsable *parent=0)
Constructor.
static void Register()
Wrapper for the registration method.
Basic string class.
Definition: TString.h:131
const char * Data() const
Definition: TString.h:364
TVirtualBranchBrowsable is a base class (not really abstract, but useless by itself) for helper objec...
void SetType(TClass *type)
const TBranch * fBranch
pointer to the branch element representing the top object
const TBranch * GetBranch() const
static TClass * GetCollectionContainedType(const TBranch *b, const TVirtualBranchBrowsable *parent, TClass *&contained)
Check whether the branch (or the parent) contains a collection.
TVirtualBranchBrowsable(const TBranch *b, TClass *type, Bool_t typeIsPointer, const TVirtualBranchBrowsable *parent=0)
Constructor setting all members according to parameters.
const char * GetIconName() const
Returns mime type name of object.
~TVirtualBranchBrowsable()
Destructor. Delete our leaves.
const TVirtualBranchBrowsable * GetParent() const
TList * GetLeaves() const
Return list of leaves. If not set up yet we'll create them.
static void RegisterGenerator(MethodCreateListOfBrowsables_t generator)
Adds a generator to be called when browsing branches.
void GetScope(TString &scope) const
Returns the full name for TTree::Draw to draw *this.
static std::list< MethodCreateListOfBrowsables_t > fgGenerators
list of MethodCreateListOfBrowsables_t called by CreateListOfBrowsables
void SetTypeIsPointer(Bool_t set=kTRUE)
TList * fLeaves
pointer to leaves
Bool_t TypeIsPointer() const
void Browse(TBrowser *b)
Calls TTree::Draw on the method if return type is not a class; otherwise expands returned object's "f...
Bool_t fTypeIsPointer
return type is pointer to class
static std::list< MethodCreateListOfBrowsables_t > & GetRegisteredGenerators()
returns the list of registered generator methods
Int_t(* MethodCreateListOfBrowsables_t)(TList &, const TBranch *branch, const TVirtualBranchBrowsable *parent)
static void UnregisterGenerator(MethodCreateListOfBrowsables_t generator)
Removes a generator from the list of generators to be called when browsing branches.
static void RegisterDefaultGenerators()
Adds the default generators.
Bool_t IsFolder() const
Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
static Bool_t fgGeneratorsSet
have we set the generators yet? empty is not good enough - user might have removed them
static Int_t FillListOfBrowsables(TList &list, const TBranch *branch, const TVirtualBranchBrowsable *parent=0)
Askes all registered generators to fill their browsables into the list.
const TVirtualBranchBrowsable * fParent
parent method if this method is member of a returned class
TClass * fClass
pointer to TClass representing our type (i.e. return type for methods), 0 if basic type
TClass * GetClassType() const
auto * m
Definition: textangle.C:8