forked from mirrors/gecko-dev
3aa25724fe
Because nsAString is nicer to work with than char16_t*. The patch relatedly changes nsIEmbeddingSiteWindow::title and nsIWindowMediator::updateWindowTitle as well. --HG-- extra : rebase_source : 0bf332dec3e09af6c39c676f8795b368768a6046
157 lines
5.1 KiB
Text
157 lines
5.1 KiB
Text
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
/* THIS IS A PUBLIC EMBEDDING API */
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
[scriptable, uuid(0b976267-4aaa-4f36-a2d4-27b5ca8d73bb)]
|
|
interface nsIEmbeddingSiteWindow : nsISupports
|
|
{
|
|
/**
|
|
* Flag indicates that position of the top left corner of the outer area
|
|
* is required/specified.
|
|
*
|
|
* @see setDimensions
|
|
* @see getDimensions
|
|
*/
|
|
const unsigned long DIM_FLAGS_POSITION = 1;
|
|
|
|
/**
|
|
* 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 setDimensions
|
|
* @see getDimensions
|
|
* @see DIM_FLAGS_SIZE_OUTER
|
|
*/
|
|
const unsigned long DIM_FLAGS_SIZE_INNER = 2;
|
|
|
|
/**
|
|
* Flag indicates that the size of the outer area is required/specified.
|
|
*
|
|
* @see setDimensions
|
|
* @see getDimensions
|
|
* @see DIM_FLAGS_SIZE_INNER
|
|
*/
|
|
const unsigned long DIM_FLAGS_SIZE_OUTER = 4;
|
|
|
|
/**
|
|
* Flag indicates that the x parameter should be ignored.
|
|
*
|
|
* @see setDimensions
|
|
*/
|
|
const unsigned long DIM_FLAGS_IGNORE_X = 8;
|
|
|
|
/**
|
|
* Flag indicates that the y parameter should be ignored.
|
|
*
|
|
* @see setDimensions
|
|
*/
|
|
const unsigned long DIM_FLAGS_IGNORE_Y = 16;
|
|
|
|
/**
|
|
* Flag indicates that the cx parameter should be ignored.
|
|
*
|
|
* @see setDimensions
|
|
*/
|
|
const unsigned long DIM_FLAGS_IGNORE_CX = 32;
|
|
|
|
/**
|
|
* Flag indicates that the cy parameter should be ignored.
|
|
*
|
|
* @see setDimensions
|
|
*/
|
|
const unsigned long DIM_FLAGS_IGNORE_CY = 64;
|
|
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @param flags 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.
|
|
* @param x Left hand corner of the outer area.
|
|
* @param y Top corner of the outer area.
|
|
* @param cx Width of the inner or outer area.
|
|
* @param cy Height of the inner or outer area.
|
|
*
|
|
* @return <code>NS_OK</code> if operation was performed correctly;
|
|
* <code>NS_ERROR_UNEXPECTED</code> if window could not be
|
|
* destroyed;
|
|
* <code>NS_ERROR_INVALID_ARG</code> for bad flag combination
|
|
* or illegal dimensions.
|
|
*
|
|
* @see getDimensions
|
|
* @see DIM_FLAGS_POSITION
|
|
* @see DIM_FLAGS_SIZE_OUTER
|
|
* @see DIM_FLAGS_SIZE_INNER
|
|
*/
|
|
void setDimensions(in unsigned long flags, in long x, in long y, in long cx, in long cy);
|
|
|
|
/**
|
|
* Gets the dimensions of the window. The caller may pass
|
|
* <CODE>nullptr</CODE> for any value it is uninterested in receiving.
|
|
*
|
|
* @param flags Combination of position, inner and outer size flag .
|
|
* @param x Left hand corner of the outer area; or <CODE>nullptr</CODE>.
|
|
* @param y Top corner of the outer area; or <CODE>nullptr</CODE>.
|
|
* @param cx Width of the inner or outer area; or <CODE>nullptr</CODE>.
|
|
* @param cy Height of the inner or outer area; or <CODE>nullptr</CODE>.
|
|
*
|
|
* @see setDimensions
|
|
* @see DIM_FLAGS_POSITION
|
|
* @see DIM_FLAGS_SIZE_OUTER
|
|
* @see DIM_FLAGS_SIZE_INNER
|
|
*/
|
|
void getDimensions(in unsigned long flags, out long x, out long y, out long cx, out long cy);
|
|
|
|
/**
|
|
* Give the window focus.
|
|
*/
|
|
void setFocus();
|
|
|
|
/**
|
|
* Visibility of the window.
|
|
*/
|
|
attribute boolean visibility;
|
|
|
|
/**
|
|
* Title of the window.
|
|
*/
|
|
attribute AString title;
|
|
|
|
/**
|
|
* 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:
|
|
*
|
|
* <ul>
|
|
* <li>On Win32 it is an <CODE>HWND</CODE>.</li>
|
|
* <li>On MacOS this is a <CODE>WindowPtr</CODE>.</li>
|
|
* <li>On GTK this is a <CODE>GtkWidget*</CODE>.</li>
|
|
* </ul>
|
|
*/
|
|
[noscript] readonly attribute voidPtr siteWindow;
|
|
|
|
/**
|
|
* Blur the window. This should unfocus the window and send an onblur event.
|
|
*/
|
|
void blur();
|
|
};
|