nsIShellService Interface Reference


Inheritance diagram for nsIShellService:
Collaboration diagram for nsIShellService:

Public Member Functions

boolean isDefaultBrowser (in boolean aStartupCheck)
void setDefaultBrowser (in boolean aClaimAllTypes, in boolean aForAllUsers)
void setDesktopBackground (in nsIDOMElement aElement, in long aPosition)
void openApplication (in long aApplication)
void openApplicationWithURI (in nsILocalFile aApplication, in ACString aURI)

Public Attributes

attribute boolean shouldCheckDefaultBrowser
const long BACKGROUND_TILE = 1
const long BACKGROUND_CENTER = 3
const long BACKGROUND_FILL = 4
const long APPLICATION_MAIL = 0
const long APPLICATION_NEWS = 1
attribute unsigned long desktopBackgroundColor
readonly attribute nsILocalFile defaultFeedReader

Detailed Description

Definition at line 44 of file nsIShellService.idl.

Member Function Documentation

boolean nsIShellService::isDefaultBrowser ( in boolean  aStartupCheck)

Determines whether or not Firefox is the "Default Browser." This is simply whether or not Firefox is registered to handle http links.

aStartupChecktrue if this is the check being performed by the first browser window at startup, false otherwise.
void nsIShellService::openApplication ( in long  aApplication)

Opens the application specified. If more than one application of the given type is available on the system, the default or "preferred" application is used.

void nsIShellService::openApplicationWithURI ( in nsILocalFile  aApplication,
in ACString  aURI 

Opens an application with a specific URI to load.

applicationThe application file (or bundle directory, on OS X)
uriThe uri to be loaded by the application
void nsIShellService::setDefaultBrowser ( in boolean  aClaimAllTypes,
in boolean  aForAllUsers 

Registers Firefox as the "Default Browser."

aClaimAllTypesRegister Firefox as the handler for additional protocols (ftp, chrome etc) and web documents (.html, .xhtml etc).
aForAllUsersWhether or not Firefox should attempt to become the default browser for all users on a multi-user system.
void nsIShellService::setDesktopBackground ( in nsIDOMElement  aElement,
in long  aPosition 

Sets the desktop background image using either the HTML element supplied or the background image of the element supplied.

aImageElementEither a HTML element or an element with a background image from which to source the background image.
aPositionHow to place the image on the desktop

Member Data Documentation

const long nsIShellService::APPLICATION_MAIL = 0

Constants identifying applications that can be opened with openApplication.

Definition at line 100 of file nsIShellService.idl.

const long nsIShellService::APPLICATION_NEWS = 1

Definition at line 101 of file nsIShellService.idl.

const long nsIShellService::BACKGROUND_CENTER = 3

Definition at line 82 of file nsIShellService.idl.

const long nsIShellService::BACKGROUND_FILL = 4

Definition at line 83 of file nsIShellService.idl.

const long nsIShellService::BACKGROUND_STRETCH = 2

Definition at line 81 of file nsIShellService.idl.

const long nsIShellService::BACKGROUND_TILE = 1

Flags for positioning/sizing of the Desktop Background image.

Definition at line 80 of file nsIShellService.idl.

readonly attribute nsILocalFile nsIShellService::defaultFeedReader

The default system handler for web feeds

Definition at line 129 of file nsIShellService.idl.

attribute unsigned long nsIShellService::desktopBackgroundColor

The desktop background color, visible when no background image is used, or if the background image is centered and does not fill the entire screen. A rgb value, where (r << 16 | g << 8 | b)

Definition at line 115 of file nsIShellService.idl.

attribute boolean nsIShellService::shouldCheckDefaultBrowser

Used to determine whether or not to show a "Set Default Browser" query dialog. This attribute is true if the application is starting up and "browser.shell.checkDefaultBrowser" is true, otherwise it is false.

Definition at line 75 of file nsIShellService.idl.

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