Storage class for one entry of a TLegend.

Definition at line 24 of file TLegendEntry.h.

Public Member Functions
	TLegendEntry ()
	TLegendEntry do-nothing default constructor.

	TLegendEntry (const TLegendEntry &entry)
	TLegendEntry copy constructor.

	TLegendEntry (const TObject obj, const char label=nullptr, Option_t *option="lpf")
	TLegendEntry normal constructor for one entry in a TLegend.

	~TLegendEntry () override
	TLegendEntry default destructor.

void	Copy (TObject &obj) const override
	copy this TLegendEntry into obj

virtual const char *	GetLabel () const

virtual TObject *	GetObject () const

Option_t *	GetOption () const override

TClass *	IsA () const override

void	Print (Option_t *option="") const override
	dump this TLegendEntry to std::cout

virtual void	SaveEntry (std::ostream &out, const char *name)
	Save this TLegendEntry as C++ statements on output stream out to be used with the SaveAs .C option.

virtual void	SetLabel (const char *label="")

virtual void	SetObject (const char *objectName)
	(re)set the obj pointed to by this entry

virtual void	SetObject (TObject *obj)
	(re)set the obj pointed to by this entry

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

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

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

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.

virtual void	Clear (Option_t *="")

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	Delete (Option_t *option="")
	Delete this object.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

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 TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: `gROOT->SetSelectedPad(c1)`.

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.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

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.

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

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

virtual const char *	GetName () const
	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 const char *	GetTitle () const
	Returns title of object.

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

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

virtual ULong_t	Hash () const
	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)

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

virtual Bool_t	IsSortable () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

virtual void	ls (Option_t *option="") const
	The ls function lists the contents of a class on stdout.

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 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 *ptr)
	Operator delete.

void	operator delete (void ptr, void vp)
	Only called by placement new when throwing an exception.

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)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator.

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

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

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.

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	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".

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	SetUniqueID (UInt_t uid)
	Set the unique object id.

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.

Public Member Functions inherited from TAttText
	TAttText ()
	AttText default constructor.

	TAttText (Int_t align, Float_t angle, Color_t color, Style_t font, Float_t tsize)
	AttText normal constructor.

virtual	~TAttText ()
	AttText destructor.

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

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

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

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

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.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TAttLine
	TAttLine ()
	AttLine default constructor.

	TAttLine (Color_t lcolor, Style_t lstyle, Width_t lwidth)
	AttLine normal constructor.

virtual	~TAttLine ()
	AttLine destructor.

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

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.

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.

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

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

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.

virtual void	SetLineAttributes ()
	Invoke the DialogCanvas Line attributes.

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

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	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TAttFill
	TAttFill ()
	AttFill default constructor.

	TAttFill (Color_t fcolor, Style_t fstyle)
	AttFill normal constructor.

virtual	~TAttFill ()
	AttFill destructor.

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

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

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

virtual Bool_t	IsTransparent () const

virtual void	Modify ()
	Change current fill area attributes if necessary.

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

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	SetFillAttributes ()
	Invoke the DialogCanvas Fill attributes.

virtual void	SetFillColor (Color_t fcolor)
	Set the fill area 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.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TAttMarker
	TAttMarker ()
	TAttMarker default constructor.

	TAttMarker (Color_t color, Style_t style, Size_t msize)
	TAttMarker normal constructor.

virtual	~TAttMarker ()
	TAttMarker destructor.

void	Copy (TAttMarker &attmarker) const
	Copy this marker attributes to a new TAttMarker.

virtual Color_t	GetMarkerColor () const
	Return the marker color.

virtual Size_t	GetMarkerSize () const
	Return the marker size.

virtual Style_t	GetMarkerStyle () const
	Return the marker style.

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

virtual void	ResetAttMarker (Option_t *toption="")
	Reset this marker attributes to the default values.

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

virtual void	SetMarkerAttributes ()
	Invoke the DialogCanvas Marker attributes.

virtual void	SetMarkerColor (Color_t mcolor=1)
	Set the marker color.

virtual void	SetMarkerColorAlpha (Color_t mcolor, Float_t malpha)
	Set a transparent marker color.

virtual void	SetMarkerSize (Size_t msize=1)
	Set the marker size.

virtual void	SetMarkerStyle (Style_t mstyle=1)
	Set the marker style.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
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.

Static Public Member Functions inherited from TAttText
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TAttLine
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TAttFill
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TAttMarker
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Width_t	GetMarkerLineWidth (Style_t style)
	Internal helper function that returns the line width of the given marker style (0 = filled marker)

static Style_t	GetMarkerStyleBase (Style_t style)
	Internal helper function that returns the corresponding marker style with line width 1 for the given style.

Protected Attributes
TString	fLabel
	Text associated with the entry, will become latex.

TObject *	fObject
	pointer to object being represented by this entry

TString	fOption
	Options associated with this entry.

Protected Attributes inherited from TAttText
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.

Protected Attributes inherited from TAttLine
Color_t	fLineColor
	Line color.

Style_t	fLineStyle
	Line style.

Width_t	fLineWidth
	Line width.

Protected Attributes inherited from TAttFill
Color_t	fFillColor
	Fill area color.

Style_t	fFillStyle
	Fill area style.

Protected Attributes inherited from TAttMarker
Color_t	fMarkerColor
	Marker color.

Size_t	fMarkerSize
	Marker size.

Style_t	fMarkerStyle
	Marker style.

Private Member Functions
TLegendEntry &	operator= (const TLegendEntry &)=delete

Additional Inherited Members
Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

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

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

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).

void	MakeZombie ()

#include <TLegendEntry.h>

Inheritance diagram for TLegendEntry:

[legend]

Constructor & Destructor Documentation

◆ TLegendEntry() [1/3]

TLegendEntry::TLegendEntry ( )

TLegendEntry do-nothing default constructor.

Definition at line 30 of file TLegendEntry.cxx.

◆ TLegendEntry() [2/3]

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

TLegendEntry normal constructor for one entry in a TLegend.

obj is the object this entry will represent. If obj has line/fill/marker attributes, then the TLegendEntry will display these attributes.

label is the text that will describe the entry, it is displayed using TLatex, so may have a complex format.

option may have values

L draw line associated w/ TAttLine if obj inherits from TAttLine
P draw polymarker assoc. w/ TAttMarker if obj inherits from TAttMarker
F draw a box with fill associated w/ TAttFill if obj inherits TAttFill default is object = "LPF"

Definition at line 51 of file TLegendEntry.cxx.

◆ TLegendEntry() [3/3]

TLegendEntry::TLegendEntry ( const TLegendEntry & entry )

TLegendEntry copy constructor.

Definition at line 64 of file TLegendEntry.cxx.

◆ ~TLegendEntry()

TLegendEntry::~TLegendEntry ( )

override

TLegendEntry default destructor.

Definition at line 72 of file TLegendEntry.cxx.

Member Function Documentation

◆ Class()

static TClass * TLegendEntry::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TLegendEntry::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TLegendEntry::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 50 of file TLegendEntry.h.

◆ Copy()

void TLegendEntry::Copy ( TObject & obj ) const

overridevirtual

copy this TLegendEntry into obj

Reimplemented from TObject.

Definition at line 80 of file TLegendEntry.cxx.

◆ DeclFileName()

static const char * TLegendEntry::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 50 of file TLegendEntry.h.

◆ GetLabel()

virtual const char * TLegendEntry::GetLabel ( ) const

inlinevirtual

Definition at line 32 of file TLegendEntry.h.

◆ GetObject()

virtual TObject * TLegendEntry::GetObject ( ) const

inlinevirtual

Definition at line 33 of file TLegendEntry.h.

◆ GetOption()

Option_t * TLegendEntry::GetOption ( ) const

inlineoverridevirtual

Reimplemented from TObject.

Definition at line 34 of file TLegendEntry.h.

◆ IsA()

TClass * TLegendEntry::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Definition at line 50 of file TLegendEntry.h.

◆ operator=()

TLegendEntry & TLegendEntry::operator= ( const TLegendEntry & )

privatedelete

◆ Print()

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

overridevirtual

dump this TLegendEntry to std::cout

Reimplemented from TObject.

Definition at line 95 of file TLegendEntry.cxx.

◆ SaveEntry()

void TLegendEntry::SaveEntry	(	std::ostream &	out,
		const char *	name
	)

virtual

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

Definition at line 114 of file TLegendEntry.cxx.

◆ SetLabel()

virtual void TLegendEntry::SetLabel ( const char * label = "" )

inlinevirtual

Definition at line 37 of file TLegendEntry.h.

◆ SetObject() [1/2]

void TLegendEntry::SetObject ( const char * objectName )

virtual

(re)set the obj pointed to by this entry

Definition at line 149 of file TLegendEntry.cxx.

◆ SetObject() [2/2]

void TLegendEntry::SetObject ( TObject * obj )

virtual

(re)set the obj pointed to by this entry

Definition at line 138 of file TLegendEntry.cxx.

◆ SetOption()

virtual void TLegendEntry::SetOption ( Option_t * option = "lpf" )

inlinevirtual

Definition at line 40 of file TLegendEntry.h.

◆ Streamer()

void TLegendEntry::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TLegendEntry::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 50 of file TLegendEntry.h.

Member Data Documentation

◆ fLabel

TString TLegendEntry::fLabel

protected

Text associated with the entry, will become latex.

Definition at line 44 of file TLegendEntry.h.

◆ fObject

TObject* TLegendEntry::fObject

protected

pointer to object being represented by this entry

Definition at line 43 of file TLegendEntry.h.

◆ fOption

TString TLegendEntry::fOption

protected

Options associated with this entry.

Definition at line 45 of file TLegendEntry.h.

Libraries for TLegendEntry:

[legend]

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

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ TLegendEntry() [1/3]

◆ TLegendEntry() [2/3]

◆ TLegendEntry() [3/3]

◆ ~TLegendEntry()

Member Function Documentation

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ Copy()

◆ DeclFileName()

◆ GetLabel()

◆ GetObject()

◆ GetOption()

◆ IsA()

◆ operator=()

◆ Print()

◆ SaveEntry()

◆ SetLabel()

◆ SetObject() [1/2]

◆ SetObject() [2/2]

◆ SetOption()

◆ Streamer()

◆ StreamerNVirtual()

Member Data Documentation

◆ fLabel

◆ fObject

◆ fOption