docshell/base/nsIMarkupDocumentViewer.idl

   1 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   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 the Mozilla browser.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Netscape Communications, Inc.
  20  * Portions created by the Initial Developer are Copyright (C) 1999
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Travis Bogard <travis@netscape.com>
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either of the GNU General Public License Version 2 or later (the "GPL"),
  28  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 /**
  41  * The nsIContentViewerEdit
  42  */
  43
  44 /**
  45  * The nsIMarkupDocumentViewer
  46  * This interface describes the properties of a content viewer
  47  * for a markup document - HTML or XML
  48  */
  49
  50 #include "nsISupports.idl"
  51
  52 interface nsIDOMNode;
  53
  54
  55 [scriptable, uuid(40b2282a-a882-4483-a634-dec468d88377)]
  56 interface nsIMarkupDocumentViewer : nsISupports
  57 {
  58
  59         /*
  60         Scrolls to a given DOM content node.
  61         */
  62         void scrollToNode(in nsIDOMNode node);
  63
  64         /** The amount by which to scale all text. Default is 1.0. */
  65         attribute float textZoom;
  66
  67         /** The amount by which to scale all lengths. Default is 1.0. */
  68         attribute float fullZoom;
  69
  70         /** Disable entire author style level (including HTML presentation hints) */
  71         attribute boolean authorStyleDisabled;
  72
  73         /*
  74         XXX Comment here!
  75         */
  76         attribute ACString defaultCharacterSet;
  77
  78         /*
  79         XXX Comment here!
  80         */
  81         attribute ACString forceCharacterSet;
  82
  83         /*
  84         XXX Comment here!
  85         */
  86         attribute ACString hintCharacterSet;
  87
  88         /*
  89         XXX Comment here!
  90         */
  91         attribute PRInt32 hintCharacterSetSource;
  92
  93         /*
  94         character set from prev document
  95         */
  96         attribute ACString prevDocCharacterSet;
  97
  98         //void GetCharacterSetHint(in wstring hintCharset, in PRInt32 charsetSource);
  99
 100         /**
 101         * Tell the container to shrink-to-fit or grow-to-fit its contents
 102         */
 103         void sizeToContent();
 104
 105   /**
 106    * Options for Bidi presentation.
 107    *
 108    * Use these attributes to access the individual Bidi options.
 109    */
 110
 111   /**
 112    * bidiTextDirection: the default direction for the layout of bidirectional text.
 113    *                    1 - left to right
 114    *                    2 - right to left
 115    */
 116   attribute octet bidiTextDirection;
 117
 118   /**
 119    * bidiTextType: the ordering of bidirectional text. This may be either "logical"
 120    * or "visual". Logical text will be reordered for presentation using the Unicode
 121    * Bidi Algorithm. Visual text will be displayed without reordering.
 122    *               1 - the default order for the charset
 123    *               2 - logical order
 124    *               3 - visual order
 125    */
 126   attribute octet bidiTextType;
 127
 128   /**
 129    * bidiControlsTextMode: the order of bidirectional text in form controls.
 130    *                       1 - logical
 131    *                       2 - visual
 132    *                       3 - like the containing document
 133    */
 134   attribute octet bidiControlsTextMode;
 135
 136   /**
 137    * bidiNumeral: the type of numerals to display.
 138    *              1 - depending on context, default is Arabic numerals
 139    *              2 - depending on context, default is Hindi numerals
 140    *              3 - Arabic numerals
 141    *              4 - Hindi numerals
 142    */
 143   attribute octet bidiNumeral;
 144
 145   /**
 146    * bidiSupport: whether to use platform bidi support or Mozilla's bidi support
 147    *              1 - Use Mozilla's bidi support
 148    *              2 - Use the platform bidi support
 149    *              3 - Disable bidi support
 150    */
 151   attribute octet bidiSupport;
 152
 153   /**
 154    * bidiCharacterSet: whether to force the user's character set
 155    *                   1 - use the document character set
 156    *                   2 - use the character set chosen by the user
 157    */
 158   attribute octet bidiCharacterSet;
 159
 160   /**
 161    * Use this attribute to access all the Bidi options in one operation
 162    */
 163   attribute PRUint32 bidiOptions;
 164 };