include/OffscreenGecko/scriptobjecttemplate.h

Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public License Version
00005  * 1.1 (the "License"); you may not use this file except in compliance with
00006  * the License. You may obtain a copy of the License at
00007  * http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the License is distributed on an "AS IS" basis,
00010  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00011  * for the specific language governing rights and limitations under the
00012  * License.
00013  *
00014  * The Original Code is OffscreenGecko code.
00015  *
00016  * The Initial Developer of the Original Code is
00017  * Frank Richter <frank.richter@gmail.com>.
00018  * Portions created by the Initial Developer are Copyright (C) 2007
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *
00023  * Alternatively, the contents of this file may be used under the terms of
00024  * either the GNU General Public License Version 2 or later (the "GPL"), or
00025  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00026  * in which case the provisions of the GPL or the LGPL are applicable instead
00027  * of those above. If you wish to allow use of your version of this file only
00028  * under the terms of either the GPL or the LGPL, and not to allow others to
00029  * use your version of this file under the terms of the MPL, indicate your
00030  * decision by deleting the provisions above and replace them with the notice
00031  * and other provisions required by the GPL or the LGPL. If you do not delete
00032  * the provisions above, a recipient may use your version of this file under
00033  * the terms of any one of the MPL, the GPL or the LGPL.
00034  *
00035  * ***** END LICENSE BLOCK ***** */
00036 
00037 #ifndef __OFFSCREENGECKO_SCRIPTOBJECTTEMPLATE_H__
00038 #define __OFFSCREENGECKO_SCRIPTOBJECTTEMPLATE_H__
00039 
00043 #include "baseobj.h"
00044 #include "browser.h"
00045 #include "scriptvariant.h"
00046 
00047 OSGK_DERIVEDTYPE(OSGK_ScriptObjectTemplate);
00048 
00049 typedef enum OSGK_ScriptResult
00050 {
00051   srSuccess = 0,
00052   srFailed = 0x80004005L /* actually NS_ERROR_FAILURE */
00053 } OSGK_ScriptResult;
00054 
00055 typedef struct OSGK_ScriptObjectCreateParams_s
00056 {
00057   void* createParam;
00058   OSGK_Browser* browser;
00059 } OSGK_ScriptObjectCreateParams;
00060 
00061 typedef OSGK_ScriptResult (*OSGK_CreateObjFunc) (
00062   OSGK_ScriptObjectCreateParams* params, void** objTag);
00063 typedef void (*OSGK_DestroyObjFunc) (void* objTag);
00064 
00065 OSGK_EXTERN_C OSGK_API OSGK_ScriptObjectTemplate* osgk_sot_create (
00066   OSGK_Embedding* embedding,
00067   OSGK_CreateObjFunc createFunc, OSGK_DestroyObjFunc destroyFunc,
00068   void* createParam);
00069 
00070 typedef OSGK_ScriptVariant* (*OSGK_GetPropertyFunc) (void* objTag,
00071   void* propTag);
00072 typedef OSGK_ScriptResult (*OSGK_SetPropertyFunc) (void* objTag,
00073   void* propTag, OSGK_ScriptVariant* val);
00074   
00075 OSGK_EXTERN_C OSGK_API int osgk_sot_add_property (
00076   OSGK_ScriptObjectTemplate* templ, const char* propName, void* propTag,
00077   OSGK_GetPropertyFunc getter, OSGK_SetPropertyFunc setter);
00078 
00079 typedef OSGK_ScriptResult (*OSGK_FunctionCallFunc) (void* objTag,
00080   void* methTag, size_t numParams, OSGK_ScriptVariant** params,
00081   OSGK_ScriptVariant** returnVal);
00082 
00083 OSGK_EXTERN_C OSGK_API int osgk_sot_add_function (
00084   OSGK_ScriptObjectTemplate* templ, const char* funcName, void* funcTag,
00085   OSGK_FunctionCallFunc callFunc);
00086 
00087 OSGK_EXTERN_C OSGK_API OSGK_ScriptVariant* osgk_sot_instantiate (
00088   OSGK_ScriptObjectTemplate* templ, void** objTag);
00089 
00090 OSGK_EXTERN_C OSGK_API int osgk_sot_register (
00091   OSGK_ScriptObjectTemplate* templ, OSGK_Embedding* embedding, 
00092   const char* name, unsigned int flags);
00093 
00094 // TODO: Create a nice C++ interface (notably, try to wrap callbacks)
00095 
00096 #endif // __OFFSCREENGECKO_SCRIPTOBJECTTEMPLATE_H__

Generated on Sun Nov 2 18:15:18 2008 for OffscreenGecko by  doxygen 1.5.4