File: nsIPluginInstanceOwner.idl

package info (click to toggle)
iceweasel 2.0.0.19-0etch1
  • links: PTS
  • area: main
  • in suites: etch
  • size: 298,784 kB
  • ctags: 317,912
  • sloc: cpp: 1,796,902; ansic: 987,677; xml: 109,036; makefile: 47,777; asm: 35,201; perl: 26,983; sh: 20,879; cs: 6,232; java: 5,513; python: 3,249; pascal: 459; lex: 306; php: 244; csh: 132; objc: 97; yacc: 79; ada: 49; awk: 14; sql: 4; sed: 4
file content (136 lines) | stat: -rw-r--r-- 4,039 bytes parent folder | download | duplicates (8)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is mozilla.org code.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 1998
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"
#include "nspluginroot.idl"

%{C++
#include "nsplugin.h"
%}

interface nsIPluginInstance;
interface nsIDocument;

[ref] native nsIPluginInstanceRef(nsIPluginInstance *);

[uuid(18270870-32f1-11d2-a830-0040959a28c9)]
interface nsIPluginInstanceOwner : nsISupports
{
  /**
   * Let the owner know that an instance has been created
   */
  void setInstance(in nsIPluginInstance aInstance);

  /**
   * Get the instance associated with this owner.
   */
  void getInstance(in nsIPluginInstanceRef aInstance);

  /**
   * Get a handle to the window structure of the owner.
   * This pointer cannot be made persistant by the caller.
   */
  void getWindow(in nsPluginWindowStarRef aWindow);

  /**
   * Get the display mode for the plugin instance.
   */
  //void getMode(nsPluginMode *aMode);
  readonly attribute nsPluginMode mode;

  /**
   * Create a place for the plugin to live in the owner's
   * environment. this may or may not create a window
   * depending on the windowless state of the plugin instance.
   */
  void createWidget();

%{C++
  /**
   * Called when there is a valid target so that the proper
   * frame can be updated with new content. will not be called
   * with nsnull aTarget.
   */
  NS_IMETHOD
  GetURL(const char *aURL, const char *aTarget, 
         void *aPostData, PRUint32 aPostDataLen, 
         void *aHeadersData, PRUint32 aHeadersDataLen, 
         PRBool aIsFile = PR_FALSE) = 0;

%}
  /**
   * Show a status message in the host environment.
   */
  void showStatus(in string aStatusMsg);

%{C++
  NS_IMETHOD
  ShowStatus(const PRUnichar *aStatusMsg) = 0;

%}

  /**
   * Get the associated document.
   */
  //void getDocument(nsIDocument* *aDocument);
  readonly attribute nsIDocument document;

  /**
   * Invalidate the rectangle
   */
  void invalidateRect(in nsPluginRectPtr aRect);

  /**
   * Invalidate the region
   */
  void invalidateRegion(in nsPluginRegion aRegion);

  /**
   * Force a redraw
   */
  void forceRedraw();

  /**
   * Get the specified variable
   */
  void getValue(in nsPluginInstancePeerVariable aVariable, in voidPtr aValue);

  /**
   * Inform the owner that no plugin for the given mime type was found.
   */
  void pluginNotAvailable(in string aMimeType);
};