gecko-dev/editor/idl/nsIHTMLAbsPosEditor.idl

166 lines
5.5 KiB
Plaintext
Raw Normal View History

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** 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.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corp.
* Portions created by the Initial Developer are Copyright (C) 2003
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Daniel Glazman (glazman@netscape.com) (Original author)
*
* Alternatively, the contents of this file may be used under the terms of
* either 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 "domstubs.idl"
[scriptable, uuid(91375f52-20e6-4757-9835-eb04fabe5498)]
interface nsIHTMLAbsPosEditor : nsISupports
{
/**
* true if the selection container is absolutely positioned
*/
readonly attribute boolean selectionContainerAbsolutelyPositioned;
/**
* this contains the absolutely positioned element currently edited
* or null
*/
readonly attribute nsIDOMElement positionedElement;
/**
* true if Absolute Positioning handling is enabled in the editor
*/
attribute boolean absolutePositioningEnabled;
/* Utility methods */
/**
* true if Snap To Grid is enabled in the editor.
*/
attribute boolean snapToGridEnabled;
/**
* sets the grid size in pixels.
* @param aSizeInPixels [IN] the size of the grid in pixels
*/
attribute unsigned long gridSize;
/* Selection-based methods */
/**
* returns the deepest absolutely positioned container of the selection
* if it exists or null.
*/
readonly attribute nsIDOMElement absolutelyPositionedSelectionContainer;
/**
* extracts the selection from the normal flow of the document and
* positions it.
* @param aEnabled [IN] true to absolutely position the selection,
* false to put it back in the normal flow
*/
void absolutePositionSelection(in boolean aEnabled);
/**
* adds aChange to the z-index of the currently positioned element.
* @param aChange [IN] relative change to apply to current z-index
*/
void relativeChangeZIndex(in long aChange);
/* Element-based methods */
/**
* extracts an element from the normal flow of the document and
* positions it, and puts it back in the normal flow.
* @param aElement [IN] the element
* @param aEnabled [IN] true to absolutely position the element,
* false to put it back in the normal flow
*/
void absolutelyPositionElement(in nsIDOMElement aElement,
in boolean aEnabled);
/**
* sets the position of an element; warning it does NOT check if the
* element is already positioned or not and that's on purpose.
* @param aElement [IN] the element
* @param aX [IN] the x position in pixels.
* @param aY [IN] the y position in pixels.
*/
void setElementPosition(in nsIDOMElement aElement, in long aX, in long aY);
/**
* returns the absolute z-index of a positioned element. Never returns 'auto'.
* @return the z-index of the element
* @param aElement [IN] the element.
*/
long getElementZIndex(in nsIDOMElement aElement);
/**
* sets the z-index of an element.
* @param aElement [IN] the element
* @param aZorder [IN] the z-index
*/
void setElementZIndex(in nsIDOMElement aElement, in long aZorder);
/**
* adds aChange to the z-index of an arbitrary element.
* @return the new z-index of the element
* @param aElement [IN] the element
* @param aChange [IN] relative change to apply to current z-index of
* the element
*/
long relativeChangeElementZIndex(in nsIDOMElement aElement, in long aChange);
/* Other */
/**
* shows a grabber attached to an arbitrary element. The grabber is an image
* positioned on the left hand side of the top border of the element. Dragging
* and dropping it allows to change the element's absolute position in the
* document. See chrome://editor/content/images/grabber.gif
* @param aElement [IN] the element
*/
void showGrabberOnElement(in nsIDOMElement aElement);
/**
* hide the grabber if it shown.
*/
void hideGrabber();
/**
* refreshes the grabber if it shown, possibly updating its position or
* even hiding it.
*/
void refreshGrabber();
};