ROOT  6.06/09
Reference Guide
Public Member Functions | Protected Member Functions | List of all members
THtml::TPathDefinition Class Reference

Definition at line 96 of file THtml.h.

Public Member Functions

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. More...
 
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. More...
 
virtual bool GetFileNameFromInclude (const char *included, TString &out_fsname) const
 Set out_fsname to the full pathname corresponding to a file included as "included". More...
 
virtual bool GetDocDir (const TString &module, TString &doc_dir) const
 Determine the module's documentation directory. More...
 
- Public Member Functions inherited from THtml::THelperBase
 THelperBase ()
 
virtual ~THelperBase ()
 Helper's destructor. More...
 
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. More...
 
THtmlGetOwner () const
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current pad. More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
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. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual Option_tGetOption () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsSortable () const
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 
voidoperator new (size_t sz)
 
voidoperator new[] (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz, void *vp)
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
void ResetBit (UInt_t f)
 
Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
void InvertBit (UInt_t f)
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
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). More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 

Protected Member Functions

 ClassDef (TPathDefinition, 0)
 
- Protected Member Functions inherited from TObject
void MakeZombie ()
 
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 

Additional Inherited Members

- Public Types inherited from TObject
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4),
  kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
enum  { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

#include <THtml.h>

+ Inheritance diagram for THtml::TPathDefinition:
+ Collaboration diagram for THtml::TPathDefinition:

Member Function Documentation

THtml::TPathDefinition::ClassDef ( TPathDefinition  ,
 
)
protected
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 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().

Definition at line 541 of file THtml.cxx.

Referenced by TDocOutput::CreateModuleIndex().

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 620 of file THtml.cxx.

Referenced by TClassDocOutput::CreateDotClassChartIncl(), and TDocParser::ExpandCPPLine().

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 571 of file THtml.cxx.

Referenced by TDocOutput::CreateClassTypeDefs(), and TClassDocOutput::WriteClassDocHeader().

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

Definition at line 512 of file THtml.cxx.

Referenced by THtml::GetModuleMacroPath().


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