npapi.h File Reference

API published in: S60 2nd Ed FP 2

Capability Information

Required Capabilities

DRM LocalServices NetworkControl NetworkServices ReadDeviceData ReadUserData SwEvent UserEnvironment WriteDeviceData WriteUserData

Exceptions


#include "prtypes.h"

Go to the source code of this file.


Data Structures

struct   _NPP
struct   _NPStream
struct   _NPByteRange
struct   _NPSavedData
struct   _NPRect
struct   _NPSize
struct   _NPWindow
struct   _NPFullPrint
struct   _NPEmbedPrint
struct   _NPPrint

Defines

#define  NP_VERSION_MAJOR   0
#define  NP_VERSION_MINOR   13
#define  NP_INFO_ProductVersion   1
#define  NP_INFO_MIMEType   2
#define  NP_INFO_FileOpenName   3
#define  NP_INFO_FileExtents   4
#define  NP_INFO_FileDescription   5
#define  NP_INFO_ProductName   6
#define  NP_INFO_CompanyName   7
#define  NP_INFO_FileVersion   8
#define  NP_INFO_InternalName   9
#define  NP_INFO_LegalCopyright   10
#define  NP_INFO_OriginalFilename   11
#define  FALSE   (0)
#define  TRUE   (1)
#define  NULL   (0L)
#define  NP_ABI_GCC3_MASK   0x10000000
#define  _NP_ABI_MIXIN_FOR_GCC3   0
#define  NP_ABI_MACHO_MASK   0x01000000
#define  _NP_ABI_MIXIN_FOR_MACHO   0
#define  NP_ABI_MASK   (_NP_ABI_MIXIN_FOR_GCC3 | _NP_ABI_MIXIN_FOR_MACHO)
#define  NP_EMBED   1
#define  NP_FULL   2
#define  NP_NORMAL   1
#define  NP_SEEK   2
#define  NP_ASFILE   3
#define  NP_ASFILEONLY   4
#define  NP_MAXREADY   (((unsigned)(~0)<<1)>>1)
#define  NPERR_BASE   0
#define  NPERR_NO_ERROR   (NPERR_BASE + 0)
#define  NPERR_GENERIC_ERROR   (NPERR_BASE + 1)
#define  NPERR_INVALID_INSTANCE_ERROR   (NPERR_BASE + 2)
#define  NPERR_INVALID_FUNCTABLE_ERROR   (NPERR_BASE + 3)
#define  NPERR_MODULE_LOAD_FAILED_ERROR   (NPERR_BASE + 4)
#define  NPERR_OUT_OF_MEMORY_ERROR   (NPERR_BASE + 5)
#define  NPERR_INVALID_PLUGIN_ERROR   (NPERR_BASE + 6)
#define  NPERR_INVALID_PLUGIN_DIR_ERROR   (NPERR_BASE + 7)
#define  NPERR_INCOMPATIBLE_VERSION_ERROR   (NPERR_BASE + 8)
#define  NPERR_INVALID_PARAM   (NPERR_BASE + 9)
#define  NPERR_INVALID_URL   (NPERR_BASE + 10)
#define  NPERR_FILE_NOT_FOUND   (NPERR_BASE + 11)
#define  NPERR_NO_DATA   (NPERR_BASE + 12)
#define  NPERR_STREAM_NOT_SEEKABLE   (NPERR_BASE + 13)
#define  NPRES_BASE   0
#define  NPRES_DONE   (NPRES_BASE + 0)
#define  NPRES_NETWORK_ERR   (NPRES_BASE + 1)
#define  NPRES_USER_BREAK   (NPRES_BASE + 2)
#define  NP_NOERR   NP_NOERR_is_obsolete_use_NPERR_NO_ERROR
#define  NP_EINVAL   NP_EINVAL_is_obsolete_use_NPERR_GENERIC_ERROR
#define  NP_EABORT   NP_EABORT_is_obsolete_use_NPRES_USER_BREAK
#define  NPVERS_HAS_STREAMOUTPUT   8
#define  NPVERS_HAS_NOTIFICATION   9
#define  NPVERS_HAS_LIVECONNECT   9
#define  NPVERS_WIN16_HAS_LIVECONNECT   9
#define  NPVERS_68K_HAS_LIVECONNECT   11
#define  NPVERS_HAS_WINDOWLESS   11
#define  NPVERS_HAS_XPCONNECT_SCRIPTING   13
#define  NP_LOADDS

Typedefs

typedef unsigned char  NPBool
typedef int16  NPError
typedef int16  NPReason
typedef char *  NPMIMEType
typedef _NPP  NPP_t
typedef NPP_t NPP
typedef _NPStream  NPStream
typedef _NPByteRange  NPByteRange
typedef _NPSavedData  NPSavedData
typedef _NPRect  NPRect
typedef _NPSize  NPSize
typedef _NPWindow  NPWindow
typedef _NPFullPrint  NPFullPrint
typedef _NPEmbedPrint  NPEmbedPrint
typedef _NPPrint  NPPrint
typedef void *  NPEvent
typedef void *  NPRegion

Enumerations

enum   NPPVariable {
  NPPVpluginNameString = 1, NPPVpluginDescriptionString, NPPVpluginWindowBool, NPPVpluginTransparentBool,
  NPPVjavaClass, NPPVpluginWindowSize, NPPVpluginTimerInterval, NPPVpluginScriptableInstance = (10 | ( 0 | 0 ) ),
  NPPVpluginScriptableIID = 11, NPPVjavascriptPushCallerBool = 12, NPPVpluginKeepLibraryInMemory = 13, NPPVpluginNeedsXEmbed = 14,
  NPPVpluginScriptableNPObject = 15, NPPVPluginFocusPosition = 100, NPPVPluginDeactivate = 101, NPPVPluginOpenInViewer = 102,
  NPPVpluginInteractiveBool = 1000
}
enum   NPNVariable {
  NPNVxDisplay = 1, NPNVxtAppContext, NPNVnetscapeWindow, NPNVjavascriptEnabledBool,
  NPNVasdEnabledBool, NPNVisOfflineBool, NPNVserviceManager = (10 | ( 0 | 0 ) ), NPNVDOMElement = (11 | ( 0 | 0 ) ),
  NPNVDOMWindow = (12 | ( 0 | 0 ) ), NPNVToolkit = (13 | ( 0 | 0 ) ), NPNVSupportsXEmbedBool = 14, NPNVWindowNPObject = 15,
  NPNVPluginElementNPObject
}
enum   NPWindowType { NPWindowTypeWindow = 1, NPWindowTypeDrawable }

Functions

NPError  NPP_Initialize (void)
void  NPP_Shutdown (void)
NPError  NPP_New (NPMIMEType pluginType, NPP instance, uint16 mode, int16 argc, char *argn[], char *argv[], NPSavedData *saved)
NPError  NPP_Destroy (NPP instance, NPSavedData **save)
NPError  NPP_SetWindow (NPP instance, NPWindow *window)
NPError  NPP_NewStream (NPP instance, NPMIMEType type, NPStream *stream, NPBool seekable, uint16 *stype)
NPError  NPP_DestroyStream (NPP instance, NPStream *stream, NPReason reason)
int32  NPP_WriteReady (NPP instance, NPStream *stream)
int32  NPP_Write (NPP instance, NPStream *stream, int32 offset, int32 len, void *buffer)
void  NPP_StreamAsFile (NPP instance, NPStream *stream, const char *fname)
void  NPP_Print (NPP instance, NPPrint *platformPrint)
int16  NPP_HandleEvent (NPP instance, void *event)
void  NPP_URLNotify (NPP instance, const char *url, NPReason reason, void *notifyData)
NPError  NPP_GetValue (NPP instance, NPPVariable variable, void *value)
NPError  NPP_SetValue (NPP instance, NPNVariable variable, void *value)
void  NPN_Version (int *plugin_major, int *plugin_minor, int *netscape_major, int *netscape_minor)
NPError  NPN_GetURLNotify (NPP instance, const char *url, const char *target, void *notifyData)
NPError  NPN_GetURL (NPP instance, const char *url, const char *target)
NPError  NPN_PostURLNotify (NPP instance, const char *url, const char *target, uint32 len, const char *buf, NPBool file, void *notifyData)
NPError  NPN_PostURL (NPP instance, const char *url, const char *target, uint32 len, const char *buf, NPBool file)
NPError  NPN_RequestRead (NPStream *stream, NPByteRange *rangeList)
NPError  NPN_NewStream (NPP instance, NPMIMEType type, const char *target, NPStream **stream)
int32  NPN_Write (NPP instance, NPStream *stream, int32 len, void *buffer)
NPError  NPN_DestroyStream (NPP instance, NPStream *stream, NPReason reason)
void  NPN_Status (NPP instance, const char *message)
const char *  NPN_UserAgent (NPP instance)
void *  NPN_MemAlloc (uint32 size)
void  NPN_MemFree (void *ptr)
uint32  NPN_MemFlush (uint32 size)
void  NPN_ReloadPlugins (NPBool reloadPages)
NPError  NPN_GetValue (NPP instance, NPNVariable variable, void *value)
NPError  NPN_SetValue (NPP instance, NPPVariable variable, void *value)
void  NPN_InvalidateRect (NPP instance, NPRect *invalidRect)
void  NPN_InvalidateRegion (NPP instance, NPRegion invalidRegion)
void  NPN_ForceRedraw (NPP instance)

Define Documentation

#define _NP_ABI_MIXIN_FOR_GCC3   0
 
#define _NP_ABI_MIXIN_FOR_MACHO   0
 
#define FALSE   (0)
 
#define NP_ABI_GCC3_MASK   0x10000000
 
#define NP_ABI_MACHO_MASK   0x01000000
 
#define NP_ABI_MASK   (_NP_ABI_MIXIN_FOR_GCC3 | _NP_ABI_MIXIN_FOR_MACHO)
 
#define NP_ASFILE   3
 
#define NP_ASFILEONLY   4
 
#define NP_EABORT   NP_EABORT_is_obsolete_use_NPRES_USER_BREAK
 
#define NP_EINVAL   NP_EINVAL_is_obsolete_use_NPERR_GENERIC_ERROR
 
#define NP_EMBED   1
 
#define NP_FULL   2
 
#define NP_INFO_CompanyName   7
 
#define NP_INFO_FileDescription   5
 
#define NP_INFO_FileExtents   4
 
#define NP_INFO_FileOpenName   3
 
#define NP_INFO_FileVersion   8
 
#define NP_INFO_InternalName   9
 
#define NP_INFO_LegalCopyright   10
 
#define NP_INFO_MIMEType   2
 
#define NP_INFO_OriginalFilename   11
 
#define NP_INFO_ProductName   6
 
#define NP_INFO_ProductVersion   1
 
#define NP_LOADDS
 
#define NP_MAXREADY   (((unsigned)(~0)<<1)>>1)
 
#define NP_NOERR   NP_NOERR_is_obsolete_use_NPERR_NO_ERROR
 
#define NP_NORMAL   1
 
#define NP_SEEK   2
 
#define NP_VERSION_MAJOR   0
 
#define NP_VERSION_MINOR   13
 
#define NPERR_BASE   0
 
#define NPERR_FILE_NOT_FOUND   (NPERR_BASE + 11)
 
#define NPERR_GENERIC_ERROR   (NPERR_BASE + 1)
 
#define NPERR_INCOMPATIBLE_VERSION_ERROR   (NPERR_BASE + 8)
 
#define NPERR_INVALID_FUNCTABLE_ERROR   (NPERR_BASE + 3)
 
#define NPERR_INVALID_INSTANCE_ERROR   (NPERR_BASE + 2)
 
#define NPERR_INVALID_PARAM   (NPERR_BASE + 9)
 
#define NPERR_INVALID_PLUGIN_DIR_ERROR   (NPERR_BASE + 7)
 
#define NPERR_INVALID_PLUGIN_ERROR   (NPERR_BASE + 6)
 
#define NPERR_INVALID_URL   (NPERR_BASE + 10)
 
#define NPERR_MODULE_LOAD_FAILED_ERROR   (NPERR_BASE + 4)
 
#define NPERR_NO_DATA   (NPERR_BASE + 12)
 
#define NPERR_NO_ERROR   (NPERR_BASE + 0)
 
#define NPERR_OUT_OF_MEMORY_ERROR   (NPERR_BASE + 5)
 
#define NPERR_STREAM_NOT_SEEKABLE   (NPERR_BASE + 13)
 
#define NPRES_BASE   0
 
#define NPRES_DONE   (NPRES_BASE + 0)
 
#define NPRES_NETWORK_ERR   (NPRES_BASE + 1)
 
#define NPRES_USER_BREAK   (NPRES_BASE + 2)
 
#define NPVERS_68K_HAS_LIVECONNECT   11
 
#define NPVERS_HAS_LIVECONNECT   9
 
#define NPVERS_HAS_NOTIFICATION   9
 
#define NPVERS_HAS_STREAMOUTPUT   8
 
#define NPVERS_HAS_WINDOWLESS   11
 
#define NPVERS_HAS_XPCONNECT_SCRIPTING   13
 
#define NPVERS_WIN16_HAS_LIVECONNECT   9
 
#define NULL   (0L)
 
#define TRUE   (1)
 

Typedef Documentation

typedef unsigned char NPBool
 
typedef struct _NPByteRange NPByteRange
 
typedef struct _NPEmbedPrint NPEmbedPrint
 
typedef int16 NPError
 
typedef void* NPEvent
 
typedef struct _NPFullPrint NPFullPrint
 
typedef char* NPMIMEType
 
typedef NPP_t* NPP
 
typedef struct _NPP NPP_t
 
typedef struct _NPPrint NPPrint
 
typedef int16 NPReason
 
typedef struct _NPRect NPRect
 
typedef void* NPRegion
 
typedef struct _NPSavedData NPSavedData
 
typedef struct _NPSize NPSize
 
typedef struct _NPStream NPStream
 
typedef struct _NPWindow NPWindow
 

Enumeration Type Documentation

enum NPNVariable
 
Enumerator:
NPNVxDisplay 
NPNVxtAppContext 
NPNVnetscapeWindow 
NPNVjavascriptEnabledBool 
NPNVasdEnabledBool 
NPNVisOfflineBool 
NPNVserviceManager 
NPNVDOMElement 
NPNVDOMWindow 
NPNVToolkit 
NPNVSupportsXEmbedBool 
NPNVWindowNPObject 
NPNVPluginElementNPObject 
enum NPPVariable
 
Enumerator:
NPPVpluginNameString 
NPPVpluginDescriptionString 
NPPVpluginWindowBool 
NPPVpluginTransparentBool 
NPPVjavaClass 
NPPVpluginWindowSize 
NPPVpluginTimerInterval 
NPPVpluginScriptableInstance 
NPPVpluginScriptableIID 
NPPVjavascriptPushCallerBool 
NPPVpluginKeepLibraryInMemory 
NPPVpluginNeedsXEmbed 
NPPVpluginScriptableNPObject 
NPPVPluginFocusPosition 
NPPVPluginDeactivate 
NPPVPluginOpenInViewer 
NPPVpluginInteractiveBool 
enum NPWindowType
 
Enumerator:
NPWindowTypeWindow 
NPWindowTypeDrawable 

Function Documentation

NPError NPN_DestroyStream NPP  instance,
NPStream stream,
NPReason  reason
 
void NPN_ForceRedraw NPP  instance  ) 
 
NPError NPN_GetURL NPP  instance,
const char *  url,
const char *  target
 
NPError NPN_GetURLNotify NPP  instance,
const char *  url,
const char *  target,
void *  notifyData
 
NPError NPN_GetValue NPP  instance,
NPNVariable  variable,
void *  value
 
void NPN_InvalidateRect NPP  instance,
NPRect invalidRect
 
void NPN_InvalidateRegion NPP  instance,
NPRegion  invalidRegion
 
void* NPN_MemAlloc uint32  size  ) 
 
uint32 NPN_MemFlush uint32  size  ) 
 
void NPN_MemFree void *  ptr  ) 
 
NPError NPN_NewStream NPP  instance,
NPMIMEType  type,
const char *  target,
NPStream **  stream
 
NPError NPN_PostURL NPP  instance,
const char *  url,
const char *  target,
uint32  len,
const char *  buf,
NPBool  file
 
NPError NPN_PostURLNotify NPP  instance,
const char *  url,
const char *  target,
uint32  len,
const char *  buf,
NPBool  file,
void *  notifyData
 
void NPN_ReloadPlugins NPBool  reloadPages  ) 
 
NPError NPN_RequestRead NPStream stream,
NPByteRange rangeList
 
NPError NPN_SetValue NPP  instance,
NPPVariable  variable,
void *  value
 
void NPN_Status NPP  instance,
const char *  message
 
const char* NPN_UserAgent NPP  instance  ) 
 
void NPN_Version int *  plugin_major,
int *  plugin_minor,
int *  netscape_major,
int *  netscape_minor
 
int32 NPN_Write NPP  instance,
NPStream stream,
int32  len,
void *  buffer
 
NPError NPP_Destroy NPP  instance,
NPSavedData **  save
 
NPError NPP_DestroyStream NPP  instance,
NPStream stream,
NPReason  reason
 
NPError NPP_GetValue NPP  instance,
NPPVariable  variable,
void *  value
 
int16 NPP_HandleEvent NPP  instance,
void *  event
 
NPError NPP_Initialize void   ) 
 
NPError NPP_New NPMIMEType  pluginType,
NPP  instance,
uint16  mode,
int16  argc,
char *  argn[],
char *  argv[],
NPSavedData saved
 
NPError NPP_NewStream NPP  instance,
NPMIMEType  type,
NPStream stream,
NPBool  seekable,
uint16 stype
 
void NPP_Print NPP  instance,
NPPrint platformPrint
 
NPError NPP_SetValue NPP  instance,
NPNVariable  variable,
void *  value
 
NPError NPP_SetWindow NPP  instance,
NPWindow window
 
void NPP_Shutdown void   ) 
 
void NPP_StreamAsFile NPP  instance,
NPStream stream,
const char *  fname
 
void NPP_URLNotify NPP  instance,
const char *  url,
NPReason  reason,
void *  notifyData
 
int32 NPP_Write NPP  instance,
NPStream stream,
int32  offset,
int32  len,
void *  buffer
 
int32 NPP_WriteReady NPP  instance,
NPStream stream
 

Copyright © Nokia Corporation 2001-2008
Back to top