Definition at line 761 of file TGHtml.h.

Public Member Functions
	TGHtmlLayoutContext ()
	Html Layout Context constructor.

void	LayoutBlock ()
	Do as much layout as possible on the block of text defined by the HtmlLayoutContext.

void	PopIndent ()
	Adjust (pop) ident.

void	PushIndent ()
	Adjust (push) ident.

void	Reset ()
	Reset the layout context.

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.

Public Attributes
int	fBottom

int	fHeadRoom

TGHtml *	fHtml

int	fLeft

SHtmlMargin_t *	fLeftMargin

int	fMaxX

int	fMaxY

int	fPageWidth

TGHtmlElement *	fPEnd

TGHtmlElement *	fPStart

int	fRight

SHtmlMargin_t *	fRightMargin

int	fTop

Protected Member Functions
void	ClearMarginStack (SHtmlMargin_t **ppMargin)
	Clear a margin stack to reclaim memory.

void	ClearObstacle (int mode)
	Clear a wrap-around obstacle.

void	ComputeMargins (int pX, int pY, int *pW)
	Compute the current margins for layout.

TGHtmlElement *	DoBreakMarkup (TGHtmlElement *p)
	Break markup is any kind of markup that might force a line-break.

void	FixAnchors (TGHtmlElement p, TGHtmlElement pEnd, int y)
	Set the y coordinate for every anchor in the given list.

int	FixLine (TGHtmlElement pStart, TGHtmlElement pEnd, int bottom, int width, int actualWidth, int leftMargin, int *maxX)
	This routine computes the X and Y coordinates for all elements of a line that has been gathered using GetLine() above.

TGHtmlElement *	GetLine (TGHtmlElement pStart, TGHtmlElement pEnd, int width, int minX, int *actualWidth)
	This routine gathers as many tokens as will fit on one line.

int	InWrapAround ()
	Return TRUE (non-zero) if we are currently wrapping text around one or more images.

void	Paragraph (TGHtmlElement *p)
	Increase the headroom to create a paragraph break at the current token.

void	PopExpiredMargins (SHtmlMargin_t **ppMarginStack, int y)
	Pop all expired margins from the stack.

void	PopMargin (SHtmlMargin_t **ppMargin, int tag)
	Pop as many margins as necessary until the margin that was created with "tag" is popped off.

void	PopOneMargin (SHtmlMargin_t **ppMargin)
	Pop one margin off of the given margin stack.

void	PushMargin (SHtmlMargin_t **ppMargin, int indent, int bottom, int tag)
	Push a new margin onto the given margin stack.

TGHtmlElement *	TableLayout (TGHtmlTable *p)
	Do all layout for a single table.

void	WidenLine (int reqWidth, int pX, int pY, int *pW)
	Move past obstacles until a linewidth of reqWidth is obtained, or until all obstacles are cleared.

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

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

#include <TGHtml.h>

Inheritance diagram for TGHtmlLayoutContext:

[legend]

Constructor & Destructor Documentation

◆ TGHtmlLayoutContext()

TGHtmlLayoutContext::TGHtmlLayoutContext ( )

Html Layout Context constructor.

Definition at line 38 of file TGHtmlLayout.cxx.

Member Function Documentation

◆ ClearMarginStack()

void TGHtmlLayoutContext::ClearMarginStack ( SHtmlMargin_t ** ppMargin )

protected

Clear a margin stack to reclaim memory.

This routine just blindly pops everything off the stack. Typically used when the screen is cleared or the widget is deleted, etc.

Definition at line 165 of file TGHtmlLayout.cxx.

◆ ClearObstacle()

void TGHtmlLayoutContext::ClearObstacle ( int mode )

protected

Clear a wrap-around obstacle.

The second option determines the precise behavior.

CLEAR_Left Clear all obstacles on the left.

CLEAR_Right Clear all obstacles on the right.

CLEAR_Both Clear all obstacles on both sides.

CLEAR_First Clear only the first obstacle on either side.

Definition at line 733 of file TGHtmlLayout.cxx.

◆ ComputeMargins()

void TGHtmlLayoutContext::ComputeMargins	(	int *	pX,
		int *	pY,
		int *	pW
	)

protected

Compute the current margins for layout.

Three values are returned:

*pY The top edge of the area in which we can put ink. This takes into account any requested headroom.

*pX The left edge of the inkable area. The takes into account any margin requests active at vertical position specified in pLC->bottom.

*pW The width of the inkable area. This takes into account an margin requests that are active at the vertical position pLC->bottom.

Definition at line 696 of file TGHtmlLayout.cxx.

◆ DoBreakMarkup()

TGHtmlElement * TGHtmlLayoutContext::DoBreakMarkup ( TGHtmlElement * p )

protected

Break markup is any kind of markup that might force a line-break.

This routine handles a single element of break markup and returns a pointer to the first element past that markup. If p doesn't point to break markup, then p is returned. If p is an incomplete table (a

lacks a

), then NULL is returned.

Definition at line 827 of file TGHtmlLayout.cxx.

◆ FixAnchors()

void TGHtmlLayoutContext::FixAnchors	(	TGHtmlElement *	p,
		TGHtmlElement *	pEnd,
		int	y
	)

protected

Set the y coordinate for every anchor in the given list.

Definition at line 428 of file TGHtmlLayout.cxx.

◆ FixLine()

int TGHtmlLayoutContext::FixLine	(	TGHtmlElement *	p_start,
		TGHtmlElement *	p_end,
		int	mbottom,
		int	width,
		int	actualWidth,
		int	lMargin,
		int *	max_x
	)

protected

This routine computes the X and Y coordinates for all elements of a line that has been gathered using GetLine() above.

It also figures the ascent and descent for in-line images.

The value returned is the Y coordinate of the bottom edge of the new line. The X coordinates are computed by adding the left margin plus any extra space needed for centering or right-justification.

p_start - Start of tokens for this line p_end - First token past end of this line. Maybe NULL mbottom - Put the top of this line here width - This is the space available to the line actualWidth - This is the actual width needed by the line lMargin - The current left margin max_x - Write maximum X coordinate of ink here

Definition at line 453 of file TGHtmlLayout.cxx.

◆ GetLine()

TGHtmlElement * TGHtmlLayoutContext::GetLine	(	TGHtmlElement *	p_start,
		TGHtmlElement *	p_end,
		int	width,
		int	minX,
		int *	actualWidth
	)

protected

This routine gathers as many tokens as will fit on one line.

The candidate tokens begin with fPStart and go thru the end of the list or to fPEnd, whichever comes first. The first token at the start of the next line is returned. NULL is returned if we exhaust data.

"width" is the maximum allowed width of the line. The actual width is returned in *actualWidth. The actual width does not include any trailing spaces. Sometimes the actual width will be greater than the maximum width. This will happen, for example, for text enclosed in

..

that has lines longer than the width of the page.

If the list begins with text, at least one token is returned, even if that one token is longer than the allowed line length. But if the list begins with some kind of break markup (possibly preceded by white space) then the returned list may be empty.

The "x" coordinates of all elements are set assuming that the line begins at 0. The calling routine should adjust these coordinates to position the line horizontally. (The FixLine() procedure does this.) Note that the "x" coordinate of elements will be negative. Text within

.. might also have a negative "x" coordinate. But in no case will the x coordinate every be less than "minX".

p_start - First token on new line p_end - End of line. Might be NULL width - How much space is on this line minX - The minimum value of the X coordinate actualWidth - Return space actually required

Definition at line 203 of file TGHtmlLayout.cxx.

◆ InWrapAround()

int TGHtmlLayoutContext::InWrapAround ( )

protected

Return TRUE (non-zero) if we are currently wrapping text around one or more images.

Definition at line 1044 of file TGHtmlLayout.cxx.

◆ LayoutBlock()

void TGHtmlLayoutContext::LayoutBlock ( )

Do as much layout as possible on the block of text defined by the HtmlLayoutContext.

Definition at line 1076 of file TGHtmlLayout.cxx.

◆ Paragraph()

void TGHtmlLayoutContext::Paragraph ( TGHtmlElement * p )

protected

Increase the headroom to create a paragraph break at the current token.

Definition at line 657 of file TGHtmlLayout.cxx.

◆ PopExpiredMargins()

void TGHtmlLayoutContext::PopExpiredMargins	(	SHtmlMargin_t **	ppMarginStack,
		int	y
	)

protected

Pop all expired margins from the stack.

An expired margin is one with a non-negative bottom parameter that is less than the value "y". "y" is the Y-coordinate of the top edge the next line of text to by positioned. What this function does is check to see if we have cleared any obstacles (an obstacle is an or ) and expands the margins if we have.

Definition at line 152 of file TGHtmlLayout.cxx.

◆ PopIndent()

void TGHtmlLayoutContext::PopIndent ( )

Adjust (pop) ident.

Definition at line 1168 of file TGHtmlLayout.cxx.

◆ PopMargin()

void TGHtmlLayoutContext::PopMargin	(	SHtmlMargin_t **	ppMargin,
		int	tag
	)

protected

Pop as many margins as necessary until the margin that was created with "tag" is popped off.

Update the layout context to move past obstacles, if necessary.

If there are some margins on the stack that contain non-negative bottom fields, that means there are some obstacles that we have not yet cleared. If these margins get popped off the stack, then we have to be careful to advance the 'bottom' value so that the next line of text will clear the obstacle.

Definition at line 119 of file TGHtmlLayout.cxx.

◆ PopOneMargin()

void TGHtmlLayoutContext::PopOneMargin ( SHtmlMargin_t ** ppMargin )

protected

Pop one margin off of the given margin stack.

Definition at line 99 of file TGHtmlLayout.cxx.

◆ PushIndent()

void TGHtmlLayoutContext::PushIndent ( )

Adjust (push) ident.

Definition at line 1156 of file TGHtmlLayout.cxx.

◆ PushMargin()

void TGHtmlLayoutContext::PushMargin	(	SHtmlMargin_t **	ppMargin,
		int	indent,
		int	mbottom,
		int	tag
	)

protected

Push a new margin onto the given margin stack.

If the "bottom" parameter is non-negative, then this margin will automatically expire for all text that is placed below the y-coordinate given by "bottom". This feature is used for and kinds of markup. It allows text to flow around an image.

If "bottom" is negative, then the margin stays in force until it is explicitly canceled by a call to PopMargin().

ppMargin - The margin stack onto which to push indent - The indentation for the new margin mbottom - The margin expires at this Y coordinate tag - Markup that will cancel this margin

Definition at line 81 of file TGHtmlLayout.cxx.

◆ Reset()

void TGHtmlLayoutContext::Reset ( )

Reset the layout context.

Definition at line 56 of file TGHtmlLayout.cxx.

◆ TableLayout()

TGHtmlElement * TGHtmlLayoutContext::TableLayout ( TGHtmlTable * pTable )

protected

Do all layout for a single table.

Return the

element or NULL if the table is unterminated.

Definition at line 1118 of file TGHtmlTable.cxx.

◆ WidenLine()

void TGHtmlLayoutContext::WidenLine	(	int	reqWidth,
		int *	pX,
		int *	pY,
		int *	pW
	)

protected

Move past obstacles until a linewidth of reqWidth is obtained, or until all obstacles are cleared.

reqWidth - Requested line width pX, pY, pW - The margins. See ComputeMargins()

Definition at line 1058 of file TGHtmlLayout.cxx.

Member Data Documentation

◆ fBottom

int TGHtmlLayoutContext::fBottom

Definition at line 800 of file TGHtml.h.

◆ fHeadRoom

int TGHtmlLayoutContext::fHeadRoom

Definition at line 798 of file TGHtml.h.

◆ fHtml

TGHtml* TGHtmlLayoutContext::fHtml

Definition at line 795 of file TGHtml.h.

◆ fLeft

int TGHtmlLayoutContext::fLeft

Definition at line 801 of file TGHtml.h.

◆ fLeftMargin

SHtmlMargin_t* TGHtmlLayoutContext::fLeftMargin

Definition at line 805 of file TGHtml.h.

◆ fMaxX

int TGHtmlLayoutContext::fMaxX

Definition at line 804 of file TGHtml.h.

◆ fMaxY

int TGHtmlLayoutContext::fMaxY

Definition at line 804 of file TGHtml.h.

◆ fPageWidth

int TGHtmlLayoutContext::fPageWidth

Definition at line 802 of file TGHtml.h.

◆ fPEnd

TGHtmlElement* TGHtmlLayoutContext::fPEnd

Definition at line 797 of file TGHtml.h.

◆ fPStart

TGHtmlElement* TGHtmlLayoutContext::fPStart

Definition at line 796 of file TGHtml.h.

◆ fRight

int TGHtmlLayoutContext::fRight

Definition at line 801 of file TGHtml.h.

◆ fRightMargin

SHtmlMargin_t* TGHtmlLayoutContext::fRightMargin

Definition at line 806 of file TGHtml.h.

◆ fTop

int TGHtmlLayoutContext::fTop

Definition at line 799 of file TGHtml.h.

Libraries for TGHtmlLayoutContext:

[legend]

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

gui/guihtml/inc/TGHtml.h
gui/guihtml/src/TGHtmlLayout.cxx
gui/guihtml/src/TGHtmlTable.cxx

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ TGHtmlLayoutContext()

Member Function Documentation

◆ ClearMarginStack()

◆ ClearObstacle()

◆ ComputeMargins()

◆ DoBreakMarkup()

◆ FixAnchors()

◆ FixLine()

◆ GetLine()

◆ InWrapAround()

◆ LayoutBlock()

◆ Paragraph()

◆ PopExpiredMargins()

◆ PopIndent()

◆ PopMargin()

◆ PopOneMargin()

◆ PushIndent()

◆ PushMargin()

◆ Reset()

◆ TableLayout()

◆ WidenLine()

Member Data Documentation

◆ fBottom

◆ fHeadRoom

◆ fHtml

◆ fLeft

◆ fLeftMargin

◆ fMaxX

◆ fMaxY

◆ fPageWidth

◆ fPEnd

◆ fPStart

◆ fRight

◆ fRightMargin

◆ fTop