Public Member Functions | Public Attributes

nsICommandLineHandler Interface Reference

Handles arguments on the command line of an XUL application. More...

import "nsICommandLineHandler.idl";

List of all members.

Public Member Functions

void handle (in nsICommandLine aCommandLine)
 Process a command line.

Public Attributes

readonly attribute AUTF8String helpInfo
 When the app is launched with the -help argument, this attribute is retrieved and displayed to the user (on stdout).

Detailed Description

Handles arguments on the command line of an XUL application.

Each handler is registered in the category "command-line-handler". The entries in this category are read in alphabetical order, and each category value is treated as a service contractid implementing this interface.

By convention, handler with ordinary priority should begin with "m".

Example: Category Entry Value command-line-handler b-jsdebug .org/venkman/clh;1 command-line-handler c-extensions .org/extension-manager/clh;1 command-line-handler m-edit .org/composer/clh;1 command-line-handler m-irc .org/chatzilla/clh;1 command-line-handler y-final .org/browser/clh-final;1

Status:
UNDER_REVIEW This interface is intended to be frozen, but it isn't frozen yet. Be careful!
Note:
What do we do about localizing helpInfo? Do we make each handler do it, or provide a generic solution of some sort? Don't freeze this interface without thinking about this!

Member Function Documentation

void nsICommandLineHandler::handle ( in nsICommandLine  aCommandLine  ) 

Process a command line.

If this handler finds arguments that it understands, it should perform the appropriate actions (such as opening a window), and remove the arguments from the command-line array.

Exceptions:
NS_ERROR_ABORT to immediately cease command-line handling (if this is STATE_INITIAL_LAUNCH, quits the app). All other exceptions are silently ignored.

Member Data Documentation

readonly attribute AUTF8String nsICommandLineHandler::helpInfo

When the app is launched with the -help argument, this attribute is retrieved and displayed to the user (on stdout).

The text should have embedded newlines which wrap at 76 columns, and should include a newline at the end. By convention, the right column which contains flag descriptions begins at the 24th character.


The documentation for this interface was generated from the following file: