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 example): "BEGIN_MACRO" .x $ROOTSYS/tutorials/hsimple.C "END_MACRO" 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)
public:
| TDocMacroDirective() | |
| TDocMacroDirective(const TDocMacroDirective&) | |
| virtual | ~TDocMacroDirective() |
| void | TObject::AbstractMethod(const char* method) const |
| virtual void | AddLine(const TSubString& line) |
| virtual void | TObject::AppendPad(Option_t* option = "") |
| virtual void | TObject::Browse(TBrowser* b) |
| static TClass* | Class() |
| virtual const char* | TObject::ClassName() const |
| virtual void | TNamed::Clear(Option_t* option = "") |
| virtual TObject* | TNamed::Clone(const char* newname = "") const |
| virtual Int_t | TNamed::Compare(const TObject* obj) const |
| virtual void | TNamed::Copy(TObject& named) const |
| virtual void | TObject::Delete(Option_t* option = "")MENU |
| virtual void | DeleteOutput() const |
| virtual Int_t | TObject::DistancetoPrimitive(Int_t px, Int_t py) |
| virtual void | TObject::Draw(Option_t* option = "") |
| virtual void | TObject::DrawClass() constMENU |
| virtual TObject* | TObject::DrawClone(Option_t* option = "") constMENU |
| virtual void | TObject::Dump() constMENU |
| virtual void | TObject::Error(const char* method, const char* msgfmt) const |
| virtual void | TObject::Execute(const char* method, const char* params, Int_t* error = 0) |
| virtual void | TObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0) |
| virtual void | TObject::ExecuteEvent(Int_t event, Int_t px, Int_t py) |
| virtual void | TObject::Fatal(const char* method, const char* msgfmt) const |
| virtual void | TNamed::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_t | TObject::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_t | TObject::GetObjectStat() |
| virtual Option_t* | TObject::GetOption() const |
| virtual Bool_t | GetResult(TString& result) |
| virtual const char* | TNamed::GetTitle() const |
| virtual UInt_t | TObject::GetUniqueID() const |
| virtual Bool_t | TObject::HandleTimer(TTimer* timer) |
| virtual ULong_t | TNamed::Hash() const |
| virtual void | TObject::Info(const char* method, const char* msgfmt) const |
| virtual Bool_t | TObject::InheritsFrom(const char* classname) const |
| virtual Bool_t | TObject::InheritsFrom(const TClass* cl) const |
| virtual void | TObject::Inspect() constMENU |
| void | TObject::InvertBit(UInt_t f) |
| virtual TClass* | IsA() const |
| virtual Bool_t | TObject::IsEqual(const TObject* obj) const |
| virtual Bool_t | TObject::IsFolder() const |
| Bool_t | TObject::IsOnHeap() const |
| virtual Bool_t | TNamed::IsSortable() const |
| Bool_t | TObject::IsZombie() const |
| virtual void | TNamed::ls(Option_t* option = "") const |
| void | TObject::MayNotUse(const char* method) const |
| virtual Bool_t | TObject::Notify() |
| void | TObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const |
| static void | TObject::operator delete(void* ptr) |
| static void | TObject::operator delete(void* ptr, void* vp) |
| static void | TObject::operator delete[](void* ptr) |
| static void | TObject::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 void | TObject::Paint(Option_t* option = "") |
| virtual void | TObject::Pop() |
| virtual void | TNamed::Print(Option_t* option = "") const |
| virtual Int_t | TObject::Read(const char* name) |
| virtual void | TObject::RecursiveRemove(TObject* obj) |
| void | TObject::ResetBit(UInt_t f) |
| virtual void | TObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU |
| virtual void | TObject::SavePrimitive(ostream& out, Option_t* option = "") |
| void | TObject::SetBit(UInt_t f) |
| void | TObject::SetBit(UInt_t f, Bool_t set) |
| virtual void | TObject::SetDrawOption(Option_t* option = "")MENU |
| static void | TObject::SetDtorOnly(void* obj) |
| virtual void | TNamed::SetName(const char* name)MENU |
| virtual void | TNamed::SetNameTitle(const char* name, const char* title) |
| static void | TObject::SetObjectStat(Bool_t stat) |
| virtual void | TNamed::SetTitle(const char* title = "")MENU |
| virtual void | TObject::SetUniqueID(UInt_t uid) |
| virtual void | ShowMembers(TMemberInspector&) |
| virtual Int_t | TNamed::Sizeof() const |
| virtual void | Streamer(TBuffer&) |
| void | StreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b) |
| virtual void | TObject::SysError(const char* method, const char* msgfmt) const |
| Bool_t | TObject::TestBit(UInt_t f) const |
| Int_t | TObject::TestBits(UInt_t f) const |
| virtual void | TObject::UseCurrentStyle() |
| virtual void | TObject::Warning(const char* method, const char* msgfmt) const |
| virtual Int_t | TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) |
| virtual Int_t | TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const |
protected:
| virtual void | TDocDirective::DeleteOutputFiles(const char* ext) const |
| virtual void | TObject::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 |
| void | TDocDirective::GetName(TString& name) const |
| const char* | TDocDirective::GetOutputDir() const |
| void | TObject::MakeZombie() |
| void | TDocDirective::SetCounter(Int_t count) |
| void | TDocDirective::SetParameters(const char* params) |
| void | TDocDirective::SetParser(TDocParser* parser) |
| void | TDocDirective::SetTag(const char* tag) |
private:
| virtual void | AddParameter(const TString& name, const char* value = 0) |
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:
| Int_t | TDocDirective::fCounter | counter to generate unique names, -1 to ignore |
| TDocOutput* | TDocDirective::fDocOutput | parser invoking this handler |
| TDocParser* | TDocDirective::fDocParser | parser invoking this handler |
| THtml* | TDocDirective::fHtml | parser's THtml object |
| TString | TNamed::fName | object identifier |
| TString | TDocDirective::fParameters | parameters to the directive |
| TString | TNamed::fTitle | object title |
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"