Public Member Functions | Public Attributes

nsICommandLineRunner Interface Reference

Extension of nsICommandLine that allows for initialization of new command lines and running the command line actions by processing the command line handlers. More...

import "nsICommandLineRunner.idl";

Inheritance diagram for nsICommandLineRunner:
Collaboration diagram for nsICommandLineRunner:

List of all members.

Public Member Functions

void init (in long argc, in nsCharPtrArray argv, in nsIFile workingDir, in unsigned long state)
 This method assumes a native character set, and is meant to be called with the argc/argv passed to main().
void setWindowContext (in nsIDOMWindow aWindow)
 Set the windowContext parameter.
void run ()
 Process the command-line handlers in the proper order, calling "handle()" on each.

Public Attributes

readonly attribute AUTF8String helpText
 Process and combine the help text provided by each command-line handler.

Detailed Description

Extension of nsICommandLine that allows for initialization of new command lines and running the command line actions by processing the command line handlers.

Status:
INTERNAL - This interface is not meant for use by embedders, and is not intended to be frozen. If you are an embedder and need functionality provided by this interface, talk to Benjamin Smedberg <benjamin@smedbergs.us>.

Member Function Documentation

void nsICommandLineRunner::init ( in long  argc,
in nsCharPtrArray  argv,
in nsIFile  workingDir,
in unsigned long  state 
)

This method assumes a native character set, and is meant to be called with the argc/argv passed to main().

Talk to bsmedberg if you need to create a command line using other data. argv will not be altered in any way.

On Windows, the "native" character set is UTF-8, not the native codepage.

Parameters:
workingDir The working directory for resolving file and URI paths.
state The nsICommandLine.state flag.
void nsICommandLineRunner::run (  ) 

Process the command-line handlers in the proper order, calling "handle()" on each.

Exceptions:
NS_ERROR_ABORT if any handler throws NS_ERROR_ABORT. All other errors thrown by handlers will be silently ignored.
void nsICommandLineRunner::setWindowContext ( in nsIDOMWindow  aWindow  ) 

Set the windowContext parameter.


Member Data Documentation

readonly attribute AUTF8String nsICommandLineRunner::helpText

Process and combine the help text provided by each command-line handler.


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