dom/base/nsISelectionDisplay.idl

   1 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "nsISupports.idl"
   8
   9 [scriptable, uuid(0DDF9E1C-1DD2-11B2-A183-908A08AA75AE)]
  10 interface nsISelectionDisplay : nsISupports
  11 {
  12    const short DISPLAY_TEXT = 1;   //display text selected.
  13    const short DISPLAY_IMAGES = 2; //show images selected
  14    const short DISPLAY_FRAMES = 4; //display hrules ect.
  15    const short DISPLAY_ALL = 7; //display all. used for isEditor as well
  16
  17    /*
  18    SetSelectionFlags used to set whether you want to see HRULES/IMAGES with border.
  19     also used to tell if the presshell is an editor right now. this should change
  20
  21     @param aToggle -either DISPLAY_(TEXT,IMAGES,FRAMES,ALL)
  22                     This will tell the rendering engine to draw the different
  23                     selection types.
  24
  25    */
  26     void setSelectionFlags(in short toggle);
  27
  28    /*
  29    GetSelectionFlags used to get whether you want to see HRULES/IMAGES with border.
  30     also used to tell if the presshell is an editor right now. this should change
  31
  32     @param short *aReturn - This will be filled with DISPLAY_(TEXT,IMAGE,FRAMES,ALL)
  33                             bit flags.
  34    */
  35     short getSelectionFlags();
  36
  37 };