Logo ROOT   6.10/09
Reference Guide
List of all members | Public Member Functions | Private Member Functions | Private Attributes | List of all members
TClassDocInfo Class Reference

Definition at line 28 of file TDocInfo.h.

Public Member Functions

 TClassDocInfo (TClass *cl, const char *htmlfilename="", const char *fsdecl="", const char *fsimpl="", const char *decl=0, const char *impl=0)
 
 TClassDocInfo (TDictionary *cl, const char *htmlfilename="", const char *fsdecl="", const char *fsimpl="", const char *decl=0, const char *impl=0)
 
virtual ~TClassDocInfo ()
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
TDictionaryGetClass () const
 
const char * GetDeclFileName () const
 
const char * GetDeclFileSysName () const
 
const char * GetHtmlFileName () const
 
const char * GetImplFileName () const
 
const char * GetImplFileSysName () const
 
TListGetListOfTypedefs ()
 
TModuleDocInfoGetModule () const
 
virtual const char * GetName () const
 Returns name of object. More...
 
ULong_t Hash () const
 Return hash value for this object. More...
 
Bool_t HaveSource () const
 
Bool_t IsSelected () const
 
virtual Bool_t IsSortable () const
 
void SetDeclFileName (const char *name)
 
void SetDeclFileSysName (const char *fsname)
 
void SetHtmlFileName (const char *name)
 
void SetImplFileName (const char *name)
 
void SetImplFileSysName (const char *fsname)
 
void SetModule (TModuleDocInfo *module)
 
void SetSelected (Bool_t sel=kTRUE)
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. 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...
 
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 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 selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. 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 void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. 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 const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. 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...
 
void InvertBit (UInt_t f)
 
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 IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. 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...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. 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...
 
void ResetBit (UInt_t f)
 
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...
 
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)
 
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 SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. 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...
 

Private Member Functions

 TClassDocInfo ()
 

Private Attributes

TDictionaryfClass
 
TString fDeclFileName
 
TString fDeclFileSysName
 
TString fHtmlFileName
 
TString fImplFileName
 
TString fImplFileSysName
 
TModuleDocInfofModule
 
Bool_t fSelected
 
TList fTypedefs
 

Additional Inherited Members

- Public Types inherited from TObject
enum  { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
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)
}
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- 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). More...
 
void MakeZombie ()
 

#include <TDocInfo.h>

Inheritance diagram for TClassDocInfo:
[legend]

Constructor & Destructor Documentation

◆ TClassDocInfo() [1/3]

TClassDocInfo::TClassDocInfo ( TClass cl,
const char *  htmlfilename = "",
const char *  fsdecl = "",
const char *  fsimpl = "",
const char *  decl = 0,
const char *  impl = 0 
)
inline

Definition at line 31 of file TDocInfo.h.

◆ TClassDocInfo() [2/3]

TClassDocInfo::TClassDocInfo ( TDictionary cl,
const char *  htmlfilename = "",
const char *  fsdecl = "",
const char *  fsimpl = "",
const char *  decl = 0,
const char *  impl = 0 
)
inline

Definition at line 41 of file TDocInfo.h.

◆ ~TClassDocInfo()

virtual TClassDocInfo::~TClassDocInfo ( )
inlinevirtual

Definition at line 51 of file TDocInfo.h.

◆ TClassDocInfo() [3/3]

TClassDocInfo::TClassDocInfo ( )
private

Member Function Documentation

◆ Compare()

Int_t TClassDocInfo::Compare ( const TObject obj) const
virtual

Compare abstract method.

Must be overridden if a class wants to be able to compare itself with other objects. Must return -1 if this is smaller than obj, 0 if objects are equal and 1 if this is larger than obj.

Reimplemented from TObject.

Definition at line 38 of file TDocInfo.cxx.

◆ GetClass()

TDictionary* TClassDocInfo::GetClass ( ) const
inline

Definition at line 53 of file TDocInfo.h.

◆ GetDeclFileName()

const char* TClassDocInfo::GetDeclFileName ( ) const
inline

Definition at line 56 of file TDocInfo.h.

◆ GetDeclFileSysName()

const char* TClassDocInfo::GetDeclFileSysName ( ) const
inline

Definition at line 58 of file TDocInfo.h.

◆ GetHtmlFileName()

const char* TClassDocInfo::GetHtmlFileName ( ) const
inline

Definition at line 55 of file TDocInfo.h.

◆ GetImplFileName()

const char* TClassDocInfo::GetImplFileName ( ) const
inline

Definition at line 57 of file TDocInfo.h.

◆ GetImplFileSysName()

const char* TClassDocInfo::GetImplFileSysName ( ) const
inline

Definition at line 59 of file TDocInfo.h.

◆ GetListOfTypedefs()

TList& TClassDocInfo::GetListOfTypedefs ( )
inline

Definition at line 77 of file TDocInfo.h.

◆ GetModule()

TModuleDocInfo* TClassDocInfo::GetModule ( ) const
inline

Definition at line 62 of file TDocInfo.h.

◆ GetName()

const char * TClassDocInfo::GetName ( ) const
virtual

Returns name of object.

This default method returns the class name. Classes that give objects a name should override this method.

Reimplemented from TObject.

Definition at line 26 of file TDocInfo.cxx.

◆ Hash()

ULong_t TClassDocInfo::Hash ( ) const
virtual

Return hash value for this object.

Reimplemented from TObject.

Definition at line 32 of file TDocInfo.cxx.

◆ HaveSource()

Bool_t TClassDocInfo::HaveSource ( ) const
inline

Definition at line 66 of file TDocInfo.h.

◆ IsSelected()

Bool_t TClassDocInfo::IsSelected ( ) const
inline

Definition at line 65 of file TDocInfo.h.

◆ IsSortable()

virtual Bool_t TClassDocInfo::IsSortable ( ) const
inlinevirtual

Reimplemented from TObject.

Definition at line 79 of file TDocInfo.h.

◆ SetDeclFileName()

void TClassDocInfo::SetDeclFileName ( const char *  name)
inline

Definition at line 70 of file TDocInfo.h.

◆ SetDeclFileSysName()

void TClassDocInfo::SetDeclFileSysName ( const char *  fsname)
inline

Definition at line 72 of file TDocInfo.h.

◆ SetHtmlFileName()

void TClassDocInfo::SetHtmlFileName ( const char *  name)
inline

Definition at line 69 of file TDocInfo.h.

◆ SetImplFileName()

void TClassDocInfo::SetImplFileName ( const char *  name)
inline

Definition at line 71 of file TDocInfo.h.

◆ SetImplFileSysName()

void TClassDocInfo::SetImplFileSysName ( const char *  fsname)
inline

Definition at line 73 of file TDocInfo.h.

◆ SetModule()

void TClassDocInfo::SetModule ( TModuleDocInfo module)
inline

Definition at line 61 of file TDocInfo.h.

◆ SetSelected()

void TClassDocInfo::SetSelected ( Bool_t  sel = kTRUE)
inline

Definition at line 64 of file TDocInfo.h.

Member Data Documentation

◆ fClass

TDictionary* TClassDocInfo::fClass
private

Definition at line 85 of file TDocInfo.h.

◆ fDeclFileName

TString TClassDocInfo::fDeclFileName
private

Definition at line 88 of file TDocInfo.h.

◆ fDeclFileSysName

TString TClassDocInfo::fDeclFileSysName
private

Definition at line 90 of file TDocInfo.h.

◆ fHtmlFileName

TString TClassDocInfo::fHtmlFileName
private

Definition at line 87 of file TDocInfo.h.

◆ fImplFileName

TString TClassDocInfo::fImplFileName
private

Definition at line 89 of file TDocInfo.h.

◆ fImplFileSysName

TString TClassDocInfo::fImplFileSysName
private

Definition at line 91 of file TDocInfo.h.

◆ fModule

TModuleDocInfo* TClassDocInfo::fModule
private

Definition at line 86 of file TDocInfo.h.

◆ fSelected

Bool_t TClassDocInfo::fSelected
private

Definition at line 93 of file TDocInfo.h.

◆ fTypedefs

TList TClassDocInfo::fTypedefs
private

Definition at line 92 of file TDocInfo.h.


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