Back to index

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

import "nsIShellService.idl";

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

List of all members.

Public Member Functions

boolean isDefaultClient (in boolean aStartupCheck, in unsigned short aApps)
 Determines whether or not Thunderbird is the "Default Client" for the passed in app type.
void setDefaultClient (in boolean aForAllUsers, in unsigned short aApps)
 Registers Thunderbird as the "Default Mail Client" for the passed in app type.

Public Attributes

const unsigned short MAIL = 0x0001
 app types we can be registered to handle
const unsigned short NEWS = 0x0002
const unsigned short RSS = 0x0004
attribute boolean shouldCheckDefaultClient
 Used to determine whether or not to show a "Set Default Client" query dialog.

Detailed Description

Definition at line 42 of file nsIShellService.idl.


Member Function Documentation

boolean nsIShellService::isDefaultClient ( in boolean  aStartupCheck,
in unsigned short  aApps 
)

Determines whether or not Thunderbird is the "Default Client" for the passed in app type.

This is simply whether or not Thunderbid is registered to handle the url scheme associatd with the app.

Parameters:
aStartupChecktrue if this is the check being performed by the first mail window at startup, false otherwise.
aAppsthe application types being tested (Mail, News, RSS, etc.)
void nsIShellService::setDefaultClient ( in boolean  aForAllUsers,
in unsigned short  aApps 
)

Registers Thunderbird as the "Default Mail Client" for the passed in app type.

Parameters:
aForAllUsersWhether or not Thunderbird should attempt to become the default client for all users on a multi-user system.
aAppsthe application types being tested (Mail, News, RSS, etc.)

Member Data Documentation

const unsigned short nsIShellService::MAIL = 0x0001

app types we can be registered to handle

Definition at line 47 of file nsIShellService.idl.

const unsigned short nsIShellService::NEWS = 0x0002

Definition at line 48 of file nsIShellService.idl.

const unsigned short nsIShellService::RSS = 0x0004

Definition at line 49 of file nsIShellService.idl.

Used to determine whether or not to show a "Set Default Client" query dialog.

This attribute is true if the application is starting up and "mail.shell.checkDefaultClient" is true, otherwise it is false.

Definition at line 82 of file nsIShellService.idl.


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