Interface nsIEmbeddingSiteWindowType

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.

Hierarchy

Properties

siteWindow: voidPtr

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*.
title: string

Title of the window.

visibility: boolean

Visibility of the window.

Methods

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

  • Blur the window. This should unfocus the window and send an onblur event.

    Returns void

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

    See

    • setDimensions
    • DIM_FLAGS_POSITION
    • DIM_FLAGS_SIZE_OUTER
    • DIM_FLAGS_SIZE_INNER

    Parameters

    • flags: number

      Combination of position, inner and outer size flag .

    • x: number

      Left hand corner of the outer area; or nullptr.

    • y: number

      Top corner of the outer area; or nullptr.

    • cx: number

      Width of the inner or outer area; or nullptr.

    • cy: number

      Height of the inner or outer area; or nullptr.

    Returns void

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

    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

    • getDimensions
    • DIM_FLAGS_POSITION
    • DIM_FLAGS_SIZE_OUTER
    • DIM_FLAGS_SIZE_INNER

    Parameters

    • flags: number

      Combination of position, inner and outer size flags. The ignore flags are telling the parent to use the current values for those dimensions and ignore the corresponding parameters the child sends.

    • x: number

      Left hand corner of the outer area.

    • y: number

      Top corner of the outer area.

    • cx: number

      Width of the inner or outer area.

    • cy: number

      Height of the inner or outer area.

    Returns void

Generated using TypeDoc