Back to index

lightning-sunbird  0.9+nobinonly
nsIFrameDebug.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 #ifndef nsIFrameDebug_h___
00038 #define nsIFrameDebug_h___
00039 
00040 #include "nsISupports.h"
00041 #include "nsIFrame.h"
00042 
00043 class nsPresContext;
00044 struct PRLogModuleInfo;
00045 
00046 // IID for the nsIFrameDebug interface {a6cf9069-15b3-11d2-932e-00805f8add32}
00047 #define NS_IFRAMEDEBUG_IID         \
00048 { 0xa6cf9069, 0x15b3, 0x11d2, \
00049   {0x93, 0x2e, 0x00, 0x80, 0x5f, 0x8a, 0xdd, 0x32}}
00050  
00054 class nsIFrameDebug : public nsISupports {
00055 public:
00056   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IFRAMEDEBUG_IID)
00057   
00058   NS_IMETHOD  List(nsPresContext* aPresContext, FILE* out, PRInt32 aIndent) const = 0;
00063   static void RootFrameList(nsPresContext* aPresContext, FILE* out, PRInt32 aIndent);
00068   NS_IMETHOD  GetFrameName(nsAString& aResult) const = 0;
00072   NS_IMETHOD_(nsFrameState)  GetDebugStateBits() const = 0;
00083   NS_IMETHOD  DumpRegressionData(nsPresContext* aPresContext, FILE* out, PRInt32 aIndent, PRBool aIncludeStyleData) = 0;
00084 
00085   NS_IMETHOD  VerifyTree() const = 0;
00086 
00093   static PRBool GetVerifyTreeEnable();
00094 
00098   static void SetVerifyTreeEnable(PRBool aEnabled);
00099 
00106   static PRBool GetVerifyStyleTreeEnable();
00107 
00111   static void SetVerifyStyleTreeEnable(PRBool aEnabled);
00112 
00120   static PRLogModuleInfo* GetLogModuleInfo();
00121 
00122   // Show frame borders when rendering
00123   static void ShowFrameBorders(PRBool aEnable);
00124   static PRBool GetShowFrameBorders();
00125 
00126   // Show frame border of event target
00127   static void ShowEventTargetFrameBorder(PRBool aEnable);
00128   static PRBool GetShowEventTargetFrameBorder();
00129 
00130 private:
00131   NS_IMETHOD_(nsrefcnt) AddRef(void) = 0;
00132   NS_IMETHOD_(nsrefcnt) Release(void) = 0;
00133 };
00134 
00135 #endif /* nsIFrameDebug_h___ */