ROOT logo
ROOT » HTML » TDocMacroDirective

class TDocMacroDirective: public TDocDirective

 Process a "begin_macro" / "end_macro" block. The block can be a file name
 or a CINT script (i.e. even ".x file.C" is allowed). See AddParameter() for
 supported options. Example (the quotes prevent THtml from expanding the

 .x $ROOTSYS/tutorials/hsimple.C

 The macro is meant to create an object that can be saved as a GIF file by
 calling object->SaveAs(outputfile.gif). The macro is expected to return that
 object as a TObject*; if it does not, gPad is used and saved. The object
 is deleted by TDocMacroDirective once saved.

Function Members (Methods)

TDocMacroDirective(const TDocMacroDirective&)
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
virtual Option_t*TObject::GetDrawOption() const
static Long_tTObject::GetDtorOnly()
virtual const char*GetEndTag() const
virtual const char*TObject::GetIconName() 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)
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)
TDocMacroDirective&operator=(const TDocMacroDirective&)
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 = "")
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
virtual voidTDocDirective::DeleteOutputFiles(const char* ext) const
virtual voidTObject::DoError(int level, const char* location, const char* fmt, va_list va) const
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
voidTDocDirective::SetCounter(Int_t count)
voidTDocDirective::SetParameters(const char* params)
voidTDocDirective::SetParser(TDocParser* parser)
voidTDocDirective::SetTag(const char* tag)
virtual voidAddParameter(const TString& name, const char* value = 0)

Data Members

Int_tTDocDirective::fCountercounter to generate unique names, -1 to ignore
TDocOutput*TDocDirective::fDocOutputparser invoking this handler
TDocParser*TDocDirective::fDocParserparser invoking this handler
THtml*TDocDirective::fHtmlparser's THtml object
TStringTNamed::fNameobject identifier
TStringTDocDirective::fParametersparameters to the directive
TStringTNamed::fTitleobject title
Bool_tfIsFilenamewhether the directive is a failename to be executed
TMacro*fMacromacro to be executed
Bool_tfNeedGraphicsif set, we cannot switch to batch mode
Bool_tfShowSourcewhether a source tab should be created

Class Charts

Inheritance Inherited Members Includes Libraries
Class Charts

Function documentation

void AddLine(const TSubString& line)
 Add a macro line.
 Lines ending on "*HIDE*" will be executed as part of the
 macro, but not shown in the source tab if the parameter
 source is supplied.
Bool_t GetResult(TString& result)
 Get the result (i.e. an HTML img tag) for the macro invocation.
 If fShowSource is set, a second tab will be created which shows
 the source.
void AddParameter(const TString& name, const char* value = 0)
 Setting fNeedGraphics if name is "GUI",
 setting fShowSource if name is "SOURCE"
const char* GetEndTag() const
 get the tag ending this directive
void DeleteOutput() const
 Delete output for the parser's current class or module.