Public Member Functions | Public Attributes

nsIEmbeddingSiteWindow Interface Reference

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. More...

import "nsIEmbeddingSiteWindow.idl";

Inheritance diagram for nsIEmbeddingSiteWindow:

List of all members.

Public Member Functions

void setDimensions (in unsigned long flags, in long x, in long y, in long cx, in long cy)
 Sets the dimensions for the window; the position & size.
void getDimensions (in unsigned long flags, out long x, out long y, out long cx, out long cy)
 Gets the dimensions of the window.
void setFocus ()
 Give the window focus.

Public Attributes

const unsigned long DIM_FLAGS_POSITION = 1
 Flag indicates that position of the top left corner of the outer area is required/specified.
const unsigned long DIM_FLAGS_SIZE_INNER = 2
 Flag indicates that the size of the inner area is required/specified.
const unsigned long DIM_FLAGS_SIZE_OUTER = 4
 Flag indicates that the size of the outer area is required/specified.
attribute boolean visibility
 Visibility of the window.
attribute wstring title
 Title of the window.
readonly attribute voidPtr siteWindow
 Native window for the site's window.

Detailed Description

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.

Status:
FROZEN

Member Function Documentation

void nsIEmbeddingSiteWindow::getDimensions ( in unsigned long  flags,
out long  x,
out long  y,
out long  cx,
out long  cy 
)

Gets the dimensions of the window.

The caller may pass nsnull for any value it is uninterested in receiving.

Parameters:
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.
See also:
setDimensions
DIM_FLAGS_POSITION
DIM_FLAGS_SIZE_OUTER
DIM_FLAGS_SIZE_INNER
void nsIEmbeddingSiteWindow::setDimensions ( in unsigned long  flags,
in long  x,
in long  y,
in long  cx,
in long  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.

Parameters:
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.
See also:
getDimensions
DIM_FLAGS_POSITION
DIM_FLAGS_SIZE_OUTER
DIM_FLAGS_SIZE_INNER
void nsIEmbeddingSiteWindow::setFocus (  ) 

Give the window focus.


Member Data Documentation

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

See also:
setDimensions
getDimensions

Flag indicates that the size of the inner area is required/specified.

Note:
The inner and outer flags are mutually exclusive and it is invalid to combine them.
See also:
setDimensions
getDimensions
DIM_FLAGS_SIZE_OUTER

Flag indicates that the size of the outer area is required/specified.

See also:
setDimensions
getDimensions
DIM_FLAGS_SIZE_INNER
readonly attribute voidPtr nsIEmbeddingSiteWindow::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:

  • On Win32 it is an HWND.
  • On MacOS this is a WindowPtr.
  • On GTK this is a GtkWidget*.
attribute wstring nsIEmbeddingSiteWindow::title

Title of the window.

Visibility of the window.


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