Back to index

lightning-sunbird  0.9+nobinonly
nsIXTFVisual.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 the Mozilla XTF project.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Alex Fritze.
00019  * Portions created by the Initial Developer are Copyright (C) 2004
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Alex Fritze <alex@croczilla.com> (original author)
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #include "nsIXTFElement.idl"
00040 
00041 interface nsIDOMElement;
00042 
00043 [scriptable, uuid(2ee5520b-6593-43c1-b660-4885939a6b68)]
00044 interface nsIXTFVisual : nsIXTFElement
00045 {
00046   // The content tree rooted in 'visualContent' will be rendered where
00047   // the xtf visual is placed into an appropriate context. A visual
00048   // will be asked for its visual content once at most. The tree
00049   // cannot be dynamically replaced during the lifetime of the
00050   // element, it may however be dynamically manipulated (i.e. you can
00051   // insert/remove content, set attributes, etc., but *not* exchange
00052   // the root element for something else).
00053   readonly attribute nsIDOMElement visualContent;
00054 
00055   // Children of the xtf visual which are themselves 'visuals'
00056   // (i.e. built-ins elements, other xtf visuals or xbl elements with
00057   // visual <content>) will be rendered as if they were children of
00058   // 'insertionPoint'. 'insertionPoint' should either be null (in
00059   // which case the children will not be automatically rendered) or
00060   // point into the 'visualContent' tree.
00061   readonly attribute nsIDOMElement insertionPoint;
00062 
00063   // If 'true', document style sheets will apply to the visual
00064   // content. If 'false', only UA and user style sheets will be
00065   // applied.
00066   readonly attribute boolean applyDocumentStyleSheets;
00067   
00068   // Notification mask constants:
00069   // To receive a given event set the corresponding bit in
00070   // nsIXTFElementWrapper::notificationMask.
00071   const unsigned long NOTIFY_DID_LAYOUT  = 0x00020000;
00072 
00073   // Event notifications:
00074   void didLayout();
00075 };