Gecko Plugin API Reference

Note: This document is in the process of being migrated. If you would like to help with this migration, please migrate from devedge-temp.


About This Guide
Who Should Read This Guide
The Plug-in Software Development Kit

Plug-in Basics

How Plug-ins Are Used
Plug-ins and Helper Applications
How Plug-ins Work
Understanding the Runtime Model
Plug-in Detection
How Gecko Finds Plug-ins
Checking Plug-ins by MIME Type
Overview of Plug-in Structure
Understanding the Plug-in API
Plug-ins and Platform Independence
Windowed and Windowless Plug-ins
The Default Plug-in
Using HTML to Display Plug-ins
Plug-in Display Modes
Using the OBJECT Tag for Plug-in Display
Nesting Rules for HTML Elements
Using the Appropriate Attributes
Using the EMBED Tag for Plug-in Display
Using Custom EMBED Attributes
Plug-in References

Plug-in Development Overview

Writing Plug-ins
Registering Plug-ins
MS Windows
Mac OS
Drawing a Plug-in Instance
Handling Memory
Sending and Receiving Streams
Working with URLs
Getting Version and UI Information
Displaying Messages on the Status Line
Making Plug-ins Scriptable
Building Plug-ins
Building, Platforms, and Compilers
Building Carbonized Plug-ins for Mac OSX
Getting and Using the xpidl Compiler
Type Libraries
Installing Plug-ins
Native Installers
XPI Plug-ins Installations
Plug-in Installation and the Windows Registry

Initialization and Destruction

Instance Creation
Instance Destruction
Initialize and Shutdown Example

Drawing and Event Handling

The NPWindow Structure
Drawing Plug-ins
Printing the Plug-in
Setting the Window
Getting Information
Windowed Plug-ins
Mac OS
Event Handling for Windowed Plug-ins
Windowless Plug-ins
Specifying That a Plug-in Is Windowless
Invalidating the Drawing Area
Forcing a Paint Message
Making a Plug-in Opaque
Making a Plug-in Transparent
Creating Pop-up Menus and Dialog Boxes
Event Handling for Windowless Plug-ins



Getting URLs
Getting the URL and Displaying the Page
Posting URLs
Posting Data to an HTTP Server
Uploading Files to an FTP Server
Sending Mail


Version, UI, and Status Information

Displaying a Status Line Message
Getting Agent Information
Getting the Current Version
Finding Out if a Feature Exists
Reloading a Plug-in

Plug-in Side Plug-in API

Browser Side Plug-in API