FreeWRL / FreeX3D 4.3.0
nsIPluginInstanceOwner.idl
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/* ***** BEGIN LICENSE BLOCK *****
3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4 *
5 * The contents of this file are subject to the Mozilla Public License Version
6 * 1.1 (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 * http://www.mozilla.org/MPL/
9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
13 * License.
14 *
15 * The Original Code is mozilla.org code.
16 *
17 * The Initial Developer of the Original Code is
18 * Netscape Communications Corporation.
19 * Portions created by the Initial Developer are Copyright (C) 1998
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 *
24 * Alternatively, the contents of this file may be used under the terms of
25 * either the GNU General Public License Version 2 or later (the "GPL"), or
26 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 * in which case the provisions of the GPL or the LGPL are applicable instead
28 * of those above. If you wish to allow use of your version of this file only
29 * under the terms of either the GPL or the LGPL, and not to allow others to
30 * use your version of this file under the terms of the MPL, indicate your
31 * decision by deleting the provisions above and replace them with the notice
32 * and other provisions required by the GPL or the LGPL. If you do not delete
33 * the provisions above, a recipient may use your version of this file under
34 * the terms of any one of the MPL, the GPL or the LGPL.
35 *
36 * ***** END LICENSE BLOCK ***** */
37
38#include "nsISupports.idl"
39#include "nspluginroot.idl"
40#include "nsIPlugin.idl"
41
42interface nsIPluginInstance;
43interface nsIDocument;
44
45[ref] native nsIPluginInstanceRef(nsIPluginInstance *);
46
47[uuid(c4ed03f3-498b-4045-97c7-0b05838f886c)]
48interface nsIPluginInstanceOwner : nsISupports
49{
53 void setInstance(in nsIPluginInstance aInstance);
54
58 void getInstance(in nsIPluginInstanceRef aInstance);
59
60%{C++
61 // make getter_AddRefs work
62 inline nsresult GetInstance(nsIPluginInstance** aInstance) {
63 return GetInstance(*aInstance);
64 }
65%}
66
71 void getWindow(in nsPluginWindowStarRef aWindow);
72
76 //void getMode(nsPluginMode *aMode);
77 readonly attribute nsPluginMode mode;
78
85
86%{C++
92 NS_IMETHOD
93 GetURL(const char *aURL, const char *aTarget,
94 void *aPostData, PRUint32 aPostDataLen,
95 void *aHeadersData, PRUint32 aHeadersDataLen,
96 PRBool aIsFile = PR_FALSE) = 0;
97
98%}
102 void showStatus(in string aStatusMsg);
103
104%{C++
105 NS_IMETHOD
106 ShowStatus(const PRUnichar *aStatusMsg) = 0;
107
108%}
109
113 //void getDocument(nsIDocument* *aDocument);
114 readonly attribute nsIDocument document;
115
119 void invalidateRect(in nsPluginRectPtr aRect);
120
124 void invalidateRegion(in nsPluginRegion aRegion);
125
130
134 void getNetscapeWindow(in voidPtr aValue);
135};
void forceRedraw()
Force a redraw.
void showStatus(in string aStatusMsg)
Show a status message in the host environment.
void setInstance(in nsIPluginInstance aInstance)
Let the owner know what its instance is.
void getWindow(in nsPluginWindowStarRef aWindow)
Get a handle to the window structure of the owner.
void getNetscapeWindow(in voidPtr aValue)
Get NetscapeWindow, corresponds to NPNVnetscapeWindow.
void getInstance(in nsIPluginInstanceRef aInstance)
Get the instance associated with this owner.
void createWidget()
Create a place for the plugin to live in the owner's environment.
readonly attribute nsPluginMode mode
Get the display mode for the plugin instance.
void invalidateRegion(in nsPluginRegion aRegion)
Invalidate the region.
readonly attribute nsIDocument document
Get the associated document.
NS_IMETHOD GetURL(const char *aURL, const char *aTarget, void *aPostData, PRUint32 aPostDataLen, void *aHeadersData, PRUint32 aHeadersDataLen, PRBool aIsFile=PR_FALSE)=0
Called when there is a valid target so that the proper frame can be updated with new content.
void invalidateRect(in nsPluginRectPtr aRect)
Invalidate the rectangle.