Interface nsIGNOMEShellServiceType

Hierarchy

Properties

canSetDesktopBackground desktopBackgroundColor

Methods

AddRef QueryInterface Release isDefaultBrowser isDefaultForScheme setDefaultBrowser setDesktopBackground

Properties

Readonly canSetDesktopBackground

canSetDesktopBackground: boolean

Used to determine whether or not to offer "Set as desktop background" functionality. Even if shell service is available it is not guaranteed that it is able to set the background for every desktop which is especially true for Linux with its many different desktop environments.

desktopBackgroundColor

desktopBackgroundColor: number

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)

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

isDefaultBrowser

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

    Parameters

    • aForAllTypes: boolean

      true if the check should be made for HTTP and HTML. false if the check should be made for HTTP only. This parameter may be ignored on some platforms.

    Returns boolean

isDefaultForScheme

  • Returns true if Firefox is set as the default handler for the scheme.

    Parameters

    • aScheme: string

    Returns boolean

setDefaultBrowser

  • Registers Firefox as the "Default Browser."

    Parameters

    • aClaimAllTypes: boolean

      Register Firefox as the handler for additional protocols (chrome etc) and web documents (.html, .xhtml etc).

    • aForAllUsers: boolean

      Whether or not Firefox should attempt to become the default browser for all users on a multi-user system.

    Returns void

setDesktopBackground

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

    Parameters

    • aElement: Element
    • aPosition: number

      How to place the image on the desktop

    • aImageName: string

      The image name. Equivalent to the leaf name of the location.href.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc