Public Types | Public Member Functions | Public Attributes

nsIHTMLObjectResizer Interface Reference

import "nsIHTMLObjectResizer.idl";

Collaboration diagram for nsIHTMLObjectResizer:

List of all members.

Public Types

typedef short EResizerLocation

Public Member Functions

void showResizers (in nsIDOMElement aResizedElement)
 Shows active resizers around an element's frame.
void hideResizers ()
 Hide resizers if they are visible.
void refreshResizers ()
 Refresh visible resizers.
void mouseDown (in long aX, in long aY, in nsIDOMElement aTarget, in nsIDOMEvent aMouseEvent)
 event callback when a mouse button is pressed
void mouseUp (in long aX, in long aY, in nsIDOMElement aTarget)
 event callback when a mouse button is released
void mouseMove (in nsIDOMEvent aMouseEvent)
 event callback when the mouse pointer is moved
void addObjectResizeEventListener (in nsIHTMLObjectResizeListener aListener)
 Creates a resize listener that can be used to get notifications that the user started to resize an object or finalized such an operation.
void removeObjectResizeEventListener (in nsIHTMLObjectResizeListener aListener)
 Deletes a resize listener.

Public Attributes

const short eTopLeft = 0
const short eTop = 1
const short eTopRight = 2
const short eLeft = 3
const short eRight = 4
const short eBottomLeft = 5
const short eBottom = 6
const short eBottomRight = 7
readonly attribute nsIDOMElement resizedObject
 the element currently displaying resizers
attribute boolean objectResizingEnabled
 a boolean indicating if object resizing is enabled in the editor

Member Typedef Documentation


Member Function Documentation

void nsIHTMLObjectResizer::addObjectResizeEventListener ( in nsIHTMLObjectResizeListener  aListener  ) 

Creates a resize listener that can be used to get notifications that the user started to resize an object or finalized such an operation.

Parameters:
aListener [IN] an instance of nsIHTMLObjectResizeListener
void nsIHTMLObjectResizer::hideResizers (  ) 

Hide resizers if they are visible.

void nsIHTMLObjectResizer::mouseDown ( in long  aX,
in long  aY,
in nsIDOMElement  aTarget,
in nsIDOMEvent  aMouseEvent 
)

event callback when a mouse button is pressed

Parameters:
aX [IN] horizontal position of the pointer
aY [IN] vertical position of the pointer
aTarget [IN] the element triggering the event
aMouseEvent [IN] the event
void nsIHTMLObjectResizer::mouseMove ( in nsIDOMEvent  aMouseEvent  ) 

event callback when the mouse pointer is moved

Parameters:
aMouseEvent [IN] the event
void nsIHTMLObjectResizer::mouseUp ( in long  aX,
in long  aY,
in nsIDOMElement  aTarget 
)

event callback when a mouse button is released

Parameters:
aX [IN] horizontal position of the pointer
aY [IN] vertical position of the pointer
aTarget [IN] the element triggering the event
void nsIHTMLObjectResizer::refreshResizers (  ) 

Refresh visible resizers.

void nsIHTMLObjectResizer::removeObjectResizeEventListener ( in nsIHTMLObjectResizeListener  aListener  ) 

Deletes a resize listener.

Parameters:
aListener [IN] an instance of nsIHTMLObjectResizeListener
void nsIHTMLObjectResizer::showResizers ( in nsIDOMElement  aResizedElement  ) 

Shows active resizers around an element's frame.

Parameters:
aResizedElement [IN] a DOM Element

Member Data Documentation

const short nsIHTMLObjectResizer::eLeft = 3
const short nsIHTMLObjectResizer::eTop = 1

a boolean indicating if object resizing is enabled in the editor

the element currently displaying resizers


The documentation for this interface was generated from the following file: