ROOT » HTML » THtml::TPathDefinition

class THtml::TPathDefinition: public THtml::THelperBase

Function Members (Methods)

public:
virtual~TPathDefinition()
voidTObject::AbstractMethod(const char* method) const
virtual voidTObject::AppendPad(Option_t* option = "")
virtual voidTObject::Browse(TBrowser* b)
static TClass*Class()
virtual const char*TObject::ClassName() const
virtual voidTObject::Clear(Option_t* = "")
virtual TObject*TObject::Clone(const char* newname = "") const
virtual Int_tTObject::Compare(const TObject* obj) const
virtual voidTObject::Copy(TObject& object) const
virtual voidTObject::Delete(Option_t* option = "")MENU
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 TObject*TObject::FindObject(const char* name) const
virtual TObject*TObject::FindObject(const TObject* obj) const
virtual boolGetDocDir(const TString& module, TString& doc_dir) const
virtual Option_t*TObject::GetDrawOption() const
static Long_tTObject::GetDtorOnly()
virtual boolGetFileNameFromInclude(const char* included, TString& out_fsname) const
virtual const char*TObject::GetIconName() const
virtual boolGetIncludeAs(TClass* cl, TString& out_include_as) const
virtual boolGetMacroPath(const TString& module, TString& out_dir) const
virtual const char*TObject::GetName() const
virtual char*TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_tTObject::GetObjectStat()
virtual Option_t*TObject::GetOption() const
THtml*THtml::THelperBase::GetOwner() const
virtual const char*TObject::GetTitle() const
virtual UInt_tTObject::GetUniqueID() const
virtual Bool_tTObject::HandleTimer(TTimer* timer)
virtual ULong_tTObject::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_tTObject::IsSortable() const
Bool_tTObject::IsZombie() const
virtual voidTObject::ls(Option_t* option = "") const
voidTObject::MayNotUse(const char* method) const
virtual Bool_tTObject::Notify()
voidTObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
voidTObject::operator delete(void* ptr)
voidTObject::operator delete(void* ptr, void* vp)
voidTObject::operator delete[](void* ptr)
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)
THtml::TPathDefinition&operator=(const THtml::TPathDefinition&)
THtml::TPathDefinition&operator=(THtml::TPathDefinition&&)
virtual voidTObject::Paint(Option_t* option = "")
virtual voidTObject::Pop()
virtual voidTObject::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(ostream& 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)
static voidTObject::SetObjectStat(Bool_t stat)
voidTHtml::THelperBase::SetOwner(THtml* html)
virtual voidTObject::SetUniqueID(UInt_t uid)
virtual voidShowMembers(TMemberInspector& insp) const
virtual voidStreamer(TBuffer&)
voidStreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_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
THtml::THelperBaseTHtml::THelperBase::THelperBase()
THtml::THelperBaseTHtml::THelperBase::THelperBase(const THtml::THelperBase&)
THtml::TPathDefinitionTPathDefinition()
THtml::TPathDefinitionTPathDefinition(THtml::TPathDefinition&&)
THtml::TPathDefinitionTPathDefinition(const THtml::TPathDefinition&)
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 voidTObject::DoError(int level, const char* location, const char* fmt, va_list va) const
voidTObject::MakeZombie()

Data Members

public:
static TObject::(anonymous)TObject::kBitMask
static TObject::EStatusBitsTObject::kCanDelete
static TObject::EStatusBitsTObject::kCannotPick
static TObject::EStatusBitsTObject::kHasUUID
static TObject::EStatusBitsTObject::kInvalidObject
static TObject::(anonymous)TObject::kIsOnHeap
static TObject::EStatusBitsTObject::kIsReferenced
static TObject::EStatusBitsTObject::kMustCleanup
static TObject::EStatusBitsTObject::kNoContextMenu
static TObject::(anonymous)TObject::kNotDeleted
static TObject::EStatusBitsTObject::kObjInCanvas
static TObject::(anonymous)TObject::kOverwrite
static TObject::(anonymous)TObject::kSingleKey
static TObject::(anonymous)TObject::kWriteDelete
static TObject::(anonymous)TObject::kZombie

Class Charts

Inheritance Inherited Members Includes Libraries
Class Charts

Function documentation

bool GetMacroPath(const TString& module, TString& out_dir) const
 Determine the path to look for macros (see TDocMacroDirective) for
 classes from a given module. If the path was sucessfully determined return true.
 For ROOT, this directory is the "doc/macros" subdirectory of the module
 directory; the path returned is GetDocDir(module) + "/macros".

 If your software cannot be mapped into this scheme then derive your
 own class from TPathDefinition and pass it to THtml::SetPathDefinition().
bool GetDocDir(const TString& module, TString& doc_dir) const
 Determine the module's documentation directory. If module is empty,
 set doc_dir to the product's documentation directory.
 If the path was sucessfuly determined return true.
 For ROOT, this directory is the subdir "doc/" in the
 module's path; the directory returned is module + "/doc".

 If your software cannot be mapped into this scheme then derive your
 own class from TPathDefinition and pass it to THtml::SetPathDefinition().
bool GetIncludeAs(TClass* cl, TString& out_include_as) const
 Determine the path and filename used in an include statement for the
 header file of the given class. E.g. the class ROOT::Math::Boost is
 meant to be included as "Math/Genvector/Boost.h" - which is what
 out_dir is set to. GetIncludeAs() returns whether the include
 statement's path was successfully determined.

 Any leading directory part that is part of fIncludePath (see SetIncludePath)
 will be removed. For ROOT, leading "include/" is removed; everything after
 is the include path.

 If your software cannot be mapped into this scheme then derive your
 own class from TPathDefinition and pass it to THtml::SetPathDefinition().
bool GetFileNameFromInclude(const char* included, TString& out_fsname) const
 Set out_fsname to the full pathname corresponding to a file
 included as "included". Return false if this file cannot be determined
 or found. For ROOT, out_fsname corresponds to included prepended with
 "include"; only THtml prefers to work on the original files, e.g.
 core/base/inc/TObject.h instead of include/TObject.h, so the
 default implementation searches the TFileSysDB for an entry with
 basename(included) and with matching directory part, setting out_fsname
 to the TFileSysEntry's path.
TString fInputPath; // directories to look for classes; prepended to Decl/ ImplFileName()