FreeWRL/FreeX3D  3.0.0
BasePlugin.h
1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* ***** BEGIN LICENSE BLOCK *****
3  * Version: NPL 1.1/GPL 2.0/LGPL 2.1
4  *
5  * The contents of this file are subject to the Netscape Public License
6  * Version 1.1 (the "License"); you may not use this file except in
7  * compliance with the License. You may obtain a copy of the License at
8  * http://www.mozilla.org/NPL/
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 NPL, 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 NPL, the GPL or the LGPL.
35  *
36  * ***** END LICENSE BLOCK ***** */
37 
38 #pragma once
39 #include "ScriptablePluginObjectBase.h"
40 
42 
44 static NPIdentifier sDocument_id; //document object
45 static NPIdentifier sBody_id; //body object
46 
47 // Scripting engine methods identifiers
48 static NPIdentifier sCreateElement_id; //create element
49 static NPIdentifier sCreateTextNode_id; //create node
50 static NPIdentifier sAppendChild_id; //append child
51 
52 //Plugin specific identifiers
53 static NPIdentifier sPluginType_id; //plugin type
54 static NPIdentifier sFoo_id; //plugin method "foo"
55 static NPIdentifier sBar_id; //plugin property "bar"
56 static NPIdentifier sShowText_id; //plugin method "showText"
57 static NPIdentifier sClearWindow_id; //plugin method "clearWindow"
58 
59 static NPObject *sWindowObj; //pointer to the window object
60 
61 
63 {
64 public:
65  BasePlugin(NPP npp)
67  {
68  }
69 
70  virtual bool HasMethod(NPIdentifier name);
71  virtual bool HasProperty(NPIdentifier name);
72  virtual bool GetProperty(NPIdentifier name, NPVariant *result);
73  virtual bool Invoke(NPIdentifier name, const NPVariant *args,
74  uint32_t argCount, NPVariant *result);
75  virtual bool InvokeDefault(const NPVariant *args, uint32_t argCount,
76  NPVariant *result);
77 };
78 
79 static NPObject *
80 AllocateScriptablePluginObject(NPP npp, NPClass *aClass)
81 {
82  return new BasePlugin(npp);
83 }
84 
85 DECLARE_NPOBJECT_CLASS_WITH_BASE(BasePlugin,
86  AllocateScriptablePluginObject);
87 
virtual bool HasProperty(NPIdentifier name)
Returns true if the NPIdentifier passed is managed as a scriptable property.
Definition: BasePlugin.cpp:51
virtual bool Invoke(NPIdentifier name, const NPVariant *args, uint32_t argCount, NPVariant *result)
returns true if the invoked method is managed and executes the appropriate code filling the NPVariant...
Definition: BasePlugin.cpp:95
virtual bool GetProperty(NPIdentifier name, NPVariant *result)
Returns true if the scriptable property is managed and fills the NPVariant pointer with the value...
Definition: BasePlugin.cpp:60
Definition: npapi.h:148
virtual bool InvokeDefault(const NPVariant *args, uint32_t argCount, NPVariant *result)
Manages the invocation of the default '()' method.
Definition: BasePlugin.cpp:103