editor/idl/nsIHTMLObjectResizer.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Mozilla.org.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corp.
  19  * Portions created by the Initial Developer are Copyright (C) 2003
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Daniel Glazman (glazman@netscape.com) (Original author)
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40 #include "domstubs.idl"
  41
  42 interface nsIHTMLObjectResizeListener;
  43
  44 [scriptable, uuid(8b396020-69d3-451f-80c1-1a96a7da25a9)]
  45
  46 interface nsIHTMLObjectResizer : nsISupports
  47 {
  48 %{C++
  49   typedef short EResizerLocation;
  50 %}
  51   const short eTopLeft = 0;
  52   const short eTop = 1;
  53   const short eTopRight = 2;
  54   const short eLeft = 3;
  55   const short eRight = 4;
  56   const short eBottomLeft = 5;
  57   const short eBottom = 6;
  58   const short eBottomRight = 7;
  59
  60   /**
  61    * the element currently displaying resizers
  62    */
  63   readonly attribute nsIDOMElement resizedObject;
  64
  65   /**
  66    * a boolean indicating if object resizing is enabled in the editor
  67    */
  68   attribute boolean objectResizingEnabled;
  69
  70   /**
  71    * Shows active resizers around an element's frame
  72    * @param aResizedElement [IN] a DOM Element
  73    */
  74   void showResizers(in nsIDOMElement aResizedElement);
  75
  76   /**
  77    * Hide resizers if they are visible
  78    */
  79   void hideResizers();
  80
  81   /**
  82    * Refresh visible resizers
  83    */
  84   void refreshResizers();
  85
  86   /**
  87    * event callback when a mouse button is pressed
  88    * @param aX      [IN] horizontal position of the pointer
  89    * @param aY      [IN] vertical position of the pointer
  90    * @param aTarget [IN] the element triggering the event
  91    * @param aMouseEvent [IN] the event
  92    */
  93   void mouseDown(in long aX, in long aY,
  94                  in nsIDOMElement aTarget, in nsIDOMEvent aMouseEvent);
  95
  96   /**
  97    * event callback when a mouse button is released
  98    * @param aX      [IN] horizontal position of the pointer
  99    * @param aY      [IN] vertical position of the pointer
 100    * @param aTarget [IN] the element triggering the event
 101    */
 102   void mouseUp(in long aX, in long aY,
 103                in nsIDOMElement aTarget);
 104
 105   /**
 106    * event callback when the mouse pointer is moved
 107    * @param aMouseEvent [IN] the event
 108    */
 109   void mouseMove(in nsIDOMEvent aMouseEvent);
 110
 111   /* Event Listeners */
 112
 113   /**
 114    * Creates a resize listener that can be used to get notifications
 115    * that the user started to resize an object or finalized such an operation
 116    * @param aListener [IN] an instance of nsIHTMLObjectResizeListener
 117    */
 118   void addObjectResizeEventListener(in nsIHTMLObjectResizeListener aListener);
 119
 120   /**
 121    * Deletes a resize listener
 122    * @param aListener [IN] an instance of nsIHTMLObjectResizeListener
 123    */
 124   void removeObjectResizeEventListener(in nsIHTMLObjectResizeListener aListener);
 125 };
 126