Logo ROOT   6.30.04
Reference Guide
 All Namespaces Files Pages
TLegend.h
Go to the documentation of this file.
1 // @(#)root/graf:$Id$
2 // Author: Matthew.Adam.Dobbs 06/09/99
3 
4 /*************************************************************************
5  * Copyright (C) 1995-2000, Rene Brun and Fons Rademakers. *
6  * All rights reserved. *
7  * *
8  * For the licensing terms see $ROOTSYS/LICENSE. *
9  * For the list of contributors see $ROOTSYS/README/CREDITS. *
10  *************************************************************************/
11 //--------------------------------------------------------------------------
12 #ifndef ROOT_TLegend
13 #define ROOT_TLegend
14 
15 
16 #include "TPave.h"
17 #include "TAttText.h"
18 
19 class TObject;
20 class TList;
21 class TLegendEntry;
22 
23 class TLegend : public TPave , public TAttText {
24 
25 protected:
26  TLegend& operator=(const TLegend&);
27 
28 public:
29  TLegend();
30  TLegend( Double_t x1, Double_t y1, Double_t x2, Double_t y2,
31  const char* header = "", Option_t* option="brNDC" );
32  TLegend( Double_t w, Double_t h, const char* header = "", Option_t* option="brNDC" );
33  virtual ~TLegend();
34  TLegend( const TLegend &legend );
35 
36  TLegendEntry *AddEntry(const TObject* obj, const char* label = "", Option_t* option = "lpf" );
37  TLegendEntry *AddEntry(const char *name, const char* label = "", Option_t* option = "lpf" );
38  virtual void Clear( Option_t* option = "" ); // *MENU*
39  virtual void Copy( TObject &obj ) const;
40  virtual void DeleteEntry(); // *MENU*
41  virtual void Draw( Option_t* option = "" );
42  virtual void EditEntryAttFill();
43  virtual void EditEntryAttLine();
44  virtual void EditEntryAttMarker();
45  virtual void EditEntryAttText();
46  Float_t GetColumnSeparation() const { return fColumnSeparation; }
47  TLegendEntry *GetEntry() const;
48  Float_t GetEntrySeparation() const { return fEntrySeparation; }
49  virtual const char *GetHeader() const;
50  TList *GetListOfPrimitives() const {return fPrimitives;}
51  Float_t GetMargin() const { return fMargin; }
52  Int_t GetNColumns() const { return fNColumns; }
53  Int_t GetNRows() const;
54  virtual void InsertEntry( const char* objectName = "",const char* label = "",
55  Option_t* option = "lpf" ); // *MENU*
56  virtual void Paint( Option_t* option = "" );
57  virtual void PaintPrimitives();
58  virtual void Print( Option_t* option = "" ) const;
59  virtual void RecursiveRemove(TObject *obj);
60  virtual void SavePrimitive(std::ostream &out, Option_t *option = "");
61  void SetDefaults() { fEntrySeparation = 0.1f; fMargin = 0.25f; fNColumns = 1; fColumnSeparation = 0.0f; }
62  void SetColumnSeparation( Float_t columnSeparation )
63  { fColumnSeparation = columnSeparation; } // *MENU*
64  virtual void SetEntryLabel( const char* label ); // *MENU*
65  virtual void SetEntryOption( Option_t* option ); // *MENU*
66  void SetEntrySeparation( Float_t entryseparation )
67  { fEntrySeparation = entryseparation; } // *MENU*
68  virtual void SetHeader( const char *header = "", Option_t *option = "" ); // *MENU*
69  void SetMargin( Float_t margin ) { fMargin = margin; } // *MENU*
70  void SetNColumns( Int_t nColumns ); // *MENU*
71 
72 protected:
73  TList *fPrimitives; ///< List of TLegendEntries
74  Float_t fEntrySeparation; ///< Separation between entries, as a fraction of
75  ///< The space allocated to one entry.
76  ///< Typical value is 0.1.
77  Float_t fMargin; ///< Fraction of total width used for symbol
78  Int_t fNColumns; ///< Number of columns in the legend
79  Float_t fColumnSeparation; ///< Separation between columns, as a fraction of
80  ///< The space allowed to one column
81 
82  ClassDef(TLegend,3) // Legend of markers/lines/boxes to represent obj's
83 };
84 
85 #endif