Logo ROOT  
Reference Guide
TDocMacroDirective Class Reference

Definition at line 95 of file TDocDirective.h.

Public Member Functions

 TDocMacroDirective ()
 
virtual ~TDocMacroDirective ()
 Destructor. More...
 
virtual void AddLine (const TSubString &line)
 Add a macro line. More...
 
virtual void DeleteOutput () const
 
virtual const char * GetEndTag () const
 
virtual Bool_t GetResult (TString &result)
 Get the result (i.e. More...
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor. More...
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
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 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...
 
TNamedoperator= (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...
 
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. 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 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 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...
 
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. 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...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
R__ALWAYS_INLINE 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...
 
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 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)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. 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 SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. 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...
 

Static Public Member Functions

static void SubProcess (const TString &what, const TString &out)
 
- 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...
 

Private Member Functions

virtual void AddParameter (const TString &name, const char *value=0)
 Setting fNeedGraphics if name is "GUI", setting fShowSource if name is "SOURCE". More...
 
TString CreateSubprocessInputFile ()
 Create the input file for SubProcess(). More...
 

Private Attributes

Bool_t fIsFilename
 
TMacrofMacro
 
Bool_t fNeedGraphics
 
Bool_t fShowSource
 

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)
}
 
- Protected Member Functions inherited from TDocDirective
 TDocDirective ()
 
 TDocDirective (const char *name)
 
virtual ~TDocDirective ()
 
virtual void DeleteOutputFiles (const char *ext) const
 Delete all output generated by the directive beginning with Name() and ending with ext. More...
 
TDocOutputGetDocOutput () const
 
TDocParserGetDocParser () const
 
THtmlGetHtml () 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 inherited from TDocDirective
Int_t fCounter
 
TDocOutputfDocOutput
 
TDocParserfDocParser
 
THtmlfHtml
 
TString fParameters
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

#include <TDocDirective.h>

Inheritance diagram for TDocMacroDirective:
[legend]

Constructor & Destructor Documentation

◆ TDocMacroDirective()

TDocMacroDirective::TDocMacroDirective ( )
inline

Definition at line 106 of file TDocDirective.h.

◆ ~TDocMacroDirective()

TDocMacroDirective::~TDocMacroDirective ( )
virtual

Destructor.

Definition at line 251 of file TDocDirective.cxx.

Member Function Documentation

◆ AddLine()

void TDocMacroDirective::AddLine ( const TSubString line)
virtual

Add a macro line.

Lines ending on "*HIDE*" will be executed as part of the macro, but not shown in the source tab if the parameter source is supplied.

Implements TDocDirective.

Definition at line 325 of file TDocDirective.cxx.

◆ AddParameter()

void TDocMacroDirective::AddParameter ( const TString name,
const char *  value = 0 
)
privatevirtual

Setting fNeedGraphics if name is "GUI", setting fShowSource if name is "SOURCE".

Reimplemented from TDocDirective.

Definition at line 553 of file TDocDirective.cxx.

◆ CreateSubprocessInputFile()

TString TDocMacroDirective::CreateSubprocessInputFile ( )
private

Create the input file for SubProcess().

Definition at line 345 of file TDocDirective.cxx.

◆ DeleteOutput()

virtual void TDocMacroDirective::DeleteOutput ( ) const
inlinevirtual

Reimplemented from TDocDirective.

Definition at line 115 of file TDocDirective.h.

◆ GetEndTag()

virtual const char* TDocMacroDirective::GetEndTag ( ) const
inlinevirtual

Implements TDocDirective.

Definition at line 112 of file TDocDirective.h.

◆ GetResult()

Bool_t TDocMacroDirective::GetResult ( TString result)
virtual

Get the result (i.e.

an HTML img tag) for the macro invocation. If fShowSource is set, a second tab will be created which shows the source.

Implements TDocDirective.

Definition at line 430 of file TDocDirective.cxx.

◆ SubProcess()

void TDocMacroDirective::SubProcess ( const TString what,
const TString out 
)
static

Definition at line 258 of file TDocDirective.cxx.

Member Data Documentation

◆ fIsFilename

Bool_t TDocMacroDirective::fIsFilename
private

Definition at line 100 of file TDocDirective.h.

◆ fMacro

TMacro* TDocMacroDirective::fMacro
private

Definition at line 97 of file TDocDirective.h.

◆ fNeedGraphics

Bool_t TDocMacroDirective::fNeedGraphics
private

Definition at line 98 of file TDocDirective.h.

◆ fShowSource

Bool_t TDocMacroDirective::fShowSource
private

Definition at line 99 of file TDocDirective.h.

Libraries for TDocMacroDirective:
[legend]

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