Back to index

lightning-sunbird  0.9+nobinonly
nsISelectionDisplay.idl
Go to the documentation of this file.
00001 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
00002  *
00003  * ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is the Mozilla browser.
00017  *
00018  * The Initial Developer of the Original Code is
00019  * Netscape Communications, Inc.
00020  * Portions created by the Initial Developer are Copyright (C) 1999
00021  * the Initial Developer. All Rights Reserved.
00022  *
00023  * Contributor(s):
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #include "nsISupports.idl"
00040 
00041 [scriptable, uuid(0DDF9E1C-1DD2-11B2-A183-908A08AA75AE)]
00042 interface nsISelectionDisplay : nsISupports
00043 {
00044    const short DISPLAY_TEXT = 1;   //display text selected.
00045    const short DISPLAY_IMAGES = 2; //show images selected
00046    const short DISPLAY_FRAMES = 4; //display hrules ect.
00047    const short DISPLAY_ALL = 7; //display all. used for isEditor as well
00048 
00049    /*
00050    SetSelectionFlags used to set whether you want to see HRULES/IMAGES with border.
00051     also used to tell if the presshell is an editor right now. this should change
00052     
00053     @param aToggle -either DISPLAY_(TEXT,IMAGES,FRAMES,ALL)
00054                     This will tell the rendering engine to draw the different
00055                     selection types. 
00056 
00057     @return NS_OK if successful.
00058    */
00059     void setSelectionFlags(in short toggle);
00060 
00061    /*
00062    GetSelectionFlags used to get whether you want to see HRULES/IMAGES with border.
00063     also used to tell if the presshell is an editor right now. this should change
00064    
00065     @param short *aReturn - This will be filled with DISPLAY_(TEXT,IMAGE,FRAMES,ALL) 
00066                             bit flags.
00067     @return NS_OK if successful.
00068    */
00069     short getSelectionFlags();
00070 
00071 };