+
class TDocDirective
-
library: libHtml
#include "TDocDirective.h"
Display options:
Show inherited
Show non-public

class TDocDirective: public TNamed








Function Members (Methods)

 
    This is an abstract class, constructors will not be documented.

    Look at the header to check for available constructors.


public:



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 = "")


virtual Int_tTObject::DistancetoPrimitive(Int_t px, Int_t py)


virtual voidTObject::Draw(Option_t* option = "")


virtual voidTObject::DrawClass() const


virtual TObject*TObject::DrawClone(Option_t* option = "") const


virtual voidTObject::Dump() const


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() const


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)


TDocDirective&operator=(const TDocDirective&)


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 = "") const


virtual voidTObject::SavePrimitive(ostream& out, Option_t* option = "")


voidTObject::SetBit(UInt_t f)


voidTObject::SetBit(UInt_t f, Bool_t set)


virtual voidTObject::SetDrawOption(Option_t* option = "")


static voidTObject::SetDtorOnly(void* obj)


virtual voidTNamed::SetName(const char* name)


virtual voidTNamed::SetNameTitle(const char* name, const char* title)


static voidTObject::SetObjectStat(Bool_t stat)


virtual voidTNamed::SetTitle(const char* title = "")


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~TDocDirective()


virtual voidAddParameter(const TString&, const char* = 0)


virtual voidTObject::DoError(int level, const char* location, const char* fmt, va_list va) const


TDocOutput*GetDocOutput() const


TDocParser*GetDocParser() const


THtml*GetHtml() const


virtual const char*GetName() const


voidGetName(TString& name) const


const char*GetOutputDir() const


voidTObject::MakeZombie()


voidSetCounter(Int_t count)


voidSetParameters(const char* params)


voidSetParser(TDocParser* parser)


voidSetTag(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:



Int_tfCountercounter to generate unique names, -1 to ignore


TDocOutput*fDocOutputparser invoking this handler


TDocParser*fDocParserparser invoking this handler


THtml*fHtmlparser's THtml object


TStringTNamed::fNameobject identifier


TStringfParametersparameters to the directive


TStringTNamed::fTitleobject title







Class Charts




























Inheritance
Inherited Members
Includes
Libraries



Class Charts


Function documentation


void  GetName(TString& name) const


 Get the full name, based on fName, fTitle, fDocParser's tag.





const char*  GetOutputDir()


 Get the directory for documentation output.





void  SetParameters(const char* params)


 Given a string containing parameters in params,
 we call AddParameter() for each of them.
 This function splits the parameter names and
 extracts their values if they are given.
 Parameters are separated by ",", values are
 separated from parameter names by "=".
 params being
    a = "a, b, c", b='d,e'
 will issue two calls to AddParameter(), one for
 a with value "a, b, c" and one for b with value
 "d,e" (each without the quotation marks).





void  SetParser(TDocParser* parser)


 Set the parser, and fDocOutput, fHtml from that





void AddParameter(const TString& , const char*  = 0)



{}






virtual ~TDocDirective()



{}






const char* GetName(TString& name) const



{ return TNamed::GetName(); }






TDocParser* GetDocParser()



{ return fDocParser; }






TDocOutput* GetDocOutput()



{ return fDocOutput; }






THtml* GetHtml()



{ return fHtml; }






void SetTag(const char* tag)



{ SetTitle(tag); }






void SetCounter(Int_t count)



{ fCounter = count; }






const char* GetEndTag()


 get the tag ending this directive





void AddLine(const TSubString& line)


 add a line to the directive's text





Bool_t GetResult(TString& result)


 retrieve the result (replacement) of the directive; return false if invalid









Last update: Mon Jun 25 19:48:45 2007





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.