Definition at line 92 of file THtml.h.

Public Member Functions
virtual bool	GetDocDir (const TString &module, TString &doc_dir) const
	Determine the module's documentation directory.

virtual bool	GetFileNameFromInclude (const char *included, TString &out_fsname) const
	Set out_fsname to the full pathname corresponding to a file included as "included".

virtual 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.

virtual bool	GetMacroPath (const TString &module, TString &out_dir) const
	Determine the path to look for macros (see TDocMacroDirective) for classes from a given module.

Public Member Functions inherited from THtml::THelperBase
	THelperBase ()

virtual	~THelperBase ()
	Helper's destructor.

THtml *	GetOwner () const

void	SetOwner (THtml *html)
	Set the THtml object owning this object; if it's already set to a different THtml object than issue an error message and signal to the currently set object that we are not belonging to it anymore.

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual void	Clear (Option_t *="")

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.

virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method.

virtual void	Copy (TObject &object) const
	Copy this to obj.

virtual void	Delete (Option_t *option="")
	Delete this object.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad for instance with: `gROOT->SetSelectedPad(gPad)`.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

virtual void	Execute (const char method, const char params, Int_t *error=0)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual const char *	GetName () const
	Returns name of object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

virtual const char *	GetTitle () const
	Returns title of object.

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

virtual ULong_t	Hash () const
	Return hash value for this object.

Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

virtual Bool_t	IsSortable () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

virtual void	ls (Option_t *option="") const
	The ls function lists the contents of a class on stdout.

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification.

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete[] (void *ptr)
	Operator delete [].

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator.

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual void	Print (Option_t *option="") const
	This method must be overridden when a class wants to print itself.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Additional Inherited Members
Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) }

enum	EDeprecatedStatusBits { kObjInCanvas = BIT(3) }

enum	EStatusBits { kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) , kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13) }

Static Public Member Functions inherited from TObject
static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = BIT(3) }

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).

void	MakeZombie ()

#include <THtml.h>

Inheritance diagram for THtml::TPathDefinition:

[legend]

Member Function Documentation

◆ GetDocDir()

bool THtml::TPathDefinition::GetDocDir	(	const TString &	module,
		TString &	doc_dir
	)		const

virtual

Determine the module's documentation directory.

If module is empty, set doc_dir to the product's documentation directory. If the path was successfully 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().

Definition at line 542 of file THtml.cxx.

◆ GetFileNameFromInclude()

bool THtml::TPathDefinition::GetFileNameFromInclude	(	const char *	included,
		TString &	out_fsname
	)		const

virtual

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.

Definition at line 621 of file THtml.cxx.

◆ GetIncludeAs()

bool THtml::TPathDefinition::GetIncludeAs	(	TClass *	cl,
		TString &	out_dir
	)		const

virtual

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

Definition at line 572 of file THtml.cxx.

◆ GetMacroPath()

bool THtml::TPathDefinition::GetMacroPath	(	const TString &	module,
		TString &	out_dir
	)		const

virtual

Determine the path to look for macros (see TDocMacroDirective) for classes from a given module.

If the path was successfully 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().

Definition at line 513 of file THtml.cxx.

Libraries for THtml::TPathDefinition:

[legend]

The documentation for this class was generated from the following files:

html/inc/THtml.h
html/src/THtml.cxx

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ GetDocDir()

◆ GetFileNameFromInclude()

◆ GetIncludeAs()

◆ GetMacroPath()