typedef unsigned short | uint16 |
typedef unsigned short | uint16_t |
typedef unsigned long | uint32 |
typedef unsigned long | uint32_t |
typedef short | int16 |
typedef short | int16_t |
typedef int | int32 |
typedef long | int32_t |
typedef long long | int64_t |
typedef unsigned long long | uint64_t |
typedef unsigned char | NPBool |
typedef int16 | NPError |
typedef int16 | NPReason |
typedef const TDesC8 & | NPMIMEType |
typedef struct _NPP | NPP_t |
typedef NPP_t * | NPP |
typedef struct _NPStream | NPStream |
typedef struct _NPByteRange | NPByteRange |
typedef struct _NPSavedData | NPSavedData |
typedef struct _NPRect | NPRect |
typedef struct _NPSize | NPSize |
Enumerator | Value | Description |
---|---|---|
NPFocusNext | 0 | |
NPFocusPrevious | 1 |
typedef struct NPN_GenericElement | GenericEntry |
Enumerator | Value | Description |
---|---|---|
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 | 16 | |
NPNVSupportsWindowless | 17 | |
NPNVprivateModeBool | 18 | |
NPNNetworkAccess | ||
NPNVGenericParameter |
Enumerator | Value | Description |
---|---|---|
NPNURLVCookie | 501 | |
NPNURLVProxy |
Enumerator | Value | Description |
---|---|---|
NPWindowTypeWindow | 1 | |
NPWindowTypeDrawable |
typedef struct _NPWindow | NPWindow |
typedef struct _NPImageExpose | NPImageExpose |
typedef struct _NPFullPrint | NPFullPrint |
typedef struct _NPEmbedPrint | NPEmbedPrint |
typedef struct _NPPrint | NPPrint |
typedef struct _NPEvent | NPEvent |
typedef void * | NPRegion |
typedef struct _NPNSString | NPNSString |
typedef struct _NPNSWindow | NPNSWindow |
typedef struct _NPNSMenu | NPNSMenu |
typedef void * | NPMenu |
NPError | NPP_Initialize | ( | void | ) |
IMPORT_C void | NPP_Shutdown | ( | void | ) |
Shutdown plugin
NPError | NPP_New | ( | NPMIMEType | pluginType, |
NPP | instance, | |||
uint16 | mode, | |||
CDesCArray * | argn, | |||
CDesCArray * | argv, | |||
NPSavedData * | saved | |||
) |
NPError | NPP_Destroy | ( | NPP | instance, |
NPSavedData ** | save | |||
) |
Deletes a specific instance of a plug-in
Parameters | |
---|---|
instance | Pointer to the plug-in instance to delete |
save | State or other information to save for reuse by a new instance of this plug-in at the same URL. Passed to NPP_New |
NPError | NPP_SetWindow | ( | NPP | instance, |
NPWindow * | window | |||
) |
Tells the plug-in when a window is created, moved, sized, or destroyed.
Parameters | |
---|---|
instance | Pointer to the current plug-in instance |
NPError | NPP_NewStream | ( | NPP | instance, |
NPMIMEType | type, | |||
NPStream * | stream, | |||
NPBool | seekable, | |||
uint16 * | stype | |||
) |
Notifies a plug-in instance of a new data stream.
Parameters | |
---|---|
instance | Pointer to the current plug-in instance |
type | Pointer to MIME type of the stream. |
stream | Pointer to new stream. |
seekable | Boolean indicating whether the stream is seekable. |
stype | Requested mode of new stream. NP_NORMAL (Default): Delivers stream data to the instance in a series of calls to NPP_WriteReady and NPP_Write. NP_ASFILEONLY: Saves stream data to a file in the local cache. NP_ASFILE: File download. Like NP_ASFILEONLY except that data is delivered to the plug-in as it is saved to the file (as in mode NP_NORMAL). NP_SEEK: Stream data randomly accessible by the plug-in as needed, through calls to NPN_RequestRead |
Tells the plug-in that a stream is about to be closed or destroyed.
Parameters | |
---|---|
instance | Pointer to the current plug-in instance |
stream | Pointer to current stream. |
reason | Reason the stream was destroyed. NPRES_DONE (Most common): Completed normally; all data was sent to the instance. NPRES_USER_BREAK: User canceled stream directly by clicking the Stop button or indirectly by some action such as deleting the instance or initiating higher-priority network operations. NPRES_NETWORK_ERR: Stream failed due to problems with network, disk I/O, lack of memory, or other problems |
int32 | NPP_WriteReady | ( | NPP | instance, |
NPStream * | stream | |||
) |
Determines maximum number of bytes that the plug-in can consume.
Parameters | |
---|---|
instance | Pointer to the current plug-in instance |
stream | Pointer to current stream. |
Delivers data to a plug-in instance.
Parameters | |
---|---|
instance | Pointer to the current plug-in instance |
stream | Pointer to current stream. |
offset | Offset in bytes of buf from the beginning of the data in the stream. Can be used to check stream progress or bye range requests from NPN_RequestRead. |
len | Length in bytes of buf; number of bytes accepted. |
buffer | Buffer of data, delivered by the stream, that contains len bytes of data offset bytes from the start of the stream. The buffer is allocated by the browser and is deleted after returning from the function, so the plug-in should make a copy of the data it needs to keep. |
void | NPP_StreamAsFile | ( | NPP | instance, |
NPStream * | stream, | |||
const TDesC & | fname | |||
) |
void | NPP_Print | ( | NPP | instance, |
NPPrint * | platformPrint | |||
) |
Requests a platform-specific print operation for an embedded or full-screen plug-in.
Parameters | |
---|---|
instance | Pointer to the current plug-in instance |
int16_t | NPP_HandleEvent | ( | NPP | instance, |
void * | event | |||
) |
Delivers a platform-specific window event to the instance.
Parameters | |
---|---|
instance | Pointer to the current plug-in instance |
event | Platform-specific value representing the event handled by the function. |
NPError | NPP_GetValue | ( | NPP | instance, |
NPPVariable | variable, | |||
void * | value | |||
) |
Allows the browser to query the plug-in for information.
Parameters | |
---|---|
instance | Pointer to the current plug-in instance |
variable | Plug-in information the call gets. |
value | Value of the variable |
NPError | NPP_SetValue | ( | NPP | instance, |
NPNVariable | variable, | |||
void * | value | |||
) |
Sets information about the plug-in.
Parameters | |
---|---|
instance | Pointer to the current plug-in instance |
variable | Plug-in information the call gets. |
value | Value of the variable |
NPBool | NPP_GotFocus | ( | NPP | instance, |
NPFocusDirection | direction | |||
) |
void | NPP_LostFocus | ( | NPP | instance | ) |
void | NPP_URLRedirectNotify | ( | NPP | instance, |
const char * | url, | |||
int32_t | status, | |||
void * | notifyData | |||
) |
char ** | NPP_GetSitesWithData | ( | void | ) |
NPError | NPN_PostURLNotify | ( | NPP | instance, |
const TDesC & | url, | |||
const TDesC * | target, | |||
const TDesC & | buf, | |||
NPBool | file, | |||
void * | notifyData | |||
) |
NPError | NPN_PostURL | ( | NPP | instance, |
const TDesC & | url, | |||
const TDesC * | target, | |||
const TDesC & | buf, | |||
NPBool | file | |||
) |
NPError | NPN_NewStream | ( | NPP | instance, |
NPMIMEType | type, | |||
const TDesC * | target, | |||
NPStream ** | stream | |||
) |
NPError | NPN_RequestRead | ( | NPStream * | stream, |
NPByteRange * | rangeList | |||
) |
Requests a range of bytes for a seekable stream
Closes and deletes a stream.
Parameters | |
---|---|
instance | Pointer to the current plug-in instance |
stream | Pointer to current stream. |
reason | Reason the stream was stopped so the application can give the user appropriate feedback. Values: NPRES_DONE (most common): Stream completed normally; all data was sent by the plug-in to the browser. NPRES_USER_BREAK: Plug-in is terminating the stream due to a user request. NPRES_NETWORK_ERR: Stream failed due to network problems |
void | NPN_Status | ( | NPP | instance, |
const TDesC & | message | |||
) |
const TDesC * | NPN_UserAgent | ( | NPP | instance | ) |
Returns the browser's user agent field
The user agent is the part of the HTTP header that identifies the browser during transfers. You can use this information to verify that the expected browser is in use, or you can use it in combination with NPN_Version to supply different code for different versions of Netscape browsers
Parameters | |
---|---|
instance | Pointer to the current plug-in instance |
void * | NPN_MemAlloc | ( | uint32 | size | ) |
Allocates memory from the browser's memory space.
Size of memory, in bytes, to allocate in the browser's memory space
void | NPN_MemFree | ( | void * | ptr | ) |
Deallocates a block of allocated memory.
Block of memory previously allocated using NPN_MemAlloc
Requests that the browser free a specified amount of memory
Size of memory, in bytes, to free in the browser's memory space.
void | NPN_ReloadPlugins | ( | NPBool | reloadPages | ) |
Reloads all plug-ins in the Plugins directory.
Whether to reload pages. Values: true: Reload pages. false: Do not reload pages
void * | NPN_GetJavaEnv | ( | void | ) |
Get java runtime environment
void * | NPN_GetJavaPeer | ( | NPP | instance | ) |
Get java runtime peer
NPError | NPN_GetValue | ( | NPP | instance, |
NPNVariable | variable, | |||
void * | value | |||
) |
Allows the browser to query the plug-in for information.
Parameters | |
---|---|
instance | Pointer to the current plug-in instance |
variable | Plug-in information the call gets. |
value | Value of the variable |
NPError | NPN_SetValue | ( | NPP | instance, |
NPPVariable | variable, | |||
void * | value | |||
) |
Sets various modes of plug-in operation.
Parameters | |
---|---|
instance | Pointer to the current plug-in instance |
variable | Variable to be set |
value | Value of the variable |
void | NPN_InvalidateRect | ( | NPP | instance, |
NPRect * | invalidRect | |||
) |
Invalidates specified drawing area prior to repainting or refreshing a windowless plug-in.
Parameters | |
---|---|
instance | Pointer to the current plug-in instance |
invalidRect | The area to invalidate, specified in a coordinate system that originates at the top left of the plug-in. |
void | NPN_InvalidateRegion | ( | NPP | instance, |
NPRegion | invalidRegion | |||
) |
Invalidates specified drawing region prior to repainting or refreshing a windowless plug-in
Parameters | |
---|---|
instance | Pointer to the current plug-in instance |
invalidRegion | The area to invalidate, specified in a coordinate system that originates at the top left of the plug-in |
void | NPN_ForceRedraw | ( | NPP | instance | ) |
Forces a paint message for a windowless plug-in.
Parameters | |
---|---|
instance | Pointer to the current plug-in instance |
void | NPN_PushPopupsEnabledState | ( | NPP | instance, |
NPBool | enabled | |||
) |
Push popup enabled state
Parameters | |
---|---|
instance | The NPP indicating which plugin instance's is making the request |
enabled | true enable popup, false disable popup |
void | NPN_PopPopupsEnabledState | ( | NPP | instance | ) |
Pop popup enabled state
Parameters | |
---|---|
instance | The NPP indicating which plugin instance's is making the request |
void | NPN_PluginThreadAsyncCall | ( | NPP | instance, |
void(*)(void *) | func, | |||
void * | userData | |||
) |
Thread safe way to request that the browser calls a plugin function on the browser or plugin thread (the thread on which the plugin was initiated
Parameters | |
---|---|
func | Pointer to the function to call on the correct thread |
userData | Pointer to the data to pass to the function func once called |
NPError | NPN_GetValueForURL | ( | NPP | instance, |
NPNURLVariable | variable, | |||
const char * | url, | |||
char ** | value, | |||
uint32_t * | len | |||
) |
NPError | NPN_SetValueForURL | ( | NPP | instance, |
NPNURLVariable | variable, | |||
const char * | url, | |||
const char * | value, | |||
uint32_t | len | |||
) |
NPError | NPN_GetAuthenticationInfo | ( | NPP | instance, |
const char * | protocol, | |||
const char * | host, | |||
int32_t | port, | |||
const char * | scheme, | |||
const char * | realm, | |||
char ** | username, | |||
uint32_t * | ulen, | |||
char ** | password, | |||
uint32_t * | plen | |||
) |
uint32_t | NPN_ScheduleTimer | ( | NPP | instance, |
uint32_t | interval, | |||
NPBool | repeat, | |||
void(*)(NPP npp, uint32_t timerID) | timerFunc | |||
) |
void | NPN_UnscheduleTimer | ( | NPP | instance, |
uint32_t | timerID | |||
) |
NPBool | NPN_ConvertPoint | ( | NPP | instance, |
double | sourceX, | |||
double | sourceY, | |||
NPCoordinateSpace | sourceSpace, | |||
double * | destX, | |||
double * | destY, | |||
NPCoordinateSpace | destSpace | |||
) |