Definition at line 122 of file TDocDirective.h.

Public Member Functions
	TDocLatexDirective ()

	~TDocLatexDirective () override
	Destructor.

void	AddLine (const TSubString &line) override
	Add a latex line.

void	DeleteOutput () const override

const char *	GetAlignment () const

const char *	GetEndTag () const override

Int_t	GetFontSize () const

TList *	GetListOfLines () const
	Get the list of lines as TObjStrings.

Bool_t	GetResult (TString &result) override
	convert fLatex to a gif by creating a TLatex, drawing it on a temporary canvas, and saving that to a filename in the output directory.

const char *	GetSeparator () const

TClass *	IsA () const override

Bool_t	SeparatorIsRegexp () const

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TDocDirective
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 ("").

TObject *	Clone (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.

void	Copy (TObject &named) const override
	Copy this to obj.

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.

TClass *	IsA () const override

Bool_t	IsSortable () const override

void	ls (Option_t *option="") const override
	List TNamed name and title.

TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator.

void	Print (Option_t *option="") const override
	Print TNamed name and title.

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	Streamer (TBuffer &) override
	Stream an object of class 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 Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the 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 TObject *	DrawClone (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	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () 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_t *	GetOption () 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)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator.

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

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.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".

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.

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TDocDirective
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TNamed
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

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.

Protected Member Functions
void	AddParameter (const TString &name, const char *value=0) override
	Parse fParameters, setting fFontSize, fAlignment, and fSeparator.

virtual void	CreateLatex (const char *filename)
	Create a gif file named filename from a latex expression in fLatex.

virtual void	GetBoundingBox (TLatex &latex, const char *text, Float_t &width, Float_t &height)
	Determines the bounding box for text as height and width.

Protected Member Functions inherited from TDocDirective
	TDocDirective ()

	TDocDirective (const char *name)

	~TDocDirective () override

virtual void	DeleteOutputFiles (const char *ext) const
	Delete all output generated by the directive beginning with Name() and ending with ext.

TDocOutput *	GetDocOutput () const

TDocParser *	GetDocParser () const

THtml *	GetHtml () const

const char *	GetName () const override
	Returns name of object.

void	GetName (TString &name) const
	Get the full name, based on fName, fTitle, fDocParser's tag.

const char *	GetOutputDir () const
	Get the directory for documentation output.

void	SetCounter (Int_t count)

void	SetParameters (const char *params)
	Given a string containing parameters in params, we call AddParameter() for each of them.

void	SetParser (TDocParser *parser)
	Set the parser, and fDocOutput, fHtml from that.

void	SetTag (const char *tag)

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
TString	fAlignment

TVirtualPad *	fBBCanvas

Int_t	fFontSize

TMacro *	fLatex

TString	fSeparator

Bool_t	fSepIsRegexp

Protected Attributes inherited from TDocDirective
Int_t	fCounter

TDocOutput *	fDocOutput

TDocParser *	fDocParser

THtml *	fHtml

TString	fParameters

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Additional Inherited Members
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 )) }

#include <TDocDirective.h>

Inheritance diagram for TDocLatexDirective:

[legend]

Constructor & Destructor Documentation

◆ TDocLatexDirective()

TDocLatexDirective::TDocLatexDirective ( )

inline

Definition at line 136 of file TDocDirective.h.

◆ ~TDocLatexDirective()

TDocLatexDirective::~TDocLatexDirective ( )

override

Destructor.

Definition at line 611 of file TDocDirective.cxx.

Member Function Documentation

◆ AddLine()

void TDocLatexDirective::AddLine ( const TSubString & line )

overridevirtual

Add a latex line.

Implements TDocDirective.

Definition at line 622 of file TDocDirective.cxx.

◆ AddParameter()

void TDocLatexDirective::AddParameter	(	const TString &	name,
		const char *	value = `0`
	)

overrideprotectedvirtual

Parse fParameters, setting fFontSize, fAlignment, and fSeparator.

Reimplemented from TDocDirective.

Definition at line 871 of file TDocDirective.cxx.

◆ Class()

static TClass * TDocLatexDirective::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TDocLatexDirective::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TDocLatexDirective::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 154 of file TDocDirective.h.

◆ CreateLatex()

void TDocLatexDirective::CreateLatex ( const char * filename )

protectedvirtual

Create a gif file named filename from a latex expression in fLatex.

Called when "Begin_Latex"/"End_Latex" is processed.

Definition at line 645 of file TDocDirective.cxx.

◆ DeclFileName()

static const char * TDocLatexDirective::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 154 of file TDocDirective.h.

◆ DeleteOutput()

void TDocLatexDirective::DeleteOutput ( ) const

inlineoverridevirtual

Reimplemented from TDocDirective.

Definition at line 152 of file TDocDirective.h.

◆ GetAlignment()

const char * TDocLatexDirective::GetAlignment ( ) const

inline

Definition at line 144 of file TDocDirective.h.

◆ GetBoundingBox()

void TDocLatexDirective::GetBoundingBox	(	TLatex &	latex,
		const char *	text,
		Float_t &	width,
		Float_t &	height
	)

protectedvirtual

Determines the bounding box for text as height and width.

Assumes that we are in batch mode.

Definition at line 805 of file TDocDirective.cxx.

◆ GetEndTag()

const char * TDocLatexDirective::GetEndTag ( ) const

inlineoverridevirtual

Implements TDocDirective.

Definition at line 142 of file TDocDirective.h.

◆ GetFontSize()

Int_t TDocLatexDirective::GetFontSize ( ) const

inline

Definition at line 147 of file TDocDirective.h.

◆ GetListOfLines()

TList * TDocLatexDirective::GetListOfLines ( ) const

Get the list of lines as TObjStrings.

Definition at line 820 of file TDocDirective.cxx.

◆ GetResult()

Bool_t TDocLatexDirective::GetResult ( TString & result )

overridevirtual

convert fLatex to a gif by creating a TLatex, drawing it on a temporary canvas, and saving that to a filename in the output directory.

Implements TDocDirective.

Definition at line 830 of file TDocDirective.cxx.

◆ GetSeparator()

const char * TDocLatexDirective::GetSeparator ( ) const

inline

Definition at line 145 of file TDocDirective.h.

◆ IsA()

TClass * TDocLatexDirective::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TDocDirective.

Definition at line 154 of file TDocDirective.h.

◆ SeparatorIsRegexp()

Bool_t TDocLatexDirective::SeparatorIsRegexp ( ) const

inline

Definition at line 146 of file TDocDirective.h.

◆ Streamer()

void TDocLatexDirective::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TDocDirective.

◆ StreamerNVirtual()

void TDocLatexDirective::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 154 of file TDocDirective.h.

Member Data Documentation

◆ fAlignment

TString TDocLatexDirective::fAlignment

protected

Definition at line 128 of file TDocDirective.h.

◆ fBBCanvas

TVirtualPad* TDocLatexDirective::fBBCanvas

protected

Definition at line 129 of file TDocDirective.h.

◆ fFontSize

Int_t TDocLatexDirective::fFontSize

protected

Definition at line 125 of file TDocDirective.h.

◆ fLatex

TMacro* TDocLatexDirective::fLatex

protected

Definition at line 124 of file TDocDirective.h.

◆ fSeparator

TString TDocLatexDirective::fSeparator

protected

Definition at line 126 of file TDocDirective.h.

◆ fSepIsRegexp

Bool_t TDocLatexDirective::fSepIsRegexp

protected

Definition at line 127 of file TDocDirective.h.

html/inc/TDocDirective.h

html/src/TDocDirective.cxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TDocLatexDirective()

◆ ~TDocLatexDirective()

Member Function Documentation

◆ AddLine()

◆ AddParameter()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ CreateLatex()

◆ DeclFileName()

◆ DeleteOutput()

◆ GetAlignment()

◆ GetBoundingBox()

◆ GetEndTag()

◆ GetFontSize()

◆ GetListOfLines()

◆ GetResult()

◆ GetSeparator()

◆ IsA()

◆ SeparatorIsRegexp()

◆ Streamer()

◆ StreamerNVirtual()

Member Data Documentation

◆ fAlignment

◆ fBBCanvas

◆ fFontSize

◆ fLatex

◆ fSeparator

◆ fSepIsRegexp