Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TLatex Class Reference

To draw Mathematical Formula.

TLatex's purpose is to write mathematical equations. The syntax is very similar to the Latex's one. It provides several functionalities:

When the font precision (see TAttText) is low (0 or 1), TLatex is painted as a normal TText, the control characters are not interpreted.

Subscripts and Superscripts

Subscripts and superscripts are made with the _ and ^ commands. These commands can be combined to make complicated subscript and superscript expressions. You may adjust the display of subscripts and superscripts by using the two functions SetIndiceSize(Double_t), which set relative size of subscripts and superscripts, and SetLimitIndiceSize(Int_t), which set limits for text resizing of subscripts and superscripts.

Examples:

The best way to put the subscripts and superscripts before the character and not after, is to use an empty character:

The subscripts and superscripts operators apply not only on one character but on all the "normal text" preceding them. In the following example the second E is lower than the first one because the operator _ is applied on /f which has a descending part, and not only on f which as no descending part.

To make sure the second operator _ applies only on f a dummy operator ^{} should be introduced to separate the f from the /.

Fractions

Fractions denoted by the / symbol are made in the obvious way. The #frac command is used for large fractions in displayed formula; it has two arguments: the numerator and the denominator.

Examples:

Splitting Lines

Text can be split in two lines via the command #splitline.

Examples:

Roots

The #sqrt command produces the square root of its argument; it has an optional first argument for other roots.

Examples:

Mathematical Symbols

TLatex can display dozens of special mathematical symbols. A few of them, such as + and > , are produced by typing the corresponding keyboard character. Others are obtained with the commands in the following table:

Delimiters

TLatex provides 4 kinds of proportional delimiters:

#[]{....} or "a la" Latex #left[.....#right] : big square brackets
#{}{....} or              #left{.....#right} : big curly brackets
#||{....} or              #left|.....#right| : big absolute value symbols
#(){....} or              #left(.....#right) : big parentheses

Greek Letters

The command to produce a lowercase Greek letter is obtained by adding a # to the name of the letter. For an uppercase Greek letter, just capitalize the first letter of the command name. Some letters have two representations. The name of the second one (the "variation") starts with "var". The following table gives the complete list:

Accents

Several kind of accents are available:

The special sign: #slash draws a slash on top of the text between brackets:

Bar and vectors sign are done the following way:

Changing Style

One can change the font, the text color, or the text size at any time using : #font[font-number]{...}, #color[color-number]{...} and #scale[scale-factor]{...}

Examples:

Alignment Rules

The TText alignment rules apply to the TLatex objects with one exception concerning the vertical alignment:

  • if the vertical alignment = 1 , subscripts are not taken into account
  • if the vertical alignment = 0 , the text is aligned to the box surrounding the full text with sub and superscripts

This is illustrated by the following example:

{
TCanvas Tlva("Tlva","Tlva",500,500);
Tlva.SetGrid();
Tlva.DrawFrame(0,0,1,1);
const char *longstring = "K_{S}... K^{*0}... #frac{2s}{#pi#alpha^{2}} #frac{d#sigma}{dcos#theta} (e^{+}e^{-} #rightarrow f#bar{f} ) = #left| #frac{1}{1 - #Delta#alpha} #right|^{2} (1+cos^{2}#theta)";
latex.SetTextSize(0.025);
latex.SetTextAlign(13); //align at top
latex.DrawLatex(.2,.9,"K_{S}");
latex.DrawLatex(.3,.9,"K^{*0}");
latex.DrawLatex(.2,.8,longstring);
latex.SetTextAlign(12); //centered
latex.DrawLatex(.2,.6,"K_{S}");
latex.DrawLatex(.3,.6,"K^{*0}");
latex.DrawLatex(.2,.5,longstring);
latex.SetTextAlign(11); //default bottom alignment
latex.DrawLatex(.2,.4,"K_{S}");
latex.DrawLatex(.3,.4,"K^{*0}");
latex.DrawLatex(.2,.3,longstring);
latex.SetTextAlign(10); //special bottom alignment
latex.DrawLatex(.2,.2,"K_{S}");
latex.DrawLatex(.3,.2,"K^{*0}");
latex.DrawLatex(.2,.1,longstring);
latex.SetTextAlign(12);
latex.SetTextFont(72);
latex.DrawLatex(.1,.80,"13");
latex.DrawLatex(.1,.55,"12");
latex.DrawLatex(.1,.35,"11");
latex.DrawLatex(.1,.18,"10");
return Tlva;
}
ROOT::Detail::TRangeCast< T, true > TRangeDynCast
TRangeDynCast is an adapter class that allows the typed iteration through a TCollection.
The Canvas class.
Definition TCanvas.h:23
To draw Mathematical Formula.
Definition TLatex.h:20

Character Adjustment

The two commands #kern and #lower enable a better control over character placement. The command #kern[(Float_t)dx]{text} moves the output string horizontally by the fraction dx of its length. Similarly, #lower[(Float_t)dy]{text} shifts the text up or down by the fraction dy of its height.

Examples:

Italic and Boldface

Text can be turned italic or boldface using the commands #it and #bf.

Examples:

Examples

{
TCanvas ex1("ex1","Latex",500,600);
Tl.SetTextAlign(12);
Tl.SetTextSize(0.04);
Tl.DrawLatex(0.1,0.8,"1) C(x) = d #sqrt{#frac{2}{#lambdaD}} #int^{x}_{0}cos(#frac{#pi}{2}t^{2})dt");
Tl.DrawLatex(0.1,0.6,"2) C(x) = d #sqrt{#frac{2}{#lambdaD}} #int^{x}cos(#frac{#pi}{2}t^{2})dt");
Tl.DrawLatex(0.1,0.4,"3) R = |A|^{2} = #frac{1}{2}(#[]{#frac{1}{2}+C(V)}^{2}+#[]{#frac{1}{2}+S(V)}^{2})");
Tl.DrawLatex(0.1,0.2,"4) F(t) = #sum_{i=-#infty}^{#infty}A(i)cos#[]{#frac{i}{t+i}}");
return ex1;
}
{
TCanvas ex2("ex2","Latex",500,300);
Tl.SetTextAlign(23);
Tl.SetTextSize(0.08);
Tl.DrawLatex(0.5,0.95,"e^{+}e^{-}#rightarrowZ^{0}#rightarrowI#bar{I}, q#bar{q}");
Tl.DrawLatex(0.5,0.75,"|#vec{a}#bullet#vec{b}|=#Sigmaa^{i}_{jk}+b^{bj}_{i}");
Tl.DrawLatex(0.5,0.5,"i(#partial_{#mu}#bar{#psi}#gamma^{#mu}+m#bar{#psi}=0#Leftrightarrow(#Box+m^{2})#psi=0");
Tl.DrawLatex(0.5,0.3,"L_{em}=eJ^{#mu}_{em}A_{#mu} , J^{#mu}_{em}=#bar{I}#gamma_{#mu}I , M^{j}_{i}=#SigmaA_{#alpha}#tau^{#alphaj}_{i}");
return ex2;
}
{
TCanvas ex3("ex3","Latex",500,300);
TPaveText pt(.1,.1,.9,.9);
pt.AddText("#frac{2s}{#pi#alpha^{2}} #frac{d#sigma}{dcos#theta} (e^{+}e^{-} #rightarrow f#bar{f} ) = ");
pt.AddText("#left| #frac{1}{1 - #Delta#alpha} #right|^{2} (1+cos^{2}#theta");
pt.AddText("+ 4 Re #left{ #frac{2}{1 - #Delta#alpha} #chi(s) #[]{#hat{g}_{#nu}^{e}#hat{g}_{#nu}^{f} (1 + cos^{2}#theta) + 2 #hat{g}_{a}^{e}#hat{g}_{a}^{f} cos#theta) } #right}");
pt.SetLabel("Born equation");
pt.Draw();
return ex3;
}
A Pave (see TPave) with text, lines or/and boxes inside.
Definition TPaveText.h:21
virtual TText * AddText(Double_t x1, Double_t y1, const char *label)
Add a new Text line to this pavetext at given coordinates.
virtual void SetLabel(const char *label)
Definition TPaveText.h:61
void Draw(Option_t *option="") override
Draw this pavetext with its current attributes.
TPaveText * pt

Interface to TMathText

The class TMathText is a TeX math formulae interpreter. It uses plain TeX syntax and uses "\\" as control instead of "#". If a piece of text containing "\" is given to TLatex then TMathText is automatically invoked. Therefore, as histograms' titles, axis titles, labels etc ... are drawn using TLatex, the TMathText syntax can be used for them also.

URL links

JSROOT, standard PDF output and standard SVG output support the syntax 'url[link]{label}'. This can be combined with other TLatex commands, such as color or font settings.

{
auto cl = new TCanvas("cl", "Use of #url in TLatex", 1200, 800);
auto latex = new TLatex(0.5, 0.5, "Link on #color[4]{#url[https://root.cern]{root.cern}} web site");
latex->SetTextSize(0.1);
latex->SetTextAlign(22);
latex->Draw();
cl->Print("cl.svg");
cl->Print("cl.pdf");
}

Definition at line 20 of file TLatex.h.

Classes

struct  TextSpec_t
 TLatex helper struct holding the attributes of a piece of text. More...
 
class  TLatexFormSize
 TLatex helper class used to compute the size of a portion of a formula. More...
 

Public Types

enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }
 
enum  { kTextNDC = (1ULL << ( 14 )) }
 
enum  { kTextNDC = (1ULL << ( 14 )) }
 
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

 TLatex ()
 Default constructor.
 
 TLatex (const TLatex &text)
 Copy constructor.
 
 TLatex (Double_t x, Double_t y, const char *text)
 Normal constructor.
 
 ~TLatex () override
 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.
 
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
 Set name and title to empty strings ("").
 
TObjectClone (const char *newname="") const override
 Make a clone of an object using the Streamer facility.
 
Int_t Compare (const TObject *obj) const override
 Compare two TNamed objects.
 
void Copy (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 &text) const override
 Copy this TLatex object to another TLatex.
 
virtual void Delete (Option_t *option="")
 Delete this object.
 
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 string.
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects.
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs.
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
 
TLatexDrawLatex (Double_t x, Double_t y, const char *text)
 Make a copy of this object with the new parameters And copy object attributes.
 
TLatexDrawLatexNDC (Double_t x, Double_t y, const char *text)
 Draw this TLatex with new coordinates in NDC.
 
virtual TTextDrawText (Double_t x, Double_t y, const char *text)
 Draw this text with new coordinates.
 
virtual TTextDrawText (Double_t x, Double_t y, const wchar_t *text)
 Draw this text with new coordinates.
 
virtual TTextDrawTextNDC (Double_t x, Double_t y, const char *text)
 Draw this text with new coordinates in NDC.
 
virtual TTextDrawTextNDC (Double_t x, Double_t y, const wchar_t *text)
 Draw this text with new coordinates in NDC.
 
virtual void Dump () const
 Dump contents of object on stdout.
 
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 void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
Rectangle_t GetBBox () override
 Return the "bounding Box" of the Box.
 
TPoint GetBBoxCenter () override
 Return the point given by Alignment as 'center'.
 
void GetBoundingBox (UInt_t &w, UInt_t &h, Bool_t angle=kFALSE) override
 Return text size in pixels.
 
virtual void GetControlBox (Int_t x, Int_t y, Double_t theta, Int_t cBoxX[4], Int_t cBoxY[4])
 Return the text control box.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
Double_t GetHeight () const
 Return height of current pad in pixels.
 
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.
 
const char * GetName () const override
 Returns name of object.
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
 
virtual Option_tGetOption () const
 
virtual void GetTextAdvance (UInt_t &a, const char *text, const Bool_t kern=kTRUE) const
 Return text advance for string text if kern is true (default) kerning is taken into account.
 
virtual Short_t GetTextAlign () const
 Return the text alignment.
 
virtual Float_t GetTextAngle () const
 Return the text angle.
 
virtual void GetTextAscentDescent (UInt_t &a, UInt_t &d, const char *text) const
 Return text ascent and descent for string text.
 
virtual void GetTextAscentDescent (UInt_t &a, UInt_t &d, const wchar_t *text) const
 Return text ascent and descent for string text.
 
virtual Color_t GetTextColor () const
 Return the text color.
 
virtual void GetTextExtent (UInt_t &w, UInt_t &h, const char *text) const
 Return text extent for string text.
 
virtual void GetTextExtent (UInt_t &w, UInt_t &h, const wchar_t *text) const
 Return text extent for string text.
 
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.
 
const char * GetTitle () const override
 Returns title of object.
 
virtual UInt_t GetUniqueID () const
 Return the unique object id.
 
const void * GetWcsTitle (void) const
 Returns the text as UNICODE.
 
Double_t GetX () const
 
Double_t GetXsize ()
 Return size of the formula along X in pad coordinates when the text precision is smaller than 3.
 
Double_t GetY () const
 
Double_t GetYsize ()
 Return size of the formula along Y in pad coordinates when the text precision is smaller than 3.
 
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 Info (const char *method, const char *msgfmt,...) const
 Issue info message.
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname".
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl.
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
 
void InvertBit (UInt_t f)
 
TClassIsA () const override
 
Bool_t IsDestructed () const
 IsDestructed.
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
Bool_t IsSortable () const override
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
void ls (Option_t *option="") const override
 List this text 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 line attributes if necessary.
 
virtual void Modify ()
 Change current text attributes if necessary.
 
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.
 
virtual void PaintControlBox (Int_t x, Int_t y, Double_t theta)
 Paint the text control box.
 
virtual void PaintLatex (Double_t x, Double_t y, Double_t angle, Double_t size, const char *text)
 Main drawing function.
 
virtual void PaintText (Double_t x, Double_t y, const char *text)
 Draw this text with new coordinates.
 
virtual void PaintText (Double_t x, Double_t y, const wchar_t *text)
 Draw this text with new coordinates.
 
virtual void PaintTextNDC (Double_t u, Double_t v, const char *text)
 Draw this text with new coordinates in NDC.
 
virtual void PaintTextNDC (Double_t u, Double_t v, const wchar_t *text)
 Draw this text with new coordinates in NDC.
 
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 text with its attributes.
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
 
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 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 primitive as a C++ statement(s) on output stream out.
 
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.
 
void SetBBoxCenter (const TPoint &p) override
 Set the point given by Alignment as 'center'.
 
void SetBBoxCenterX (const Int_t x) override
 Set X coordinate of the point given by Alignment as 'center'.
 
void SetBBoxCenterY (const Int_t y) override
 Set Y coordinate of the point given by Alignment as 'center'.
 
void SetBBoxX1 (const Int_t) override
 Set left hand side of BoundingBox to a value (resize in x direction on left)
 
void SetBBoxX2 (const Int_t) override
 Set right hand side of BoundingBox to a value (resize in x direction on right)
 
void SetBBoxY1 (const Int_t) override
 Set top of BoundingBox to a value (resize in y direction on top)
 
void SetBBoxY2 (const Int_t) 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 SetDrawOption (Option_t *option="")
 Set drawing option for object.
 
virtual void SetIndiceSize (Double_t factorSize)
 Set relative size of subscripts and superscripts.
 
virtual void SetLimitIndiceSize (Int_t limitFactorSize)
 Set limit for text resizing of subscripts and superscripts.
 
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.
 
virtual void SetMbTitle (const wchar_t *title=L"")
 Change (i.e. set) the title of the TNamed.
 
virtual void SetName (const char *name)
 Set the name of the TNamed.
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title).
 
virtual void SetNDC (Bool_t isNDC=kTRUE)
 Set NDC mode on if isNDC = kTRUE, off otherwise.
 
virtual void SetText (Double_t x, Double_t y, const char *text)
 
virtual void SetText (Double_t x, Double_t y, const wchar_t *text)
 
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 SetTitle (const char *title="")
 Set the title of the TNamed.
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
 
virtual void SetX (Double_t x)
 
virtual void SetY (Double_t y)
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject.
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
 
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 TClassClass ()
 
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

TLatexFormSize Anal1 (const TextSpec_t &spec, const Char_t *t, Int_t length)
 Analyse function.
 
TLatexFormSize Analyse (Double_t x, Double_t y, const TextSpec_t &spec, const Char_t *t, Int_t length)
 Analyse and paint the TLatex formula.
 
Int_t CheckLatexSyntax (TString &text)
 Check if the Latex syntax is correct.
 
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
 
void DrawCircle (Double_t x1, Double_t y1, Double_t r, const TextSpec_t &spec)
 Draw an arc of ellipse in a Latex formula (right or left parenthesis)
 
void DrawLine (Double_t x1, Double_t y1, Double_t x2, Double_t y2, const TextSpec_t &spec)
 Draw a line in a Latex formula.
 
void DrawParenthesis (Double_t x1, Double_t y1, Double_t r1, Double_t r2, Double_t phimin, Double_t phimax, const TextSpec_t &spec)
 Draw an arc of ellipse in a Latex formula (right or left parenthesis)
 
void DrawPolyLine (Int_t npoints, Double_t *xx, Double_t *yy, const TextSpec_t &spec, Double_t scale_width=0.)
 Draw a poly line in a Latex formula Is scale_width parameter >=1, fill area will be drawn Otherwise line width will be scaled proportional to current font size If not specified - default line width will be used.
 
TLatexFormSize FirstParse (Double_t angle, Double_t size, const Char_t *text)
 First parsing of the analyse sequence.
 
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 ()
 
TLatexoperator= (const TLatex &)
 assignment operator
 
Int_t PaintLatex1 (Double_t x, Double_t y, Double_t angle, Double_t size, const char *text)
 Drawing function.
 
TLatexFormSize Readfs ()
 Read fs in fTabSize.
 
void Rotate (TVirtualPad *pad, Double_t angle, Double_t x, Double_t y, Double_t &xx, Double_t &yy)
 Rotate single point around fX, fY coordinate by specified angle.
 
void Rotate (TVirtualPad *pad, Double_t angle, Int_t np, Double_t *x, Double_t *y)
 Rotate array of points around fX, fY coordinate by specified angle.
 
void Savefs (TLatexFormSize *fs)
 Save fs values in array fTabSize.
 
void SavePrimitiveNameTitle (std::ostream &out, const char *variable_name)
 Save object name and title into the output stream "out".
 

Static Protected Member Functions

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

Protected Attributes

const Char_tfError {nullptr}
 ! error code
 
Double_t fFactorPos
 ! Relative position of subscripts and superscripts
 
Double_t fFactorSize
 ! Relative size of subscripts and superscripts
 
Bool_t fItalic
 ! Currently inside italic operator
 
Int_t fLimitFactorSize
 lower bound for subscripts/superscripts size
 
Color_t fLineColor
 Line color.
 
Style_t fLineStyle
 Line style.
 
Width_t fLineWidth
 Line width.
 
TString fName
 
Double_t fOriginSize
 Font size of the starting font.
 
Bool_t fShow
 ! is true during the second pass (Painting)
 
std::vector< TLatexFormSizefTabSize
 ! array of values for the different zones
 
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.
 
TString fTitle
 
void * fWcsTitle {nullptr}
 !Used by TMathText
 
Double_t fX {0}
 X position of text (left,center,etc..)
 
Double_t fY {0}
 Y position of text (left,center,etc..)
 

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

Inheritance diagram for TLatex:
TText TAttLine TNamed TAttText TAttBBox2D TObject TAnnotation

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

Enumerator
kTextNDC 

The text position is in NDC coordinates.

Definition at line 98 of file TLatex.h.

◆ anonymous enum

anonymous enum
inherited
Enumerator
kTextNDC 

The text position is in the NDC space.

Definition at line 31 of file TText.h.

◆ EDeprecatedStatusBits

Enumerator
kObjInCanvas 

for backward compatibility only, use kMustCleanup

Definition at line 84 of file TObject.h.

◆ EStatusBits

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

◆ TLatex() [1/3]

TLatex::TLatex ( )

Default constructor.

Definition at line 416 of file TLatex.cxx.

◆ TLatex() [2/3]

TLatex::TLatex ( Double_t x,
Double_t y,
const char * text )

Normal constructor.

Definition at line 431 of file TLatex.cxx.

◆ TLatex() [3/3]

TLatex::TLatex ( const TLatex & text)

Copy constructor.

Definition at line 454 of file TLatex.cxx.

◆ ~TLatex()

TLatex::~TLatex ( )
override

Destructor.

Definition at line 447 of file TLatex.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.

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

◆ Anal1()

TLatex::TLatexFormSize TLatex::Anal1 ( const TextSpec_t & spec,
const Char_t * t,
Int_t length )
protected

Analyse function.

Definition at line 536 of file TLatex.cxx.

◆ Analyse()

TLatex::TLatexFormSize TLatex::Analyse ( Double_t x,
Double_t y,
const TextSpec_t & spec,
const Char_t * t,
Int_t length )
protected

Analyse and paint the TLatex formula.

It is called twice : first for calculating the size of each portion of the formula, then to paint the formula. When analyse finds an operator or separator, it calls itself recursively to analyse the arguments of the operator. when the argument is an atom (normal text), it calculates the size of it and return it as the result. for example : if the operator #frac{arg1}{arg2} is found : Analyse(arg1) return the size of arg1 (width, up, down) Analyse(arg2) return the size of arg2 now, we know the size of #frac{arg1}{arg2}:

so, when the user wants to paint a fraction at position (x,y), the rect used for the formula is : (x,y-up,x+width,y+down)

return size of zone occupied by the text/formula

  • t : chain to be analyzed
  • length : number of chars in t.

Definition at line 568 of file TLatex.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()

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

◆ CheckLatexSyntax()

Int_t TLatex::CheckLatexSyntax ( TString & text)
protected

Check if the Latex syntax is correct.

Definition at line 2341 of file TLatex.cxx.

◆ Class()

static TClass * TLatex::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * TLatex::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t TLatex::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 123 of file TLatex.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 TNamed::Clear ( Option_t * option = "")
overridevirtualinherited

Set name and title to empty strings ("").

Reimplemented from TObject.

Reimplemented in TStreamerInfo, TVirtualStreamerInfo, TProcessID, TTask, TPrincipal, and TVirtualFitter.

Definition at line 63 of file TNamed.cxx.

◆ Clone()

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

Make a clone of an object using the Streamer facility.

If newname is specified, this will be the name of the new object.

Reimplemented from TObject.

Reimplemented in TStreamerInfo, and TTreeIndex.

Definition at line 73 of file TNamed.cxx.

◆ Compare()

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

Compare two TNamed objects.

Returns 0 when equal, -1 when this is smaller and +1 when bigger (like strcmp).

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 84 of file TNamed.cxx.

◆ Copy() [1/3]

void TAttLine::Copy ( TAttLine & attline) const
inherited

Copy this line attributes to a new TAttLine.

Definition at line 176 of file TAttLine.cxx.

◆ Copy() [2/3]

void TAttText::Copy ( TAttText & atttext) const
inherited

Copy this text attributes to a new TAttText.

Definition at line 300 of file TAttText.cxx.

◆ Copy() [3/3]

void TLatex::Copy ( TObject & text) const
overridevirtual

Copy this TLatex object to another TLatex.

Reimplemented from TObject.

Definition at line 489 of file TLatex.cxx.

◆ DeclFileName()

static const char * TLatex::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 123 of file TLatex.h.

◆ Delete()

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

◆ 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
#define d(i)
Definition RSha256.hxx:102
#define b(i)
Definition RSha256.hxx:100
#define c(i)
Definition RSha256.hxx:101
#define a(i)
Definition RSha256.hxx:99
Option_t Option_t TPoint TPoint const char x2
Option_t Option_t TPoint TPoint const char x1
Option_t Option_t TPoint TPoint const char y2
Option_t Option_t TPoint TPoint const char y1
Double_t y[n]
Definition legend1.C:17
Double_t x[n]
Definition legend1.C:17

Definition at line 210 of file TAttLine.cxx.

◆ DistancetoPrimitive()

Int_t TText::DistancetoPrimitive ( Int_t px,
Int_t py )
overridevirtualinherited

Compute distance from point px,py to a string.

The rectangle surrounding this string is evaluated. If the point (px,py) is in the rectangle, the distance is set to zero.

Reimplemented from TObject.

Definition at line 140 of file TText.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()

◆ DrawCircle()

void TLatex::DrawCircle ( Double_t x1,
Double_t y1,
Double_t r,
const TextSpec_t & spec )
protected

Draw an arc of ellipse in a Latex formula (right or left parenthesis)

Definition at line 2074 of file TLatex.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.

◆ DrawLatex()

TLatex * TLatex::DrawLatex ( Double_t x,
Double_t y,
const char * text )

Make a copy of this object with the new parameters And copy object attributes.

Definition at line 2001 of file TLatex.cxx.

◆ DrawLatexNDC()

TLatex * TLatex::DrawLatexNDC ( Double_t x,
Double_t y,
const char * text )

Draw this TLatex with new coordinates in NDC.

Definition at line 2015 of file TLatex.cxx.

◆ DrawLine()

void TLatex::DrawLine ( Double_t x1,
Double_t y1,
Double_t x2,
Double_t y2,
const TextSpec_t & spec )
protected

Draw a line in a Latex formula.

Definition at line 2060 of file TLatex.cxx.

◆ DrawParenthesis()

void TLatex::DrawParenthesis ( Double_t x1,
Double_t y1,
Double_t r1,
Double_t r2,
Double_t phimin,
Double_t phimax,
const TextSpec_t & spec )
protected

Draw an arc of ellipse in a Latex formula (right or left parenthesis)

Definition at line 2101 of file TLatex.cxx.

◆ DrawPolyLine()

void TLatex::DrawPolyLine ( Int_t npoints,
Double_t * xx,
Double_t * yy,
const TextSpec_t & spec,
Double_t scale_width = 0. )
protected

Draw a poly line in a Latex formula Is scale_width parameter >=1, fill area will be drawn Otherwise line width will be scaled proportional to current font size If not specified - default line width will be used.

Definition at line 2028 of file TLatex.cxx.

◆ DrawText() [1/2]

TText * TText::DrawText ( Double_t x,
Double_t y,
const char * text )
virtualinherited

Draw this text with new coordinates.

Definition at line 172 of file TText.cxx.

◆ DrawText() [2/2]

TText * TText::DrawText ( Double_t x,
Double_t y,
const wchar_t * text )
virtualinherited

Draw this text with new coordinates.

Definition at line 185 of file TText.cxx.

◆ DrawTextNDC() [1/2]

TText * TText::DrawTextNDC ( Double_t x,
Double_t y,
const char * text )
virtualinherited

Draw this text with new coordinates in NDC.

Definition at line 198 of file TText.cxx.

◆ DrawTextNDC() [2/2]

TText * TText::DrawTextNDC ( Double_t x,
Double_t y,
const wchar_t * text )
virtualinherited

Draw this text with new coordinates in NDC.

Definition at line 208 of file TText.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
fBits 50331648 bit field status word
fFillColor 19 fill area color
fFillStyle 1001 fill area style
#define X(type, name)
Option_t Option_t TPoint TPoint angle
Option_t Option_t style
Width_t fLineWidth
Line width.
Definition TAttLine.h:26
Style_t fLineStyle
Line style.
Definition TAttLine.h:25
Color_t fLineColor
Line color.
Definition TAttLine.h:24
UInt_t fUniqueID
object unique identifier
Definition TObject.h:46
UInt_t fBits
bit field status word
Definition TObject.h:47
TLine * line

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

Definition at line 367 of file TObject.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
Collectable string class.
Definition TObjString.h:28
const Int_t n
Definition legend1.C:16

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

Definition at line 398 of file TObject.cxx.

◆ ExecuteEvent()

void TText::ExecuteEvent ( Int_t event,
Int_t px,
Int_t py )
overridevirtualinherited

Execute action corresponding to one event.

This member function must be implemented to realize the action corresponding to the mouse click on the object in the window

Reimplemented from TObject.

Definition at line 221 of file TText.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.

◆ FillBuffer()

void TNamed::FillBuffer ( char *& buffer)
virtualinherited

Encode TNamed into output buffer.

Reimplemented in TKeySQL, TSQLFile, TKeyXML, TXMLFile, TDirectoryFile, TFile, and TKey.

Definition at line 103 of file TNamed.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.

◆ FirstParse()

TLatex::TLatexFormSize TLatex::FirstParse ( Double_t angle,
Double_t size,
const Char_t * text )
protected

First parsing of the analyse sequence.

Definition at line 2540 of file TLatex.cxx.

◆ GetBBox()

Rectangle_t TText::GetBBox ( )
overridevirtualinherited

Return the "bounding Box" of the Box.

Implements TAttBBox2D.

Definition at line 788 of file TText.cxx.

◆ GetBBoxCenter()

TPoint TText::GetBBoxCenter ( )
overridevirtualinherited

Return the point given by Alignment as 'center'.

Reimplemented from TAttBBox2D.

Definition at line 822 of file TText.cxx.

◆ GetBoundingBox()

void TLatex::GetBoundingBox ( UInt_t & w,
UInt_t & h,
Bool_t angle = kFALSE )
overridevirtual

Return text size in pixels.

Reimplemented from TText.

Definition at line 2618 of file TLatex.cxx.

◆ GetControlBox()

void TText::GetControlBox ( Int_t x,
Int_t y,
Double_t theta,
Int_t cBoxX[4],
Int_t cBoxY[4] )
virtualinherited

Return the text control box.

The text position coordinates is (x,y) and the text angle is theta. The control box coordinates are returned in cBoxX and cBoxY.

Definition at line 420 of file TText.cxx.

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

◆ GetHeight()

Double_t TLatex::GetHeight ( ) const

Return height of current pad in pixels.

Definition at line 2573 of file TLatex.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.

◆ GetName()

const char * TNamed::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 49 of file TNamed.h.

◆ 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()

virtual Option_t * TObject::GetOption ( ) const
inlinevirtualinherited

◆ GetTextAdvance()

void TText::GetTextAdvance ( UInt_t & a,
const char * text,
const Bool_t kern = kTRUE ) const
virtualinherited

Return text advance for string text if kern is true (default) kerning is taken into account.

If it is false the kerning is not taken into account.

Definition at line 568 of file TText.cxx.

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

◆ GetTextAscentDescent() [1/2]

void TText::GetTextAscentDescent ( UInt_t & a,
UInt_t & d,
const char * text ) const
virtualinherited

Return text ascent and descent for string text.

  • in a return total text ascent
  • in d return text descent

Definition at line 516 of file TText.cxx.

◆ GetTextAscentDescent() [2/2]

void TText::GetTextAscentDescent ( UInt_t & a,
UInt_t & d,
const wchar_t * text ) const
virtualinherited

Return text ascent and descent for string text.

  • in a return total text ascent
  • in d return text descent

Definition at line 534 of file TText.cxx.

◆ GetTextColor()

virtual Color_t TAttText::GetTextColor ( ) const
inlinevirtualinherited

Return the text color.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 37 of file TAttText.h.

◆ GetTextExtent() [1/2]

void TText::GetTextExtent ( UInt_t & w,
UInt_t & h,
const char * text ) const
virtualinherited

Return text extent for string text.

  • in w return total text width
  • in h return text height

Definition at line 551 of file TText.cxx.

◆ GetTextExtent() [2/2]

void TText::GetTextExtent ( UInt_t & w,
UInt_t & h,
const wchar_t * text ) const
virtualinherited

Return text extent for string text.

  • in w return total text width
  • in h return text height

Definition at line 585 of file TText.cxx.

◆ 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 * TNamed::GetTitle ( ) const
inlineoverridevirtualinherited

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

Definition at line 50 of file TNamed.h.

◆ GetUniqueID()

UInt_t TObject::GetUniqueID ( ) const
virtualinherited

Return the unique object id.

Definition at line 480 of file TObject.cxx.

◆ GetWcsTitle()

const void * TText::GetWcsTitle ( void ) const
inherited

Returns the text as UNICODE.

Definition at line 126 of file TText.cxx.

◆ GetX()

Double_t TText::GetX ( ) const
inlineinherited

Definition at line 53 of file TText.h.

◆ GetXCoord()

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

Definition at line 60 of file TAttBBox2D.cxx.

◆ GetXsize()

Double_t TLatex::GetXsize ( )

Return size of the formula along X in pad coordinates when the text precision is smaller than 3.

Definition at line 2588 of file TLatex.cxx.

◆ GetY()

Double_t TText::GetY ( ) const
inlineinherited

Definition at line 61 of file TText.h.

◆ GetYCoord()

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

Definition at line 76 of file TAttBBox2D.cxx.

◆ GetYsize()

Double_t TLatex::GetYsize ( )

Return size of the formula along Y in pad coordinates when the text precision is smaller than 3.

Definition at line 2674 of file TLatex.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 TNamed::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

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

ULong_t Hash() const override
Return hash value for this object.
Definition TNamed.h:51
Mother of all ROOT objects.
Definition TObject.h:42
virtual void Error(const char *method, const char *msgfmt,...) const
Issue error message.
Definition TObject.cxx:1098
void RecursiveRemove(TObject *obj) override
Recursively remove this object from the list of Cleanups.
Definition TROOT.cxx:2651

Reimplemented from TObject.

Definition at line 51 of file TNamed.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.

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

◆ 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 * TLatex::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TObject.

Definition at line 123 of file TLatex.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()

◆ IsOnHeap()

R__ALWAYS_INLINE Bool_t TObject::IsOnHeap ( ) const
inlineinherited

Definition at line 160 of file TObject.h.

◆ IsSortable()

Bool_t TNamed::IsSortable ( ) const
inlineoverridevirtualinherited

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 52 of file TNamed.h.

◆ IsZombie()

R__ALWAYS_INLINE Bool_t TObject::IsZombie ( ) const
inlineinherited

Definition at line 161 of file TObject.h.

◆ ls()

void TText::ls ( Option_t * option = "") const
overridevirtualinherited

List this text with its attributes.

Reimplemented from TNamed.

Definition at line 600 of file TText.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/2]

void TAttLine::Modify ( )
virtualinherited

Change current line attributes if necessary.

Definition at line 246 of file TAttLine.cxx.

◆ Modify() [2/2]

void TAttText::Modify ( )
virtualinherited

Change current text attributes if necessary.

Definition at line 364 of file TAttText.cxx.

◆ ModifyOn() [1/2]

void TAttLine::ModifyOn ( TVirtualPad & pad)
virtualinherited

Change current line attributes on specified pad.

Definition at line 255 of file TAttLine.cxx.

◆ ModifyOn() [2/2]

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=()

TLatex & TLatex::operator= ( const TLatex & lt)
protected

assignment operator

Definition at line 469 of file TLatex.cxx.

◆ Paint()

void TLatex::Paint ( Option_t * option = "")
overridevirtual

Paint.

Reimplemented from TObject.

Definition at line 2132 of file TLatex.cxx.

◆ PaintControlBox()

void TText::PaintControlBox ( Int_t x,
Int_t y,
Double_t theta )
virtualinherited

Paint the text control box.

(x,y) are the coordinates where the control box should be painted and theta is the angle of the box.

Definition at line 621 of file TText.cxx.

◆ PaintLatex()

void TLatex::PaintLatex ( Double_t x,
Double_t y,
Double_t angle,
Double_t size,
const char * text )
virtual

Main drawing function.

Warning: Unlike most others "XYZ::PaintXYZ" methods, PaintLatex modifies the TLatex data members.

Definition at line 2154 of file TLatex.cxx.

◆ PaintLatex1()

Int_t TLatex::PaintLatex1 ( Double_t x,
Double_t y,
Double_t angle,
Double_t size,
const char * text )
protected

Drawing function.

Definition at line 2235 of file TLatex.cxx.

◆ PaintText() [1/2]

void TText::PaintText ( Double_t x,
Double_t y,
const char * text )
virtualinherited

Draw this text with new coordinates.

Definition at line 674 of file TText.cxx.

◆ PaintText() [2/2]

void TText::PaintText ( Double_t x,
Double_t y,
const wchar_t * text )
virtualinherited

Draw this text with new coordinates.

Definition at line 683 of file TText.cxx.

◆ PaintTextNDC() [1/2]

void TText::PaintTextNDC ( Double_t u,
Double_t v,
const char * text )
virtualinherited

Draw this text with new coordinates in NDC.

Definition at line 692 of file TText.cxx.

◆ PaintTextNDC() [2/2]

void TText::PaintTextNDC ( Double_t u,
Double_t v,
const wchar_t * text )
virtualinherited

Draw this text with new coordinates in NDC.

Definition at line 701 of file TText.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 TText::Print ( Option_t * option = "") const
overridevirtualinherited

Dump this text with its attributes.

Reimplemented from TNamed.

Definition at line 710 of file TText.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.

◆ Readfs()

TLatex::TLatexFormSize TLatex::Readfs ( )
protected

Read fs in fTabSize.

Definition at line 2704 of file TLatex.cxx.

◆ RecursiveRemove()

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

◆ Rotate() [1/2]

void TLatex::Rotate ( TVirtualPad * pad,
Double_t angle,
Double_t x,
Double_t y,
Double_t & xx,
Double_t & yy )
protected

Rotate single point around fX, fY coordinate by specified angle.

Definition at line 526 of file TLatex.cxx.

◆ Rotate() [2/2]

void TLatex::Rotate ( TVirtualPad * pad,
Double_t angle,
Int_t np,
Double_t * x,
Double_t * y )
protected

Rotate array of points around fX, fY coordinate by specified angle.

Definition at line 506 of file TLatex.cxx.

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

◆ Savefs()

void TLatex::Savefs ( TLatex::TLatexFormSize * fs)
protected

Save fs values in array fTabSize.

Definition at line 2719 of file TLatex.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 TLatex::SavePrimitive ( std::ostream & out,
Option_t * option = "" )
overridevirtual

Save primitive as a C++ statement(s) on output stream out.

Reimplemented from TObject.

Definition at line 2727 of file TLatex.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.

◆ SavePrimitiveNameTitle()

void TNamed::SavePrimitiveNameTitle ( std::ostream & out,
const char * variable_name )
protectedinherited

Save object name and title into the output stream "out".

Definition at line 135 of file TNamed.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 TText::SetBBoxCenter ( const TPoint & p)
overridevirtualinherited

Set the point given by Alignment as 'center'.

Reimplemented from TAttBBox2D.

Definition at line 835 of file TText.cxx.

◆ SetBBoxCenterX()

void TText::SetBBoxCenterX ( const Int_t x)
overridevirtualinherited

Set X coordinate of the point given by Alignment as 'center'.

Implements TAttBBox2D.

Definition at line 845 of file TText.cxx.

◆ SetBBoxCenterY()

void TText::SetBBoxCenterY ( const Int_t y)
overridevirtualinherited

Set Y coordinate of the point given by Alignment as 'center'.

Implements TAttBBox2D.

Definition at line 854 of file TText.cxx.

◆ SetBBoxX1()

void TText::SetBBoxX1 ( const Int_t )
overridevirtualinherited

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

Implements TAttBBox2D.

Definition at line 864 of file TText.cxx.

◆ SetBBoxX2()

void TText::SetBBoxX2 ( const Int_t )
overridevirtualinherited

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

Implements TAttBBox2D.

Definition at line 873 of file TText.cxx.

◆ SetBBoxY1()

void TText::SetBBoxY1 ( const Int_t )
overridevirtualinherited

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

Implements TAttBBox2D.

Definition at line 881 of file TText.cxx.

◆ SetBBoxY2()

void TText::SetBBoxY2 ( const Int_t )
overridevirtualinherited

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

Implements TAttBBox2D.

Definition at line 890 of file TText.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.

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

◆ SetIndiceSize()

void TLatex::SetIndiceSize ( Double_t factorSize)
virtual

Set relative size of subscripts and superscripts.

Definition at line 2745 of file TLatex.cxx.

◆ SetLimitIndiceSize()

void TLatex::SetLimitIndiceSize ( Int_t limitFactorSize)
virtual

Set limit for text resizing of subscripts and superscripts.

Definition at line 2753 of file TLatex.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]

◆ 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
lcolordefines the line color
lalphadefines 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

◆ SetLineWidth()

◆ SetMbTitle()

void TText::SetMbTitle ( const wchar_t * title = L"")
virtualinherited

Change (i.e. set) the title of the TNamed.

Definition at line 747 of file TText.cxx.

◆ SetName()

void TNamed::SetName ( const char * name)
virtualinherited

Set the name of the TNamed.

WARNING: if the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented in TEveScene, TColor, TSystemDirectory, TSystemFile, TNode, TRotMatrix, TShape, TEfficiency, TFormula, TGraph2D, TH1, RooAbsArg, RooAbsData, RooDataHist, RooDataSet, RooFitResult, RooPlot, ROOT::Experimental::XRooFit::xRooNode, TChain, TEventList, TTree, TGraph, and TDirectory.

Definition at line 149 of file TNamed.cxx.

◆ SetNameTitle()

void TNamed::SetNameTitle ( const char * name,
const char * title )
virtualinherited

Set all the TNamed parameters (name and title).

WARNING: if the name is changed and the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented in TContextMenu, TNode, TGraph2D, TH1, RooAbsArg, RooAbsData, RooDataHist, RooDataSet, RooFitResult, RooPlot, and TGraph.

Definition at line 163 of file TNamed.cxx.

◆ SetNDC()

void TText::SetNDC ( Bool_t isNDC = kTRUE)
virtualinherited

Set NDC mode on if isNDC = kTRUE, off otherwise.

Definition at line 739 of file TText.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.

◆ SetText() [1/2]

virtual void TText::SetText ( Double_t x,
Double_t y,
const char * text )
inlinevirtualinherited

Definition at line 74 of file TText.h.

◆ SetText() [2/2]

virtual void TText::SetText ( Double_t x,
Double_t y,
const wchar_t * text )
inlinevirtualinherited

Definition at line 75 of file TText.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
tcolordefines the text color
talphadefines 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.

◆ SetTitle()

void TNamed::SetTitle ( const char * title = "")
virtualinherited

◆ SetUniqueID()

void TObject::SetUniqueID ( UInt_t uid)
virtualinherited

Set the unique object id.

Definition at line 899 of file TObject.cxx.

◆ SetX()

virtual void TText::SetX ( Double_t x)
inlinevirtualinherited

Definition at line 76 of file TText.h.

◆ SetY()

virtual void TText::SetY ( Double_t y)
inlinevirtualinherited

Definition at line 77 of file TText.h.

◆ Sizeof()

Int_t TNamed::Sizeof ( ) const
virtualinherited

Return size of the TNamed part of the TObject.

Reimplemented in TSQLFile, TXMLFile, TDirectory, TDirectoryFile, TFile, and TKey.

Definition at line 182 of file TNamed.cxx.

◆ Streamer()

void TLatex::Streamer ( TBuffer & R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TLatex::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b)
inline

Definition at line 123 of file TLatex.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.

◆ fError

const Char_t* TLatex::fError {nullptr}
protected

! error code

Definition at line 67 of file TLatex.h.

◆ fFactorPos

Double_t TLatex::fFactorPos
protected

! Relative position of subscripts and superscripts

Definition at line 65 of file TLatex.h.

◆ fFactorSize

Double_t TLatex::fFactorSize
protected

! Relative size of subscripts and superscripts

Definition at line 64 of file TLatex.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.

◆ fItalic

Bool_t TLatex::fItalic
protected

! Currently inside italic operator

Definition at line 71 of file TLatex.h.

◆ fLimitFactorSize

Int_t TLatex::fLimitFactorSize
protected

lower bound for subscripts/superscripts size

Definition at line 66 of file TLatex.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.

◆ fName

TString TNamed::fName
protectedinherited

Definition at line 32 of file TNamed.h.

◆ fOriginSize

Double_t TLatex::fOriginSize
protected

Font size of the starting font.

Definition at line 70 of file TLatex.h.

◆ fShow

Bool_t TLatex::fShow
protected

! is true during the second pass (Painting)

Definition at line 68 of file TLatex.h.

◆ fTabSize

std::vector<TLatexFormSize> TLatex::fTabSize
protected

! array of values for the different zones

Definition at line 69 of file TLatex.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.

◆ fTitle

TString TNamed::fTitle
protectedinherited

Definition at line 33 of file TNamed.h.

◆ fUniqueID

UInt_t TObject::fUniqueID
privateinherited

object unique identifier

Definition at line 46 of file TObject.h.

◆ fWcsTitle

void* TText::fWcsTitle {nullptr}
protectedinherited

!Used by TMathText

Definition at line 27 of file TText.h.

◆ fX

Double_t TText::fX {0}
protectedinherited

X position of text (left,center,etc..)

Definition at line 25 of file TText.h.

◆ fY

Double_t TText::fY {0}
protectedinherited

Y position of text (left,center,etc..)

Definition at line 26 of file TText.h.


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