Text Attributes class.

This class is used (in general by secondary inheritance) by many other classes (graphics, histograms). It holds all the text attributes.

Text attributes

Text attributes are:

Text Alignment
Text Angle
Text Color
Text Size
Text Font and Precision

Text Alignment

The text alignment is an integer number (align) allowing to control the horizontal and vertical position of the text string with respect to the text position. The text alignment of any class inheriting from TAttText can be changed using the method SetTextAlign and retrieved using the method GetTextAlign.

align = 10*HorizontalAlign + VerticalAlign

For horizontal alignment the following convention applies:

1=left adjusted, 2=centered, 3=right adjusted

For vertical alignment the following convention applies:

1=bottom adjusted, 2=centered, 3=top adjusted

For example:

align = 11 = left adjusted and bottom adjusted

align = 32 = right adjusted and vertically centered

{
   TCanvas *Ta = new TCanvas("Ta","Ta",0,0,500,200);
   Ta->Range(0,0,1,1);
   TLine *lv = new TLine;
   lv->SetLineStyle(3); lv->SetLineColor(kBlue);
   lv->DrawLine(0.33,0.0,0.33,1.0);
   lv->DrawLine(0.6,0.165,1.,0.165);
   lv->DrawLine(0.6,0.493,1.,0.493);
   lv->DrawLine(0.6,0.823,1.,0.823);
   // Horizontal alignment.
   TText *th1 = new TText(0.33,0.165,"Left adjusted");
   th1->SetTextAlign(11); th1->SetTextSize(0.12);
   th1->Draw();
   TText *th2 = new TText(0.33,0.493,"Center adjusted");
   th2->SetTextAlign(21); th2->SetTextSize(0.12);
   th2->Draw();
   TText *th3 = new TText(0.33,0.823,"Right adjusted");
   th3->SetTextAlign(31); th3->SetTextSize(0.12);
   th3->Draw();
   // Vertical alignment.
   TText *tv1 = new TText(0.66,0.165,"Bottom adjusted");
   tv1->SetTextAlign(11); tv1->SetTextSize(0.12);
   tv1->Draw();
   TText *tv2 = new TText(0.66,0.493,"Center adjusted");
   tv2->SetTextAlign(12); tv2->SetTextSize(0.12);
   tv2->Draw();
   TText *tv3 = new TText(0.66,0.823,"Top adjusted");
   tv3->SetTextAlign(13); tv3->SetTextSize(0.12);
   tv3->Draw();
   return Ta;
}

Text Angle

Text angle in degrees. The text angle of any class inheriting from TAttText can be changed using the method SetTextAngle and retrieved using the method GetTextAngle. The following picture shows the text angle:

Mnemonic constants are available:

kHAlignLeft = 10, kHAlignCenter = 20, kHAlignRight = 30,

kVAlignBottom = 1, kVAlignCenter = 2, kVAlignTop = 3

They allow to write:

object->SetTextAlign(kHAlignLeft+kVAlignTop);

Text Color

The text color is a color index (integer) pointing in the ROOT color table. The text color of any class inheriting from TAttText can be changed using the method SetTextColor and retrieved using the method GetTextColor. The following table shows the first 50 default colors.

Color transparency

SetTextColorAlpha(), allows to set a transparent color. In the following example the text color of the text text is set to blue with a transparency of 35%. The color kBlue itself remains fully opaque.

text->SetTextColorAlpha(kBlue, 0.35);

The transparency is available on all platforms when the flagOpenGL.CanvasPreferGL is set to 1 in $ROOTSYS/etc/system.rootrc, or on Mac with the Cocoa backend. On the file output it is visible with PDF, PNG, Gif, JPEG, SVG ... but not PostScript.

If the text precision (see next paragraph) is smaller than 3, the text size (textsize) is a fraction of the current pad size. Therefore the same textsize value can generate text outputs with different absolute sizes in two different pads. The text size in pixels (charheight) is computed the following way:

pad_width  = gPad->XtoPixel(gPad->GetX2());
pad_height = gPad->YtoPixel(gPad->GetY1());
if (pad_width < pad_height)  charheight = textsize*pad_width;
else                         charheight = textsize*pad_height;

If the text precision is equal to 3, the text size doesn't depend on the pad's dimensions. A given textsize value always generates the same absolute size. The text size (charheight) is given in pixels:

charheight = textsize;

Note that to scale fonts to the same size as the old True Type package a scale factor of 0.93376068 is apply to the text size before drawing.

The text size of any class inheriting from TAttText can be changed using the method SetTextSize and retrieved using the method GetTextSize.

Text Font and Precision

The text font code is combination of the font number and the precision.

Text font code = 10*fontnumber + precision

Font numbers must be between 1 and 14.

The precision can be:

precision = 0 fast hardware fonts (steps in the size)
precision = 1 scalable and rotatable hardware fonts (see below)
precision = 2 scalable and rotatable hardware fonts
precision = 3 scalable and rotatable hardware fonts. Text size is given in pixels.

The text font and precision of any class inheriting from TAttText can be changed using the method SetTextFont and retrieved using the method GetTextFont.

Font quality and speed

When precision 0 is used, only the original non-scaled system fonts are used. The fonts have a minimum (4) and maximum (37) size in pixels. These fonts are fast and are of good quality. Their size varies with large steps and they cannot be rotated. Precision 1 and 2 fonts have a different behaviour depending if the True Type Fonts (TTF) are used or not. If TTF are used, you always get very good quality scalable and rotatable fonts. However TTF are slow.

How to use True Type Fonts

One can activate the TTF by adding (or activating) the following line in the .rootrc file:

Unix.*.Root.UseTTFonts: true

It is possible to check the TTF are in use in a Root session with the command:

gEnv->Print();

If the TTF are in use the following line will appear at the beginning of the printout given by this command:

Unix.*.Root.UseTTFonts: true [Global]

List of the currently supported fonts

Font number         X11 Names             Win32/TTF Names
:       times-medium-i-normal      "Times New Roman"
:       times-bold-r-normal        "Times New Roman"
:       times-bold-i-normal        "Times New Roman"
:       helvetica-medium-r-normal  "Arial"
:       helvetica-medium-o-normal  "Arial"
:       helvetica-bold-r-normal    "Arial"
:       helvetica-bold-o-normal    "Arial"
:       courier-medium-r-normal    "Courier New"
:       courier-medium-o-normal    "Courier New"
:       courier-bold-r-normal      "Courier New"
:       courier-bold-o-normal      "Courier New"
:       symbol-medium-r-normal     "Symbol"
:       times-medium-r-normal      "Times New Roman"
:                                  "Wingdings"
:       Symbol italic (derived from Symbol)

The following picture shows how each font looks. The number on the left is the "text font code". In this picture precision 2 was selected.

Definition at line 32 of file TAttText.h.

Public Member Functions
	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...

Protected Attributes
Float_t	fTextAngle

Float_t	fTextSize

Short_t	fTextAlign

Color_t	fTextColor

Font_t	fTextFont

#include <TAttText.h>

Inheritance diagram for TAttText:

Constructor & Destructor Documentation

TAttText::TAttText ( )

TAttText::TAttText	(	Int_t	align,
		Float_t	angle,
		Color_t	color,
		Style_t	font,
		Float_t	tsize
	)

AttText normal constructor.

Text attributes are taken from the argument list.

Definition at line 272 of file TAttText.cxx.

TAttText::~TAttText ( )

virtual

AttText destructor.

Definition at line 284 of file TAttText.cxx.

Member Function Documentation

void TAttText::Copy ( TAttText & atttext ) const

Copy this text attributes to a new TAttText.

Definition at line 291 of file TAttText.cxx.

Referenced by TPaveLabel::Copy(), TLegend::Copy(), TLegendEntry::Copy(), TText::Copy(), TStyle::Copy(), TLatex::DrawLatex(), TMathText::DrawMathText(), TText::DrawText(), TPaveLabel::TPaveLabel(), and TStyle::TStyle().

virtual Short_t TAttText::GetTextAlign ( ) const

inlinevirtual

Reimplemented in TGWin32VirtualXProxy.

Definition at line 46 of file TAttText.h.

Referenced by TASImage::DrawText(), TPaveText::GetObject(), TPaveStats::Paint(), TPad::PaintDate(), TGLAxis::PaintGLAxisLabels(), TLatex::PaintLatex1(), TButton::PaintModified(), TPaveLabel::PaintPaveLabel(), TLegend::PaintPrimitives(), TPaveText::PaintPrimitives(), TText::Print(), TPaveText::SaveLines(), TStyle::SavePrimitive(), TAttTextEditor::SetModel(), and TStyleManager::UpdateEditor().

virtual Float_t TAttText::GetTextAngle ( ) const

inlinevirtual

virtual Color_t TAttText::GetTextColor ( ) const

inlinevirtual

Reimplemented in TGWin32VirtualXProxy.

Definition at line 48 of file TAttText.h.

Referenced by TAttTextEditor::DoAlpha(), TAttTextEditor::DoAlphaField(), TAttTextEditor::DoLiveAlpha(), TGQuartz::DrawText(), TASImage::DrawText(), TLatex::FirstParse(), TAttTextEditor::GetCurAlpha(), TPaveStats::Paint(), TGraphNode::Paint(), TPie::Paint(), TGaxis::PaintAxis(), TPad::PaintDate(), TGLAxis::PaintGLAxisLabels(), TGLText::PaintGLText(), TLatex::PaintLatex1(), TButton::PaintModified(), TPaveLabel::PaintPaveLabel(), TLegend::PaintPrimitives(), TPaveText::PaintPrimitives(), TText::Print(), TGQuartz::RenderTTFString(), TPaveText::SaveLines(), TPie::SavePrimitive(), TGaxis::SavePrimitive(), TStyle::SavePrimitive(), TAttTextEditor::SetModel(), TPieEditor::SetModel(), TStyleManager::UpdateEditor(), TPaveStats::UseCurrentStyle(), TPaveText::UseCurrentStyle(), and TPad::UseCurrentStyle().

virtual Font_t TAttText::GetTextFont ( ) const

inlinevirtual

Reimplemented in TGWin32VirtualXProxy.

Definition at line 49 of file TAttText.h.

Referenced by TLatex::Analyse(), TPieEditor::DoTextChange(), TGQuartz::DrawText(), TASImage::DrawText(), TLatex::FirstParse(), TGQuartz::GetFontAscent(), TGQuartz::GetFontDescent(), TGQuartz::GetTextExtent(), TStyleManager::ModAttDateTextFont(), TStyleManager::ModAttDateTextSizeInPixels(), TStyleManager::ModTextFont(), TStyleManager::ModTextSizeInPixels(), TPaveStats::Paint(), TGraphNode::Paint(), TPie::Paint(), TGaxis::PaintAxis(), TPad::PaintDate(), TGLAxis::PaintGLAxisLabels(), TLatex::PaintLatex1(), TButton::PaintModified(), TPaveLabel::PaintPaveLabel(), TLegend::PaintPrimitives(), TPaveText::PaintPrimitives(), THistPainter::PaintText(), THistPainter::PaintTH2PolyText(), TText::Print(), TAttTextEditor::ProcessMessage(), TRecorderRecording::RecordPave(), TRecorderRecording::RecordText(), TPaveText::SaveLines(), TPie::SavePrimitive(), TGaxis::SavePrimitive(), TStyle::SavePrimitive(), TLegend::SetHeader(), TAttTextEditor::SetModel(), TPieEditor::SetModel(), TStyleManager::UpdateEditor(), TPaveStats::UseCurrentStyle(), TPaveText::UseCurrentStyle(), and TPad::UseCurrentStyle().

virtual Float_t TAttText::GetTextSize ( ) const

inlinevirtual

Reimplemented in TGWin32VirtualXProxy.

Definition at line 50 of file TAttText.h.

Referenced by TGQuartz::DrawText(), TASImage::DrawText(), TGroupButton::ExecuteAction(), TMathText::GetBoundingBox(), TLatex::GetBoundingBox(), TGQuartz::GetFontAscent(), TGQuartz::GetFontDescent(), TPaveText::GetObject(), TGQuartz::GetTextExtent(), TMathText::GetXsize(), TLatex::GetXsize(), TMathText::GetYsize(), TLatex::GetYsize(), TStyleManager::ModAttDateTextSizeInPixels(), TStyleManager::ModTextSizeInPixels(), TPaveStats::Paint(), TMathText::Paint(), TGraphNode::Paint(), TPie::Paint(), TSpider::Paint(), TLatex::Paint(), TGaxis::PaintAxis(), TPad::PaintDate(), TGLText::PaintGLText(), TParallelCoordVar::PaintLabels(), TButton::PaintModified(), TPaveLabel::PaintPaveLabel(), TLegend::PaintPrimitives(), TPaveText::PaintPrimitives(), TText::Print(), TRecorderRecording::RecordPave(), TRecorderRecording::RecordText(), TPaveText::SaveLines(), TPie::SavePrimitive(), TStyle::SavePrimitive(), TTextEditor::SetModel(), TAttTextEditor::SetModel(), TPieEditor::SetModel(), TPaveStats::UseCurrentStyle(), and TPaveText::UseCurrentStyle().

void TAttText::Modify ( )

virtual

Change current text attributes if necessary.

Definition at line 303 of file TAttText.cxx.

Referenced by TLatex::Analyse(), TText::DistancetoPrimitive(), TText::ExecuteEvent(), TText::Paint(), TLatex::PaintLatex(), TMathText::PaintMathText(), TText::PaintText(), and TText::PaintTextNDC().

void TAttText::ResetAttText ( Option_t * toption = "" )

virtual

Reset this text attributes to default values.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 332 of file TAttText.cxx.

Referenced by TStyle::Reset().

void TAttText::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`
	)