WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsIEmbeddingSiteWindow

IID:3E5432CD-9568-4bd1-8CBE-D50ABA110743
Inherits From:nsISupports
Status:FROZEN

The nsIEmbeddingSiteWindow is implemented by the embedder to provide Gecko with the means to call up to the host to resize the window, hide or show it and set/get its title.

Constants

Flag indicates that position of the top left corner of the outer area is required/specified.

PRUint32 DIM_FLAGS_POSITION = 1
Flag indicates that the size of the inner area is required/specified.

PRUint32 DIM_FLAGS_SIZE_INNER = 2
Flag indicates that the size of the outer area is required/specified.

PRUint32 DIM_FLAGS_SIZE_OUTER = 4

Properties

readonly voidPtr* siteWindow

Native window for the site's window. The implementor should copy the native window object into the address supplied by the caller. The type of the native window that the address refers to is platform and OS specific as follows:

PRUnichar* title

Title of the window.

PRBool visibility

Visibility of the window.

Methods

void getDimensions ( PRUint32 flags , out PRInt32 x , out PRInt32 y , out PRInt32 cx , out PRInt32 cy ) void setDimensions ( PRUint32 flags , PRInt32 x , PRInt32 y , PRInt32 cx , PRInt32 cy ) void setFocus ( )

void getDimensions ( PRUint32 flags , out PRInt32 x , out PRInt32 y , out PRInt32 cx , out PRInt32 cy )

Gets the dimensions of the window. The caller may pass nsnull for any value it is uninterested in receiving.

Arguments:
flags: Combination of position, inner and outer size flag .
x: Left hand corner of the outer area; or nsnull.
y: Top corner of the outer area; or nsnull.
cx: Width of the inner or outer area; or nsnull.
cy: Height of the inner or outer area; or nsnull.

void setDimensions ( PRUint32 flags , PRInt32 x , PRInt32 y , PRInt32 cx , PRInt32 cy )

Sets the dimensions for the window; the position & size. The flags to indicate what the caller wants to set and whether the size refers to the inner or outer area. The inner area refers to just the embedded area, wheras the outer area can also include any surrounding chrome, window frame, title bar, and so on.

Arguments:
flags: Combination of position, inner and outer size flags.
x: Left hand corner of the outer area.
y: Top corner of the outer area.
cx: Width of the inner or outer area.
cy: Height of the inner or outer area.
Returns:
NS_OK if operation was performed correctly; NS_ERROR_UNEXPECTED if window could not be destroyed; NS_ERROR_INVALID_ARG for bad flag combination or illegal dimensions.

void setFocus ( )

Give the window focus.

Reference documentation is generated from Mozilla's source.