Structures

This list is a quick reference to the structures used by the Plug-in API. Each structure name links to a reference entry.

NPAnyCallbackStruct

NPByteRange 

NPEmbedPrint 

NPEvent

NPFullPrint 

NPP

NP_Port 

NPPrint 

NPPrintCallbackStruct

NP_Rect

NP_Region

NPSavedData 

NPSetWindowCallbackStruct

NPStream 

NPWindow 

[Top] [Structures]

NPAnyCallbackStruct

 Contains information required during embedded mode printing

Syntax

typedef struct
{
    int32 type;
} NPAnyCallbackStruct;

Fields

Description

During printing in embedded mode, the platformPrint field of the NPEmbedPrint structure points to an NPAnyCallbackStruct. This structure contains the file pointer to which the plug-in should write its Postscript data. At the time the plug-in is called, Navigator has already opened the file and written Postscript for other parts of the page. When the plug-in is done, it should leave the file open, as Navigator can continue to write additional Postscript data to the file.

See Also

NPP_Print, NPEmbedPrint, NPSetWindowCallbackStruct, NPPrintCallbackStruct

[Top] [Structures]

NPByteRange

Syntax

typedef struct _NPByteRange
{
    int32  offset;  /* negative offset = from the end */
    uint32 length;
    struct _NPByteRange* next;
} NPByteRange;

Fields

offset

length

next

Description

 The plug-in is responsible for deleting NPByteRange objects when finished with them. Communicator makes a copy if it needs to keep the objects beyond the call to NPN_RequestRead.

See Also

NPN_RequestRead

NPEmbedPrint

Syntax

typedef struct _NPEmbedPrint
{
    NPWindow window;
    void*    platformPrint;  /* Platform-specific */
} NPEmbedPrint;

Fields

window

platformPrint

Description

Unix

See Also

NPFullPrint, NP_Port, NPP_Print, NPPrint, NPPrintCallbackStruct

NPEvent

Represents an event passed by NPP_HandleEvent to a windowless plug-in

Syntax

• MS Windows syntax
• Mac OS syntax
• XWindows syntax

MS Windows

typedef struct _NPEvent
{
    uint16 event;
    uint32 wParam;
    uint32 lParam;
} NPEvent;

Mac OS

typedef EventRecord NPEvent;
TYPE EventRecord =
    RECORD {
       what:      Integer;
       message:   LongInt;
       when:      LongInt;
       where:     Point;
       modifiers: Integer;
    END;

XWindows

typedef XEvent NPEvent;

Fields

• MS Windows fields
• Mac OS fields
• XWindows

NPEvent on MS Windows

event

wParam

lParam

EventRecord NPEvent on Mac OS

what

0 nullEvent 

1 mouseDown 

2 mouseUp 

3 keyDown 

4 keyUp 

5 autoKey 

6 updateEvt 

7 diskEvt 

8 activateEvt

15 osEvt

23 kHighLevelEvent

getFocusEvent 0, 1 (true, false)

loseFocusEvent

adjustCursorEvent 0, 1 (true, false)

message

when

where

modifiers

Description

• MS Windows Description


• Mac OS Description


• XWindows Description

MS Windows Description

Mac OS Description

• Mouse events: Sent if the mouse is within the bounds of the instance.
• Key events: Sent if the instance has text focus (see below).
• Update events: Sent if the update region intersects the instance's bounds.
• Activate events: Sent to all instances in the window being activate or deactivated.
• Suspend/Resume events: Sent to all instances in all windows.
• Null events: Sent to all instances in all windows.

• getFocusEvent: Sent when the instance could become the focus of subsequent key events, when the user clicks the instance or presses the tab key to focus the instance.
• If your instance accepts key events, return true, and key events will be sent to the instance until it receives a loseFocusEvent.


• If your plug-in ignores key events, return false, and the key events will be processed by Netscape itself.
• loseFocusEvent: Sent when the instance has lost the text focus, as a result of the user clicking elsewhere on the page or pressing the Tab key to move the focus. No key events are sent to the instance until the next getFocusEvent.
• adjustCursorEvent: Send when the mouse enters or leaves the bounds of the instance.
• If your plug-in wants to set the cursor when the mouse is within the instance, set the cursor and return true.


• If you don't want a special cursor, return false and Netscape will use the standard arrow cursor.

XWindows Description

See Also

NPP_HandleEvent

NPFullPrint

Syntax

typedef struct _NPFullPrint
{
    NPBool pluginPrinted; /* true: print fullscreen */
    NPBool printOne;      /* true: print one copy */
                          /*       to default printer */
    void*  platformPrint; /* Platform-specific */
} NPFullPrint;

Fields

pluginPrinted

printOne

platformPrint

Description

 The pluginPrinted field of this structure determines whether the plug-in prints in full-page mode or not. If you want the plug-in to take complete control of the printing process, it should print the full page and set the field pluginPrinted to true before returning.

If you want an embedded plug-in to simply render its area of the page, set pluginPrinted to false and return immediately; Communicator calls NPP_Print again with the NPEmbedPrint substructure of NPPrint.

See Also

NPP_Print, NPPrint, NPEmbedPrint

NPP

Syntax

typedef struct _NPP
{
    void* pdata; /* plug-in private data */
    void* ndata; /* Netscape private data */
} NPP_t;
typedef NPP_t*  NPP;

Fields

pdata

ndata

Description

The NPP_Destroy function informs the plug-in when the NPP instance is about to be deleted; after this call returns, the NPP pointer is no longer valid.

See Also

NPP_New, NPP_Destroy

NP_Port

Contains information required by the window field of an NPWindow structure

Syntax

typedef struct NP_Port
{
    CGrafPtr port;  /* Grafport */
    int32    portx; /* position inside the topmost window */
    int32    porty;
} NP_Port;

Fields

port

portx, porty

Description

Since the port is shared between the plug-in and other plug-ins and Communicator, the plug-in should always do the following:

• Draw only within the area designated by the NPWindow.
• Save the current port settings before changing the port for drawing.
• Set the desired port settings before drawing.
• Restore the previous port settings after drawing.

See Also

NPP_SetWindow, NPWindow

NPPrint

Syntax

typedef struct _NPPrint
{
    uint16 mode;   /* NP_FULL or NP_EMBED */
    union
    {
        NPFullPrint fullPrint;   /* if mode is NP_FULL */
        NPEmbedPrint embedPrint; /* if mode is NP_EMBED */
    } print;
} NPPrint;

Fields

mode

Description

See Also

NPP_Print, NPFullPrint, NPEmbedPrint

NPPrintCallbackStruct

Contains information required by the platformPrint field of the NPEmbedPrint during embedded mode printing

Syntax

typedef struct
{
    int32  type;
    FILE*  fp;
} NPPrintCallbackStruct;

Fields

type

fp

Description

At the time the plug-in is called, Navigator has already opened the file and written Postscript for other parts of the page. When the plug-in is done, it should leave the file open, as Navigator can continue to write additional Postscript data to the file.

See Also

NPP_Print, NPEmbedPrint, NPSetWindowCallbackStruct, NPAnyCallbackStruct

NP_Rect

Syntax

typedef struct _NPRect
{
    uint16 top;
    uint16 left;
    uint16 bottom;
    uint16 right;
} NPRect;

Fields

top, left, bottom, right

Description

See Also

NPN_ForceRedraw, NPN_InvalidateRect, NPN_InvalidateRegion, NP_Region, NPWindow

NP_Region

Represents a platform-defined region of a page

Syntax

typedef HRGN NPRegion;

typedef RgnHandle NPRegion;

typedef Region NPRegion;

Description

See Also

NPN_ForceRedraw, NPN_InvalidateRect, NPN_InvalidateRegion, NP_Rect, NPWindow

NPSavedData

Syntax

typedef struct _NPSavedData
{
    int32  len;
    void*  buf;
} NPSavedData;

Fields

len

buf

Description

You can use the plug-in's NPP_Destroy function to allocate an NPSavedData object using the NPN_MemAlloc function, fill in the fields, and return it to Communicator as an output parameter. See "Instance Destruction" for a code example that shows how to use NPSavedData.

If the user revisits a web page that contains a plug-in, Communicator returns the NPSavedData to the new instance of the plug-in in a call to NPP_New. After this, the plug-in is responsible for keeping or deleting the objects as necessary.

See Also

NPP_New, NPP_Destroy

NPSetWindowCallbackStruct

Contains information about the plug-in's Unix window environment

Syntax

typedef struct
{
    int32         type;
    Display*      display;
    Visual*       visual;
    Colormap      colormap;
    unsigned int  depth;
} NPSetWindowCallbackStruct;

Fields

Description

The NPP_SetWindow function passes a pointer to this structure to the plug-in. The structure is valid for the lifetime of the NPWindow, that is, until NPP_SetWindow is called again or the instance is destroyed.

The type field of this structure always contains NP_SetWindow. The remaining fields are Standard X Toolkit attributes of the top-level shell window in the Netscape window hierarchy.

See Also

NPP_SetWindow, NPWindow, NPPrintCallbackStruct, NPAnyCallbackStruct

NPStream

Syntax

typedef struct _NPStream

{
    void* pdata;    /* plug-in private data */
    void* ndata;    /* Netscape private data */
    const char* url;
    uint32      end;
    uint32      lastmodified;
    void*       notifyData;
} NPStream;

Fields

ndata

url

end

lastmodified

notifyData

• For these streams, notifyData is set to the value of the notifyData parameter to NPN_GetURLNotify or NPN_PostURLNotify. 
• For other streams, notifyData is null. 

Description

Streams produced by Communicator: Communicator creates the NPStream object and passes it to the plug-in initially as a parameter to NPP_NewStream. All API calls that operate on the stream (such as NPP_WriteReady and NPP_Write) use a pointer to this stream. Communicator informs the plug-in when the stream is about to be deleted through NPP_DestroyStream, after which the NPStream object is no longer valid.

Streams produced by the plug-in: Communicator creates the NPStream object and returns it as an output parameter when the plug-in calls NPP_NewStream. The plug-in must pass a pointer to the NPStream to all API calls that operate on the stream, such as NPN_Write and NPN_DestroyStream.

See Also

NPP_NewStream, NPN_DestroyStream, NPP_NewStream, NPP_DestroyStream

NPWindow

Syntax

typedef struct _NPWindow
{
    void*     window;   /* Platform specific handle */
    uint32    x;        /* Coordinates of top left corner */
    uint32    y;        /*   relative to a Netscape page */
    uint32    width;    /* Maximum window size */
    uint32    height;
    NPRect    clipRect; /* Clipping rectangle coordinates */
                        /*   in port - Used by Mac only */
#ifdef XP_UNIX
    void *    ws_info;  /* Platform-dependent additional data */
#endif /* XP_UNIX */
    NPWindowType type;   /* Window or drawable target */
} NPWindow;

Fields

window

x, y

height, width

clipRect

ws_info

type

Description

Communicator calls NPP_SetValue whenever the drawable changes.

A windowed plug-in is drawn into a native window (or portion of a native window) on a web page. For windowed plug-ins, Communicator calls the NPP_SetWindow method with an NPWindow structure that represents a drawable (a pointer to an NPWindow allocated by Communicator). This window is valid until NPP_SetWindow is called again with a different window or the instance is destroyed.

A windowless plug-in is drawn into a target called a drawable, which can be defined in several ways depending on the platform. For windowless plug-ins, Communicator calls the NPP_SetWindow method with an NPWindow structure that represents a drawable.

The plug-in should not modify the field values in this structure.

See Also

NPP_SetWindow, NP_Port, NPSetWindowCallbackStruct, NP_Rect

Constants and Definitions

This section is a reference to the program definitions used by the Plug-in API. All program definitions are found in npapi.h.

[Top] [Constants and Definitions]

Definition of Basic Types

_UINT16

_UINT32

_INT16

short int16

_INT32

false

0

true

1

null

0L

NPBool

unsigned char

NPError

int16

NPReason

int16

NPMIMEType

char*

[Top] [Constants and Definitions]

Error Codes

Return values of type NPError. See Definition of Basic Types for a definition of the NPError type.

NPERR_NO_ERROR 

0

NPERR_GENERIC_ERROR 

1

NPERR_INVALID_INSTANCE_ERROR 

2

NPERR_INVALID_FUNCTABLE_ERROR 

3

NPERR_MODULE_LOAD_FAILED_ERROR

4

NPERR_OUT_OF_MEMORY_ERROR

5

NPERR_INVALID_PLUGIN_ERROR 

6

NPERR_INVALID_PLUGIN_DIR_ERROR

7

NPERR_INCOMPATIBLE_VERSION_ERROR

8

NPERR_INVALID_PARAM 

9

NPERR_INVALID_URL         

10

NPERR_FILE_NOT_FOUND     

11

NPERR_NO_DATA          

12

NPERR_STREAM_NOT_SEEKABLE 

13

[Top] [Constants and Definitions]

Result Codes

Result values of type NPReason. Used by NPP_DestroyStream.

NPRES_DONE 

0

NPRES_NETWORK_ERR

1

NPRES_USER_BREAK

2

[Top] [Constants and Definitions]

Plug-in Version Constants

NP_VERSION_MAJOR

0

NP_VERSION_MINOR

11

For information about using these constants, see NPN_Version.

[Top] [Constants and Definitions]

Version Feature Constants

For information about using these constants, see NPN_Version and "Getting the Current Version."

8

9

9

9

11

11

[Top] [Constants and Definitions]