Back to index

lightning-sunbird  0.9+nobinonly
nsISelectionPrivate.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 #include "nsISelectionListener.idl"
00040 #include "nsIEnumerator.idl"
00041 
00042 interface nsIFrameSelection;
00043 interface nsIDOMRange;
00044 interface nsISelectionListener;
00045 
00046 %{C++
00047 class nsIFrame;
00048 class nsIPresShell;
00049 struct nsPoint;
00050 %}
00051 
00052 [ptr] native nsIFrame(nsIFrame);
00053 [ptr] native nsIPresShell(nsIPresShell);
00054 [ref] native nsPointRef(nsPoint);
00055 
00056 [scriptable, uuid(3225CA54-D7E1-4FF5-8EE9-091B0BFCDA1F)]
00057 interface nsISelectionPrivate : nsISupports
00058  {
00059     const short ENDOFPRECEDINGLINE=0;
00060     const short STARTOFNEXTLINE=1;
00061     
00062     attribute boolean interlinePosition;
00063 
00064     /* startBatchChanges
00065        match this up with endbatchChanges. will stop ui updates while multiple selection methods are called
00066     */
00067     void  startBatchChanges();
00068     
00069     /* endBatchChanges
00070        match this up with startBatchChanges
00071     */
00072     void  endBatchChanges();
00073               
00074     nsIEnumerator  getEnumerator();
00075     wstring  toStringWithFormat(in string formatType, in unsigned long flags, in PRInt32 wrapColumn);
00076     void  addSelectionListener(in nsISelectionListener newListener);
00077     void  removeSelectionListener(in nsISelectionListener listenerToRemove);
00078 
00079     /* Table selection stuff
00080        We should probably move this and table-related 
00081        items in nsIFrameSelection  to a 
00082        new nsITableSelection interface
00083     */
00084     const long TABLESELECTION_NONE     = 0; 
00085     const long TABLESELECTION_CELL     = 1; 
00086     const long TABLESELECTION_ROW      = 2; 
00087     const long TABLESELECTION_COLUMN   = 3; 
00088     const long TABLESELECTION_TABLE    = 4; 
00089     const long TABLESELECTION_ALLCELLS = 5;
00090 
00095     long getTableSelectionType(in nsIDOMRange range);
00096     
00097     /* Internal utility method to set the pres shell on a newly created selection */
00098     [noscript] void setPresShell(in nsIPresShell aPresShell);
00099 
00100     /* canCacheFrameOffset
00101      * Frame Offset cache can be used just during calling nsEditor::EndPlaceHolderTransaction.
00102      * EndPlaceHolderTransaction will give rise to reflow/refreshing view/scroll, and call times
00103      * of nsTextFrame::GetPointFromOffset whose return value is to be cached.
00104      * see bugs 35296 and 199412
00105      */
00106     [noscript] attribute boolean canCacheFrameOffset;
00107 
00108     /* GetCachedOffsetForFrame
00109      * Returns cached value for nsTextFrame::GetPointFromOffset.
00110      */
00111     [noscript] void getCachedFrameOffset(in nsIFrame aFrame, in PRInt32 inOffset, in nsPointRef aPoint);
00112 
00113     /* getFrameSelection
00114      * Returnes a reference to the frame selection associated with this selection 
00115      */
00116     [noscript] nsIFrameSelection getFrameSelection();
00117 };
00118