Logo ROOT   6.19/01
Reference Guide
TLegendEntry Class Reference

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. More...
 
 TLegendEntry (const TObject *obj, const char *label=0, Option_t *option="lpf")
 TLegendEntry normal constructor for one entry in a TLegend. More...
 
 TLegendEntry (const TLegendEntry &entry)
 TLegendEntry copy constructor. More...
 
virtual ~TLegendEntry ()
 TLegendEntry default destructor. More...
 
virtual void Copy (TObject &obj) const
 copy this TLegendEntry into obj More...
 
virtual const char * GetLabel () const
 
virtual TObjectGetObject () const
 
virtual Option_tGetOption () const
 
virtual void Print (Option_t *option="") const
 dump this TLegendEntry to std::cout More...
 
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. More...
 
virtual void SetLabel (const char *label="")
 
virtual void SetObject (TObject *obj)
 (re)set the obj pointed to by this entry More...
 
virtual void SetObject (const char *objectName)
 (re)set the obj pointed to by this entry More...
 
virtual void SetOption (Option_t *option="lpf")
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
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. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
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. More...
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 
- Public Member Functions inherited from TAttText
 TAttText ()
 AttText default constructor. More...
 
 TAttText (Int_t align, Float_t angle, Color_t color, Style_t font, Float_t tsize)
 AttText normal constructor. More...
 
virtual ~TAttText ()
 AttText destructor. More...
 
void Copy (TAttText &atttext) const
 Copy this text attributes to a new TAttText. More...
 
virtual Short_t GetTextAlign () const
 Return the text alignment. More...
 
virtual Float_t GetTextAngle () const
 Return the text angle. More...
 
virtual Color_t GetTextColor () const
 Return the text color. More...
 
virtual Font_t GetTextFont () const
 Return the text font. More...
 
virtual Float_t GetTextSize () const
 Return the text size. More...
 
virtual void Modify ()
 Change current text attributes if necessary. More...
 
virtual void ResetAttText (Option_t *toption="")
 Reset this text attributes to default values. More...
 
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. More...
 
virtual void SetTextAlign (Short_t align=11)
 Set the text alignment. More...
 
virtual void SetTextAngle (Float_t tangle=0)
 Set the text angle. More...
 
virtual void SetTextAttributes ()
 Invoke the DialogCanvas Text attributes. More...
 
virtual void SetTextColor (Color_t tcolor=1)
 Set the text color. More...
 
virtual void SetTextColorAlpha (Color_t tcolor, Float_t talpha)
 Set a transparent marker color. More...
 
virtual void SetTextFont (Font_t tfont=62)
 Set the text font. More...
 
virtual void SetTextSize (Float_t tsize=1)
 Set the text size. More...
 
virtual void SetTextSizePixels (Int_t npixels)
 Set the text size in pixels. More...
 
- Public Member Functions inherited from TAttLine
 TAttLine ()
 AttLine default constructor. More...
 
 TAttLine (Color_t lcolor, Style_t lstyle, Width_t lwidth)
 AttLine normal constructor. More...
 
virtual ~TAttLine ()
 AttLine destructor. More...
 
void Copy (TAttLine &attline) const
 Copy this line attributes to a new TAttLine. More...
 
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. More...
 
virtual Color_t GetLineColor () const
 Return the line color. More...
 
virtual Style_t GetLineStyle () const
 Return the line style. More...
 
virtual Width_t GetLineWidth () const
 Return the line width. More...
 
virtual void Modify ()
 Change current line attributes if necessary. More...
 
virtual void ResetAttLine (Option_t *option="")
 Reset this line attributes to default values. More...
 
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. More...
 
virtual void SetLineAttributes ()
 Invoke the DialogCanvas Line attributes. More...
 
virtual void SetLineColor (Color_t lcolor)
 Set the line color. More...
 
virtual void SetLineColorAlpha (Color_t lcolor, Float_t lalpha)
 Set a transparent line color. More...
 
virtual void SetLineStyle (Style_t lstyle)
 Set the line style. More...
 
virtual void SetLineWidth (Width_t lwidth)
 Set the line width. More...
 
- Public Member Functions inherited from TAttFill
 TAttFill ()
 AttFill default constructor. More...
 
 TAttFill (Color_t fcolor, Style_t fstyle)
 AttFill normal constructor. More...
 
virtual ~TAttFill ()
 AttFill destructor. More...
 
void Copy (TAttFill &attfill) const
 Copy this fill attributes to a new TAttFill. More...
 
virtual Color_t GetFillColor () const
 Return the fill area color. More...
 
virtual Style_t GetFillStyle () const
 Return the fill area style. More...
 
virtual Bool_t IsTransparent () const
 
virtual void Modify ()
 Change current fill area attributes if necessary. More...
 
virtual void ResetAttFill (Option_t *option="")
 Reset this fill attributes to default values. More...
 
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. More...
 
virtual void SetFillAttributes ()
 Invoke the DialogCanvas Fill attributes. More...
 
virtual void SetFillColor (Color_t fcolor)
 Set the fill area color. More...
 
virtual void SetFillColorAlpha (Color_t fcolor, Float_t falpha)
 Set a transparent fill color. More...
 
virtual void SetFillStyle (Style_t fstyle)
 Set the fill area style. More...
 
- Public Member Functions inherited from TAttMarker
 TAttMarker ()
 TAttMarker default constructor. More...
 
 TAttMarker (Color_t color, Style_t style, Size_t msize)
 TAttMarker normal constructor. More...
 
virtual ~TAttMarker ()
 TAttMarker destructor. More...
 
void Copy (TAttMarker &attmarker) const
 Copy this marker attributes to a new TAttMarker. More...
 
virtual Color_t GetMarkerColor () const
 Return the marker color. More...
 
virtual Size_t GetMarkerSize () const
 Return the marker size. More...
 
virtual Style_t GetMarkerStyle () const
 Return the marker style. More...
 
virtual void Modify ()
 Change current marker attributes if necessary. More...
 
virtual void ResetAttMarker (Option_t *toption="")
 Reset this marker attributes to the default values. More...
 
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. More...
 
virtual void SetMarkerAttributes ()
 Invoke the DialogCanvas Marker attributes. More...
 
virtual void SetMarkerColor (Color_t mcolor=1)
 Set the marker color. More...
 
virtual void SetMarkerColorAlpha (Color_t mcolor, Float_t malpha)
 Set a transparent marker color. More...
 
virtual void SetMarkerSize (Size_t msize=1)
 Set the marker size. More...
 
virtual void SetMarkerStyle (Style_t mstyle=1)
 Set the marker style. More...
 

Protected Attributes

TString fLabel
 Text associated with the entry, will become latex. More...
 
TObjectfObject
 pointer to object being represented by this entry More...
 
TString fOption
 Options associated with this entry. More...
 
- Protected Attributes inherited from TAttText
Short_t fTextAlign
 Text alignment. More...
 
Float_t fTextAngle
 Text angle. More...
 
Color_t fTextColor
 Text color. More...
 
Font_t fTextFont
 Text font. More...
 
Float_t fTextSize
 Text size. More...
 
- Protected Attributes inherited from TAttLine
Color_t fLineColor
 Line color. More...
 
Style_t fLineStyle
 Line style. More...
 
Width_t fLineWidth
 Line width. More...
 
- Protected Attributes inherited from TAttFill
Color_t fFillColor
 Fill area color. More...
 
Style_t fFillStyle
 Fill area style. More...
 
- Protected Attributes inherited from TAttMarker
Color_t fMarkerColor
 Marker color. More...
 
Size_t fMarkerSize
 Marker size. More...
 
Style_t fMarkerStyle
 Marker style. More...
 

Private Member Functions

TLegendEntryoperator= (const TLegendEntry &)
 

Additional Inherited Members

- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kInconsistent = 0x08000000,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Static Public Member Functions inherited from TAttMarker
static Width_t GetMarkerLineWidth (Style_t style)
 Internal helper function that returns the line width of the given marker style (0 = filled marker) More...
 
static Style_t GetMarkerStyleBase (Style_t style)
 Internal helper function that returns the corresponding marker style with line width 1 for the given style. More...
 
- 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). More...
 
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 = 0,
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

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

TLegendEntry default destructor.

Definition at line 72 of file TLegendEntry.cxx.

Member Function Documentation

◆ Copy()

void TLegendEntry::Copy ( TObject obj) const
virtual

copy this TLegendEntry into obj

Reimplemented from TObject.

Definition at line 80 of file TLegendEntry.cxx.

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

virtual Option_t* TLegendEntry::GetOption ( ) const
inlinevirtual

Reimplemented from TObject.

Definition at line 34 of file TLegendEntry.h.

◆ operator=()

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

◆ Print()

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

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 ( TObject obj)
virtual

(re)set the obj pointed to by this entry

Definition at line 135 of file TLegendEntry.cxx.

◆ SetObject() [2/2]

void TLegendEntry::SetObject ( const char *  objectName)
virtual

(re)set the obj pointed to by this entry

Definition at line 146 of file TLegendEntry.cxx.

◆ SetOption()

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

Definition at line 40 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: