Back to index

lightning-sunbird  0.9+nobinonly
nsISelection.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
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  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
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 "nsISupports.idl"
00039 
00040 /* THIS IS A PUBLIC INTERFACE */
00041 
00042 interface nsIDOMNode;
00043 interface nsIDOMRange;
00044 
00053 [scriptable, uuid(B2C7ED59-8634-4352-9E37-5484C8B6E4E1)]
00054 interface nsISelection : nsISupports
00055 {
00059     readonly attribute nsIDOMNode anchorNode;
00060 
00064     readonly attribute long anchorOffset;
00065 
00069     readonly attribute nsIDOMNode focusNode;
00070 
00074     readonly attribute long focusOffset;
00075 
00079     readonly attribute boolean isCollapsed;
00080 
00084     readonly attribute long rangeCount;
00085 
00089     nsIDOMRange getRangeAt(in long index);
00090 
00098     void collapse(in nsIDOMNode parentNode, in long offset);
00099 
00100 
00108     void extend(in nsIDOMNode parentNode, in long offset);
00109 
00115     void collapseToStart();
00116 
00122     void collapseToEnd();
00123 
00131     boolean containsNode(in nsIDOMNode node, in boolean entirelyContained);
00132 
00137     void selectAllChildren(in nsIDOMNode parentNode); 
00138 
00142     void addRange(in nsIDOMRange range);
00143  
00147     void removeRange(in nsIDOMRange range);
00148 
00152     void removeAllRanges();
00153 
00157     void deleteFromDocument();
00158 
00164     void selectionLanguageChange(in boolean langRTL);
00165 
00169     wstring toString();
00170 };