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

Define a Frame.

A TFrame is a TWbox for drawing histogram frames.

Definition at line 19 of file TFrame.h.

Public Member Functions

 TFrame ()
 Frame default constructor.
 
 TFrame (const TFrame &frame)
 Frame copy constructor.
 
 TFrame (Double_t x1, Double_t y1, Double_t x2, Double_t y2)
 Frame normal constructor.
 
virtual ~TFrame ()
 Frame default destructor.
 
void Copy (TObject &frame) const override
 Copy this frame to frame.
 
void Draw (Option_t *option="") override
 Draw this frame with its current attributes.
 
void ExecuteEvent (Int_t event, Int_t px, Int_t py) override
 Execute action corresponding to one event.
 
TClassIsA () const override
 
void Paint (Option_t *option="") override
 Paint this wbox with its current attributes.
 
void Pop () override
 Do not pop frame's, if allowed they would cover the picture they frame.
 
void SavePrimitive (std::ostream &out, Option_t *option="") override
 Save primitive as a C++ statement(s) on output stream out.
 
void Streamer (TBuffer &) override
 Stream an object of class TBox.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
void UseCurrentStyle () override
 Replace current frame attributes by current style.
 
- Public Member Functions inherited from TWbox
 TWbox ()
 
 TWbox (const TWbox &wbox)
 wbox copy constructor.
 
 TWbox (Double_t x1, Double_t y1, Double_t x2, Double_t y2, Color_t color=18, Short_t bordersize=5, Short_t bordermode=1)
 wbox normal constructor.
 
virtual ~TWbox ()=default
 
void Copy (TObject &wbox) const override
 Copy this wbox to wbox.
 
void Draw (Option_t *option="") override
 Draw this wbox with its current attributes.
 
virtual TWboxDrawWbox (Double_t x1, Double_t y1, Double_t x2, Double_t y2, Color_t color=33, Short_t bordersize=5, Short_t bordermode=-1)
 Draw this wbox with new coordinates.
 
void ExecuteEvent (Int_t event, Int_t px, Int_t py) override
 Execute action corresponding to one event.
 
Short_t GetBorderMode () const
 
Short_t GetBorderSize () const
 
Int_t GetDarkColor () const
 
Int_t GetLightColor () const
 
TClassIsA () const override
 
TWboxoperator= (const TWbox &src)
 assignment operator
 
void Paint (Option_t *option="") override
 Paint this wbox with its current attributes.
 
virtual void PaintFrame (Double_t x1, Double_t y1, Double_t x2, Double_t y2, Color_t color, Short_t bordersize, Short_t bordermode, Bool_t tops)
 Paint a 3D frame around a box.
 
virtual void PaintWbox (Double_t x1, Double_t y1, Double_t x2, Double_t y2, Color_t color=33, Short_t bordersize=5, Short_t bordermode=-1)
 Draw this wbox with new coordinates.
 
void SavePrimitive (std::ostream &out, Option_t *option="") override
 Save primitive as a C++ statement(s) on output stream out.
 
virtual void SetBorderMode (Short_t bordermode)
 
virtual void SetBorderSize (Short_t bordersize)
 
void Streamer (TBuffer &) override
 Stream an object of class TBox.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TBox
 TBox ()
 Box default constructor.
 
 TBox (const TBox &box)
 Box copy constructor.
 
 TBox (Double_t x1, Double_t y1, Double_t x2, Double_t y2)
 Box standard constructor.
 
virtual ~TBox ()
 Box destructor.
 
Int_t DistancetoPrimitive (Int_t px, Int_t py) override
 Compute distance from point px,py to a box.
 
virtual TBoxDrawBox (Double_t x1, Double_t y1, Double_t x2, Double_t y2)
 Draw this box with new coordinates.
 
Rectangle_t GetBBox () override
 Return the "bounding Box" of the Box.
 
TPoint GetBBoxCenter () override
 Return the center of the Box as TPoint in pixels.
 
Double_t GetX1 () const
 
Double_t GetX2 () const
 
Double_t GetY1 () const
 
Double_t GetY2 () const
 
virtual void HideToolTip (Int_t event)
 Hide tool tip depending on the event type.
 
Bool_t IsBeingResized () const
 
virtual Int_t IsInside (Double_t x, Double_t y) const
 Function which returns 1 if point x,y lies inside the box, 0 otherwise.
 
void ls (Option_t *option="") const override
 List this box with its attributes.
 
TBoxoperator= (const TBox &)
 Assignment operator.
 
virtual void PaintBox (Double_t x1, Double_t y1, Double_t x2, Double_t y2, Option_t *option="")
 Draw this box with new coordinates.
 
void Print (Option_t *option="") const override
 Dump this box with its attributes.
 
void SetBBoxCenter (const TPoint &p) override
 Set center of the Box.
 
void SetBBoxCenterX (const Int_t x) override
 Set X coordinate of the center of the Box.
 
void SetBBoxCenterY (const Int_t y) override
 Set Y coordinate of the center of the Box.
 
void SetBBoxX1 (const Int_t x) override
 Set left hand side of BoundingBox to a value (resize in x direction on left)
 
void SetBBoxX2 (const Int_t x) override
 Set right hand side of BoundingBox to a value (resize in x direction on right)
 
void SetBBoxY1 (const Int_t y) override
 Set top of BoundingBox to a value (resize in y direction on top)
 
void SetBBoxY2 (const Int_t y) override
 Set bottom of BoundingBox to a value (resize in y direction on bottom)
 
virtual void SetToolTipText (const char *text, Long_t delayms=1000)
 Set tool tip text associated with this box.
 
virtual void SetX1 (Double_t x1)
 
virtual void SetX2 (Double_t x2)
 
virtual void SetY1 (Double_t y1)
 
virtual void SetY2 (Double_t y2)
 
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 TObjectClone (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 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).
 
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 Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () 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 Option_tGetOption () const
 
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
 
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.
 
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)
 Operator delete [].
 
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)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator.
 
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.
 
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 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 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 TAttBBox2D
virtual ~TAttBBox2D ()
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TWbox
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TBox
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
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.
 
- Static Public Member Functions inherited from TAttLine
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TAttFill
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TAttBBox2D
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 

Additional Inherited Members

- Public Types inherited from TBox
enum  { kCannotMove = (1ULL << ( 12 )) }
 
- 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 ()
 
- Protected Attributes inherited from TWbox
Short_t fBorderMode {0}
 Bordermode (-1=down, 0 = no border, 1=up)
 
Short_t fBorderSize {0}
 window box bordersize in pixels
 
- Protected Attributes inherited from TBox
Bool_t fResizing
 ! True if box is being resized
 
Double_t fX1
 X of 1st point.
 
Double_t fX2
 X of 2nd point.
 
Double_t fY1
 Y of 1st point.
 
Double_t fY2
 Y of 2nd point.
 
- 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.
 

#include <TFrame.h>

Inheritance diagram for TFrame:
[legend]

Constructor & Destructor Documentation

◆ TFrame() [1/3]

TFrame::TFrame ( )

Frame default constructor.

Definition at line 29 of file TFrame.cxx.

◆ TFrame() [2/3]

TFrame::TFrame ( Double_t  x1,
Double_t  y1,
Double_t  x2,
Double_t  y2 
)

Frame normal constructor.

Definition at line 36 of file TFrame.cxx.

◆ TFrame() [3/3]

TFrame::TFrame ( const TFrame frame)

Frame copy constructor.

Definition at line 44 of file TFrame.cxx.

◆ ~TFrame()

TFrame::~TFrame ( )
virtual

Frame default destructor.

Definition at line 52 of file TFrame.cxx.

Member Function Documentation

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 35 of file TFrame.h.

◆ Copy()

void TFrame::Copy ( TObject frame) const
overridevirtual

Copy this frame to frame.

Reimplemented from TBox.

Definition at line 59 of file TFrame.cxx.

◆ DeclFileName()

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

Definition at line 35 of file TFrame.h.

◆ Draw()

void TFrame::Draw ( Option_t option = "")
overridevirtual

Draw this frame with its current attributes.

Reimplemented from TBox.

Definition at line 67 of file TFrame.cxx.

◆ ExecuteEvent()

void TFrame::ExecuteEvent ( Int_t  event,
Int_t  px,
Int_t  py 
)
overridevirtual

Execute action corresponding to one event.

This member function is called when a TFrame object is clicked.

Reimplemented from TBox.

Definition at line 77 of file TFrame.cxx.

◆ IsA()

TClass * TFrame::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TBox.

Definition at line 35 of file TFrame.h.

◆ Paint()

void TFrame::Paint ( Option_t option = "")
overridevirtual

Paint this wbox with its current attributes.

Reimplemented from TBox.

Definition at line 128 of file TFrame.cxx.

◆ Pop()

void TFrame::Pop ( )
overridevirtual

Do not pop frame's, if allowed they would cover the picture they frame.

Reimplemented from TObject.

Definition at line 143 of file TFrame.cxx.

◆ SavePrimitive()

void TFrame::SavePrimitive ( std::ostream &  out,
Option_t option = "" 
)
overridevirtual

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

Reimplemented from TBox.

Definition at line 150 of file TFrame.cxx.

◆ Streamer()

void TFrame::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TBox.

Reimplemented from TBox.

◆ StreamerNVirtual()

void TFrame::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 35 of file TFrame.h.

◆ UseCurrentStyle()

void TFrame::UseCurrentStyle ( )
overridevirtual

Replace current frame attributes by current style.

Reimplemented from TObject.

Definition at line 157 of file TFrame.cxx.

Libraries for TFrame:

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