editor/nsIHTMLEditor.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "nsISupports.idl"
   7 #include "domstubs.idl"
   8
   9 interface nsIContent;
  10
  11 webidl Document;
  12 webidl Element;
  13 webidl Node;
  14 webidl Selection;
  15
  16 [scriptable, builtinclass, uuid(87ee993e-985f-4a43-a974-0d9512da2fb0)]
  17 interface nsIHTMLEditor : nsISupports
  18 {
  19 %{C++
  20   typedef short EAlignment;
  21 %}
  22
  23   // used by GetAlignment()
  24   const short eLeft = 0;
  25   const short eCenter = 1;
  26   const short eRight = 2;
  27   const short eJustify = 3;
  28
  29
  30   /* ------------ Inline property methods -------------- */
  31
  32   /**
  33    * SetInlineProperty() sets the aggregate properties on the current selection
  34    *
  35    * @param aProperty   the property to set on the selection
  36    * @param aAttribute  the attribute of the property, if applicable.
  37    *                    May be null.
  38    *                    Example: aProperty="font", aAttribute="color"
  39    * @param aValue      if aAttribute is not null, the value of the attribute.
  40    *                    May be null.
  41    *                    Example: aProperty="font", aAttribute="color",
  42    *                             aValue="0x00FFFF"
  43    */
  44   [can_run_script]
  45   void setInlineProperty(in AString aProperty,
  46                          in AString aAttribute,
  47                          in AString aValue);
  48
  49   /**
  50    * getInlineProperty() gets aggregate properties of the current selection.
  51    * All object in the current selection are scanned and their attributes are
  52    * represented in a list of Property object.
  53    *
  54    * @param aProperty   the property to get on the selection
  55    * @param aAttribute  the attribute of the property, if applicable.
  56    *                    May be null.
  57    *                    Example: aProperty="font", aAttribute="color"
  58    * @param aValue      if aAttribute is not null, the value of the attribute.
  59    *                    May be null.
  60    *                    Example: aProperty="font", aAttribute="color",
  61    *                             aValue="0x00FFFF"
  62    * @param aFirst      [OUT] PR_TRUE if the first text node in the
  63    *                          selection has the property
  64    * @param aAny        [OUT] PR_TRUE if any of the text nodes in the
  65    *                          selection have the property
  66    * @param aAll        [OUT] PR_TRUE if all of the text nodes in the
  67    *                          selection have the property
  68    */
  69   [can_run_script]
  70   void getInlineProperty(in AString aProperty,
  71                          in AString aAttribute,
  72                          in AString aValue,
  73                          out boolean aFirst,
  74                          out boolean aAny,
  75                          out boolean aAll);
  76
  77   [can_run_script]
  78   AString getInlinePropertyWithAttrValue(in AString aProperty,
  79                                          in AString aAttribute,
  80                                          in AString aValue,
  81                                          out boolean aFirst,
  82                                          out boolean aAny,
  83                                          out boolean aAll);
  84
  85   /**
  86    * removeInlineProperty() removes a property which changes inline style of
  87    * text.  E.g., bold, italic, super and sub.
  88    *
  89    * @param aProperty   Tag name whcih represents the inline style you want to
  90    *                    remove.  E.g., "strong", "b", etc.
  91    *                    If "href", <a> element which has href attribute will be
  92    *                    removed.
  93    *                    If "name", <a> element which has non-empty name
  94    *                    attribute will be removed.
  95    * @param aAttribute  If aProperty is "font", aAttribute should be "face",
  96    *                    "size", "color" or "bgcolor".
  97    */
  98   [can_run_script]
  99   void removeInlineProperty(in AString aProperty, in AString aAttribute);
 100
 101   /* ------------ HTML content methods -------------- */
 102
 103   /**
 104    * Tests if a node is a BLOCK element according the the HTML 4.0 DTD.
 105    *   This does NOT consider CSS effect on display type
 106    *
 107    * @param aNode      the node to test
 108    */
 109   boolean nodeIsBlock(in Node node);
 110
 111   /**
 112    * Insert some HTML source at the current location
 113    *
 114    * @param aInputString   the string to be inserted
 115    */
 116   [can_run_script]
 117   void insertHTML(in AString aInputString);
 118
 119
 120   /**
 121     * Paste the text in the OS clipboard at the cursor position, replacing
 122     * the selected text (if any), but strip out any HTML styles and formatting
 123     */
 124   [can_run_script]
 125   void pasteNoFormatting(in long aSelectionType);
 126
 127   /**
 128    *  Rebuild the entire document from source HTML
 129    *  Needed to be able to edit HEAD and other outside-of-BODY content
 130    *
 131    *  @param aSourceString   HTML source string of the entire new document
 132    */
 133   [can_run_script]
 134   void rebuildDocumentFromSource(in AString aSourceString);
 135
 136   /**
 137     * Insert an element, which may have child nodes, at the selection
 138     * Used primarily to insert a new element for various insert element dialogs,
 139     *   but it enforces the HTML 4.0 DTD "CanContain" rules, so it should
 140     *   be useful for other elements.
 141     *
 142     * @param aElement           The element to insert
 143     * @param aDeleteSelection   Delete the selection before inserting
 144     *     If aDeleteSelection is PR_FALSE, then the element is inserted
 145     *     after the end of the selection for all element except
 146     *     Named Anchors, which insert before the selection
 147     */
 148   [can_run_script]
 149   void insertElementAtSelection(in Element aElement,
 150                                 in boolean aDeleteSelection);
 151
 152   /**
 153    *   Set the BaseURL for the document to the current URL
 154    *     but only if the page doesn't have a <base> tag
 155    *   This should be done after the document URL has changed,
 156    *     such as after saving a file
 157    *   This is used as base for relativizing link and image urls
 158    */
 159   void updateBaseURL();
 160
 161
 162   /* ------------ Selection manipulation -------------- */
 163   /* Should these be moved to Selection? */
 164
 165   /**
 166     * Set the selection at the suppled element
 167     *
 168     * @param aElement   An element in the document
 169     */
 170   [can_run_script]
 171   void selectElement(in Element aElement);
 172
 173   /**
 174     * Create a collapsed selection just after aElement
 175     *
 176     * XXX could we parameterize SelectElement(before/select/after>?
 177     *
 178     * The selection is set to parent-of-aElement with an
 179     *   offset 1 greater than aElement's offset
 180     *   but it enforces the HTML 4.0 DTD "CanContain" rules, so it should
 181     *   be useful for other elements.
 182     *
 183     * @param aElement  An element in the document
 184     */
 185   void setCaretAfterElement(in Element aElement);
 186
 187   /**
 188    * getParagraphState returns what block tag paragraph format is in
 189    * the selection.
 190    * @param aMixed     True if there is more than one format
 191    * @return           Name of block tag. "" is returned for none.
 192    */
 193   AString getParagraphState(out boolean aMixed);
 194
 195   /**
 196    * getFontFaceState returns what font face is in the selection.
 197    * @param aMixed    True if there is more than one font face
 198    * @return          Name of face.  Note: "tt" is returned for
 199    *                  tt tag.  "" is returned for none.
 200    */
 201   [can_run_script]
 202   AString getFontFaceState(out boolean aMixed);
 203
 204   /**
 205    * getHighlightColorState returns what the highlight color of the selection.
 206    * @param aMixed     True if there is more than one font color
 207    * @return           Color string. "" is returned for none.
 208    */
 209   [can_run_script]
 210   AString getHighlightColorState(out boolean aMixed);
 211
 212   /**
 213    * getListState returns what list type is in the selection.
 214    * @param aMixed    True if there is more than one type of list, or
 215    *                  if there is some list and non-list
 216    * @param aOL       The company that employs me.  No, really, it's
 217    *                  true if an "ol" list is selected.
 218    * @param aUL       true if an "ul" list is selected.
 219    * @param aDL       true if a "dl" list is selected.
 220    */
 221   void getListState(out boolean aMixed, out boolean aOL, out boolean aUL,
 222                     out boolean aDL);
 223
 224   /**
 225    * getListItemState returns what list item type is in the selection.
 226    * @param aMixed    True if there is more than one type of list item, or
 227    *                  if there is some list and non-list
 228    *                  XXX This ignores `<li>` element selected state.
 229    *                      For example, even if `<li>` and `<dt>` are selected,
 230    *                      this is set to false.
 231    * @param aLI       true if "li" list items are selected.
 232    * @param aDT       true if "dt" list items are selected.
 233    * @param aDD       true if "dd" list items are selected.
 234    */
 235   void getListItemState(out boolean aMixed, out boolean aLI,
 236                         out boolean aDT, out boolean aDD);
 237
 238   /**
 239    * getAlignment     returns what alignment is in the selection.
 240    * @param aMixed    Always returns false.
 241    * @param aAlign    enum value for first encountered alignment
 242    *                  (left/center/right)
 243    */
 244   [can_run_script]
 245   void getAlignment(out boolean aMixed, out short aAlign);
 246
 247   /**
 248    * Document me!
 249    *
 250    */
 251   [can_run_script]
 252   void makeOrChangeList(in AString aListType, in boolean entireList,
 253                         in AString aBulletType);
 254
 255   /**
 256    * removeList removes list items (<li>, <dd>, and <dt>) and list structures
 257    * (<ul>, <ol>, and <dl>).
 258    *
 259    * @param aListType  Unused.
 260    */
 261   [can_run_script]
 262   void removeList(in AString aListType);
 263
 264   /**
 265    * GetElementOrParentByTagName() returns an inclusive ancestor element whose
 266    * name matches aTagName from aNode or anchor node of Selection to <body>
 267    * element or null if there is no element matching with aTagName.
 268    *
 269    * @param aTagName        The tag name which you want to look for.
 270    *                        Must not be empty string.
 271    *                        If "list", the result may be <ul>, <ol> or <dl>
 272    *                        element.
 273    *                        If "td", the result may be <td> or <th>.
 274    *                        If "href", the result may be <a> element
 275    *                        which has "href" attribute with non-empty value.
 276    *                        If "anchor", the result may be <a> which has
 277    *                        "name" attribute with non-empty value.
 278    * @param aNode           If non-null, this starts to look for the result
 279    *                        from it.  Otherwise, i.e., null, starts from
 280    *                        anchor node of Selection.
 281    * @return                If an element which matches aTagName, returns
 282    *                        an Element.  Otherwise, nullptr.
 283    */
 284   Element getElementOrParentByTagName(in AString aTagName,
 285                                       in Node aNode);
 286
 287   /**
 288    * getSelectedElement() returns a "selected" element node.  "selected" means:
 289    * - there is only one selection range
 290    * - the range starts from an element node or in an element
 291    * - the range ends at immediately after same element
 292    * - and the range does not include any other element nodes.
 293    * Additionally, only when aTagName is "href", this thinks that an <a>
 294    * element which has non-empty "href" attribute includes the range, the
 295    * <a> element is selected.
 296    *
 297    * @param aTagName    Case-insensitive element name.
 298    *                    If empty string, this returns any element node or null.
 299    *                    If "href", this returns an <a> element which has
 300    *                    non-empty "href" attribute or null.
 301    *                    If "anchor", this returns an <a> element which has
 302    *                    non-empty "name" attribute or null.
 303    *                    Otherwise, returns an element node whose name is
 304    *                    same as aTagName or null.
 305    * @return            A "selected" element.
 306    */
 307   nsISupports getSelectedElement(in AString aTagName);
 308
 309   /**
 310    * Return a new element with default attribute values
 311    *
 312    * This does not rely on the selection, and is not sensitive to context.
 313    *
 314    * Used primarily to supply new element for various insert element dialogs
 315    *  (Image, Link, NamedAnchor, Table, and HorizontalRule
 316    *   are the only returned elements as of 7/25/99)
 317    *
 318    * @param aTagName  The HTML tagname
 319    *    Special input values for Links and Named anchors:
 320    *    Use "href" to get a link node
 321    *      (an "A" tag with the "href" attribute set)
 322    *    Use "anchor" or "namedanchor" to get a named anchor node
 323    *      (an "A" tag with the "name" attribute set)
 324    * @return          The new element created.
 325    */
 326   [can_run_script]
 327   Element createElementWithDefaults(in AString aTagName);
 328
 329   /**
 330    * Insert an link element as the parent of the current selection
 331    *
 332    * @param aElement   An "A" element with a non-empty "href" attribute
 333    */
 334   [can_run_script]
 335   void insertLinkAroundSelection(in Element aAnchorElement);
 336
 337   /**
 338    * Set the value of the "bgcolor" attribute on the document's <body> element
 339    *
 340    * @param aColor  The HTML color string, such as "#ffccff" or "yellow"
 341    */
 342   [can_run_script]
 343   void setBackgroundColor(in AString aColor);
 344
 345   /**
 346    * A boolean which is true is the HTMLEditor has been instantiated
 347    * with CSS knowledge and if the CSS pref is currently checked
 348    *
 349    * @return    true if CSS handled and enabled
 350    */
 351   [setter_can_run_script] attribute boolean isCSSEnabled;
 352
 353   /**
 354    * checkSelectionStateForAnonymousButtons() may refresh editing UI such as
 355    * resizers, inline-table-editing UI, absolute positioning UI for current
 356    * Selection and focus state.  When this method shows or hides UI, the
 357    * editor (and/or its document/window) could be broken by mutation observers.
 358    * FYI: Current user in script is only BlueGriffon.
 359    */
 360   [can_run_script]
 361   void checkSelectionStateForAnonymousButtons();
 362
 363   boolean isAnonymousElement(in Element aElement);
 364
 365   /**
 366    * A boolean indicating if a return key pressed in a paragraph creates
 367    * another paragraph or just inserts a <br> at the caret
 368    *
 369    * @return    true if CR in a paragraph creates a new paragraph
 370    */
 371   attribute boolean returnInParagraphCreatesNewParagraph;
 372 };
 373