firefox-dev 11.0+build1-0ubuntu4 / usr / share / idl / firefox / nsISelectionPrivate.idl

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is mozilla.org code.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 1998
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either of the GNU General Public License Version 2 or later (the "GPL"),
 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"
#include "nsISelectionListener.idl"
#include "nsIEnumerator.idl"
#include "nsISelection.idl"

interface nsIDOMRange;
interface nsIDOMNode;
interface nsISelectionListener;
interface nsIContent;

%{C++
class nsFrameSelection;
class nsIFrame;
class nsIPresShell;
struct nsTextRangeStyle;
struct nsPoint;
#include "nsIFrame.h"
#include "nsCOMArray.h"
%}

[ptr] native nsFrameSelection(nsFrameSelection);
[ptr] native nsIFrame(nsIFrame);
[ptr] native nsIPresShell(nsIPresShell);
[ptr] native RangeArray(nsCOMArray<nsIDOMRange>);
[ref] native constTextRangeStyleRef(const nsTextRangeStyle);
[ref] native nsPointRef(nsPoint);
native nsDirection(nsDirection);

[scriptable, uuid(1820a940-6203-4e27-bc94-fa81131722a4)]
interface nsISelectionPrivate : nsISelection
 {
    const short ENDOFPRECEDINGLINE=0;
    const short STARTOFNEXTLINE=1;
    
    attribute boolean interlinePosition;

    /* startBatchChanges
       match this up with endbatchChanges. will stop ui updates while multiple selection methods are called
    */
    void  startBatchChanges();
    
    /* endBatchChanges
       match this up with startBatchChanges
    */
    void  endBatchChanges();
		
    nsIEnumerator  getEnumerator();
    wstring  toStringWithFormat(in string formatType, in unsigned long flags, in PRInt32 wrapColumn);
    void  addSelectionListener(in nsISelectionListener newListener);
    void  removeSelectionListener(in nsISelectionListener listenerToRemove);

    /* Table selection stuff
       We should probably move this and table-related 
       items in nsFrameSelection  to a
       new nsITableSelection interface
    */
    const long TABLESELECTION_NONE     = 0; 
    const long TABLESELECTION_CELL     = 1; 
    const long TABLESELECTION_ROW      = 2; 
    const long TABLESELECTION_COLUMN   = 3; 
    const long TABLESELECTION_TABLE    = 4; 
    const long TABLESELECTION_ALLCELLS = 5;

    /** Test if supplied range points to a single table element:
      *    Result is one of above constants. "None" means
      *    a table element isn't selected.
      */
    long getTableSelectionType(in nsIDOMRange range);
    
    /* Internal utility method to set the pres shell on a newly created selection */
    [noscript] void setPresShell(in nsIPresShell aPresShell);

    /* canCacheFrameOffset
     * Frame Offset cache can be used just during calling nsEditor::EndPlaceHolderTransaction.
     * EndPlaceHolderTransaction will give rise to reflow/refreshing view/scroll, and call times
     * of nsTextFrame::GetPointFromOffset whose return value is to be cached.
     * see bugs 35296 and 199412
     */
    [noscript] attribute boolean canCacheFrameOffset;

    /* GetCachedOffsetForFrame
     * Returns cached value for nsTextFrame::GetPointFromOffset.
     */
    [noscript] void getCachedFrameOffset(in nsIFrame aFrame, in PRInt32 inOffset, in nsPointRef aPoint);

    /* getFrameSelection
     * Returnes a reference to the frame selection associated with this selection 
     */
    [noscript] nsFrameSelection getFrameSelection();

    [noscript] void setAncestorLimiter(in nsIContent aContent);

    /**
     * Set the painting style for the range. The range must be a range in
     * the selection. The textRangeStyle will be used by text frame
     * when it is painting the selection.
     */
    [noscript] void setTextRangeStyle(in nsIDOMRange range,
                      in constTextRangeStyleRef textRangeStyle);

    /**
     * Get the direction of the selection.
     */
    [noscript, notxpcom] nsDirection getSelectionDirection();
    [noscript, notxpcom] void setSelectionDirection(in nsDirection aDirection);
    
    /**
     * Returns the type of the selection (see nsISelectionController for
     * available constants).
     */
    readonly attribute short type;

    /**
     * Return array of ranges intersecting with the given DOM interval.
     */
    void GetRangesForInterval(
        in nsIDOMNode beginNode, in PRInt32 beginOffset,
        in nsIDOMNode endNode, in PRInt32 endOffset,
        in boolean allowAdjacent,
        out PRUint32 resultCount,
        [retval, array, size_is(resultCount)] out nsIDOMRange results);

    [noscript] void GetRangesForIntervalCOMArray(
        in nsIDOMNode beginNode, in PRInt32 beginOffset,
        in nsIDOMNode endNode, in PRInt32 endOffset,
        in boolean allowAdjacent,
        in RangeArray results);

    /**
     * Scrolls a region of the selection, so that it is visible in
     * the scrolled view.
     *
     * @param aRegion - the region inside the selection to scroll into view
     *                  (see selection region constants defined in
     *                   nsISelectionController).
     * @param aIsSynchronous - when true, scrolls the selection into view
     *                         before returning. If false, posts a request which
     *                         is processed at some point after the method returns.
     * @param aVPercent - how to align the frame vertically. A value of 0
     *                   means the frame's upper edge is aligned with the top edge
     *                   of the visible area. A value of 100 means the frame's
     *                   bottom edge is aligned with the bottom edge of
     *                   the visible area. For values in between, the point
     *                   "aVPercent" down the frame is placed at the point
     *                   "aVPercent" down the visible area. A value of 50 centers
     *                   the frame vertically. A value of -1 means move
     *                   the frame the minimum amount necessary in order for
     *                   the entire frame to be visible vertically (if possible).
     * @param aHPercent - how to align the frame horizontally. A value of 0
     *                    means the frame's left edge is aligned with the left
     *                    edge of the visible area. A value of 100 means the
     *                    frame's right edge is aligned with the right edge of
     *                    the visible area. For values in between, the point
     *                    "aHPercent" across the frame is placed at the point
     *                    "aHPercent" across the visible area. A value of 50
     *                    centers the frame horizontally . A value of -1 means
     *                    move the frame the minimum amount necessary in order
     *                    for the entire frame to be visible horizontally
     *                    (if possible).
     */
    void scrollIntoView(in short aRegion, in boolean aIsSynchronous,
                        in short aVPercent, in short aHPercent);
};