Definition at line 34 of file TDocDirective.h.

Public Member Functions
virtual void	AddLine (const TSubString &line)=0

virtual void	DeleteOutput () const

virtual const char *	GetEndTag () const =0

virtual Bool_t	GetResult (TString &result)=0

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TString &name, const TString &title)

	TNamed (const TNamed &named)
	TNamed copy ctor. More...

virtual	~TNamed ()

virtual void	Clear (Option_t *option="")
	Set name and title to empty strings (""). More...

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

virtual Int_t	Compare (const TObject *obj) const
	Compare two TNamed objects. More...

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

virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer. More...

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

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

virtual Bool_t	IsSortable () const

virtual void	ls (Option_t *option="") const
	List TNamed name and title. More...

TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator. More...

virtual void	Print (Option_t *option="") const
	Print TNamed name and title. More...

virtual void	SetName (const char *name)
	Set the name of the TNamed. More...

virtual void	SetNameTitle (const char name, const char title)
	Set all the TNamed parameters (name and title). More...

virtual void	SetTitle (const char *title="")
	Set the title of the TNamed. More...

virtual Int_t	Sizeof () const
	Return size of the TNamed part of the TObject. More...

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	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 TObject *	DrawClone (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 TObject *	FindObject (const char *name) const
	Must be redefined in derived classes. More...

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

virtual Option_t *	GetDrawOption () 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_t *	GetOption () const

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

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

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

Protected Member Functions
	TDocDirective ()

	TDocDirective (const char *name)

virtual	~TDocDirective ()

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

virtual void	DeleteOutputFiles (const char *ext) const
	Delete all output generated by the directive beginning with Name() and ending with ext. More...

TDocOutput *	GetDocOutput () const

TDocParser *	GetDocParser () const

THtml *	GetHtml () const

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

void	GetName (TString &name) const
	Get the full name, based on fName, fTitle, fDocParser's tag. More...

const char *	GetOutputDir () const
	Get the directory for documentation output. More...

void	SetCounter (Int_t count)

void	SetParameters (const char *params)
	Given a string containing parameters in params, we call AddParameter() for each of them. More...

void	SetParser (TDocParser *parser)
	Set the parser, and fDocOutput, fHtml from that. More...

void	SetTag (const char *tag)

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

Protected Attributes
Int_t	fCounter

TDocOutput *	fDocOutput

TDocParser *	fDocParser

THtml *	fHtml

TString	fParameters

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Friends
class	TDocParser

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

#include <TDocDirective.h>

Inheritance diagram for TDocDirective:

[legend]

Constructor & Destructor Documentation

◆ TDocDirective() [1/2]

TDocDirective::TDocDirective ( )

inlineprotected

Definition at line 44 of file TDocDirective.h.

◆ TDocDirective() [2/2]

TDocDirective::TDocDirective ( const char * name )

inlineprotected

Definition at line 45 of file TDocDirective.h.

◆ ~TDocDirective()

virtual TDocDirective::~TDocDirective ( )

inlineprotectedvirtual

Definition at line 47 of file TDocDirective.h.

Member Function Documentation

◆ AddLine()

virtual void TDocDirective::AddLine ( const TSubString & line )

pure virtual

Implemented in TDocLatexDirective, TDocMacroDirective, and TDocHtmlDirective.

◆ AddParameter()

virtual void TDocDirective::AddParameter	(	const TString &	,
		const char *	= `0`
	)

inlineprotectedvirtual

Reimplemented in TDocLatexDirective, and TDocMacroDirective.

Definition at line 42 of file TDocDirective.h.

◆ DeleteOutput()

virtual void TDocDirective::DeleteOutput ( ) const

inlinevirtual

Reimplemented in TDocLatexDirective, and TDocMacroDirective.

Definition at line 73 of file TDocDirective.h.

◆ DeleteOutputFiles()

void TDocDirective::DeleteOutputFiles ( const char * ext ) const

protectedvirtual

Delete all output generated by the directive beginning with Name() and ending with ext.

Definition at line 52 of file TDocDirective.cxx.

◆ GetDocOutput()

TDocOutput* TDocDirective::GetDocOutput ( ) const

inlineprotected

Definition at line 52 of file TDocDirective.h.

◆ GetDocParser()

TDocParser* TDocDirective::GetDocParser ( ) const

inlineprotected

Definition at line 51 of file TDocDirective.h.

◆ GetEndTag()

virtual const char* TDocDirective::GetEndTag ( ) const

pure virtual

Implemented in TDocLatexDirective, TDocMacroDirective, and TDocHtmlDirective.

◆ GetHtml()

THtml* TDocDirective::GetHtml ( ) const

inlineprotected

Definition at line 53 of file TDocDirective.h.

◆ GetName() [1/2]

const char* TDocDirective::GetName ( ) const

inlineprotectedvirtual

Returns name of object.

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

Reimplemented from TNamed.

Definition at line 49 of file TDocDirective.h.

◆ GetName() [2/2]

void TDocDirective::GetName ( TString & name ) const

protected

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

Definition at line 71 of file TDocDirective.cxx.

◆ GetOutputDir()

const char * TDocDirective::GetOutputDir ( ) const

protected

Get the directory for documentation output.

Definition at line 96 of file TDocDirective.cxx.

◆ GetResult()

virtual Bool_t TDocDirective::GetResult ( TString & result )

pure virtual

Implemented in TDocLatexDirective, TDocMacroDirective, and TDocHtmlDirective.

◆ SetCounter()

void TDocDirective::SetCounter ( Int_t count )

inlineprotected

Definition at line 59 of file TDocDirective.h.

◆ SetParameters()

void TDocDirective::SetParameters ( const char * params )

protected

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

Definition at line 114 of file TDocDirective.cxx.

◆ SetParser()

void TDocDirective::SetParser ( TDocParser * parser )

protected

Set the parser, and fDocOutput, fHtml from that.

Definition at line 149 of file TDocDirective.cxx.

◆ SetTag()

void TDocDirective::SetTag ( const char * tag )

inlineprotected

Definition at line 58 of file TDocDirective.h.

Friends And Related Function Documentation

◆ TDocParser

friend class TDocParser

friend

Definition at line 75 of file TDocDirective.h.

Member Data Documentation

◆ fCounter

Int_t TDocDirective::fCounter

protected

Definition at line 40 of file TDocDirective.h.

◆ fDocOutput

TDocOutput* TDocDirective::fDocOutput

protected

Definition at line 38 of file TDocDirective.h.

◆ fDocParser

TDocParser* TDocDirective::fDocParser

protected

Definition at line 36 of file TDocDirective.h.

◆ fHtml

THtml* TDocDirective::fHtml

protected

Definition at line 37 of file TDocDirective.h.

◆ fParameters

TString TDocDirective::fParameters

protected

Definition at line 39 of file TDocDirective.h.

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

html/inc/TDocDirective.h
html/src/TDocDirective.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ TDocDirective() [1/2]

◆ TDocDirective() [2/2]

◆ ~TDocDirective()

Member Function Documentation

◆ AddLine()

◆ AddParameter()

◆ DeleteOutput()

◆ DeleteOutputFiles()

◆ GetDocOutput()

◆ GetDocParser()

◆ GetEndTag()

◆ GetHtml()

◆ GetName() [1/2]

◆ GetName() [2/2]

◆ GetOutputDir()

◆ GetResult()

◆ SetCounter()

◆ SetParameters()

◆ SetParser()

◆ SetTag()

Friends And Related Function Documentation

◆ TDocParser

Member Data Documentation

◆ fCounter

◆ fDocOutput

◆ fDocParser

◆ fHtml

◆ fParameters