Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Static Public Member Functions | Private Member Functions
nsIFrameDebug Class Reference

Debug related functions. More...

#include <nsIFrameDebug.h>

Inheritance diagram for nsIFrameDebug:
Inheritance graph
[legend]
Collaboration diagram for nsIFrameDebug:
Collaboration graph
[legend]

List of all members.

Public Member Functions

NS_IMETHOD List (nsPresContext *aPresContext, FILE *out, PRInt32 aIndent) const =0
NS_IMETHOD GetFrameName (nsAString &aResult) const =0
 Get a printable from of the name of the frame type.
 NS_IMETHOD_ (nsFrameState) GetDebugStateBits() const =0
 Return the state bits that are relevant to regression tests (that is, those bits which indicate a real difference when they differ.
NS_IMETHOD DumpRegressionData (nsPresContext *aPresContext, FILE *out, PRInt32 aIndent, PRBool aIncludeStyleData)=0
 Called to dump out regression data that describes the layout of the frame and it's children, and so on.
NS_IMETHOD VerifyTree () const =0

Static Public Member Functions

static void RootFrameList (nsPresContext *aPresContext, FILE *out, PRInt32 aIndent)
 lists the frames beginning from the root frame
static PRBool GetVerifyTreeEnable ()
 See if tree verification is enabled.
static void SetVerifyTreeEnable (PRBool aEnabled)
 Set the verify-tree enable flag.
static PRBool GetVerifyStyleTreeEnable ()
 See if style tree verification is enabled.
static void SetVerifyStyleTreeEnable (PRBool aEnabled)
 Set the verify-style-tree enable flag.
static PRLogModuleInfoGetLogModuleInfo ()
 The frame class and related classes share an nspr log module for logging frame activity.
static void ShowFrameBorders (PRBool aEnable)
static PRBool GetShowFrameBorders ()
static void ShowEventTargetFrameBorder (PRBool aEnable)
static PRBool GetShowEventTargetFrameBorder ()

Private Member Functions

 NS_IMETHOD_ (nsrefcnt) AddRef(void)=0
 NS_IMETHOD_ (nsrefcnt) Release(void)=0

Detailed Description

Debug related functions.

Definition at line 54 of file nsIFrameDebug.h.


Member Function Documentation

NS_IMETHOD nsIFrameDebug::DumpRegressionData ( nsPresContext aPresContext,
FILE out,
PRInt32  aIndent,
PRBool  aIncludeStyleData 
) [pure virtual]

Called to dump out regression data that describes the layout of the frame and it's children, and so on.

The format of the data is dictated to be XML (using a specific DTD); the specific kind of data dumped is up to the frame itself, with the caveat that some base types are defined. For more information, see XXX.

Argument aIncludeStyleData: if PR_TRUE, style information is dumpted, otherwise it is not

Here is the caller graph for this function:

NS_IMETHOD nsIFrameDebug::GetFrameName ( nsAString &  aResult) const [pure virtual]

Get a printable from of the name of the frame type.

XXX This should be eliminated and we use GetType() instead...

Here is the caller graph for this function:

The frame class and related classes share an nspr log module for logging frame activity.

Note: the log module is created during library initialization which means that you cannot perform logging before then.

Here is the caller graph for this function:

Here is the caller graph for this function:

See if style tree verification is enabled.

To enable style tree verification add "styleverifytree:1" to your NSPR_LOG_MODULES environment variable (any non-zero debug level will work). Or, call SetVerifyStyleTreeEnable with PR_TRUE.

See if tree verification is enabled.

To enable tree verification add "frameverifytree:1" to your NSPR_LOG_MODULES environment variable (any non-zero debug level will work). Or, call SetVerifyTreeEnable with PR_TRUE.

Here is the caller graph for this function:

NS_IMETHOD nsIFrameDebug::List ( nsPresContext aPresContext,
FILE out,
PRInt32  aIndent 
) const [pure virtual]

Here is the caller graph for this function:

nsIFrameDebug::NS_IMETHOD_ ( nsFrameState  ) const [pure virtual]

Return the state bits that are relevant to regression tests (that is, those bits which indicate a real difference when they differ.

nsIFrameDebug::NS_IMETHOD_ ( nsrefcnt  ) [private, pure virtual]
nsIFrameDebug::NS_IMETHOD_ ( nsrefcnt  ) [private, pure virtual]
static void nsIFrameDebug::RootFrameList ( nsPresContext aPresContext,
FILE out,
PRInt32  aIndent 
) [static]

lists the frames beginning from the root frame

  • calls root frame's List(...)

Here is the caller graph for this function:

static void nsIFrameDebug::SetVerifyStyleTreeEnable ( PRBool  aEnabled) [static]

Set the verify-style-tree enable flag.

static void nsIFrameDebug::SetVerifyTreeEnable ( PRBool  aEnabled) [static]

Set the verify-tree enable flag.

static void nsIFrameDebug::ShowFrameBorders ( PRBool  aEnable) [static]
NS_IMETHOD nsIFrameDebug::VerifyTree ( ) const [pure virtual]

Here is the caller graph for this function:


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