ROOT  6.06/09
Reference Guide
Public Member Functions | Protected Attributes | Private Member Functions | List of all members
TLegendEntry Class Reference

Storage class for one entry of a TLegend.

Definition at line 44 of file TLegendEntry.h.

Public Member Functions

 TLegendEntry ()
 
 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 (const TObject &object)
 TObject copy ctor. More...
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual ~TObject ()
 TObject destructor. 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...
 
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 pad. More...
 
virtual void Dump () const
 Dump contents of object on stdout. 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 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 UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetIconName () const
 Returns mime type 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 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...
 
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...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
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 IsSortable () const
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. 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...
 
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...
 
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 UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. 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...
 
voidoperator new (size_t sz)
 
voidoperator new[] (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz, void *vp)
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. 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)
 
void ResetBit (UInt_t f)
 
Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
void InvertBit (UInt_t f)
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. 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...
 
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...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
- Public Member Functions inherited from TAttText
 TAttText ()
 
 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
 
virtual Float_t GetTextAngle () const
 
virtual Color_t GetTextColor () const
 
virtual Font_t GetTextFont () const
 
virtual Float_t GetTextSize () const
 
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 SetTextAttributes ()
 Invoke the DialogCanvas Text attributes. More...
 
virtual void SetTextAlign (Short_t align=11)
 
virtual void SetTextAngle (Float_t tangle=0)
 
virtual void SetTextColor (Color_t tcolor=1)
 
virtual void SetTextColorAlpha (Color_t tcolor, Float_t talpha)
 Set a transparent marker color. More...
 
virtual void SetTextFont (Font_t tfont=62)
 
virtual void SetTextSize (Float_t tsize=1)
 
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
 
virtual Style_t GetLineStyle () const
 
virtual Width_t GetLineWidth () const
 
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)
 
virtual void SetLineColorAlpha (Color_t lcolor, Float_t lalpha)
 Set a transparent line color. More...
 
virtual void SetLineStyle (Style_t lstyle)
 
virtual void SetLineWidth (Width_t lwidth)
 
 ClassDef (TAttLine, 2)
 
- Public Member Functions inherited from TAttFill
 TAttFill ()
 
 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
 
virtual Style_t GetFillStyle () const
 
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)
 
virtual void SetFillColorAlpha (Color_t fcolor, Float_t falpha)
 Set a transparent fill color. More...
 
virtual void SetFillStyle (Style_t fstyle)
 
- Public Member Functions inherited from TAttMarker
 TAttMarker ()
 
 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
 
virtual Style_t GetMarkerStyle () const
 
virtual Size_t GetMarkerSize () const
 
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)
 
virtual void SetMarkerColorAlpha (Color_t mcolor, Float_t malpha)
 Set a transparent marker color. More...
 
virtual void SetMarkerStyle (Style_t mstyle=1)
 
virtual void SetMarkerSize (Size_t msize=1)
 
 ClassDef (TAttMarker, 2)
 

Protected Attributes

TObjectfObject
 
TString fLabel
 
TString fOption
 
- Protected Attributes inherited from TAttText
Float_t fTextAngle
 
Float_t fTextSize
 
Short_t fTextAlign
 
Color_t fTextColor
 
Font_t fTextFont
 
- Protected Attributes inherited from TAttLine
Color_t fLineColor
 
Style_t fLineStyle
 
Width_t fLineWidth
 
- Protected Attributes inherited from TAttFill
Color_t fFillColor
 
Style_t fFillStyle
 
- Protected Attributes inherited from TAttMarker
Color_t fMarkerColor
 
Style_t fMarkerStyle
 
Size_t fMarkerSize
 

Private Member Functions

TLegendEntryoperator= (const TLegendEntry &)
 

Additional Inherited Members

- Public Types inherited from TObject
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4),
  kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
enum  { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Protected Member Functions inherited from TObject
void MakeZombie ()
 
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 

#include <TLegendEntry.h>

+ Inheritance diagram for TLegendEntry:
+ Collaboration diagram for TLegendEntry:

Constructor & Destructor Documentation

TLegendEntry::TLegendEntry ( )
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::TLegendEntry ( const TLegendEntry entry)

TLegendEntry copy constructor.

Definition at line 64 of file TLegendEntry.cxx.

TLegendEntry::~TLegendEntry ( )
virtual

TLegendEntry default destructor.

Definition at line 72 of file TLegendEntry.cxx.

Member Function Documentation

void TLegendEntry::Copy ( TObject obj) const
virtual

copy this TLegendEntry into obj

Reimplemented from TObject.

Definition at line 80 of file TLegendEntry.cxx.

virtual const char* TLegendEntry::GetLabel ( ) const
inlinevirtual

Definition at line 52 of file TLegendEntry.h.

Referenced by TLegend::GetHeader(), and TLegend::PaintPrimitives().

virtual TObject* TLegendEntry::GetObject ( ) const
inlinevirtual

Definition at line 53 of file TLegendEntry.h.

Referenced by TLegend::PaintPrimitives(), and TLegend::RecursiveRemove().

virtual Option_t* TLegendEntry::GetOption ( ) const
inlinevirtual

Reimplemented from TObject.

Definition at line 54 of file TLegendEntry.h.

Referenced by TLegend::GetHeader(), TLegend::PaintPrimitives(), and TLegend::SetHeader().

TLegendEntry& TLegendEntry::operator= ( const TLegendEntry )
private
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.

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.

Referenced by TLegend::SavePrimitive().

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

Definition at line 57 of file TLegendEntry.h.

Referenced by TLegend::SetEntryLabel(), and TLegend::SetHeader().

void TLegendEntry::SetObject ( TObject obj)
virtual

(re)set the obj pointed to by this entry

Definition at line 135 of file TLegendEntry.cxx.

Referenced by TLegend::RecursiveRemove(), SetObject(), and TLegendEntry().

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

(re)set the obj pointed to by this entry

Definition at line 146 of file TLegendEntry.cxx.

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

Definition at line 60 of file TLegendEntry.h.

Referenced by TLegend::SetEntryOption().

Member Data Documentation

TString TLegendEntry::fLabel
protected

Definition at line 64 of file TLegendEntry.h.

Referenced by Copy(), GetLabel(), Print(), SaveEntry(), SetLabel(), SetObject(), and TLegendEntry().

TObject* TLegendEntry::fObject
protected

Definition at line 63 of file TLegendEntry.h.

Referenced by Copy(), GetObject(), Print(), SaveEntry(), SetObject(), TLegendEntry(), and ~TLegendEntry().

TString TLegendEntry::fOption
protected

Definition at line 65 of file TLegendEntry.h.

Referenced by Copy(), GetOption(), Print(), SaveEntry(), SetOption(), and TLegendEntry().


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