Back to index

lightning-sunbird  0.9+nobinonly
nsIDOMHTMLCanvasElement.idl
Go to the documentation of this file.
00001 /* -*- Mode: IDL; 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  *   Vladimir Vukicevic <vladimir@pobox.com>
00019  * Portions created by the Initial Developer are Copyright (C) 2005
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 
00038 #include "nsIDOMHTMLElement.idl"
00039 
00050 [scriptable, uuid(0583A2EA-AB19-40e1-8BE4-5E9B2F275560)]
00051 interface nsIDOMHTMLCanvasElement : nsIDOMHTMLElement
00052 {
00053   attribute long width;
00054   attribute long height;
00055 
00056   nsISupports getContext(in DOMString contextId);
00057 
00058   // This version will query the JS context for its arguments; C++
00059   // callers should use toDataURLAs.
00060   //
00061   // Valid calls are:
00062   //  toDataURL();              -- defaults to image/png
00063   //  toDataURL(type);          -- uses given type
00064   //  toDataURL(type, params);  -- only available to trusted callers
00065   DOMString toDataURL();
00066 
00067   // This version lets you specify different image types and pass parameters
00068   // to the encoder. For example toDataURLAs("image/png", "transparency=none")
00069   // gives you a PNG with the alpha channel discarded. See the encoder for
00070   // the options string that it supports. Separate multiple options with
00071   // semicolons.
00072   [noscript] DOMString toDataURLAs(in DOMString mimeType, in DOMString encoderOptions);
00073 };
00074