class TDocLatexDirective: public TDocDirective


 Handle a "Begin_Latex"/"End_Latex" directive.
 called as
 "Begin_Latex(fontsize=10, separator='=,', rseparator='=|,', align=lcl)"
 will create and include a TLatex-processed image, with a given fontsize
 in pixels (defaults to 16). If (r)separator is given, the formulas on the
 following lines will be grouped into columns; a new column starts with
 (regexp) match of the separator; by default there is only one column.
 separator matches any character, rseparator matches as regexp with one
 column per pattern match. Only one of separator or rseparator can be given.
 align defines the alignment for each columns; be default, all columns
 are right aligned. NOTE that the column separator counts as a column itself!

Function Members (Methods)

public:
TDocLatexDirective()
TDocLatexDirective(const TDocLatexDirective&)
virtual~TDocLatexDirective()
voidTObject::AbstractMethod(const char* method) const
virtual voidAddLine(const TSubString& line)
virtual voidTObject::AppendPad(Option_t* option = "")
virtual voidTObject::Browse(TBrowser* b)
static TClass*Class()
virtual const char*TObject::ClassName() const
virtual voidTNamed::Clear(Option_t* option = "")
virtual TObject*TNamed::Clone(const char* newname = "") const
virtual Int_tTNamed::Compare(const TObject* obj) const
virtual voidTNamed::Copy(TObject& named) const
virtual voidTObject::Delete(Option_t* option = "")MENU
virtual voidDeleteOutput() const
virtual Int_tTObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual voidTObject::Draw(Option_t* option = "")
virtual voidTObject::DrawClass() constMENU
virtual TObject*TObject::DrawClone(Option_t* option = "") constMENU
virtual voidTObject::Dump() constMENU
virtual voidTObject::Error(const char* method, const char* msgfmt) const
virtual voidTObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual voidTObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual voidTObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual voidTObject::Fatal(const char* method, const char* msgfmt) const
virtual voidTNamed::FillBuffer(char*& buffer)
virtual TObject*TObject::FindObject(const char* name) const
virtual TObject*TObject::FindObject(const TObject* obj) const
const char*GetAlignment() const
virtual Option_t*TObject::GetDrawOption() const
static Long_tTObject::GetDtorOnly()
virtual const char*GetEndTag() const
Int_tGetFontSize() const
virtual const char*TObject::GetIconName() const
TList*GetListOfLines() const
virtual char*TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_tTObject::GetObjectStat()
virtual Option_t*TObject::GetOption() const
virtual Bool_tGetResult(TString& result)
const char*GetSeparator() const
virtual const char*TNamed::GetTitle() const
virtual UInt_tTObject::GetUniqueID() const
virtual Bool_tTObject::HandleTimer(TTimer* timer)
virtual ULong_tTNamed::Hash() const
virtual voidTObject::Info(const char* method, const char* msgfmt) const
virtual Bool_tTObject::InheritsFrom(const char* classname) const
virtual Bool_tTObject::InheritsFrom(const TClass* cl) const
virtual voidTObject::Inspect() constMENU
voidTObject::InvertBit(UInt_t f)
virtual TClass*IsA() const
virtual Bool_tTObject::IsEqual(const TObject* obj) const
virtual Bool_tTObject::IsFolder() const
Bool_tTObject::IsOnHeap() const
virtual Bool_tTNamed::IsSortable() const
Bool_tTObject::IsZombie() const
virtual voidTNamed::ls(Option_t* option = "") const
voidTObject::MayNotUse(const char* method) const
virtual Bool_tTObject::Notify()
static voidTObject::operator delete(void* ptr)
static voidTObject::operator delete(void* ptr, void* vp)
static voidTObject::operator delete[](void* ptr)
static voidTObject::operator delete[](void* ptr, void* vp)
void*TObject::operator new(size_t sz)
void*TObject::operator new(size_t sz, void* vp)
void*TObject::operator new[](size_t sz)
void*TObject::operator new[](size_t sz, void* vp)
TDocLatexDirective&operator=(const TDocLatexDirective&)
virtual voidTObject::Paint(Option_t* option = "")
virtual voidTObject::Pop()
virtual voidTNamed::Print(Option_t* option = "") const
virtual Int_tTObject::Read(const char* name)
virtual voidTObject::RecursiveRemove(TObject* obj)
voidTObject::ResetBit(UInt_t f)
virtual voidTObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual voidTObject::SavePrimitive(basic_ostream<char,char_traits<char> >& out, Option_t* option = "")
Bool_tSeparatorIsRegexp() const
voidTObject::SetBit(UInt_t f)
voidTObject::SetBit(UInt_t f, Bool_t set)
virtual voidTObject::SetDrawOption(Option_t* option = "")MENU
static voidTObject::SetDtorOnly(void* obj)
virtual voidTNamed::SetName(const char* name)MENU
virtual voidTNamed::SetNameTitle(const char* name, const char* title)
static voidTObject::SetObjectStat(Bool_t stat)
virtual voidTNamed::SetTitle(const char* title = "")MENU
virtual voidTObject::SetUniqueID(UInt_t uid)
virtual voidShowMembers(TMemberInspector& insp, char* parent)
virtual Int_tTNamed::Sizeof() const
virtual voidStreamer(TBuffer& b)
voidStreamerNVirtual(TBuffer& b)
virtual voidTObject::SysError(const char* method, const char* msgfmt) const
Bool_tTObject::TestBit(UInt_t f) const
Int_tTObject::TestBits(UInt_t f) const
virtual voidTObject::UseCurrentStyle()
virtual voidTObject::Warning(const char* method, const char* msgfmt) const
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const
protected:
virtual voidAddParameter(const TString& name, const char* value = 0)
virtual voidCreateLatex(const char* filename)
virtual voidTDocDirective::DeleteOutputFiles(const char* ext) const
virtual voidTObject::DoError(int level, const char* location, const char* fmt, va_list va) const
virtual voidGetBoundingBox(TLatex& latex, const char* text, Float_t& width, Float_t& height)
TDocOutput*TDocDirective::GetDocOutput() const
TDocParser*TDocDirective::GetDocParser() const
THtml*TDocDirective::GetHtml() const
virtual const char*TDocDirective::GetName() const
voidTDocDirective::GetName(TString& name) const
const char*TDocDirective::GetOutputDir() const
voidTObject::MakeZombie()
voidTDocDirective::SetCounter(Int_t count)
voidTDocDirective::SetParameters(const char* params)
voidTDocDirective::SetParser(TDocParser* parser)
voidTDocDirective::SetTag(const char* tag)

Data Members

public:
enum TObject::EStatusBits { kCanDelete
kMustCleanup
kObjInCanvas
kIsReferenced
kHasUUID
kCannotPick
kNoContextMenu
kInvalidObject
};
enum TObject::[unnamed] { kIsOnHeap
kNotDeleted
kZombie
kBitMask
kSingleKey
kOverwrite
kWriteDelete
};
protected:
TStringfAlignmentcolumn alignment: 'l' for justify left, 'c' for center, 'r' for right
TVirtualPad*fBBCanvascanvas for bounding box determination
Int_tTDocDirective::fCountercounter to generate unique names, -1 to ignore
TDocOutput*TDocDirective::fDocOutputparser invoking this handler
TDocParser*TDocDirective::fDocParserparser invoking this handler
Int_tfFontSizefontsize for current latex block, in pixels
THtml*TDocDirective::fHtmlparser's THtml object
TMacro*fLatexcollection of lines
TStringTNamed::fNameobject identifier
TStringTDocDirective::fParametersparameters to the directive
Bool_tfSepIsRegexpwhether fSeparator is a regexp expression
TStringfSeparatorcolumn separator, often "="
TStringTNamed::fTitleobject title

Class Charts

Inheritance Inherited Members Includes Libraries
Class Charts

Function documentation

~TDocLatexDirective()
 Destructor
void AddLine(const TSubString& line)
 Add a latex line
void CreateLatex(const char* filename)
 Create a gif file named filename from a latex expression in fLatex.
 Called when "Begin_Latex"/"End_Latex" is processed.
void GetBoundingBox(TLatex& latex, const char* text, Float_t& width, Float_t& height)
 Determines the bounding box for text as height and width.
 Assumes that we are in batch mode.
TList* GetListOfLines()
 Get the list of lines as TObjStrings
Bool_t GetResult(TString& result)
 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.
void AddParameter(const TString& name, const char* value = 0)
 Parse fParameters, setting fFontSize, fAlignment, and fSeparator
const char* GetEndTag()
 get the tag ending this directive
void DeleteOutput()
 Delete output for the parser's current class or module.
{}
TDocLatexDirective(const TDocLatexDirective& )
{}
const char* GetAlignment()
{return fAlignment;}
const char* GetSeparator()
{return fSeparator;}
Bool_t SeparatorIsRegexp()
{return fSepIsRegexp;}
Int_t GetFontSize()
{return fFontSize;}

Author: Axel Naumann 2007-01-25
Last change: root/html:$Id: TDocDirective.h 23799 2008-05-12 13:10:34Z axel $
Last generated: 2008-06-25 08:36
Copyright (C) 1995-2007, Rene Brun and Fons Rademakers. *
This page has been automatically generated. If you have any comments or suggestions about the page layout send a mail to ROOT support, or contact the developers with any questions or problems regarding ROOT.