зеркало из https://github.com/mozilla/pjs.git
124 строки
4.3 KiB
C++
124 строки
4.3 KiB
C++
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
|
*
|
|
* 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/
|
|
*
|
|
* 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.
|
|
*
|
|
* The Original Code is mozilla.org code.
|
|
*
|
|
* The Initial Developer of the Original Code is Netscape
|
|
* Communications Corporation. Portions created by Netscape are
|
|
* Copyright (C) 1998 Netscape Communications Corporation. All
|
|
* Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*/
|
|
#ifndef nsIFrameDebug_h___
|
|
#define nsIFrameDebug_h___
|
|
|
|
#include "nslayout.h"
|
|
#include "nsISupports.h"
|
|
|
|
class nsIFrame;
|
|
class nsIPresContext;
|
|
|
|
// 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:
|
|
static const nsIID& GetIID() { static nsIID iid = NS_IFRAMEDEBUG_IID; return iid; }
|
|
|
|
NS_IMETHOD List(nsIPresContext* aPresContext, FILE* out, PRInt32 aIndent) const = 0;
|
|
|
|
/**
|
|
* Get a printable from of the name of the frame type.
|
|
* XXX This should be eliminated and we use GetFrameType() instead...
|
|
*/
|
|
NS_IMETHOD GetFrameName(nsString& aResult) const = 0;
|
|
/**
|
|
* 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.
|
|
*/
|
|
NS_IMETHOD DumpRegressionData(nsIPresContext* aPresContext, FILE* out, PRInt32 aIndent) = 0;
|
|
|
|
/**
|
|
* Get the size of the frame object. The size value should include
|
|
* all subordinate data referenced by the frame that is not
|
|
* accounted for by child frames. However, this value should not
|
|
* include the content objects, style contexts, views or other data
|
|
* that lies logically outside the frame system.
|
|
*
|
|
* If the implementation so chooses, instead of returning the total
|
|
* subordinate data it may instead use the sizeof handler to store
|
|
* away subordinate data under its own key so that the subordinate
|
|
* data may be tabulated independently of the frame itself.
|
|
*
|
|
* The caller is responsible for recursing over all child-lists that
|
|
* the frame supports.
|
|
*/
|
|
NS_IMETHOD SizeOf(nsISizeOfHandler* aSizer, PRUint32* aResult) const = 0;
|
|
|
|
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.
|
|
*/
|
|
static NS_LAYOUT PRBool GetVerifyTreeEnable();
|
|
|
|
/**
|
|
* Set the verify-tree enable flag.
|
|
*/
|
|
static NS_LAYOUT void SetVerifyTreeEnable(PRBool aEnabled);
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
static NS_LAYOUT PRBool GetVerifyStyleTreeEnable();
|
|
|
|
/**
|
|
* Set the verify-style-tree enable flag.
|
|
*/
|
|
static NS_LAYOUT void SetVerifyStyleTreeEnable(PRBool aEnabled);
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
static NS_LAYOUT PRLogModuleInfo* GetLogModuleInfo();
|
|
|
|
// Show frame borders when rendering
|
|
static NS_LAYOUT void ShowFrameBorders(PRBool aEnable);
|
|
static NS_LAYOUT PRBool GetShowFrameBorders();
|
|
|
|
private:
|
|
NS_IMETHOD_(nsrefcnt) AddRef(void) = 0;
|
|
NS_IMETHOD_(nsrefcnt) Release(void) = 0;
|
|
};
|
|
|
|
#endif /* nsIFrameDebug_h___ */
|