2001-09-29 00:14:13 +04:00
|
|
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
|
|
* Version: NPL 1.1/GPL 2.0/LGPL 2.1
|
1999-11-02 01:12:45 +03:00
|
|
|
*
|
2001-09-29 00:14:13 +04:00
|
|
|
* The contents of this file are subject to the Netscape Public License
|
|
|
|
* Version 1.1 (the "License"); you may not use this file except in
|
|
|
|
* compliance with the License. You may obtain a copy of the License at
|
|
|
|
* http://www.mozilla.org/NPL/
|
1999-11-02 01:12:45 +03:00
|
|
|
*
|
2001-09-29 00:14:13 +04:00
|
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
|
|
* for the specific language governing rights and limitations under the
|
|
|
|
* License.
|
1999-11-02 01:12:45 +03:00
|
|
|
*
|
1999-11-06 06:40:37 +03:00
|
|
|
* The Original Code is mozilla.org code.
|
|
|
|
*
|
2001-09-29 00:14:13 +04:00
|
|
|
* The Initial Developer of the Original Code is
|
|
|
|
* Netscape Communications Corporation.
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 1998
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
1999-11-06 06:40:37 +03:00
|
|
|
*
|
2001-09-29 00:14:13 +04:00
|
|
|
* Contributor(s):
|
|
|
|
*
|
|
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
|
|
* use your version of this file under the terms of the NPL, indicate your
|
|
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
|
|
* the provisions above, a recipient may use your version of this file under
|
|
|
|
* the terms of any one of the NPL, the GPL or the LGPL.
|
|
|
|
*
|
|
|
|
* ***** END LICENSE BLOCK ***** */
|
1999-11-02 01:12:45 +03:00
|
|
|
#ifndef nsIFrameDebug_h___
|
|
|
|
#define nsIFrameDebug_h___
|
|
|
|
|
|
|
|
#include "nsISupports.h"
|
|
|
|
|
|
|
|
class nsIFrame;
|
|
|
|
class nsIPresContext;
|
2001-08-01 05:27:50 +04:00
|
|
|
struct PRLogModuleInfo;
|
1999-11-02 01:12:45 +03:00
|
|
|
|
|
|
|
// IID for the nsIFrameDebug interface {a6cf9069-15b3-11d2-932e-00805f8add32}
|
|
|
|
#define NS_IFRAMEDEBUG_IID \
|
|
|
|
{ 0xa6cf9069, 0x15b3, 0x11d2, \
|
|
|
|
{0x93, 0x2e, 0x00, 0x80, 0x5f, 0x8a, 0xdd, 0x32}}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Debug related functions
|
|
|
|
*/
|
|
|
|
class nsIFrameDebug : public nsISupports {
|
|
|
|
public:
|
2002-06-26 07:38:55 +04:00
|
|
|
NS_DEFINE_STATIC_IID_ACCESSOR(NS_IFRAMEDEBUG_IID)
|
1999-11-02 01:12:45 +03:00
|
|
|
|
|
|
|
NS_IMETHOD List(nsIPresContext* aPresContext, FILE* out, PRInt32 aIndent) const = 0;
|
2001-07-18 01:29:08 +04:00
|
|
|
/**
|
|
|
|
* lists the frames beginning from the root frame
|
|
|
|
* - calls root frame's List(...)
|
|
|
|
*/
|
2001-10-23 05:37:21 +04:00
|
|
|
static void RootFrameList(nsIPresContext* aPresContext, FILE* out, PRInt32 aIndent);
|
1999-11-02 01:12:45 +03:00
|
|
|
/**
|
|
|
|
* Get a printable from of the name of the frame type.
|
|
|
|
* XXX This should be eliminated and we use GetFrameType() instead...
|
|
|
|
*/
|
2001-11-14 04:33:42 +03:00
|
|
|
NS_IMETHOD GetFrameName(nsAString& aResult) const = 0;
|
1999-11-02 01:12:45 +03:00
|
|
|
/**
|
|
|
|
* 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.
|
2000-12-07 18:31:40 +03:00
|
|
|
*
|
|
|
|
* Argument aIncludeStyleData: if PR_TRUE, style information is dumpted, otherwise it is not
|
1999-11-02 01:12:45 +03:00
|
|
|
*/
|
2000-12-07 18:31:40 +03:00
|
|
|
NS_IMETHOD DumpRegressionData(nsIPresContext* aPresContext, FILE* out, PRInt32 aIndent, PRBool aIncludeStyleData) = 0;
|
1999-11-02 01:12:45 +03:00
|
|
|
|
|
|
|
NS_IMETHOD VerifyTree() const = 0;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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.
|
|
|
|
*/
|
2001-10-23 05:37:21 +04:00
|
|
|
static PRBool GetVerifyTreeEnable();
|
1999-11-02 01:12:45 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the verify-tree enable flag.
|
|
|
|
*/
|
2001-10-23 05:37:21 +04:00
|
|
|
static void SetVerifyTreeEnable(PRBool aEnabled);
|
1999-11-02 01:12:45 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* 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.
|
|
|
|
*/
|
2001-10-23 05:37:21 +04:00
|
|
|
static PRBool GetVerifyStyleTreeEnable();
|
1999-11-02 01:12:45 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the verify-style-tree enable flag.
|
|
|
|
*/
|
2001-10-23 05:37:21 +04:00
|
|
|
static void SetVerifyStyleTreeEnable(PRBool aEnabled);
|
1999-11-02 01:12:45 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* 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.
|
|
|
|
*/
|
2001-10-23 05:37:21 +04:00
|
|
|
static PRLogModuleInfo* GetLogModuleInfo();
|
1999-11-02 01:12:45 +03:00
|
|
|
|
|
|
|
// Show frame borders when rendering
|
2001-10-23 05:37:21 +04:00
|
|
|
static void ShowFrameBorders(PRBool aEnable);
|
|
|
|
static PRBool GetShowFrameBorders();
|
1999-11-02 01:12:45 +03:00
|
|
|
|
2000-02-03 05:49:58 +03:00
|
|
|
// Show frame border of event target
|
2001-10-23 05:37:21 +04:00
|
|
|
static void ShowEventTargetFrameBorder(PRBool aEnable);
|
|
|
|
static PRBool GetShowEventTargetFrameBorder();
|
2000-02-03 05:49:58 +03:00
|
|
|
|
1999-11-02 01:12:45 +03:00
|
|
|
private:
|
|
|
|
NS_IMETHOD_(nsrefcnt) AddRef(void) = 0;
|
|
|
|
NS_IMETHOD_(nsrefcnt) Release(void) = 0;
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif /* nsIFrameDebug_h___ */
|