content/base/public/nsISelection2.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Selection code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Google Inc.
  19  * Portions created by the Initial Developer are Copyright (C) 2006
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Brett Wilson <brettw@gmail.com>
  24  *   Alexander Surkov <surkov.alexander@gmail.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 #include "nsISelection.idl"
  41
  42 interface nsIDOMNode;
  43 interface nsIDOMRange;
  44
  45 %{C++
  46 #include "nsCOMArray.h"
  47 %}
  48
  49 [ptr] native RangeArray(nsCOMArray<nsIDOMRange>);
  50
  51 [scriptable, uuid(5d21d5fe-3691-4716-a334-4691eea54d29)]
  52 interface nsISelection2 : nsISelection
  53 {
  54   /**
  55    * Returns the type of the selection (see nsISelectionController for
  56    * available constants).
  57    */
  58   readonly attribute short type;
  59
  60   /**
  61    * Return array of ranges intersecting with the given DOM interval.
  62    */
  63   void GetRangesForInterval(
  64       in nsIDOMNode beginNode, in PRInt32 beginOffset,
  65       in nsIDOMNode endNode, in PRInt32 endOffset,
  66       in PRBool allowAdjacent,
  67       out PRUint32 resultCount,
  68       [retval, array, size_is(resultCount)] out nsIDOMRange results);
  69
  70   [noscript] void GetRangesForIntervalCOMArray(
  71       in nsIDOMNode beginNode, in PRInt32 beginOffset,
  72       in nsIDOMNode endNode, in PRInt32 endOffset,
  73       in PRBool allowAdjacent,
  74       in RangeArray results);
  75
  76   /**
  77    * Scrolls a region of the selection, so that it is visible in
  78    * the scrolled view.
  79    *
  80    * @param aRegion - the region inside the selection to scroll into view
  81    *                  (see selection region constants defined in
  82    *                   nsISelectionController).
  83    * @param aIsSynchronous - when true, scrolls the selection into view
  84    *                         before returning. If false, posts a request which
  85    *                         is processed at some point after the method returns.
  86    * @param aVPercent - how to align the frame vertically. A value of 0
  87    *                   means the frame's upper edge is aligned with the top edge
  88    *                   of the visible area. A value of 100 means the frame's
  89    *                   bottom edge is aligned with the bottom edge of
  90    *                   the visible area. For values in between, the point
  91    *                   "aVPercent" down the frame is placed at the point
  92    *                   "aVPercent" down the visible area. A value of 50 centers
  93    *                   the frame vertically. A value of -1 means move
  94    *                   the frame the minimum amount necessary in order for
  95    *                   the entire frame to be visible vertically (if possible).
  96    * @param aHPercent - how to align the frame horizontally. A value of 0
  97    *                    means the frame's left edge is aligned with the left
  98    *                    edge of the visible area. A value of 100 means the
  99    *                    frame's right edge is aligned with the right edge of
 100    *                    the visible area. For values in between, the point
 101    *                    "aHPercent" across the frame is placed at the point
 102    *                    "aHPercent" across the visible area. A value of 50
 103    *                    centers the frame horizontally . A value of -1 means
 104    *                    move the frame the minimum amount necessary in order
 105    *                    for the entire frame to be visible horizontally
 106    *                    (if possible).
 107    */
 108   void scrollIntoView(in short aRegion, in boolean aIsSynchronous,
 109                       in short aVPercent, in short aHPercent);
 110 };
 111