Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIAppStartup Interface Reference

import "nsIAppStartup.idl";

Inheritance diagram for nsIAppStartup:
Inheritance graph
[legend]
Collaboration diagram for nsIAppStartup:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void createHiddenWindow ()
 Create the hidden window.
void run ()
 Runs an application event loop: normally the main event pump which defines the lifetime of the application.
void enterLastWindowClosingSurvivalArea ()
 During application startup (and at other times!) we may temporarily encounter a situation where all application windows will be closed but we don't want to take this as a signal to quit the app.
void exitLastWindowClosingSurvivalArea ()
void quit (in PRUint32 aMode)
 Exit the event loop, and shut down the app.
void initialize (in nsISupports nativeAppSupportOrSplashScreen)
 Required initialization routine.
void createHiddenWindow ()
 Create the hidden window.
void doProfileStartup (in nsICmdLineService aCmdLineService, in boolean canInteract)
 Starts up the profile manager with the given arguments.
void run ()
 Runs an application event loop: normally the main event pump which defines the lifetime of the application.
void enterLastWindowClosingSurvivalArea ()
 During application startup (and at other times!) we may temporarily encounter a situation where all application windows will be closed but we don't want to take this as a signal to quit the app.
void exitLastWindowClosingSurvivalArea ()
void quit (in PRUint32 aFerocity)
 Exit the event loop, shut down the app.
void hideSplashScreen ()
 Remove the splash screen (if visible).
boolean createStartupState (in long aWindowWidth, in long aWindowHeight)
 Creates the initial state of the application by launching tasks specfied by "general.startup.*" prefs.
void ensure1Window (in nsICmdLineService aCmdLineService)
 Ensures that at least one window exists after creating the startup state.

Public Attributes

const PRUint32 eConsiderQuit = 0x01
 The following flags may be passed as the aMode parameter to the quit method.
const PRUint32 eAttemptQuit = 0x02
 Try to close all windows, then quit if successful.
const PRUint32 eForceQuit = 0x03
 Quit, damnit!
const PRUint32 eRestart = 0x10
 Restart the application after quitting.
readonly attribute
nsINativeAppSupport 
nativeAppSupport
 Getter for "native app support.".

Detailed Description

Definition at line 45 of file nsIAppStartup.idl.


Member Function Documentation

Create the hidden window.

Create the hidden window.

Only bootstrap code (nsAppRunner.cpp) should call this method.

boolean nsIAppStartup::createStartupState ( in long  aWindowWidth,
in long  aWindowHeight 
)

Creates the initial state of the application by launching tasks specfied by "general.startup.*" prefs.

Parameters:
aWindowWidththe width to make the initial window(s) opened
aWindowHeightthe height to make the initial window(s) opened
Note:
SIZE_TO_CONTENT may be used for width or height.
Returns:
TRUE if a window was opened
void nsIAppStartup::doProfileStartup ( in nsICmdLineService  aCmdLineService,
in boolean  canInteract 
)

Starts up the profile manager with the given arguments.

Parameters:
aCmdLineServicethe arguments given to the program
canInteractIf FALSE and UI is needed, will fail

Ensures that at least one window exists after creating the startup state.

If one has not been made, this will create a browser window.

Parameters:
aCmdLineServicethe command line from which startup args can be read.

During application startup (and at other times!) we may temporarily encounter a situation where all application windows will be closed but we don't want to take this as a signal to quit the app.

Bracket the code where the last window could close with these. (And at application startup, on platforms that don't normally quit when the last window has closed, call Enter once, but not Exit)

During application startup (and at other times!) we may temporarily encounter a situation where all application windows will be closed but we don't want to take this as a signal to quit the app.

Bracket the code where the last window could close with these. (And at application startup, on platforms that don't normally quit when the last window has closed, call Enter once, but not Exit)

Remove the splash screen (if visible).

This need be called only once per application session.

void nsIAppStartup::initialize ( in nsISupports  nativeAppSupportOrSplashScreen)

Required initialization routine.

Parameters:
aNativeAppSupportOrSplashScreenThis is an object that can be QI'd to either an nsINativeAppSupport or nsISplashScreen; this object will be used to implement HideSplashScreen.

Exit the event loop, shut down the app.

Exit the event loop, and shut down the app.

Parameters:
aModeThis parameter modifies how the app is shutdown, and it is constructed from the constants defined above.

Runs an application event loop: normally the main event pump which defines the lifetime of the application.

NS_SUCCESS_RESTART_APP This return code indicates that the application should be restarted because quit was called with the eRestart flag.

Runs an application event loop: normally the main event pump which defines the lifetime of the application.


Member Data Documentation

Try to close all windows, then quit if successful.

Definition at line 88 of file nsIAppStartup.idl.

The following flags may be passed as the aMode parameter to the quit method.

One and only one of the "Quit" flags must be specified. The eRestart flag may be bit-wise combined with one of the "Quit" flags to cause the application to restart after it quits. Attempt to quit if all windows are closed.

Definition at line 83 of file nsIAppStartup.idl.

Quit, damnit!

Definition at line 93 of file nsIAppStartup.idl.

Restart the application after quitting.

The application will be restarted with the same profile and an empty command line.

Definition at line 99 of file nsIAppStartup.idl.

Getter for "native app support.".

Definition at line 72 of file nsIAppStartup.idl.


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