Gecko Plugin API Reference

Table of contents

  1. 1. Plug-in Basics
  2. 2. Plug-in Development Overview
  3. 3. Initialization and Destruction
  4. 4. Drawing and Event Handling
  5. 5. Streams
  6. 6. URLs
  7. 7. Memory
  8. 8. Version, UI, and Status Information
  9. 9. Plug-in Side Plug-in API
  10. 10. Browser Side Plug-in API
  11. 11. Scripting plugins
  12. 12. Structures
  13. 13. Constants
  14. 14. External Resources
  15. 15. Original Document Information
Page Notifications Off

Plug-in Side Plug-in API

This chapter describes methods in the plug-in API that are available from the plug-in object. The names of all of these methods begin with NPP_ to indicate that they are implemented by the plug-in and called by the browser. For an overview of how these two sides of the plug-in API interact, see the How Plug-ins Work and Overview of Plug-in Structure sections in the introduction.

Browser Side Plug-in API

This chapter describes methods in the plug-in API that are available from the browser. The names of all of these methods begin with NPN_ to indicate that they are implemented by the browser and called by the plug-in. For an overview of how these two sides of the plug-in API interact, see the How Plug-ins Work and Overview of Plug-in Structure sections in the introduction.

Warning: You must only call these from the main thread; calling them from other threads is not supported and may have unpredictable results.
NPN_DestroyStream
Closes and deletes a stream.
NPN_ForceRedraw
Forces a paint message for a windowless plug-in.
NPN_GetAuthenticationInfo
Requires Gecko 1.9 This function is called by plugins to get HTTP authentication information from the browser.
NPN_GetURL
Asks the browser to create a stream for the specified URL.
NPN_GetURLNotify
Requests creation of a new stream with the contents of the specified URL; gets notification of the result.
NPN_GetValue
Allows the plug-in to query the browser for information.
NPN_GetValueForURL
Requires Gecko 1.9 Provides information to a plugin which is associated with a given URL, for example the cookies or preferred proxy.
NPN_InvalidateRect
Invalidates specified drawing area prior to repainting or refreshing a windowless plug-in.
NPN_InvalidateRegion
Invalidates specified drawing region prior to repainting or refreshing a windowless plug-in.
NPN_MemAlloc
Allocates memory from the browser's memory space.
NPN_MemFlush
Requests that the browser free a specified amount of memory.
NPN_MemFree
Deallocates a block of allocated memory.
NPN_NewStream
Requests the creation of a new data stream produced by the plug-in and consumed by the browser.
NPN_PluginThreadAsyncCall
Requires Gecko 1.9 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).
NPN_PopPopupsEnabledState
Requires Gecko 1.8 Pops the popups-enabled state.
NPN_PostURL
Posts data to a URL.
NPN_PostURLNotify
Posts data to a URL, and receives notification of the result.
NPN_PushPopupsEnabledState
Requires Gecko 1.8 Pushes the popups-enabled state.
NPN_ReloadPlugins
Reloads all plug-ins in the Plugins directory.
NPN_RequestRead
Requests a range of bytes for a seekable stream.
NPN_SetValue
Sets windowless plug-in as transparent or opaque.
NPN_SetValueForURL
Requires Gecko 1.9 Allows a plugin to change the stored information associated with a URL, in particular its cookies.
NPN_Status
Displays a message on the status line of the browser window.
NPN_UserAgent
Returns the browser's user agent field.
NPN_Version
Returns version information for the Plug-in API.
NPN_Write
Pushes data into a stream produced by the plug-in and consumed by the browser.

External Resources

Original Document Information

  • Copyright Information: Netscape Communication

Tags (4)

Edit tags

Attachments (0)

 

Attach file