gecko/dom/interfaces/events/nsIDOMPaintRequest.idl
2009-09-04 16:49:18 +12:00

63 lines
2.6 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla 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/MPL/
*
* 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 code.
*
* The Initial Developer of the Original Code is
* Mozilla Corporation.
* Portions created by the Initial Developer are Copyright (C) 2009
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Robert O'Callahan <robert@ocallahan.org>
*
* Alternatively, the contents of this file may be used under the terms of
* either of 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 MPL, 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 MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "domstubs.idl"
interface nsIDOMClientRect;
/**
* These objects are exposed by the MozDOMAfterPaint event. Each one represents
* a request to repaint a rectangle that was generated by the browser.
*/
[scriptable, uuid(4802360b-f1c0-4d84-bb9e-9d2ccb9de461)]
interface nsIDOMPaintRequest : nsISupports
{
/**
* The client rect where invalidation was triggered.
*/
readonly attribute nsIDOMClientRect clientRect;
/**
* The reason for the request, as a string. If an empty string, then we don't know
* the reason (this is common). Reasons include "scroll repaint", meaning that we
* needed to repaint the rectangle due to scrolling, and "scroll copy", meaning
* that we updated the rectangle due to scrolling but instead of painting
* manually, we were able to do a copy from another area of the screen.
*/
readonly attribute DOMString reason;
};