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

Special TText object used to show hyperlinks.

In the example below created by TObject::Inspect, TLinks are used to show pointers to other objects. Clicking on one link, inspect the corresponding object.

Definition at line 17 of file TLink.h.

Public Types

enum  EStatusBits { kIsStarStar = (1ULL << ( 2 )) }
 
- Public Types inherited from TText
enum  { kTextNDC = (1ULL << ( 14 )) }
 
- 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 ))
}
 

Public Member Functions

 TLink ()
 Link default constructor.
 
 TLink (Double_t x, Double_t y, void *pointer)
 Constructor to define a link object.
 
 ~TLink () override
 Link default destructor.
 
void ExecuteEvent (Int_t event, Int_t px, Int_t py) override
 Execute action corresponding to one event.
 
TClassIsA () const override
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TText
 TText ()
 
 TText (const TText &text)
 Copy constructor.
 
 TText (Double_t x, Double_t y, const char *text)
 Text normal constructor.
 
 TText (Double_t x, Double_t y, const wchar_t *text)
 Text normal constructor.
 
 ~TText () override
 Text default destructor.
 
void Copy (TObject &text) const override
 Copy this text to text.
 
Int_t DistancetoPrimitive (Int_t px, Int_t py) override
 Compute distance from point px,py to a string.
 
virtual TTextDrawText (Double_t x, Double_t y, const char *text)
 Draw this text with new coordinates.
 
virtual TTextDrawText (Double_t x, Double_t y, const wchar_t *text)
 Draw this text with new coordinates.
 
virtual TTextDrawTextNDC (Double_t x, Double_t y, const char *text)
 Draw this text with new coordinates in NDC.
 
virtual TTextDrawTextNDC (Double_t x, Double_t y, const wchar_t *text)
 Draw this text with new coordinates in NDC.
 
void ExecuteEvent (Int_t event, Int_t px, Int_t py) override
 Execute action corresponding to one event.
 
Rectangle_t GetBBox () override
 Return the "bounding Box" of the Box.
 
TPoint GetBBoxCenter () override
 Return the point given by Alignment as 'center'.
 
virtual void GetBoundingBox (UInt_t &w, UInt_t &h, Bool_t angle=kFALSE)
 Return text size in pixels.
 
virtual void GetControlBox (Int_t x, Int_t y, Double_t theta, Int_t cBoxX[4], Int_t cBoxY[4])
 Return the text control box.
 
virtual void GetTextAdvance (UInt_t &a, const char *text, const Bool_t kern=kTRUE) const
 Return text advance for string text if kern is true (default) kerning is taken into account.
 
virtual void GetTextAscentDescent (UInt_t &a, UInt_t &d, const char *text) const
 Return text ascent and descent for string text.
 
virtual void GetTextAscentDescent (UInt_t &a, UInt_t &d, const wchar_t *text) const
 Return text ascent and descent for string text.
 
virtual void GetTextExtent (UInt_t &w, UInt_t &h, const char *text) const
 Return text extent for string text.
 
virtual void GetTextExtent (UInt_t &w, UInt_t &h, const wchar_t *text) const
 Return text extent for string text.
 
const void * GetWcsTitle (void) const
 Returns the text as UNICODE.
 
Double_t GetX () const
 
Double_t GetY () const
 
TClassIsA () const override
 
void ls (Option_t *option="") const override
 List this text with its attributes.
 
TTextoperator= (const TText &src)
 Assignment operator.
 
void Paint (Option_t *option="") override
 Paint this text with its current attributes.
 
virtual void PaintControlBox (Int_t x, Int_t y, Double_t theta)
 Paint the text control box.
 
virtual void PaintText (Double_t x, Double_t y, const char *text)
 Draw this text with new coordinates.
 
virtual void PaintText (Double_t x, Double_t y, const wchar_t *text)
 Draw this text with new coordinates.
 
virtual void PaintTextNDC (Double_t u, Double_t v, const char *text)
 Draw this text with new coordinates in NDC.
 
virtual void PaintTextNDC (Double_t u, Double_t v, const wchar_t *text)
 Draw this text with new coordinates in NDC.
 
void Print (Option_t *option="") const override
 Dump this text with its attributes.
 
void SavePrimitive (std::ostream &out, Option_t *option="") override
 Save primitive as a C++ statement(s) on output stream out.
 
void SetBBoxCenter (const TPoint &p) override
 Set the point given by Alignment as 'center'.
 
void SetBBoxCenterX (const Int_t x) override
 Set X coordinate of the point given by Alignment as 'center'.
 
void SetBBoxCenterY (const Int_t y) override
 Set Y coordinate of the point given by Alignment as 'center'.
 
void SetBBoxX1 (const Int_t) override
 Set left hand side of BoundingBox to a value (resize in x direction on left)
 
void SetBBoxX2 (const Int_t) override
 Set right hand side of BoundingBox to a value (resize in x direction on right)
 
void SetBBoxY1 (const Int_t) override
 Set top of BoundingBox to a value (resize in y direction on top)
 
void SetBBoxY2 (const Int_t) override
 Set bottom of BoundingBox to a value (resize in y direction on bottom)
 
virtual void SetMbTitle (const wchar_t *title=L"")
 Change (i.e. set) the title of the TNamed.
 
virtual void SetNDC (Bool_t isNDC=kTRUE)
 Set NDC mode on if isNDC = kTRUE, off otherwise.
 
virtual void SetText (Double_t x, Double_t y, const char *text)
 
virtual void SetText (Double_t x, Double_t y, const wchar_t *text)
 
virtual void SetX (Double_t x)
 
virtual void SetY (Double_t y)
 
void Streamer (TBuffer &) override
 Stream an object of class TText.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor.
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor.
 
void Clear (Option_t *option="") override
 Set name and title to empty strings ("").
 
TObjectClone (const char *newname="") const override
 Make a clone of an object using the Streamer facility.
 
Int_t Compare (const TObject *obj) const override
 Compare two TNamed objects.
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
 
const char * GetName () const override
 Returns name of object.
 
const char * GetTitle () const override
 Returns title of object.
 
ULong_t Hash () const override
 Return hash value for this object.
 
Bool_t IsSortable () const override
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator.
 
virtual void SetName (const char *name)
 Set the name of the TNamed.
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title).
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed.
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the 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 Delete (Option_t *option="")
 Delete this 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 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 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 UInt_t GetUniqueID () const
 Return the unique object id.
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
 
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
 
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 (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)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator.
 
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.
 
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 marker 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 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 TText
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TNamed
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 TAttText
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 ()
 

Protected Attributes

void * fLink {nullptr}
 pointer to object
 
- Protected Attributes inherited from TText
void * fWcsTitle {nullptr}
 !Used by TMathText
 
Double_t fX {0}
 X position of text (left,center,etc..)
 
Double_t fY {0}
 Y position of text (left,center,etc..)
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 
- 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.
 

Additional Inherited Members

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

Inheritance diagram for TLink:
[legend]

Member Enumeration Documentation

◆ EStatusBits

Enumerator
kIsStarStar 

Definition at line 24 of file TLink.h.

Constructor & Destructor Documentation

◆ TLink() [1/2]

TLink::TLink ( )

Link default constructor.

Definition at line 34 of file TLink.cxx.

◆ TLink() [2/2]

TLink::TLink ( Double_t  x,
Double_t  y,
void *  pointer 
)

Constructor to define a link object.

pointer points to any kind of object.

Definition at line 43 of file TLink.cxx.

◆ ~TLink()

TLink::~TLink ( )
override

Link default destructor.

Definition at line 55 of file TLink.cxx.

Member Function Documentation

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 30 of file TLink.h.

◆ DeclFileName()

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

Definition at line 30 of file TLink.h.

◆ ExecuteEvent()

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

Execute action corresponding to one event.

This member function is called when a link is clicked with the locator

If mouse is clicked on a link text, the object pointed by the link is Inspected

Reimplemented from TObject.

Definition at line 67 of file TLink.cxx.

◆ IsA()

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

Reimplemented from TObject.

Definition at line 30 of file TLink.h.

◆ Streamer()

void TLink::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TLink::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 30 of file TLink.h.

Member Data Documentation

◆ fLink

void* TLink::fLink {nullptr}
protected

pointer to object

Definition at line 21 of file TLink.h.

Libraries for TLink:

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