extensions/layout-debug/src/nsILayoutDebuggingTools.idl

   1 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 // vim:cindent:tabstop=4:expandtab:shiftwidth=4:
   3 /* ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is layout debugging code.
  17  *
  18  * The Initial Developer of the Original Code is L. David Baron.
  19  * Portions created by the Initial Developer are Copyright (C) 2002
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   L. David Baron <dbaron@dbaron.org> (original author)
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40
  41 interface nsIDOMWindow;
  42
  43 /**
  44  * A series of hooks into non-IDL-ized layout code to allow all the
  45  * layout debugging functions to be used from chrome.
  46  */
  47
  48 [scriptable, uuid(4b968d4b-9c08-4635-a7e0-55084843f0fd)]
  49 interface nsILayoutDebuggingTools : nsISupports
  50 {
  51
  52     /*
  53      * Initialize debugger object to act on a docshell.
  54      */
  55     void init(in nsIDOMWindow win);
  56
  57     /*
  58      * Notify the debugger that the docshell has been told to load a new
  59      * URI.
  60      */
  61     void newURILoaded();
  62
  63     /* Toggle various debugging states */
  64     attribute boolean visualDebugging;
  65     attribute boolean visualEventDebugging;
  66     attribute boolean paintFlashing;
  67     attribute boolean paintDumping;
  68     attribute boolean invalidateDumping;
  69     attribute boolean eventDumping;
  70     attribute boolean motionEventDumping;
  71     attribute boolean crossingEventDumping;
  72     attribute boolean reflowCounts;
  73
  74     /* Run various tests. */
  75     void dumpWebShells();
  76     void dumpContent();
  77     void dumpFrames();
  78     void dumpViews();
  79
  80     void dumpStyleSheets();
  81     void dumpStyleContexts();
  82
  83     void dumpReflowStats();
  84 };