nsIEmbeddingSiteWindow.idl
上传用户:goldcmy89
上传日期:2017-12-03
资源大小:2246k
文件大小:6k
源码类别:

PlugIns编程

开发平台:

Visual C++

  1. /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
  2.  *
  3.  * ***** BEGIN LICENSE BLOCK *****
  4.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  5.  *
  6.  * The contents of this file are subject to the Mozilla Public License Version
  7.  * 1.1 (the "License"); you may not use this file except in compliance with
  8.  * the License. You may obtain a copy of the License at
  9.  * http://www.mozilla.org/MPL/
  10.  *
  11.  * Software distributed under the License is distributed on an "AS IS" basis,
  12.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13.  * for the specific language governing rights and limitations under the
  14.  * License.
  15.  *
  16.  * The Original Code is the Mozilla browser.
  17.  *
  18.  * The Initial Developer of the Original Code is
  19.  * Netscape Communications, Inc.
  20.  * Portions created by the Initial Developer are Copyright (C) 1999
  21.  * the Initial Developer. All Rights Reserved.
  22.  *
  23.  * Contributor(s):
  24.  *   Adam Lock <adamlock@netscape.com>
  25.  *
  26.  * Alternatively, the contents of this file may be used under the terms of
  27.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29.  * in which case the provisions of the GPL or the LGPL are applicable instead
  30.  * of those above. If you wish to allow use of your version of this file only
  31.  * under the terms of either the GPL or the LGPL, and not to allow others to
  32.  * use your version of this file under the terms of the MPL, indicate your
  33.  * decision by deleting the provisions above and replace them with the notice
  34.  * and other provisions required by the GPL or the LGPL. If you do not delete
  35.  * the provisions above, a recipient may use your version of this file under
  36.  * the terms of any one of the MPL, the GPL or the LGPL.
  37.  *
  38.  * ***** END LICENSE BLOCK ***** */
  39. #include "nsISupports.idl"
  40. /* THIS IS A PUBLIC EMBEDDING API */
  41. /**
  42.  * The nsIEmbeddingSiteWindow is implemented by the embedder to provide
  43.  * Gecko with the means to call up to the host to resize the window,
  44.  * hide or show it and set/get its title.
  45.  *
  46.  * @status FROZEN
  47.  */
  48. [scriptable, uuid(3E5432CD-9568-4bd1-8CBE-D50ABA110743)]
  49. interface nsIEmbeddingSiteWindow : nsISupports
  50. {
  51.     /**
  52.      * Flag indicates that position of the top left corner of the outer area
  53.      * is required/specified.
  54.      *
  55.      * @see setDimensions
  56.      * @see getDimensions
  57.      */
  58.     const unsigned long DIM_FLAGS_POSITION   = 1;
  59.     
  60.     /**
  61.      * Flag indicates that the size of the inner area is required/specified.
  62.      *
  63.      * @note The inner and outer flags are mutually exclusive and it is
  64.      *       invalid to combine them.
  65.      *
  66.      * @see setDimensions
  67.      * @see getDimensions
  68.      * @see DIM_FLAGS_SIZE_OUTER
  69.      */
  70.     const unsigned long DIM_FLAGS_SIZE_INNER = 2;
  71.     /**
  72.      * Flag indicates that the size of the outer area is required/specified.
  73.      *
  74.      * @see setDimensions
  75.      * @see getDimensions
  76.      * @see DIM_FLAGS_SIZE_INNER
  77.      */
  78.     const unsigned long DIM_FLAGS_SIZE_OUTER = 4;
  79.     /**
  80.      * Sets the dimensions for the window; the position & size. The
  81.      * flags to indicate what the caller wants to set and whether the size
  82.      * refers to the inner or outer area. The inner area refers to just
  83.      * the embedded area, wheras the outer area can also include any 
  84.      * surrounding chrome, window frame, title bar, and so on.
  85.      *
  86.      * @param flags  Combination of position, inner and outer size flags.
  87.      * @param x      Left hand corner of the outer area.
  88.      * @param y      Top corner of the outer area.
  89.      * @param cx     Width of the inner or outer area.
  90.      * @param cy     Height of the inner or outer area.
  91.      *
  92.      * @return <code>NS_OK</code> if operation was performed correctly;
  93.      *         <code>NS_ERROR_UNEXPECTED</code> if window could not be
  94.      *           destroyed;
  95.      *         <code>NS_ERROR_INVALID_ARG</code> for bad flag combination
  96.      *           or illegal dimensions.
  97.      *
  98.      * @see getDimensions
  99.      * @see DIM_FLAGS_POSITION
  100.      * @see DIM_FLAGS_SIZE_OUTER
  101.      * @see DIM_FLAGS_SIZE_INNER
  102.      */
  103.     void setDimensions(in unsigned long flags, in long x, in long y, in long cx, in long cy);
  104.     /**
  105.      * Gets the dimensions of the window. The caller may pass
  106.      * <CODE>nsnull</CODE> for any value it is uninterested in receiving.
  107.      *
  108.      * @param flags  Combination of position, inner and outer size flag .
  109.      * @param x      Left hand corner of the outer area; or <CODE>nsnull</CODE>.
  110.      * @param y      Top corner of the outer area; or <CODE>nsnull</CODE>.
  111.      * @param cx     Width of the inner or outer area; or <CODE>nsnull</CODE>.
  112.      * @param cy     Height of the inner or outer area; or <CODE>nsnull</CODE>.
  113.      *
  114.      * @see setDimensions
  115.      * @see DIM_FLAGS_POSITION
  116.      * @see DIM_FLAGS_SIZE_OUTER
  117.      * @see DIM_FLAGS_SIZE_INNER
  118.      */
  119.     void getDimensions(in unsigned long flags, out long x, out long y, out long cx, out long cy);
  120.     /**
  121.      * Give the window focus.
  122.      */
  123.     void setFocus();
  124.     /**
  125.      * Visibility of the window.
  126.      */
  127.     attribute boolean visibility;
  128.     /**
  129.      * Title of the window.
  130.      */
  131.     attribute wstring title;
  132.     /**
  133.      * Native window for the site's window. The implementor should copy the
  134.      * native window object into the address supplied by the caller. The
  135.      * type of the native window that the address refers to is  platform
  136.      * and OS specific as follows:
  137.      *
  138.      * <ul>
  139.      *   <li>On Win32 it is an <CODE>HWND</CODE>.</li>
  140.      *   <li>On MacOS this is a <CODE>WindowPtr</CODE>.</li>
  141.      *   <li>On GTK this is a <CODE>GtkWidget*</CODE>.</li>
  142.      * </ul>
  143.      */
  144.     [noscript] readonly attribute voidPtr siteWindow;
  145. };