Struct xpcom::interfaces::nsIXULWindow [] [src]

#[repr(C)]
pub struct nsIXULWindow { /* fields omitted */ }

interface nsIXULWindow : nsISupports

Methods

impl nsIXULWindow
[src]

[src]

Cast this nsIXULWindow to one of its base interfaces.

impl nsIXULWindow
[src]

lowestZ: i64 = 0

loweredZ: i64 = 4

normalZ: i64 = 5

raisedZ: i64 = 6

highestZ: i64 = 9

[src]

/**
   * The docshell owning the XUL for this window.
   */

readonly attribute nsIDocShell docShell;

[src]

/**
   * Indicates if this window is instrinsically sized.
   */

attribute boolean intrinsicallySized;

[src]

/**
   * Indicates if this window is instrinsically sized.
   */

attribute boolean intrinsicallySized;

[src]

/**
   * The primary content shell.
   *
   * Note that this is a docshell tree item and therefore can not be assured of
   * what object it is. It could be an editor, a docshell, or a browser object.
   * Or down the road any other object that supports being a DocShellTreeItem
   * Query accordingly to determine the capabilities.
   */

readonly attribute nsIDocShellTreeItem primaryContentShell;

[src]

/**
   * In multiprocess case we may not have primaryContentShell but
   * primaryTabParent.
   */

readonly attribute nsITabParent primaryTabParent;

[src]

void tabParentAdded (in nsITabParent aTab, in boolean aPrimary);

[src]

void tabParentRemoved (in nsITabParent aTab);

[src]

/**
   * Tell this window that it has picked up a child XUL window
   * @param aChild the child window being added
   */

void addChildWindow (in nsIXULWindow aChild);

[src]

/**
   * Tell this window that it has lost a child XUL window
   * @param aChild the child window being removed
   */

void removeChildWindow (in nsIXULWindow aChild);

[src]

/**
   * Move the window to a centered position.
   * @param aRelative If not null, the window relative to which the window is
   *                  moved. See aScreen parameter for details.
   * @param aScreen   PR_TRUE to center the window relative to the screen
   *                  containing aRelative if aRelative is not null. If
   *                  aRelative is null then relative to the screen of the
   *                  opener window if it was initialized by passing it to
   *                  nsWebShellWindow::Initialize. Failing that relative to
   *                  the main screen.
   *                  PR_FALSE to center it relative to aRelative itself.
   * @param aAlert    PR_TRUE to move the window to an alert position,
   *                  generally centered horizontally and 1/3 down from the top.
   */

void center (in nsIXULWindow aRelative, in boolean aScreen, in boolean aAlert);

[src]

/**
   * Shows the window as a modal window. That is, ensures that it is visible
   * and runs a local event loop, exiting only once the window has been closed.
   */

void showModal ();

[src]

attribute unsigned long zLevel;

[src]

attribute unsigned long zLevel;

[src]

attribute uint32_t chromeFlags;

[src]

attribute uint32_t chromeFlags;

[src]

/**
   * Begin assuming |chromeFlags| don't change hereafter, and assert
   * if they do change.  The state change is one-way and idempotent.
   */

void assumeChromeFlagsAreFrozen ();

[src]

/**
   * Create a new window.
   * @param aChromeFlags see nsIWebBrowserChrome
   * @param aOpeningTab the TabParent that requested this new window be opened.
   *                    Can be left null.
   * @param aOpener The window which is requesting that this new window be opened.
   * @param aNextTabParentId The integer ID of the next tab parent actor to use.
   *        0 means there is no next tab parent actor to use.
   * @return the newly minted window
   */

nsIXULWindow createNewWindow (in int32_t aChromeFlags, in nsITabParent aOpeningTab, in mozIDOMWindowProxy aOpener, in unsigned long long aNextTabParentId);

[src]

attribute nsIXULBrowserWindow XULBrowserWindow;

[src]

attribute nsIXULBrowserWindow XULBrowserWindow;

[src]

/**
   * Back-door method to force application of chrome flags at a particular
   * time.  Do NOT call this unless you know what you're doing!  In particular,
   * calling this when this XUL window doesn't yet have a document in its
   * docshell could cause problems.
   */

[noscript] void applyChromeFlags ();

[src]

/**
   * Given the dimensions of some content area held within this
   * XUL window, and assuming that that content area will change
   * its dimensions in linear proportion to the dimensions of this
   * XUL window, changes the size of the XUL window so that the
   * content area reaches a particular size.
   *
   * We need to supply the content area dimensions because sometimes
   * the child's nsDocShellTreeOwner needs to propagate a SizeShellTo
   * call to the parent. But the shellItem argument of the call will
   * not be available on the parent side.
   *
   * Note: this is an internal method, other consumers should never call this.
   *
   * @param aDesiredWidth
   *        The desired width of the content area in device pixels.
   * @param aDesiredHeight
   *        The desired height of the content area in device pixels.
   * @param shellItemWidth
   *        The current width of the content area.
   * @param shellItemHeight
   *        The current height of the content area.
   */

[noscript,notxpcom] void sizeShellToWithLimit (in int32_t aDesiredWidth, in int32_t aDesiredHeight, in int32_t shellItemWidth, in int32_t shellItemHeight);

[src]

/**
   * If the window was opened as a content window by script, this will return the
   * integer ID of the next TabParent actor to use.
   */

[noscript] readonly attribute unsigned long long nextTabParentId;

Methods from Deref<Target = nsISupports>

[src]

Cast this nsISupports to one of its base interfaces.

[src]

void QueryInterface (in nsIIDRef uuid, [iid_is (uuid), retval] out nsQIResult result);

[src]

[noscript,notxpcom] nsrefcnt AddRef ();

[src]

[noscript,notxpcom] nsrefcnt Release ();

Trait Implementations

impl XpCom for nsIXULWindow
[src]

IID: nsIID = nsID(3604455444, 57997, 19613, [135, 39, 28, 246, 216, 112, 97, 155])

[src]

Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise. Read more

impl RefCounted for nsIXULWindow
[src]

[src]

Increment the reference count.

[src]

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIXULWindow
[src]

The resulting type after dereferencing.

[src]

Dereferences the value.