This class displays a legend box (TPaveText) containing several legend entries.

Each legend entry is made of a reference to a ROOT object, a text label and an option specifying which graphical attributes (marker/line/fill) should be displayed.

The following example shows how to create a legend. In this example the legend contains a histogram, a function and a graph. The histogram is put in the legend using its reference pointer whereas the graph and the function are added using their names. Note that, because TGraph constructors do not have the TGraph name as parameter, the graph name should be specified using the SetName method.

When an object is added by name, a scan is performed on the list of objects contained in the current pad (gPad) and also in the possible TMultiGraph and THStack present in the pad. If a matching name is found, the corresponding object is added in the legend using its pointer.

{
   auto c1 = new TCanvas("c1","c1",600,500);
   gStyle->SetOptStat(0);
 
   auto h1 = new TH1F("h1","TLegend Example",200,-10,10);
   h1->FillRandom("gaus",30000);
   h1->SetFillColor(kGreen);
   h1->SetFillStyle(3003);
   h1->Draw();
 
   auto f1=new TF1("f1","1000*TMath::Abs(sin(x)/x)",-10,10);
   f1->SetLineColor(kBlue);
   f1->SetLineWidth(4);
   f1->Draw("same");
 
   const Int_t n = 20;
   Double_t x[n], y[n], ex[n], ey[n];
   for (Int_t i=0;i<n;i++) {
      x[i]  = i*0.1;
      y[i]  = 1000*sin(x[i]+0.2);
      x[i]  = 17.8*x[i]-8.9;
      ex[i] = 1.0;
      ey[i] = 10.*i;
   }
   auto gr = new TGraphErrors(n,x,y,ex,ey);
   gr->SetName("gr");
   gr->SetLineColor(kRed);
   gr->SetLineWidth(2);
   gr->SetMarkerStyle(21);
   gr->SetMarkerSize(1.3);
   gr->SetMarkerColor(7);
   gr->Draw("P");
 
   auto legend = new TLegend(0.1,0.7,0.48,0.9);
   legend->SetHeader("The Legend Title","C"); // option "C" allows to center the header
   legend->AddEntry(h1,"Histogram filled with random numbers","f");
   legend->AddEntry("f1","Function abs(#frac{sin(x)}{x})","l");
   legend->AddEntry("gr","Graph with error bars","lep");
   legend->Draw();
}

TLegend inherits from TAttText therefore changing any text attributes (text alignment, font, color...) on a legend will changed the text attributes on each line.

In particular it can be interesting to change the text alignement that way. In order to have a base-line vertical alignment instead of a centered one simply do:

legend->SetTextAlign(13);

or

legend->SetTextAlign(11);

The default value of some TLegend attributes can be changed using gStyle. The default settings are:

SetLegendBorderSize(1);
SetLegendFillColor(0);
SetLegendFont(42);
SetLegendTextSize(0.);

The global attributes change the default values for the next created legends.

Text attributes can be also changed individually on each legend entry:

TLegendEntry *le = leg->AddEntry(h1,"Histogram filled with random numbers","f");

le->SetTextColor(kBlue);

TLegendEntry

Storage class for one entry of a TLegend.

Definition TLegendEntry.h:25

leg

Definition legend1.C:34

Note that the TPad class has a method to build automatically a legend for all objects in the pad. It is called TPad::BuildLegend().

Each item in the legend is added using the AddEntry method. This method defines the object to be added (by reference or name), the label associated to this object and an option which a combination of:

L: draw line associated with TAttLine if obj inherits from TAttLine
P: draw polymarker associated with TAttMarker if obj inherits from TAttMarker
F: draw a box with fill associated wit TAttFill if obj inherits TAttFill
E: draw vertical error bar

As shown in the following example, passing a NULL pointer as first parameter in AddEntry is also valid. This allows to add text or blank lines in a legend.

{
   auto c2 = new TCanvas("c2","c2",500,300);
 
   auto* legend = new TLegend(0.2, 0.2, .8, .8);
   auto h = new TH1F("", "", 1, 0, 1);
 
   legend->AddEntry(h, "Histogram \"h\"", "l");
   legend->AddEntry((TObject*)0, "", "");
   legend->AddEntry((TObject*)0, "Some text", "");
   legend->AddEntry((TObject*)0, "", "");
   legend->AddEntry(h, "Histogram \"h\" again", "l");
 
   legend->Draw();
}

It is possible to draw the legend entries over several columns using the method SetNColumns() like in the following example.

{
   auto c3 = new TCanvas("c2","c2",500,300);
 
   auto legend = new TLegend(0.2, 0.2, .8, .8);
   auto h = new TH1F("", "", 1, 0, 1);
 
   legend->SetNColumns(2);
 
   legend->AddEntry(h, "Column 1 line 1", "l");
   legend->AddEntry(h, "Column 2 line 1", "l");
   legend->AddEntry(h, "Column 1 line 2", "l");
   legend->AddEntry(h, "Column 2 line 2", "l");
 
   legend->Draw();
}

Since: ROOT version 6.09/03

The legend can be placed automatically in the current pad in an empty space found at painting time.

The following example illustrate this facility. Only the width and height of the legend is specified in percentage of the pad size.

 
void hist011_TH1_legend_autoplaced()
{
   auto *c4 = new TCanvas("c", "c", 600, 500);
 
   // Create a dummy histogram
   auto *hpx = new TH1D("hpx", "This is the hpx distribution", 100, -4., 4.);
   hpx->FillRandom("gaus", 50000);
   hpx->Draw("E");
   hpx->GetYaxis()->SetTitle("Y Axis title");
   hpx->GetYaxis()->SetTitleOffset(1.3);
   hpx->GetYaxis()->CenterTitle(true);
   hpx->GetXaxis()->SetTitle("X Axis title");
   hpx->GetXaxis()->CenterTitle(true);
 
   // Create another dummy histogram
   auto *h1 = new TH1D("h1", "A green histogram", 100, -2., 2.);
   h1->FillRandom("gaus", 10000);
   h1->SetLineColor(kGreen);
   h1->Draw("same");
 
   // Create a dummy graph
   auto *g = new TGraph();
   g->SetPoint(0, -3.5, 100);
   g->SetPoint(1, -3.0, 300);
   g->SetPoint(2, -2.0, 1000);
   g->SetPoint(3, 1.0, 800);
   g->SetPoint(4, 0.0, 200);
   g->SetPoint(5, 3.0, 200);
   g->SetPoint(6, 3.0, 700);
   g->Draw("L");
   g->SetTitle("This is a TGraph");
   g->SetLineColor(kRed);
   g->SetFillColor(0);
 
   // TPad::BuildLegend() default placement values are such that they trigger
   // the automatic placement.
   c4->BuildLegend();
}

Definition at line 23 of file TLegend.h.

Public Types
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

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

enum	{ kCannotMove = (1ULL << ( 12 )) }

enum	{ kNameIsAction = (1ULL << ( 11 )) }

enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }

enum	EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) }

Public Member Functions
	TLegend ()
	Default constructor.

	TLegend (const TLegend &legend)
	Copy constructor.

	TLegend (Double_t w, Double_t h, const char header="", Option_t option="brNDC")
	Constructor with automatic placement.

	TLegend (Double_t x1, Double_t y1, Double_t x2, Double_t y2, const char header="", Option_t option="brNDC")
	Normal constructor.

	~TLegend () override
	Default destructor.

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.

TLegendEntry *	AddEntry (const char name, const char label="", Option_t *option="lpf")
	Add a new entry to this legend.

TLegendEntry *	AddEntry (const TObject obj, const char label="", Option_t *option="lpf")
	Add a new entry to this legend.

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.

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.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

void	Clear (Option_t *option="") override
	Clear all entries in this legend, including the header.

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.

virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method.

virtual void	ConvertNDCtoPad ()
	Convert pave coordinates from NDC to Pad coordinates.

void	Copy (TAttFill &attfill) const
	Copy this fill attributes to a new TAttFill.

void	Copy (TAttLine &attline) const
	Copy this line attributes to a new TAttLine.

void	Copy (TAttText &atttext) const
	Copy this text attributes to a new TAttText.

void	Copy (TObject &obj) const override
	Copy this legend into "obj".

virtual void	Delete (Option_t *option="")
	Delete this object.

virtual void	DeleteEntry ()
	Delete entry at the mouse position.

Int_t	DistancetoLine (Int_t px, Int_t py, Double_t xp1, Double_t yp1, Double_t xp2, Double_t yp2)
	Compute distance from point px,py to a line.

Int_t	DistancetoPrimitive (Int_t px, Int_t py) override
	Compute distance from point px,py to a pave.

void	Draw (Option_t *option="") override
	Draw this legend with its current attributes.

virtual TBox *	DrawBox (Double_t x1, Double_t y1, Double_t x2, Double_t y2)
	Draw this box with new coordinates.

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 TPave *	DrawPave (Double_t x1, Double_t y1, Double_t x2, Double_t y2, Int_t bordersize=4, Option_t *option="br")
	Draw this pave with new coordinates.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	EditEntryAttFill ()
	Edit the fill attributes for the entry pointed by the mouse.

virtual void	EditEntryAttLine ()
	Edit the line attributes for the entry pointed by the mouse.

virtual void	EditEntryAttMarker ()
	Edit the marker attributes for the entry pointed by the mouse.

virtual void	EditEntryAttText ()
	Edit the text attributes for the entry pointed by the mouse.

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

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	ExecuteEvent (Int_t event, Int_t px, Int_t py) override
	Execute action corresponding to one event.

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

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.

Rectangle_t	GetBBox () override
	Return the "bounding Box" of the Box.

virtual TPoint	GetBBoxCenter ()

Int_t	GetBorderSize () const

Float_t	GetColumnSeparation () const

Double_t	GetCornerRadius () const

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

TLegendEntry *	GetEntry () const
	Get entry pointed to by the mouse.

Float_t	GetEntrySeparation () const

virtual Color_t	GetFillColor () const
	Return the fill area color.

virtual Style_t	GetFillStyle () const
	Return the fill area style.

virtual const char *	GetHeader () const
	Returns the header, which is the title that appears at the top of the legend.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual Color_t	GetLineColor () const
	Return the line color.

virtual Style_t	GetLineStyle () const
	Return the line style.

virtual Width_t	GetLineWidth () const
	Return the line width.

TList *	GetListOfPrimitives () const

Float_t	GetMargin () const

const char *	GetName () const override
	Returns name of object.

Int_t	GetNColumns () const

Int_t	GetNRows () const
	Get the number of rows.

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

Option_t *	GetOption () const override

Int_t	GetShadowColor () const

virtual Short_t	GetTextAlign () const
	Return the text alignment.

virtual Float_t	GetTextAngle () const
	Return the text angle.

virtual Color_t	GetTextColor () const
	Return the text color.

virtual Font_t	GetTextFont () const
	Return the text font.

virtual Float_t	GetTextSize () const
	Return the text size.

virtual Float_t	GetTextSizePercent (Float_t size)
	Return the text in percent of the pad size.

virtual Float_t	GetTextSizePixels (TVirtualPad &pad) const
	Return the text size in pixels for specified pad.

virtual Float_t	GetTextSizeRelative (TVirtualPad &pad) const
	Return the text size in relative units.

virtual const char *	GetTitle () const
	Returns title of object.

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

Double_t	GetX1 () const

Double_t	GetX1NDC () const

Double_t	GetX2 () const

Double_t	GetX2NDC () const

Double_t	GetY1 () const

Double_t	GetY1NDC () const

Double_t	GetY2 () const

Double_t	GetY2NDC () const

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.

virtual void	HideToolTip (Int_t event)
	Hide tool tip depending on the event type.

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	InsertEntry (const char objectName="", const char label="", Option_t *option="lpf")
	Add a new entry before the entry at the mouse position.

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

void	InvertBit (UInt_t f)

TClass *	IsA () const override

Bool_t	IsBeingResized () const

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

virtual Int_t	IsInside (Double_t x, Double_t y) const
	Function which returns 1 if point x,y lies inside the box, 0 otherwise.

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

Bool_t	IsSortable () const override

virtual Bool_t	IsTransparent () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

void	ls (Option_t *option="") const override
	List this pave with its attributes.

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 void	Modify ()
	Change current fill area attributes if necessary.

virtual void	Modify ()
	Change current line attributes if necessary.

virtual void	Modify ()
	Change current text attributes if necessary.

virtual void	ModifyOn (TVirtualPad &pad)
	Change current fill area attributes on speicifed pad.

virtual void	ModifyOn (TVirtualPad &pad)
	Change current line attributes on specified pad.

virtual void	ModifyOn (TVirtualPad &pad)
	Change current text attributes if necessary on specified pad.

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)

void	Paint (Option_t *option="") override
	Paint this legend with its current attributes.

virtual void	PaintBox (Double_t x1, Double_t y1, Double_t x2, Double_t y2, Option_t *option="")
	Draw this box with new coordinates.

virtual void	PaintPave (Double_t x1, Double_t y1, Double_t x2, Double_t y2, Int_t bordersize=4, Option_t *option="br")
	Draw this pave with new coordinates.

virtual void	PaintPaveArc (Double_t x1, Double_t y1, Double_t x2, Double_t y2, Int_t bordersize=4, Option_t *option="br")
	Draw this pave with rounded corners.

virtual void	PaintPrimitives ()
	Paint the entries (list of primitives) for this legend.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

void	Print (Option_t *option="") const override
	Dump this TLegend and its contents.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

void	RecursiveRemove (TObject *obj) override
	Reset the legend entries pointing to "obj".

virtual void	ResetAttFill (Option_t *option="")
	Reset this fill attributes to default values.

virtual void	ResetAttLine (Option_t *option="")
	Reset this line attributes to default values.

virtual void	ResetAttText (Option_t *toption="")
	Reset this text attributes to default values.

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	SaveFillAttributes (std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1001)
	Save fill attributes as C++ statement(s) on output stream out.

virtual void	SaveLineAttributes (std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1, Int_t widdef=1)
	Save line attributes as C++ statement(s) on output stream out.

void	SavePrimitive (std::ostream &out, Option_t *option="") override
	Save this legend as C++ statements on output stream out to be used with the SaveAs .C option.

virtual void	SaveTextAttributes (std::ostream &out, const char *name, Int_t alidef=12, Float_t angdef=0, Int_t coldef=1, Int_t fondef=61, Float_t sizdef=1)
	Save text attributes as C++ statement(s) on output stream out.

virtual void	SetBBoxCenter (const TPoint &p)

void	SetBBoxCenterX (const Int_t x) override
	Set X coordinate of the center of the Box.

void	SetBBoxCenterY (const Int_t y) override
	Set Y coordinate of the center of the Box.

void	SetBBoxX1 (const Int_t x) override
	Set left hand side of BoundingBox to a value (resize in x direction on left)

void	SetBBoxX2 (const Int_t x) override
	Set right hand side of BoundingBox to a value (resize in x direction on right)

void	SetBBoxY1 (const Int_t y) override
	Set top of BoundingBox to a value (resize in y direction on top)

void	SetBBoxY2 (const Int_t y) override
	Set bottom of BoundingBox to a value (resize in y direction on bottom)

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetBorderSize (Int_t bordersize=4)
	Sets the border size of the TPave box and shadow.

void	SetColumnSeparation (Float_t columnSeparation)

virtual void	SetCornerRadius (Double_t rad=0.2)

void	SetDefaults ()

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetEntryLabel (const char *label)
	Edit the label of the entry pointed to by the mouse.

virtual void	SetEntryOption (Option_t *option)
	Edit the option of the entry pointed to by the mouse.

void	SetEntrySeparation (Float_t entryseparation)

virtual void	SetFillAttributes ()
	Invoke the DialogCanvas Fill attributes.

virtual void	SetFillColor (Color_t fcolor)
	Set the fill area color.

void	SetFillColor (TColorNumber)
	Set a fill color.

virtual void	SetFillColorAlpha (Color_t fcolor, Float_t falpha)
	Set a transparent fill color.

virtual void	SetFillStyle (Style_t fstyle)
	Set the fill area style.

virtual void	SetHeader (const char header="", Option_t option="")
	Sets the header, which is the "title" that appears at the top of the legend.

virtual void	SetLineAttributes ()
	Invoke the DialogCanvas Line attributes.

virtual void	SetLineColor (Color_t lcolor)
	Set the line color.

void	SetLineColor (TColorNumber lcolor)

virtual void	SetLineColorAlpha (Color_t lcolor, Float_t lalpha)
	Set a transparent line color.

virtual void	SetLineStyle (Style_t lstyle)
	Set the line style.

virtual void	SetLineWidth (Width_t lwidth)
	Set the line width.

void	SetMargin (Float_t margin)

virtual void	SetName (const char *name="")

void	SetNColumns (Int_t nColumns)
	Set the number of columns for the legend.

virtual void	SetOption (Option_t *option="br")

virtual void	SetShadowColor (Int_t color)

virtual void	SetTextAlign (Short_t align=11)
	Set the text alignment.

virtual void	SetTextAngle (Float_t tangle=0)
	Set the text angle.

virtual void	SetTextAttributes ()
	Invoke the DialogCanvas Text attributes.

virtual void	SetTextColor (Color_t tcolor=1)
	Set the text color.

void	SetTextColor (TColorNumber lcolor)

virtual void	SetTextColorAlpha (Color_t tcolor, Float_t talpha)
	Set a transparent text color.

virtual void	SetTextFont (Font_t tfont=62)
	Set the text font.

virtual void	SetTextSize (Float_t tsize=1)
	Set the text size.

virtual void	SetTextSizePixels (Int_t npixels)
	Set the text size in pixel.

virtual void	SetToolTipText (const char *text, Long_t delayms=1000)
	Set tool tip text associated with this box.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

void	SetX1 (Double_t x1) override
	Set the X1 value.

virtual void	SetX1NDC (Double_t x1)

void	SetX2 (Double_t x2) override
	Set the X2 value.

virtual void	SetX2NDC (Double_t x2)

void	SetY1 (Double_t y1) override
	Set the Y1 value.

virtual void	SetY1NDC (Double_t y1)

void	SetY2 (Double_t y2) override
	Set the Y2 value.

virtual void	SetY2NDC (Double_t y2)

void	Streamer (TBuffer &) override
	Stream an object of class TBox.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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

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.

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

TString	GetSavePaveArgs (const char *extra_arg=nullptr, Bool_t save_option=kTRUE)
	Returns arguments which should be used when saving primitive constructor Check if coordinates are initialized, add extra arguments and options.

Double_t	GetXCoord (const Int_t x, Bool_t is_ndc=kFALSE)

Double_t	GetYCoord (const Int_t y, Bool_t is_ndc=kFALSE)

void	MakeZombie ()

TLegend &	operator= (const TLegend &)
	Assignment operator.

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
Int_t	fBorderSize
	window box bordersize in pixels

Float_t	fColumnSeparation
	Separation between columns, as a fraction of The space allowed to one column.

Double_t	fCornerRadius
	Corner radius in case of option arc.

Float_t	fEntrySeparation
	Separation between entries, as a fraction of The space allocated to one entry.

Color_t	fFillColor
	Fill area color.

Style_t	fFillStyle
	Fill area style.

Int_t	fInit
	(=0 if transformation to NDC not yet done)

Color_t	fLineColor
	Line color.

Style_t	fLineStyle
	Line style.

Width_t	fLineWidth
	Line width.

Float_t	fMargin
	Fraction of total width used for symbol.

TString	fName
	Pave name.

Int_t	fNColumns
	Number of columns in the legend.

TString	fOption
	Pave style.

TList *	fPrimitives {nullptr}
	List of TLegendEntries.

Bool_t	fResizing
	! True if box is being resized

Int_t	fShadowColor
	Color of the pave's shadow.

Short_t	fTextAlign
	Text alignment.

Float_t	fTextAngle
	Text angle.

Color_t	fTextColor
	Text color.

Font_t	fTextFont
	Text font.

Float_t	fTextSize
	Text size.

Double_t	fX1
	X of 1st point.

Double_t	fX1NDC
	X1 point in NDC coordinates.

Double_t	fX2
	X of 2nd point.

Double_t	fX2NDC
	X2 point in NDC coordinates.

Double_t	fY1
	Y of 1st point.

Double_t	fY1NDC
	Y1 point in NDC coordinates.

Double_t	fY2
	Y of 2nd point.

Double_t	fY2NDC
	Y2 point in NDC coordinates.

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 *	fTip {nullptr}
	! tool tip associated with box

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

Inheritance diagram for TLegend:

Member Enumeration Documentation

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

◆ 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

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
kCannotMove

Definition at line 36 of file TBox.h.

◆ anonymous enum

anonymous enum

inherited

Enumerator
kNameIsAction	double clicking on TPave will execute action

Definition at line 37 of file TPave.h.

◆ EDeprecatedStatusBits

enum TObject::EDeprecatedStatusBits

inherited

Enumerator
kObjInCanvas	for backward compatibility only, use kMustCleanup

Definition at line 84 of file TObject.h.

◆ EStatusBits

enum TObject::EStatusBits

inherited

Enumerator
kCanDelete	if object in a list can be deleted
kMustCleanup	if object destructor must call RecursiveRemove()
kIsReferenced	if object is referenced by a TRef or TRefArray
kHasUUID	if object has a TUUID (its fUniqueID=UUIDNumber)
kCannotPick	if object in a pad cannot be picked
kNoContextMenu	if object does not want context menu
kInvalidObject	if object ctor succeeded but object should not be used

Definition at line 70 of file TObject.h.

Constructor & Destructor Documentation

◆ TLegend() [1/4]

TLegend::TLegend ( )

Default constructor.

This constructor allows to place automatically the legend with a default width(0.3) and a default height (0.15) in normalize coordinates.

Definition at line 199 of file TLegend.cxx.

◆ TLegend() [2/4]

TLegend::TLegend	(	Double_t	x1,
		Double_t	y1,
		Double_t	x2,
		Double_t	y2,
		const char *	header = "",
		Option_t *	option = "brNDC" )

Normal constructor.

A TLegend is a Pave with several TLegendEntry(s).

x1,y1,x2,y2 are the coordinates of the Legend in the current pad (in normalised coordinates by default)

header is the title displayed at the top of the legend it is a TLatex string treated like a regular entry. The default is no header (header = 0).

The options are the same as for TPave.

Definition at line 223 of file TLegend.cxx.

◆ TLegend() [3/4]

TLegend::TLegend	(	Double_t	w,
		Double_t	h,
		const char *	header = "",
		Option_t *	option = "brNDC" )

Constructor with automatic placement.

A TLegend is a Pave with several TLegendEntry(s).

This constructor doesn't define the legend position. w and h are the width and height of the legend in percentage of the current pad size. The position will be automatically defined at painting time.

header is the title displayed at the top of the legend it is a TLatex string treated like a regular entry. The default is no header (header = 0).

The options are the same as for TPave.

Definition at line 258 of file TLegend.cxx.

◆ ~TLegend()

TLegend::~TLegend ( )

override

Default destructor.

Definition at line 299 of file TLegend.cxx.

◆ TLegend() [4/4]

TLegend::TLegend ( const TLegend & legend )

Copy constructor.

Definition at line 280 of file TLegend.cxx.

Member Function Documentation

◆ AbstractMethod()

void TObject::AbstractMethod ( const char * method ) const

inherited

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.

In other word, this method acts as a "runtime purely virtual" warning instead of a "compiler purely virtual" error.

Warning: This interface is a legacy function that is no longer recommended to be used by new development code.

Note: The name "AbstractMethod" does not imply that it's an abstract method in the strict C++ sense.

Definition at line 1149 of file TObject.cxx.

◆ AddEntry() [1/2]

TLegendEntry * TLegend::AddEntry	(	const char *	name,
		const char *	label = "",
		Option_t *	option = "lpf" )

Add a new entry to this legend.

"name" is the name of an object in the pad to be represented label is the text you wish to associate with obj in the legend if label is null or empty, the title of the object will be used.

Options are:

L: draw line associated with TAttLine if obj inherits from TAttLine
P: draw polymarker associated with TAttMarker if obj inherits from TAttMarker
F: draw a box with fill associated wit TAttFill if obj inherits TAttFill
E: draw vertical error bar if option "L" is also specified

Definition at line 342 of file TLegend.cxx.

◆ AddEntry() [2/2]

TLegendEntry * TLegend::AddEntry	(	const TObject *	obj,
		const char *	label = "",
		Option_t *	option = "lpf" )

Add a new entry to this legend.

"obj" is the object to be represented. "label" is the text you wish to associate with obj in the legend. If "label" is null or empty, the title of the object will be used.

Options are:

L: draw line associated with TAttLine if obj inherits from TAttLine
P: draw polymarker associated with TAttMarker if obj inherits from TAttMarker
F: draw a box with fill associated wit TAttFill if obj inherits TAttFill
E: draw vertical error bar if option "L" is also specified

Definition at line 319 of file TLegend.cxx.

◆ AddToTObjectTable()

void TObject::AddToTObjectTable ( TObject * op )

staticprivateinherited

Private helper function which will dispatch to TObjectTable::AddObj.

Included here to avoid circular dependency between header files.

Definition at line 195 of file TObject.cxx.

◆ AppendPad()

void TObject::AppendPad ( Option_t * option = "" )

virtualinherited

Append graphics object to current pad.

In case no current pad is set yet, create a default canvas with the name "c1".

Definition at line 204 of file TObject.cxx.

◆ Browse()

void TObject::Browse ( TBrowser * b )

virtualinherited

Browse object. May be overridden for another default action.

Reimplemented in TASImage, TRecorder, TEfficiency, TGraph2D, TChain, TTree, TDirectory, TFolder, TMacro, TRemoteObject, TROOT, TStyle, TSystemDirectory, TSystemFile, TTask, TCollection, TPair, TBrowserObject, TBaseClass, TClass, TGeoManager, TGeoNode, TGeoVolume, TGeoOverlap, TGeoTrack, TCanvas, TPad, TAxis3D, TGeometry, TNode, TRootIconList, THbookBranch, THbookFile, THbookKey, TF1, TGraph, TH1, THnBase, ROOT::Internal::THnBaseBrowsable, THStack, TMultiDimFit, TMultiGraph, TPrincipal, TDirectoryFile, TKey, TKeyMapFile, TMapFile, TSPlot, TDatabasePDG, TGenerator, TParticleClassPDG, TApplicationRemote, RooPlot, TBranch, TVirtualBranchBrowsable, TCollectionPropertyBrowsable, TBranchClones, TBranchElement, TBranchObject, TBranchSTL, TLeaf, TNtuple, TNtupleD, TTreePerfStats, and ROOT::Experimental::XRooFit::xRooNode.

Definition at line 218 of file TObject.cxx.

◆ CheckedHash()

ULong_t TObject::CheckedHash ( )

inlineinherited

Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

The intent is for this routine to be called instead of directly calling the function Hash during "insert" operations. See TObject::HasInconsistenTObjectHash();

(*) The setup is consistent when all classes in the class hierarchy that overload TObject::Hash do call ROOT::CallRecursiveRemoveIfNeeded in their destructor. i.e. it is safe to call the Hash virtual function during the RecursiveRemove operation.

Definition at line 332 of file TObject.h.

◆ Class()

static TClass * TLegend::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TLegend::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TLegend::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 82 of file TLegend.h.

◆ ClassName()

const char * TObject::ClassName ( ) const

virtualinherited

Returns name of class to which the object belongs.

Definition at line 227 of file TObject.cxx.

◆ Clear()

void TLegend::Clear ( Option_t * option = "" )

overridevirtual

Clear all entries in this legend, including the header.

Reimplemented from TObject.

Definition at line 378 of file TLegend.cxx.

◆ Clone()

TObject * TObject::Clone ( const char * newname = "" ) const

virtualinherited

Make a clone of an object using the Streamer facility.

If the object derives from TNamed, this function is called by TNamed::Clone. TNamed::Clone uses the optional argument to set a new name to the newly created object.

If the object class has a DirectoryAutoAdd function, it will be called at the end of the function with the parameter gDirectory. This usually means that the object will be appended to the current ROOT directory.

Reimplemented in TMVA::MinuitWrapper, RooCatType, TImage, RooStudyPackage, RooLinkedList, RooStats::ModelConfig, TNamed, TCollection, TClass, TFunction, TFunctionTemplate, TMethod, TMethodCall, TASImage, TH1, TStreamerInfo, TMinuit, RooAbsStudy, RooDataHist, RooDataSet, RooWorkspace, TChainIndex, TTreeIndex, TF1, RooAbsArg, RooAbsBinning, RooAbsCollection, RooCmdArg, RooFitResult, RooTemplateProxy< T >, RooTemplateProxy< const RooHistFunc >, RooTemplateProxy< RooAbsCategory >, RooTemplateProxy< RooAbsPdf >, RooTemplateProxy< RooAbsReal >, RooTemplateProxy< RooAbsRealLValue >, RooTemplateProxy< RooMultiCategory >, RooTemplateProxy< RooRealVar >, and RooStats::HypoTestResult.

Definition at line 243 of file TObject.cxx.

◆ Compare()

Int_t TObject::Compare ( const TObject * obj ) const

virtualinherited

Compare abstract method.

Must be overridden if a class wants to be able to compare itself with other objects. Must return -1 if this is smaller than obj, 0 if objects are equal and 1 if this is larger than obj.

Reimplemented in TEnvRec, TFileInfo, TNamed, TObjString, TParameter< AParamType >, TParameter< Long64_t >, TUrl, TCollection, TGeoBranchArray, TGeoOverlap, TStructNode, TStructNodeProperty, TGFSFrameElement, TGLBFrameElement, RooAbsArg, and RooDouble.

Definition at line 258 of file TObject.cxx.

◆ ConvertNDCtoPad()

void TPave::ConvertNDCtoPad ( )

virtualinherited

Convert pave coordinates from NDC to Pad coordinates.

Definition at line 138 of file TPave.cxx.

◆ Copy() [1/4]

void TAttFill::Copy ( TAttFill & attfill ) const

inherited

Copy this fill attributes to a new TAttFill.

Definition at line 203 of file TAttFill.cxx.

◆ Copy() [2/4]

void TAttLine::Copy ( TAttLine & attline ) const

inherited

Copy this line attributes to a new TAttLine.

Definition at line 176 of file TAttLine.cxx.

◆ Copy() [3/4]

void TAttText::Copy ( TAttText & atttext ) const

inherited

Copy this text attributes to a new TAttText.

Definition at line 300 of file TAttText.cxx.

◆ Copy() [4/4]

void TLegend::Copy ( TObject & obj ) const

overridevirtual

Copy this legend into "obj".

Reimplemented from TBox.

Definition at line 387 of file TLegend.cxx.

◆ DeclFileName()

static const char * TLegend::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 82 of file TLegend.h.

◆ Delete()

void TObject::Delete ( Option_t * option = "" )

virtualinherited

Delete this object.

Typically called as a command via the interpreter. Normally use "delete" operator when object has been allocated on the heap.

Reimplemented in TDirectory, TDirectoryFile, TFile, TSystemDirectory, TSystemFile, TTreeViewer, TGItemContext, TCanvas, TGFrame, TGTextEdit, TAxis, RooLinkedList, TExMap, TObjectTable, TProtoClass, TKeySQL, TKeyXML, TQCommand, TBtree, TClonesArray, THashList, THashTable, TList, TMap, TObjArray, TOrdCollection, TRefArray, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TViewPubDataMembers, TViewPubFunctions, TThread, TKey, TMVA::Results, TTree, and TCollection.

Definition at line 268 of file TObject.cxx.

◆ DeleteEntry()

void TLegend::DeleteEntry ( )

virtual

Delete entry at the mouse position.

Definition at line 412 of file TLegend.cxx.

◆ DistancetoLine()

Int_t TAttLine::DistancetoLine	(	Int_t	px,
		Int_t	py,
		Double_t	xp1,
		Double_t	yp1,
		Double_t	xp2,
		Double_t	yp2 )

inherited

Compute distance from point px,py to a line.

Compute the closest distance of approach from point px,py to this line. The distance is computed in pixels units.

Algorithm:

  A(x1,y1)         P                             B(x2,y2)
  -----------------+------------------------------
                   |
                   |
                   |
                   |
                  M(x,y)
 
Let us call  a = distance AM     A=a**2
             b = distance BM     B=b**2
             c = distance AB     C=c**2
             d = distance PM     D=d**2
             u = distance AP     U=u**2
             v = distance BP     V=v**2     c = u + v
 
D = A - U
D = B - V  = B -(c-u)**2
   ==> u = (A -B +C)/2c

Definition at line 210 of file TAttLine.cxx.

◆ DistancetoPrimitive()

Int_t TPave::DistancetoPrimitive	(	Int_t	px,
		Int_t	py )

overridevirtualinherited

Compute distance from point px,py to a pave.

Compute the closest distance of approach from point px,py to the edges of this pave. The distance is computed in pixels units.

Reimplemented from TBox.

Definition at line 207 of file TPave.cxx.

◆ DoError()

void TObject::DoError	(	int	level,
		const char *	location,
		const char *	fmt,
		va_list	va ) const

protectedvirtualinherited

Interface to ErrorHandler (protected).

Reimplemented in TTreeViewer, and TThread.

Definition at line 1059 of file TObject.cxx.

◆ Draw()

void TLegend::Draw ( Option_t * option = "" )

overridevirtual

Draw this legend with its current attributes.

Reimplemented from TBox.

Definition at line 424 of file TLegend.cxx.

◆ DrawBox()

TBox * TBox::DrawBox	(	Double_t	x1,
		Double_t	y1,
		Double_t	x2,
		Double_t	y2 )

virtualinherited

Draw this box with new coordinates.

Definition at line 205 of file TBox.cxx.

◆ DrawClass()

void TObject::DrawClass ( ) const

virtualinherited

Draw class inheritance tree of the class to which this object belongs.

If a class B inherits from a class A, description of B is drawn on the right side of description of A. Member functions overridden by B are shown in class A with a blue line crossing-out the corresponding member function. The following picture is the class inheritance tree of class TPaveLabel:

Reimplemented in TSystemDirectory, TSystemFile, and TGFrame.

Definition at line 308 of file TObject.cxx.

◆ DrawClone()

TObject * TObject::DrawClone ( Option_t * option = "" ) const

virtualinherited

Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).

If pad was not selected - gPad will be used.

Note: For histograms, use the more specialised TH1::DrawCopy().

Reimplemented in TSystemDirectory, TSystemFile, TGFrame, TAxis, and TCanvas.

Definition at line 319 of file TObject.cxx.

◆ DrawPave()

TPave * TPave::DrawPave	(	Double_t	x1,
		Double_t	y1,
		Double_t	x2,
		Double_t	y2,
		Int_t	bordersize = 4,
		Option_t *	option = "br" )

virtualinherited

Draw this pave with new coordinates.

Definition at line 240 of file TPave.cxx.

◆ Dump()

void TObject::Dump ( ) const

virtualinherited

Dump contents of object on stdout.

Using the information in the object dictionary (class TClass) each data member is interpreted. If a data member is a pointer, the pointer value is printed

The following output is the Dump of a TArrow object:

fAngle                   0           Arrow opening angle (degrees)
fArrowSize               0.2         Arrow Size
fOption.*fData
fX1                      0.1         X of 1st point
fY1                      0.15        Y of 1st point
fX2                      0.67        X of 2nd point
fY2                      0.83        Y of 2nd point
fUniqueID                0           object unique identifier
fBits                    50331648    bit field status word
fLineColor               1           line color
fLineStyle               1           line style
fLineWidth               1           line width
fFillColor               19          fill area color
fFillStyle               1001        fill area style

Reimplemented in TSystemFile, TCollection, TClass, TGFrame, and TGPack.

Definition at line 367 of file TObject.cxx.

◆ EditEntryAttFill()

void TLegend::EditEntryAttFill ( )

virtual

Edit the fill attributes for the entry pointed by the mouse.

Definition at line 432 of file TLegend.cxx.

◆ EditEntryAttLine()

void TLegend::EditEntryAttLine ( )

virtual

Edit the line attributes for the entry pointed by the mouse.

Definition at line 443 of file TLegend.cxx.

◆ EditEntryAttMarker()

void TLegend::EditEntryAttMarker ( )

virtual

Edit the marker attributes for the entry pointed by the mouse.

Definition at line 454 of file TLegend.cxx.

◆ EditEntryAttText()

void TLegend::EditEntryAttText ( )

virtual

Edit the text attributes for the entry pointed by the mouse.

Definition at line 465 of file TLegend.cxx.

◆ Error()

void TObject::Error	(	const char *	location,
		const char *	fmt,
			... ) const

virtualinherited

Issue error message.

Use "location" to specify the method where the error occurred. Accepts standard printf formatting arguments.

Reimplemented in TFitResult.

Definition at line 1098 of file TObject.cxx.

◆ Execute() [1/2]

void TObject::Execute	(	const char *	method,
		const char *	params,
		Int_t *	error = nullptr )

virtualinherited

Execute method on this object with the given parameter string, e.g.

"3.14,1,\"text\"".

Reimplemented in TMethodCall, TCling, TInterpreter, ROOT::R::TRInterface, and TContextMenu.

Definition at line 378 of file TObject.cxx.

◆ Execute() [2/2]

void TObject::Execute	(	TMethod *	method,
		TObjArray *	params,
		Int_t *	error = nullptr )

virtualinherited

Execute method on this object with parameters stored in the TObjArray.

The TObjArray should contain an argv vector like:

argv[0] ... argv[n] = the list of TObjString parameters

TObjString

Collectable string class.

Definition TObjString.h:28

Reimplemented in TCling, TMethodCall, TInterpreter, ROOT::R::TRInterface, and TContextMenu.

Definition at line 398 of file TObject.cxx.

◆ ExecuteEvent()

void TPave::ExecuteEvent	(	Int_t	event,
		Int_t	px,
		Int_t	py )

overridevirtualinherited

Execute action corresponding to one event.

This member function is called when a PAVE object is clicked.

Reimplemented from TBox.

Definition at line 254 of file TPave.cxx.

◆ Fatal()

void TObject::Fatal	(	const char *	location,
		const char *	fmt,
			... ) const

virtualinherited

Issue fatal error message.

Use "location" to specify the method where the fatal error occurred. Accepts standard printf formatting arguments.

Definition at line 1126 of file TObject.cxx.

◆ FindObject() [1/2]

TObject * TObject::FindObject ( const char * name ) const

virtualinherited

Must be redefined in derived classes.

This function is typically used with TCollections, but can also be used to find an object by name inside this object.

Reimplemented in TListOfEnums, TMap, TDirectory, TFolder, TROOT, TListOfTypes, TListOfTypes, TBtree, TCollection, THashList, THashTable, TList, TObjArray, TListOfDataMembers, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TListOfFunctionTemplates, TViewPubDataMembers, TViewPubFunctions, TPad, TGeometry, THbookFile, TGraph, TGraph2D, TH1, RooAbsCollection, and RooLinkedList.

Definition at line 425 of file TObject.cxx.

◆ FindObject() [2/2]

TObject * TObject::FindObject ( const TObject * obj ) const

virtualinherited

Must be redefined in derived classes.

This function is typically used with TCollections, but can also be used to find an object inside this object.

Reimplemented in TMap, TDirectory, TFolder, TROOT, TListOfTypes, TBtree, TCollection, THashList, THashTable, TList, TObjArray, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TViewPubDataMembers, TViewPubFunctions, TPad, TGeometry, THbookFile, TGraph, TGraph2D, TH1, RooAbsCollection, and RooLinkedList.

Definition at line 435 of file TObject.cxx.

◆ GetBBox()

Rectangle_t TBox::GetBBox ( )

overridevirtualinherited

Return the "bounding Box" of the Box.

Implements TAttBBox2D.

Definition at line 637 of file TBox.cxx.

◆ GetBBoxCenter()

TPoint TAttBBox2D::GetBBoxCenter ( )

virtualinherited

Reimplemented in TPad, TCurlyArc, TCurlyLine, TEllipse, and TText.

Definition at line 40 of file TAttBBox2D.cxx.

◆ GetBorderSize()

Int_t TPave::GetBorderSize ( ) const

inlineinherited

Definition at line 56 of file TPave.h.

◆ GetColumnSeparation()

Float_t TLegend::GetColumnSeparation ( ) const

inline

Definition at line 46 of file TLegend.h.

◆ GetCornerRadius()

Double_t TPave::GetCornerRadius ( ) const

inlineinherited

Definition at line 57 of file TPave.h.

◆ GetDrawOption()

Option_t * TObject::GetDrawOption ( ) const

virtualinherited

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 in TBrowser, TFitEditor, TGedFrame, TGFileBrowser, TRootBrowser, and TRootBrowserLite.

Definition at line 445 of file TObject.cxx.

◆ GetDtorOnly()

Longptr_t TObject::GetDtorOnly ( )

staticinherited

Return destructor only flag.

Definition at line 1196 of file TObject.cxx.

◆ GetEntry()

TLegendEntry * TLegend::GetEntry ( ) const

Get entry pointed to by the mouse.

This method is mostly a tool for other methods inside this class.

Definition at line 477 of file TLegend.cxx.

◆ GetEntrySeparation()

Float_t TLegend::GetEntrySeparation ( ) const

inline

Definition at line 48 of file TLegend.h.

◆ GetFillColor()

virtual Color_t TAttFill::GetFillColor ( ) const

inlinevirtualinherited

Return the fill area color.

Reimplemented in TGraphMultiErrors, TGWin32, TGWin32VirtualXProxy, and TGX11.

Definition at line 32 of file TAttFill.h.

◆ GetFillStyle()

virtual Style_t TAttFill::GetFillStyle ( ) const

inlinevirtualinherited

Return the fill area style.

Reimplemented in TGraphMultiErrors, TGWin32, TGWin32VirtualXProxy, and TGX11.

Definition at line 33 of file TAttFill.h.

◆ GetHeader()

const char * TLegend::GetHeader ( ) const

virtual

Returns the header, which is the title that appears at the top of the legend.

Definition at line 520 of file TLegend.cxx.

◆ GetIconName()

const char * TObject::GetIconName ( ) const

virtualinherited

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 in TSystemFile, TGeoVolume, TASImage, TGMainFrame, TKey, ROOT::Experimental::XRooFit::xRooNode, TBranch, TVirtualBranchBrowsable, TMethodBrowsable, and TBranchElement.

Definition at line 472 of file TObject.cxx.

◆ GetLineColor()

virtual Color_t TAttLine::GetLineColor ( ) const

inlinevirtualinherited

Return the line color.

Reimplemented in TGraphMultiErrors, and TGWin32VirtualXProxy.

Definition at line 36 of file TAttLine.h.

◆ GetLineStyle()

virtual Style_t TAttLine::GetLineStyle ( ) const

inlinevirtualinherited

Return the line style.

Reimplemented in TGraphMultiErrors, TGWin32, TGWin32VirtualXProxy, and TGX11.

Definition at line 37 of file TAttLine.h.

◆ GetLineWidth()

virtual Width_t TAttLine::GetLineWidth ( ) const

inlinevirtualinherited

Return the line width.

Reimplemented in TGraphMultiErrors, TGWin32, TGWin32VirtualXProxy, and TGX11.

Definition at line 38 of file TAttLine.h.

◆ GetListOfPrimitives()

TList * TLegend::GetListOfPrimitives ( ) const

inline

Definition at line 50 of file TLegend.h.

◆ GetMargin()

Float_t TLegend::GetMargin ( ) const

inline

Definition at line 51 of file TLegend.h.

◆ GetName()

const char * TPave::GetName ( ) const

inlineoverridevirtualinherited

Returns name of object.

This default method returns the class name. Classes that give objects a name should override this method.

Reimplemented from TObject.

Definition at line 58 of file TPave.h.

◆ GetNColumns()

Int_t TLegend::GetNColumns ( ) const

inline

Definition at line 52 of file TLegend.h.

◆ GetNRows()

Int_t TLegend::GetNRows ( ) const

Get the number of rows.

Definition at line 585 of file TLegend.cxx.

◆ GetObjectInfo()

char * TObject::GetObjectInfo	(	Int_t	px,
		Int_t	py ) const

virtualinherited

Returns string containing info about the object at position (px,py).

This method is typically overridden by classes of which the objects can report peculiarities for different positions. Returned string will be re-used (lock in MT environment).

Reimplemented in TGeoNode, TGeoVolume, TGeoTrack, TASImage, TColorWheel, TAxis3D, TNode, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TF1, TF2, TGraph, TH1, THistPainter, TPaletteAxis, TFileDrawMap, TParallelCoordVar, and TVirtualHistPainter.

Definition at line 491 of file TObject.cxx.

◆ GetObjectStat()

Bool_t TObject::GetObjectStat ( )

staticinherited

Get status of object stat flag.

Definition at line 1181 of file TObject.cxx.

◆ GetOption()

Option_t * TPave::GetOption ( ) const

inlineoverridevirtualinherited

Reimplemented from TObject.

Definition at line 59 of file TPave.h.

◆ GetSavePaveArgs()

TString TPave::GetSavePaveArgs	(	const char *	extra_arg = nullptr,
		Bool_t	save_option = kTRUE )

protectedinherited

Returns arguments which should be used when saving primitive constructor Check if coordinates are initialized, add extra arguments and options.

Definition at line 610 of file TPave.cxx.

◆ GetShadowColor()

Int_t TPave::GetShadowColor ( ) const

inlineinherited

Definition at line 60 of file TPave.h.

◆ GetTextAlign()

virtual Short_t TAttText::GetTextAlign ( ) const

inlinevirtualinherited

Return the text alignment.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 35 of file TAttText.h.

◆ GetTextAngle()

virtual Float_t TAttText::GetTextAngle ( ) const

inlinevirtualinherited

Return the text angle.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 36 of file TAttText.h.

◆ GetTextColor()

virtual Color_t TAttText::GetTextColor ( ) const

inlinevirtualinherited

Return the text color.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 37 of file TAttText.h.

◆ GetTextFont()

virtual Font_t TAttText::GetTextFont ( ) const

inlinevirtualinherited

Return the text font.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 38 of file TAttText.h.

◆ GetTextSize()

virtual Float_t TAttText::GetTextSize ( ) const

inlinevirtualinherited

Return the text size.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 39 of file TAttText.h.

◆ GetTextSizePercent()

Float_t TAttText::GetTextSizePercent ( Float_t size )

virtualinherited

Return the text in percent of the pad size.

Return the text size in percent of the pad size.

If the font precision is greater than 2, the text size returned is the size in pixel converted into percent of the pad size, otherwise the size returned is the same as the size given as input parameter.

Definition at line 316 of file TAttText.cxx.

◆ GetTextSizePixels()

Float_t TAttText::GetTextSizePixels ( TVirtualPad & pad ) const

virtualinherited

Return the text size in pixels for specified pad.

Return the text size in pixels for the specified pad.

If the font precision less than 3 size defined as percent of pad size and scaled to minimal pad size

Definition at line 350 of file TAttText.cxx.

◆ GetTextSizeRelative()

Float_t TAttText::GetTextSizeRelative ( TVirtualPad & pad ) const

virtualinherited

Return the text size in relative units.

If the font precision grater then 2 use pad dimensions to get value

Definition at line 333 of file TAttText.cxx.

◆ GetTitle()

const char * TObject::GetTitle ( ) const

virtualinherited

Returns title of object.

This default method returns the class title (i.e. description). Classes that give objects a title should override this method.

Reimplemented in TNamed, TQCommand, TPair, TClassMenuItem, TBaseClass, TASImage, TPad, TGaxis, TPaveLabel, TEveGeoNode, TEvePointSet, TGTextButton, TGGroupFrame, TGLabel, TGTextLBEntry, TGLVEntry, TGTextEntry, TRootIconList, TAxis, TKey, TMapFile, TParticle, TPrimary, Axis2, TParallelCoordSelect, and TVirtualPad.

Definition at line 507 of file TObject.cxx.

◆ GetUniqueID()

UInt_t TObject::GetUniqueID ( ) const

virtualinherited

Return the unique object id.

Definition at line 480 of file TObject.cxx.

◆ GetX1()

Double_t TBox::GetX1 ( ) const

inlineinherited

Definition at line 51 of file TBox.h.

◆ GetX1NDC()

Double_t TPave::GetX1NDC ( ) const

inlineinherited

Definition at line 61 of file TPave.h.

◆ GetX2()

Double_t TBox::GetX2 ( ) const

inlineinherited

Definition at line 52 of file TBox.h.

◆ GetX2NDC()

Double_t TPave::GetX2NDC ( ) const

inlineinherited

Definition at line 62 of file TPave.h.

◆ GetXCoord()

Double_t TAttBBox2D::GetXCoord	(	const Int_t	x,
		Bool_t	is_ndc = kFALSE )

protectedinherited

Definition at line 60 of file TAttBBox2D.cxx.

◆ GetY1()

Double_t TBox::GetY1 ( ) const

inlineinherited

Definition at line 53 of file TBox.h.

◆ GetY1NDC()

Double_t TPave::GetY1NDC ( ) const

inlineinherited

Definition at line 63 of file TPave.h.

◆ GetY2()

Double_t TBox::GetY2 ( ) const

inlineinherited

Definition at line 54 of file TBox.h.

◆ GetY2NDC()

Double_t TPave::GetY2NDC ( ) const

inlineinherited

Definition at line 64 of file TPave.h.

◆ GetYCoord()

Double_t TAttBBox2D::GetYCoord	(	const Int_t	y,
		Bool_t	is_ndc = kFALSE )

protectedinherited

Definition at line 76 of file TAttBBox2D.cxx.

◆ HandleTimer()

Bool_t TObject::HandleTimer ( TTimer * timer )

virtualinherited

Execute action in response of a timer timing out.

This method must be overridden if an object has to react to timers.

Reimplemented in TGWindow, TGuiBldDragManager, TGraphTime, TGLEventHandler, TGCommandPlugin, TGDNDManager, TGFileContainer, TGPopupMenu, TGScrollBar, TGShutter, TGTextEdit, TGTextEditor, TGTextEntry, TGTextView, TGToolTip, TGHtml, and TTreeViewer.

Definition at line 516 of file TObject.cxx.

◆ Hash()

ULong_t TPave::Hash ( ) const

inlineoverridevirtualinherited

Return hash value for this object.

Note: If this routine is overloaded in a derived class, this derived class should also add

ROOT::CallRecursiveRemoveIfNeeded(*this)

ROOT::CallRecursiveRemoveIfNeeded

void CallRecursiveRemoveIfNeeded(TObject &obj)

call RecursiveRemove for obj if gROOT is valid and obj.TestBit(kMustCleanup) is true.

Definition TROOT.h:406

Otherwise, when RecursiveRemove is called (by ~TObject or example) for this type of object, the transversal of THashList and THashTable containers will will have to be done without call Hash (and hence be linear rather than logarithmic complexity). You will also see warnings like

Error in <ROOT::Internal::TCheckHashRecursiveRemoveConsistency::CheckRecursiveRemove>: The class SomeName overrides

TObject::Hash but does not call TROOT::RecursiveRemove in its destructor.

TObject::Error

virtual void Error(const char *method, const char *msgfmt,...) const

Issue error message.

Definition TObject.cxx:1098

TPave::Hash

ULong_t Hash() const override

Return hash value for this object.

Definition TPave.h:65

TROOT::RecursiveRemove

void RecursiveRemove(TObject *obj) override

Recursively remove this object from the list of Cleanups.

Definition TROOT.cxx:2651

Reimplemented from TObject.

Definition at line 65 of file TPave.h.

◆ HasInconsistentHash()

Bool_t TObject::HasInconsistentHash ( ) const

inlineinherited

Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

missing call to RecursiveRemove in destructor).

Note: Since the consistency is only tested for during inserts, this routine will return true for object that have never been inserted whether or not they have a consistent setup. This has no negative side-effect as searching for the object with the right or wrong Hash will always yield a not-found answer (Since anyway no hash can be guaranteed unique, there is always a check)

Definition at line 366 of file TObject.h.

◆ HideToolTip()

void TBox::HideToolTip ( Int_t event )

virtualinherited

Hide tool tip depending on the event type.

Typically tool tips are hidden when event is not a kMouseEnter and not a kMouseMotion event.

Definition at line 504 of file TBox.cxx.

◆ Info()

void TObject::Info	(	const char *	location,
		const char *	fmt,
			... ) const

virtualinherited

Issue info message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1072 of file TObject.cxx.

◆ InheritsFrom() [1/2]

Bool_t TObject::InheritsFrom ( const char * classname ) const

virtualinherited

Returns kTRUE if object inherits from class "classname".

Reimplemented in TClass.

Definition at line 549 of file TObject.cxx.

◆ InheritsFrom() [2/2]

Bool_t TObject::InheritsFrom ( const TClass * cl ) const

virtualinherited

Returns kTRUE if object inherits from TClass cl.

Reimplemented in TClass.

Definition at line 557 of file TObject.cxx.

◆ InsertEntry()

void TLegend::InsertEntry	(	const char *	objectName = "",
		const char *	label = "",
		Option_t *	option = "lpf" )

virtual

Add a new entry before the entry at the mouse position.

Definition at line 535 of file TLegend.cxx.

◆ Inspect()

void TObject::Inspect ( ) const

virtualinherited

Dump contents of this object in a graphics canvas.

Same action as Dump but in a graphical form. In addition pointers to other objects can be followed.

The following picture is the Inspect of a histogram object:

Reimplemented in TSystemFile, TInspectorObject, TGFrame, and ROOT::Experimental::XRooFit::xRooNode.

Definition at line 570 of file TObject.cxx.

◆ InvertBit()

void TObject::InvertBit ( UInt_t f )

inlineinherited

Definition at line 206 of file TObject.h.

◆ IsA()

TClass * TLegend::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TBox.

Definition at line 82 of file TLegend.h.

◆ IsBeingResized()

Bool_t TBox::IsBeingResized ( ) const

inlineinherited

Definition at line 50 of file TBox.h.

◆ IsDestructed()

Bool_t TObject::IsDestructed ( ) const

inlineinherited

IsDestructed.

Note: This function must be non-virtual as it can be used on destructed (but not yet modified) memory. This is used for example in TClonesArray to record the element that have been destructed but not deleted and thus are ready for re-use (by operator new with placement).

Returns: true if this object's destructor has been run.

Definition at line 186 of file TObject.h.

◆ IsEqual()

Bool_t TObject::IsEqual ( const TObject * obj ) const

virtualinherited

Default equal comparison (objects are equal if they have the same address in memory).

More complicated classes might want to override this function.

Reimplemented in TObjString, TQCommand, TPair, and TGObject.

Definition at line 589 of file TObject.cxx.

◆ IsFolder()

Bool_t TObject::IsFolder ( ) const

virtualinherited

Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

Reimplemented in TDirectory, TFolder, TRemoteObject, TROOT, TSystemDirectory, TTask, TCollection, TPair, TBrowserObject, TBaseClass, TClass, TGeoManager, TGeoNode, TGeoNodeMatrix, TGeoVolume, TGeoOverlap, TGeoTrack, TCanvas, TPad, TAxis3D, TGeometry, TNode, TRootIconList, THbookFile, THbookKey, THnBase, ROOT::Internal::THnBaseBrowsable, TMultiDimFit, TPrincipal, TKey, TMapFile, TSPlot, TDatabasePDG, TParticleClassPDG, TApplicationRemote, ROOT::Experimental::XRooFit::xRooNode, TBranch, TVirtualBranchBrowsable, TBranchClones, TBranchElement, TBranchObject, TBranchSTL, and TTree.

Definition at line 579 of file TObject.cxx.

◆ IsInside()

Int_t TBox::IsInside	(	Double_t	x,
		Double_t	y ) const

virtualinherited

Function which returns 1 if point x,y lies inside the box, 0 otherwise.

Reimplemented in TDiamond.

Definition at line 513 of file TBox.cxx.

◆ IsOnHeap()

R__ALWAYS_INLINE Bool_t TObject::IsOnHeap ( ) const

inlineinherited

Definition at line 160 of file TObject.h.

◆ IsSortable()

Bool_t TPave::IsSortable ( ) const

inlineoverridevirtualinherited

Reimplemented from TObject.

Definition at line 66 of file TPave.h.

◆ IsTransparent()

Bool_t TAttFill::IsTransparent ( ) const

inlinevirtualinherited

Reimplemented in TGWin32VirtualXProxy.

Definition at line 49 of file TAttFill.h.

◆ IsZombie()

R__ALWAYS_INLINE Bool_t TObject::IsZombie ( ) const

inlineinherited

Definition at line 161 of file TObject.h.

◆ ls()

void TPave::ls ( Option_t * option = "" ) const

overridevirtualinherited

List this pave with its attributes.

Reimplemented from TBox.

Definition at line 278 of file TPave.cxx.

◆ MakeZombie()

void TObject::MakeZombie ( )

inlineprotectedinherited

Definition at line 55 of file TObject.h.

◆ MayNotUse()

void TObject::MayNotUse ( const char * method ) const

inherited

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

Definition at line 1160 of file TObject.cxx.

◆ Modify() [1/3]

void TAttFill::Modify ( )

virtualinherited

Change current fill area attributes if necessary.

Definition at line 212 of file TAttFill.cxx.

◆ Modify() [2/3]

void TAttLine::Modify ( )

virtualinherited

Change current line attributes if necessary.

Definition at line 246 of file TAttLine.cxx.

◆ Modify() [3/3]

void TAttText::Modify ( )

virtualinherited

Change current text attributes if necessary.

Definition at line 364 of file TAttText.cxx.

◆ ModifyOn() [1/3]

void TAttFill::ModifyOn ( TVirtualPad & pad )

virtualinherited

Change current fill area attributes on speicifed pad.

Definition at line 221 of file TAttFill.cxx.

◆ ModifyOn() [2/3]

void TAttLine::ModifyOn ( TVirtualPad & pad )

virtualinherited

Change current line attributes on specified pad.

Definition at line 255 of file TAttLine.cxx.

◆ ModifyOn() [3/3]

void TAttText::ModifyOn ( TVirtualPad & pad )

virtualinherited

Change current text attributes if necessary on specified pad.

Definition at line 373 of file TAttText.cxx.

◆ Notify()

Bool_t TObject::Notify ( )

virtualinherited

This method must be overridden to handle object notification (the base implementation is no-op).

Different objects in ROOT use the Notify method for different purposes, in coordination with other objects that call this method at the appropriate time.

For example, TLeaf uses it to load class information; TBranchRef to load contents of referenced branches TBranchRef; most notably, based on Notify, TChain implements a callback mechanism to inform interested parties when it switches to a new sub-tree.

Reimplemented in TMessageHandler, TNotifyLink< Type >, TNotifyLink< RNoCleanupNotifierHelper >, TNotifyLink< ROOT::Detail::TBranchProxy >, TNotifyLink< TTreeReader >, TFileHandler, TSignalHandler, TStdExceptionHandler, TProcessEventTimer, TTimer, TIdleTimer, TSingleShotCleaner, TCollection, TRefTable, TBrowserTimer, TInterruptHandler, TTermInputHandler, TThreadTimer, TGLRedrawTimer, TViewTimer, TGContainerKeyboardTimer, TGContainerScrollTimer, TGInputHandler, TViewUpdateTimer, TPopupDelayTimer, TRepeatTimer, TSBRepeatTimer, TGTextEditHist, TInsCharCom, TDelCharCom, TBreakLineCom, TInsTextCom, TDelTextCom, TBlinkTimer, TTipDelayTimer, TGuiBldDragManagerRepeatTimer, TARInterruptHandler, TASLogHandler, TASInterruptHandler, TASSigPipeHandler, TASInputHandler, TSocketHandler, TTimeOutTimer, TBranchElement, TBranchRef, TLeafObject, TSelector, TTree, TSelectorDraw, TSelectorEntries, TTreeFormula, TTreeFormulaManager, TTreeReader, h1analysis, h1analysisTreeReader, and TSysEvtHandler.

Definition at line 618 of file TObject.cxx.

◆ Obsolete()

void TObject::Obsolete	(	const char *	method,
		const char *	asOfVers,
		const char *	removedFromVers ) const

inherited

Use this method to declare a method obsolete.

Specify as of which version the method is obsolete and as from which version it will be removed.

Definition at line 1169 of file TObject.cxx.

◆ operator delete() [1/3]

void TObject::operator delete	(	void *	ptr,
		size_t	size )

inherited

Operator delete for sized deallocation.

Definition at line 1234 of file TObject.cxx.

◆ operator delete() [2/3]

void TObject::operator delete ( void * ptr )

inherited

Operator delete.

Definition at line 1212 of file TObject.cxx.

◆ operator delete() [3/3]

void TObject::operator delete	(	void *	ptr,
		void *	vp )

inherited

Only called by placement new when throwing an exception.

Definition at line 1266 of file TObject.cxx.

◆ operator delete[]() [1/3]

void TObject::operator delete[]	(	void *	ptr,
		size_t	size )

inherited

Operator delete [] for sized deallocation.

Definition at line 1245 of file TObject.cxx.

◆ operator delete[]() [2/3]

void TObject::operator delete[] ( void * ptr )

inherited

Operator delete [].

Definition at line 1223 of file TObject.cxx.

◆ operator delete[]() [3/3]

void TObject::operator delete[]	(	void *	ptr,
		void *	vp )

inherited

Only called by placement new[] when throwing an exception.

Definition at line 1274 of file TObject.cxx.

◆ operator new() [1/2]

void * TObject::operator new ( size_t sz )

inlineinherited

Definition at line 189 of file TObject.h.

◆ operator new() [2/2]

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

inlineinherited

Definition at line 191 of file TObject.h.

◆ operator new[]() [1/2]

void * TObject::operator new[] ( size_t sz )

inlineinherited

Definition at line 190 of file TObject.h.

◆ operator new[]() [2/2]

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

inlineinherited

Definition at line 192 of file TObject.h.

◆ operator=()

TLegend & TLegend::operator= ( const TLegend & lg )

protected

Assignment operator.

Definition at line 289 of file TLegend.cxx.

◆ Paint()

void TLegend::Paint ( Option_t * option = "" )

overridevirtual

Paint this legend with its current attributes.

Reimplemented from TBox.

Definition at line 560 of file TLegend.cxx.

◆ PaintBox()

void TBox::PaintBox	(	Double_t	x1,
		Double_t	y1,
		Double_t	x2,
		Double_t	y2,
		Option_t *	option = "" )

virtualinherited

Draw this box with new coordinates.

Definition at line 540 of file TBox.cxx.

◆ PaintPave()

void TPave::PaintPave	(	Double_t	x1,
		Double_t	y1,
		Double_t	x2,
		Double_t	y2,
		Int_t	bordersize = 4,
		Option_t *	option = "br" )

virtualinherited

Draw this pave with new coordinates.

Definition at line 314 of file TPave.cxx.

◆ PaintPaveArc()

void TPave::PaintPaveArc	(	Double_t	x1,
		Double_t	y1,
		Double_t	x2,
		Double_t	y2,
		Int_t	bordersize = 4,
		Option_t *	option = "br" )

virtualinherited

Draw this pave with rounded corners.

Definition at line 401 of file TPave.cxx.

◆ PaintPrimitives()

void TLegend::PaintPrimitives ( )

virtual

Paint the entries (list of primitives) for this legend.

Definition at line 617 of file TLegend.cxx.

◆ Pop()

void TObject::Pop ( )

virtualinherited

Pop on object drawn in a pad to the top of the display list.

I.e. it will be drawn last and on top of all other primitives.

Reimplemented in TPad, TFrame, and TVirtualPad.

Definition at line 640 of file TObject.cxx.

◆ Print()

void TLegend::Print ( Option_t * option = "" ) const

overridevirtual

Dump this TLegend and its contents.

Reimplemented from TBox.

Definition at line 990 of file TLegend.cxx.

◆ Read()

Int_t TObject::Read ( const char * name )

virtualinherited

Read contents of object with specified name from the current directory.

First the key with the given name is searched in the current directory, next the key buffer is deserialized into the object. The object must have been created before via the default constructor. See TObject::Write().

Reimplemented in TKeyXML, TBuffer, TKey, and TKeySQL.

Definition at line 673 of file TObject.cxx.

◆ RecursiveRemove()

void TLegend::RecursiveRemove ( TObject * obj )

overridevirtual

Reset the legend entries pointing to "obj".

Reimplemented from TObject.

Definition at line 999 of file TLegend.cxx.

◆ ResetAttFill()

void TAttFill::ResetAttFill ( Option_t * option = "" )

virtualinherited

Reset this fill attributes to default values.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 231 of file TAttFill.cxx.

◆ ResetAttLine()

void TAttLine::ResetAttLine ( Option_t * option = "" )

virtualinherited

Reset this line attributes to default values.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 279 of file TAttLine.cxx.

◆ ResetAttText()

void TAttText::ResetAttText ( Option_t * toption = "" )

virtualinherited

Reset this text attributes to default values.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 387 of file TAttText.cxx.

◆ ResetBit()

void TObject::ResetBit ( UInt_t f )

inlineinherited

Definition at line 203 of file TObject.h.

◆ SaveAs()

void TObject::SaveAs	(	const char *	filename = "",
		Option_t *	option = "" ) const

virtualinherited

Save this object in the file specified by filename.

if "filename" contains ".root" the object is saved in filename as root binary file.
if "filename" contains ".xml" the object is saved in filename as a xml ascii file.
if "filename" contains ".cc" the object is saved in filename as C code independent from ROOT. The code is generated via SavePrimitive(). Specific code should be implemented in each object to handle this option. Like in TF1::SavePrimitive().
otherwise the object is written to filename as a CINT/C++ script. The C++ code to rebuild this object is generated via SavePrimitive(). The "option" parameter is passed to SavePrimitive. By default it is an empty string. It can be used to specify the Draw option in the code generated by SavePrimitive.

The function is available via the object context menu.

Reimplemented in TSpline, TFolder, TGeoVolume, TClassTree, TPad, TPaveClass, TGObject, TSpline3, TSpline5, ROOT::Experimental::XRooFit::xRooNode, TTreePerfStats, TVirtualPad, TGraph, and TH1.

Definition at line 708 of file TObject.cxx.

◆ SaveFillAttributes()

void TAttFill::SaveFillAttributes	(	std::ostream &	out,
		const char *	name,
		Int_t	coldef = 1,
		Int_t	stydef = 1001 )

virtualinherited

Save fill attributes as C++ statement(s) on output stream out.

Definition at line 240 of file TAttFill.cxx.

◆ SaveLineAttributes()

void TAttLine::SaveLineAttributes	(	std::ostream &	out,
		const char *	name,
		Int_t	coldef = 1,
		Int_t	stydef = 1,
		Int_t	widdef = 1 )

virtualinherited

Save line attributes as C++ statement(s) on output stream out.

Definition at line 289 of file TAttLine.cxx.

◆ SavePrimitive()

void TLegend::SavePrimitive	(	std::ostream &	out,
		Option_t *	option = "" )

overridevirtual

Save this legend as C++ statements on output stream out to be used with the SaveAs .C option.

Reimplemented from TBox.

Definition at line 1012 of file TLegend.cxx.

◆ SavePrimitiveConstructor()

void TObject::SavePrimitiveConstructor	(	std::ostream &	out,
		TClass *	cl,
		const char *	variable_name,
		const char *	constructor_agrs = "",
		Bool_t	empty_line = kTRUE )

staticprotectedinherited

Save object constructor in the output stream "out".

Can be used as first statement when implementing SavePrimitive() method for the object

Definition at line 777 of file TObject.cxx.

◆ SavePrimitiveDraw()

void TObject::SavePrimitiveDraw	(	std::ostream &	out,
		const char *	variable_name,
		Option_t *	option = nullptr )

staticprotectedinherited

Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.

Definition at line 845 of file TObject.cxx.

◆ SavePrimitiveVector()

TString TObject::SavePrimitiveVector	(	std::ostream &	out,
		const char *	prefix,
		Int_t	len,
		Double_t *	arr,
		Int_t	flag = 0 )

staticprotectedinherited

Save array in the output stream "out" as vector.

Create unique variable name based on prefix value Returns name of vector which can be used in constructor or in other places of C++ code If flag === kTRUE, just add empty line If flag === 111, check if array is empty and return nullptr or <vectorname>.data()

Definition at line 796 of file TObject.cxx.

◆ SaveTextAttributes()

void TAttText::SaveTextAttributes	(	std::ostream &	out,
		const char *	name,
		Int_t	alidef = 12,
		Float_t	angdef = 0,
		Int_t	coldef = 1,
		Int_t	fondef = 61,
		Float_t	sizdef = 1 )

virtualinherited

Save text attributes as C++ statement(s) on output stream out.

Definition at line 399 of file TAttText.cxx.

◆ SetBBoxCenter()

void TAttBBox2D::SetBBoxCenter ( const TPoint & p )

virtualinherited

Reimplemented in TPad, TCurlyArc, TCurlyLine, TEllipse, and TText.

Definition at line 50 of file TAttBBox2D.cxx.

◆ SetBBoxCenterX()

void TBox::SetBBoxCenterX ( const Int_t x )

overridevirtualinherited

Set X coordinate of the center of the Box.

Implements TAttBBox2D.

Definition at line 663 of file TBox.cxx.

◆ SetBBoxCenterY()

void TBox::SetBBoxCenterY ( const Int_t y )

overridevirtualinherited

Set Y coordinate of the center of the Box.

Implements TAttBBox2D.

Definition at line 674 of file TBox.cxx.

◆ SetBBoxX1()

void TBox::SetBBoxX1 ( const Int_t x )

overridevirtualinherited

Set left hand side of BoundingBox to a value (resize in x direction on left)

Implements TAttBBox2D.

Definition at line 686 of file TBox.cxx.

◆ SetBBoxX2()

void TBox::SetBBoxX2 ( const Int_t x )

overridevirtualinherited

Set right hand side of BoundingBox to a value (resize in x direction on right)

Implements TAttBBox2D.

Definition at line 695 of file TBox.cxx.

◆ SetBBoxY1()

void TBox::SetBBoxY1 ( const Int_t y )

overridevirtualinherited

Set top of BoundingBox to a value (resize in y direction on top)

Implements TAttBBox2D.

Definition at line 703 of file TBox.cxx.

◆ SetBBoxY2()

void TBox::SetBBoxY2 ( const Int_t y )

overridevirtualinherited

Set bottom of BoundingBox to a value (resize in y direction on bottom)

Implements TAttBBox2D.

Definition at line 712 of file TBox.cxx.

◆ SetBit() [1/2]

void TObject::SetBit ( UInt_t f )

inlineinherited

Definition at line 202 of file TObject.h.

◆ SetBit() [2/2]

void TObject::SetBit	(	UInt_t	f,
		Bool_t	set )

inherited

Set or unset the user status bits as specified in f.

Definition at line 888 of file TObject.cxx.

◆ SetBorderSize()

virtual void TPave::SetBorderSize ( Int_t bordersize = 4 )

inlinevirtualinherited

Sets the border size of the TPave box and shadow.

Parameters

bordersize 0: disable shadow and box, 1: disable only shadow, 2+: tunes the shadow border size

Definition at line 79 of file TPave.h.

◆ SetColumnSeparation()

void TLegend::SetColumnSeparation ( Float_t columnSeparation )

inline

Definition at line 62 of file TLegend.h.

◆ SetCornerRadius()

virtual void TPave::SetCornerRadius ( Double_t rad = 0.2 )

inlinevirtualinherited

Definition at line 80 of file TPave.h.

◆ SetDefaults()

void TLegend::SetDefaults ( )

inline

Definition at line 61 of file TLegend.h.

◆ SetDrawOption()

void TObject::SetDrawOption ( Option_t * option = "" )

virtualinherited

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 in TSystemDirectory, TSystemFile, TPad, TGFrame, TAxis, TBrowser, TPaveStats, TGedFrame, TRootBrowserLite, and RooPlot.

Definition at line 871 of file TObject.cxx.

◆ SetDtorOnly()

void TObject::SetDtorOnly ( void * obj )

staticinherited

Set destructor only flag.

Definition at line 1204 of file TObject.cxx.

◆ SetEntryLabel()

void TLegend::SetEntryLabel ( const char * label )

virtual

Edit the label of the entry pointed to by the mouse.

Definition at line 1035 of file TLegend.cxx.

◆ SetEntryOption()

void TLegend::SetEntryOption ( Option_t * option )

virtual

Edit the option of the entry pointed to by the mouse.

Definition at line 1044 of file TLegend.cxx.

◆ SetEntrySeparation()

void TLegend::SetEntrySeparation ( Float_t entryseparation )

inline

Definition at line 66 of file TLegend.h.

◆ SetFillAttributes()

void TAttFill::SetFillAttributes ( )

virtualinherited

Invoke the DialogCanvas Fill attributes.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 251 of file TAttFill.cxx.

◆ SetFillColor() [1/2]

virtual void TAttFill::SetFillColor ( Color_t fcolor )

inlinevirtualinherited

Set the fill area color.

Reimplemented in TVirtualX, TGQuartz, TGWin32, TGWin32VirtualXProxy, TGX11, TPDF, TPostScript, TSVG, TTeXDump, TSpider, and TGraphMultiErrors.

Definition at line 40 of file TAttFill.h.

◆ SetFillColor() [2/2]

void TAttFill::SetFillColor ( TColorNumber lcolor )

inherited

Set a fill color.

Definition at line 270 of file TAttFill.cxx.

◆ SetFillColorAlpha()

void TAttFill::SetFillColorAlpha	(	Color_t	fcolor,
		Float_t	falpha )

virtualinherited

Set a transparent fill color.

Parameters

fcolor	defines the fill color
falpha	defines the percentage of opacity from 0. (fully transparent) to 1. (fully opaque).

Note: falpha is ignored (treated as 1) if the TCanvas has no GL support activated.

Reimplemented in TGraphMultiErrors.

Definition at line 262 of file TAttFill.cxx.

◆ SetFillStyle()

virtual void TAttFill::SetFillStyle ( Style_t fstyle )

inlinevirtualinherited

Set the fill area style.

Reimplemented in TGraphMultiErrors, TPad, TSpider, TVirtualX, TGQuartz, TGWin32, TGWin32VirtualXProxy, and TGX11.

Definition at line 42 of file TAttFill.h.

◆ SetHeader()

void TLegend::SetHeader	(	const char *	header = "",
		Option_t *	option = "" )

virtual

Sets the header, which is the "title" that appears at the top of the legend.

If option contains C, the title will be centered.

Definition at line 1054 of file TLegend.cxx.

◆ SetLineAttributes()

void TAttLine::SetLineAttributes ( )

virtualinherited

Invoke the DialogCanvas Line attributes.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 306 of file TAttLine.cxx.

◆ SetLineColor() [1/2]

virtual void TAttLine::SetLineColor ( Color_t lcolor )

inlinevirtualinherited

Set the line color.

Reimplemented in TEveTrackList, ROOT::Experimental::REveTrackList, TVirtualX, TGQuartz, TGWin32, TGWin32VirtualXProxy, TGX11, TPDF, TPostScript, TSVG, TTeXDump, TEveLine, TEveStraightLineSet, ROOT::Experimental::REveLine, ROOT::Experimental::REveStraightLineSet, TParallelCoordRange, TSpider, TGraphMultiErrors, TGeoVolume, and TGeoVolumeMulti.

Definition at line 44 of file TAttLine.h.

◆ SetLineColor() [2/2]

void TAttLine::SetLineColor ( TColorNumber lcolor )

inherited

Definition at line 322 of file TAttLine.cxx.

◆ SetLineColorAlpha()

void TAttLine::SetLineColorAlpha	(	Color_t	lcolor,
		Float_t	lalpha )

virtualinherited

Set a transparent line color.

Parameters

lcolor	defines the line color
lalpha	defines the percentage of opacity from 0. (fully transparent) to 1. (fully opaque).

Note: lalpha is ignored (treated as 1) if the TCanvas has no GL support activated.

Reimplemented in TGraphMultiErrors.

Definition at line 317 of file TAttLine.cxx.

◆ SetLineStyle()

virtual void TAttLine::SetLineStyle ( Style_t lstyle )

inlinevirtualinherited

Set the line style.

Reimplemented in TVirtualX, TGQuartz, TGWin32, TGWin32VirtualXProxy, TGX11, TPDF, TPostScript, TSVG, TTeXDump, TGraphMultiErrors, TGeoVolume, TGeoVolumeMulti, TEveLine, ROOT::Experimental::REveLine, TEveTrackList, ROOT::Experimental::REveTrackList, and TSpider.

Definition at line 46 of file TAttLine.h.

◆ SetLineWidth()

virtual void TAttLine::SetLineWidth ( Width_t lwidth )

inlinevirtualinherited

Set the line width.

Reimplemented in TPDF, TPostScript, TSVG, TTeXDump, TGraphMultiErrors, TGeoVolume, TGeoVolumeMulti, TEveLine, ROOT::Experimental::REveLine, TEveTrackList, ROOT::Experimental::REveTrackList, TParallelCoordRange, TSpider, TVirtualX, TGQuartz, TGWin32, TGWin32VirtualXProxy, TGX11, and TPaletteAxis.

Definition at line 47 of file TAttLine.h.

◆ SetMargin()

void TLegend::SetMargin ( Float_t margin )

inline

Definition at line 69 of file TLegend.h.

◆ SetName()

virtual void TPave::SetName ( const char * name = "" )

inlinevirtualinherited

Definition at line 81 of file TPave.h.

◆ SetNColumns()

void TLegend::SetNColumns ( Int_t nColumns )

Set the number of columns for the legend.

The header, if set, is given its own row. After that, every nColumns entries are inserted into the same row. For example, if one calls legend.SetNColumns(2), and there is no header, then the first two TObjects added to the legend will be in the first row, the next two will appear in the second row, and so on.

Definition at line 605 of file TLegend.cxx.

◆ SetObjectStat()

void TObject::SetObjectStat ( Bool_t stat )

staticinherited

Turn on/off tracking of objects in the TObjectTable.

Definition at line 1188 of file TObject.cxx.

◆ SetOption()

virtual void TPave::SetOption ( Option_t * option = "br" )

inlinevirtualinherited

Reimplemented in TPaveStats.

Definition at line 82 of file TPave.h.

◆ SetShadowColor()

virtual void TPave::SetShadowColor ( Int_t color )

inlinevirtualinherited

Definition at line 83 of file TPave.h.

◆ SetTextAlign()

virtual void TAttText::SetTextAlign ( Short_t align = 11 )

inlinevirtualinherited

Set the text alignment.

Reimplemented in TVirtualX, TGQuartz, TGWin32, TGWin32VirtualXProxy, and TGX11.

Definition at line 48 of file TAttText.h.

◆ SetTextAngle()

virtual void TAttText::SetTextAngle ( Float_t tangle = 0 )

inlinevirtualinherited

Set the text angle.

Reimplemented in TGWin32VirtualXProxy, and TGraphNode.

Definition at line 49 of file TAttText.h.

◆ SetTextAttributes()

void TAttText::SetTextAttributes ( )

virtualinherited

Invoke the DialogCanvas Text attributes.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 418 of file TAttText.cxx.

◆ SetTextColor() [1/2]

virtual void TAttText::SetTextColor ( Color_t tcolor = 1 )

inlinevirtualinherited

Set the text color.

Reimplemented in TVirtualX, TGQuartz, TGWin32, TGX11, TPDF, TPostScript, TSVG, TTeXDump, and TGWin32VirtualXProxy.

Definition at line 50 of file TAttText.h.

◆ SetTextColor() [2/2]

void TAttText::SetTextColor ( TColorNumber lcolor )

inherited

Definition at line 453 of file TAttText.cxx.

◆ SetTextColorAlpha()

void TAttText::SetTextColorAlpha	(	Color_t	tcolor,
		Float_t	talpha )

virtualinherited

Set a transparent text color.

Parameters

tcolor	defines the text color
talpha	defines the percentage of opacity from 0. (fully transparent) to 1. (fully opaque).

Note: talpha is ignored (treated as 1) if the TCanvas has no GL support activated.

Definition at line 430 of file TAttText.cxx.

◆ SetTextFont()

virtual void TAttText::SetTextFont ( Font_t tfont = 62 )

inlinevirtualinherited

Set the text font.

Reimplemented in TVirtualX, TGQuartz, TGWin32, TGX11, and TGWin32VirtualXProxy.

Definition at line 52 of file TAttText.h.

◆ SetTextSize()

virtual void TAttText::SetTextSize ( Float_t tsize = 1 )

inlinevirtualinherited

Set the text size.

Reimplemented in TVirtualX, TGQuartz, TGWin32, TGX11, and TGWin32VirtualXProxy.

Definition at line 53 of file TAttText.h.

◆ SetTextSizePixels()

void TAttText::SetTextSizePixels ( Int_t npixels )

virtualinherited

Set the text size in pixel.

Set the text size in pixels.

If the font precision is greater than 2, the text size is set to npixels, otherwise the text size is computed as a percent of the pad size.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 441 of file TAttText.cxx.

◆ SetToolTipText()

void TBox::SetToolTipText	(	const char *	text,
		Long_t	delayms = 1000 )

virtualinherited

Set tool tip text associated with this box.

The delay is in milliseconds (minimum 250). To remove tool tip call method with text = 0.

Definition at line 589 of file TBox.cxx.

◆ SetUniqueID()

void TObject::SetUniqueID ( UInt_t uid )

virtualinherited

Set the unique object id.

Definition at line 899 of file TObject.cxx.

◆ SetX1()

void TPave::SetX1 ( Double_t x1 )

overridevirtualinherited

Set the X1 value.

Reimplemented from TBox.

Definition at line 657 of file TPave.cxx.

◆ SetX1NDC()

virtual void TPave::SetX1NDC ( Double_t x1 )

inlinevirtualinherited

Definition at line 84 of file TPave.h.

◆ SetX2()

void TPave::SetX2 ( Double_t x2 )

overridevirtualinherited

Set the X2 value.

Reimplemented from TBox.

Definition at line 670 of file TPave.cxx.

◆ SetX2NDC()

virtual void TPave::SetX2NDC ( Double_t x2 )

inlinevirtualinherited

Definition at line 85 of file TPave.h.

◆ SetY1()

void TPave::SetY1 ( Double_t y1 )

overridevirtualinherited

Set the Y1 value.

Reimplemented from TBox.

Definition at line 683 of file TPave.cxx.

◆ SetY1NDC()

virtual void TPave::SetY1NDC ( Double_t y1 )

inlinevirtualinherited

Definition at line 86 of file TPave.h.

◆ SetY2()

void TPave::SetY2 ( Double_t y2 )

overridevirtualinherited

Set the Y2 value.

Reimplemented from TBox.

Definition at line 696 of file TPave.cxx.

◆ SetY2NDC()

virtual void TPave::SetY2NDC ( Double_t y2 )

inlinevirtualinherited

Definition at line 87 of file TPave.h.

◆ Streamer()

void TLegend::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TBox.

Reimplemented from TBox.

◆ StreamerNVirtual()

void TLegend::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 82 of file TLegend.h.

◆ SysError()

void TObject::SysError	(	const char *	location,
		const char *	fmt,
			... ) const

virtualinherited

Issue system error message.

Use "location" to specify the method where the system error occurred. Accepts standard printf formatting arguments.

Definition at line 1112 of file TObject.cxx.

◆ TestBit()

R__ALWAYS_INLINE Bool_t TObject::TestBit ( UInt_t f ) const

inlineinherited

Definition at line 204 of file TObject.h.

◆ TestBits()

Int_t TObject::TestBits ( UInt_t f ) const

inlineinherited

Definition at line 205 of file TObject.h.

◆ UseCurrentStyle()

void TObject::UseCurrentStyle ( )

virtualinherited

Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

Reimplemented in TCanvas, TPad, TFrame, TPaveStats, TPaveText, TAxis3D, TGraph, TH1, and TTree.

Definition at line 909 of file TObject.cxx.

◆ Warning()

void TObject::Warning	(	const char *	location,
		const char *	fmt,
			... ) const

virtualinherited

Issue warning message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1084 of file TObject.cxx.

◆ Write() [1/2]

Int_t TObject::Write	(	const char *	name = nullptr,
		Int_t	option = 0,
		Int_t	bufsize = 0 )

virtualinherited

Write this object to the current directory.

For more see the const version of this method.

Reimplemented in TSQLFile, TXMLFile, TDirectory, TBuffer, ROOT::TBufferMergerFile, TDirectoryFile, TFile, TParallelMergingFile, TCollection, TMap, and TTree.

Definition at line 989 of file TObject.cxx.

◆ Write() [2/2]

Int_t TObject::Write	(	const char *	name = nullptr,
		Int_t	option = 0,
		Int_t	bufsize = 0 ) const

virtualinherited

Write this object to the current directory.

The data structure corresponding to this object is serialized. The corresponding buffer is written to the current directory with an associated key with name "name".

Writing an object to a file involves the following steps:

Creation of a support TKey object in the current directory. The TKey object creates a TBuffer object.
The TBuffer object is filled via the class::Streamer function.
If the file is compressed (default) a second buffer is created to hold the compressed buffer.
Reservation of the corresponding space in the file by looking in the TFree list of free blocks of the file.
The buffer is written to the file.

Bufsize can be given to force a given buffer size to write this object. By default, the buffersize will be taken from the average buffer size of all objects written to the current file so far.

If a name is specified, it will be the name of the key. If name is not given, the name of the key will be the name as returned by GetName().

The option can be a combination of: kSingleKey, kOverwrite or kWriteDelete Using the kOverwrite option a previous key with the same name is overwritten. The previous key is deleted before writing the new object. Using the kWriteDelete option a previous key with the same name is deleted only after the new object has been written. This option is safer than kOverwrite but it is slower. NOTE: Neither kOverwrite nor kWriteDelete reduces the size of a TFile– the space is simply freed up to be overwritten; in the case of a TTree, it is more complicated. If one opens a TTree, appends some entries, then writes it out, the behaviour is effectively the same. If, however, one creates a new TTree and writes it out in this way, only the metadata is replaced, effectively making the old data invisible without deleting it. TTree::Delete() can be used to mark all disk space occupied by a TTree as free before overwriting its metadata this way. The kSingleKey option is only used by TCollection::Write() to write a container with a single key instead of each object in the container with its own key.

An object is read from the file into memory via TKey::Read() or via TObject::Read().

The function returns the total number of bytes written to the file. It returns 0 if the object cannot be written.

Reimplemented in TSQLFile, TXMLFile, TDirectory, TBuffer, TDirectoryFile, TFile, TParallelMergingFile, TCollection, TMap, and TTree.

Definition at line 964 of file TObject.cxx.

Member Data Documentation

◆ fBits

UInt_t TObject::fBits

privateinherited

bit field status word

Definition at line 47 of file TObject.h.

◆ fBorderSize

Int_t TPave::fBorderSize

protectedinherited

window box bordersize in pixels

Definition at line 26 of file TPave.h.

◆ fColumnSeparation

Float_t TLegend::fColumnSeparation

protected

Separation between columns, as a fraction of The space allowed to one column.

Definition at line 79 of file TLegend.h.

◆ fCornerRadius

Double_t TPave::fCornerRadius

protectedinherited

Corner radius in case of option arc.

Definition at line 29 of file TPave.h.

◆ fEntrySeparation

Float_t TLegend::fEntrySeparation

protected

Separation between entries, as a fraction of The space allocated to one entry.

Typical value is 0.1.

Definition at line 74 of file TLegend.h.

◆ fFillColor

Color_t TAttFill::fFillColor

protectedinherited

Fill area color.

Definition at line 24 of file TAttFill.h.

◆ fFillStyle

Style_t TAttFill::fFillStyle

protectedinherited

Fill area style.

Definition at line 25 of file TAttFill.h.

◆ fgDtorOnly

Longptr_t TObject::fgDtorOnly = 0

staticprivateinherited

object for which to call dtor only (i.e. no delete)

Definition at line 49 of file TObject.h.

◆ fgObjectStat

Bool_t TObject::fgObjectStat = kTRUE

staticprivateinherited

if true keep track of objects in TObjectTable

Definition at line 50 of file TObject.h.

◆ fInit

Int_t TPave::fInit

protectedinherited

(=0 if transformation to NDC not yet done)

Definition at line 27 of file TPave.h.

◆ fLineColor

Color_t TAttLine::fLineColor

protectedinherited

Line color.

Definition at line 24 of file TAttLine.h.

◆ fLineStyle

Style_t TAttLine::fLineStyle

protectedinherited

Line style.

Definition at line 25 of file TAttLine.h.

◆ fLineWidth

Width_t TAttLine::fLineWidth

protectedinherited

Line width.

Definition at line 26 of file TAttLine.h.

◆ fMargin

Float_t TLegend::fMargin

protected

Fraction of total width used for symbol.

Definition at line 77 of file TLegend.h.

◆ fName

TString TPave::fName

protectedinherited

Pave name.

Definition at line 31 of file TPave.h.

◆ fNColumns

Int_t TLegend::fNColumns

protected

Number of columns in the legend.

Definition at line 78 of file TLegend.h.

◆ fOption

TString TPave::fOption

protectedinherited

Pave style.

Definition at line 30 of file TPave.h.

◆ fPrimitives

TList* TLegend::fPrimitives {nullptr}

protected

List of TLegendEntries.

Definition at line 73 of file TLegend.h.

◆ fResizing

Bool_t TBox::fResizing

protectedinherited

! True if box is being resized

Definition at line 32 of file TBox.h.

◆ fShadowColor

Int_t TPave::fShadowColor

protectedinherited

Color of the pave's shadow.

Definition at line 28 of file TPave.h.

◆ fTextAlign

Short_t TAttText::fTextAlign

protectedinherited

Text alignment.

Definition at line 26 of file TAttText.h.

◆ fTextAngle

Float_t TAttText::fTextAngle

protectedinherited

Text angle.

Definition at line 24 of file TAttText.h.

◆ fTextColor

Color_t TAttText::fTextColor

protectedinherited

Text color.

Definition at line 27 of file TAttText.h.

◆ fTextFont

Font_t TAttText::fTextFont

protectedinherited

Text font.

Definition at line 28 of file TAttText.h.

◆ fTextSize

Float_t TAttText::fTextSize

protectedinherited

Text size.

Definition at line 25 of file TAttText.h.

◆ fTip

TObject* TBox::fTip {nullptr}

privateinherited

! tool tip associated with box

Definition at line 25 of file TBox.h.

◆ fUniqueID

UInt_t TObject::fUniqueID

privateinherited

object unique identifier

Definition at line 46 of file TObject.h.

◆ fX1

Double_t TBox::fX1

protectedinherited

X of 1st point.

Definition at line 28 of file TBox.h.

◆ fX1NDC

Double_t TPave::fX1NDC

protectedinherited

X1 point in NDC coordinates.

Definition at line 22 of file TPave.h.

◆ fX2

Double_t TBox::fX2

protectedinherited

X of 2nd point.

Definition at line 30 of file TBox.h.

◆ fX2NDC

Double_t TPave::fX2NDC

protectedinherited

X2 point in NDC coordinates.

Definition at line 24 of file TPave.h.

◆ fY1

Double_t TBox::fY1

protectedinherited

Y of 1st point.

Definition at line 29 of file TBox.h.

◆ fY1NDC

Double_t TPave::fY1NDC

protectedinherited

Y1 point in NDC coordinates.

Definition at line 23 of file TPave.h.

◆ fY2

Double_t TBox::fY2

protectedinherited

Y of 2nd point.

Definition at line 31 of file TBox.h.

◆ fY2NDC

Double_t TPave::fY2NDC

protectedinherited

Y2 point in NDC coordinates.

Definition at line 25 of file TPave.h.

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

graf2d/graf/inc/TLegend.h
graf2d/graf/src/TLegend.cxx

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Private Member Functions

Private Attributes

Static Private Attributes

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ EDeprecatedStatusBits

◆ EStatusBits

Constructor & Destructor Documentation

◆ TLegend() [1/4]

◆ TLegend() [2/4]

◆ TLegend() [3/4]

◆ ~TLegend()

◆ TLegend() [4/4]

Member Function Documentation

◆ AbstractMethod()

◆ AddEntry() [1/2]

◆ AddEntry() [2/2]

◆ AddToTObjectTable()

◆ AppendPad()

◆ Browse()

◆ CheckedHash()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ ClassName()

◆ Clear()

◆ Clone()

◆ Compare()

◆ ConvertNDCtoPad()

◆ Copy() [1/4]

◆ Copy() [2/4]

◆ Copy() [3/4]

◆ Copy() [4/4]

◆ DeclFileName()

◆ Delete()

◆ DeleteEntry()

◆ DistancetoLine()

◆ DistancetoPrimitive()

◆ DoError()

◆ Draw()

◆ DrawBox()

◆ DrawClass()

◆ DrawClone()

◆ DrawPave()

◆ Dump()

◆ EditEntryAttFill()

◆ EditEntryAttLine()

◆ EditEntryAttMarker()

◆ EditEntryAttText()

◆ Error()

◆ Execute() [1/2]

◆ Execute() [2/2]

◆ ExecuteEvent()

◆ Fatal()

◆ FindObject() [1/2]

◆ FindObject() [2/2]

◆ GetBBox()

◆ GetBBoxCenter()

◆ GetBorderSize()

◆ GetColumnSeparation()

◆ GetCornerRadius()

◆ GetDrawOption()

◆ GetDtorOnly()

◆ GetEntry()

◆ GetEntrySeparation()

◆ GetFillColor()

◆ GetFillStyle()

◆ GetHeader()

◆ GetIconName()