Struct xpcom::interfaces::nsIWebHandlerApp

#[repr(C)]
pub struct nsIWebHandlerApp { /* fields omitted */ }

interface nsIWebHandlerApp : nsIHandlerApp

/**
 * nsIWebHandlerApp is a web-based handler, as speced by the WhatWG HTML5
 * draft.  Currently, only GET-based handlers are supported.  At some point,
 * we probably want to work with WhatWG to spec out and implement POST-based
 * handlers as well.
 */

Methods

impl nsIWebHandlerApp

pub fn coerce<T: nsIWebHandlerAppCoerce>(&self) -> &T

Cast this nsIWebHandlerApp to one of its base interfaces.

impl nsIWebHandlerApp

pub unsafe fn GetUriTemplate(&self, aUriTemplate: &mut nsACString) -> nsresult

/**
     * Template used to construct the URI to GET.  Template is expected to have
     * a %s in it, and the escaped URI to be handled is inserted in place of
     * that %s, as per the HTML5 spec.
     */

attribute AUTF8String uriTemplate;

pub unsafe fn SetUriTemplate(&self, aUriTemplate: &nsACString) -> nsresult

/**
     * Template used to construct the URI to GET.  Template is expected to have
     * a %s in it, and the escaped URI to be handled is inserted in place of
     * that %s, as per the HTML5 spec.
     */

attribute AUTF8String uriTemplate;

Methods from Deref<Target = nsIHandlerApp>

pub fn coerce<T: nsIHandlerAppCoerce>(&self) -> &T

Cast this nsIHandlerApp to one of its base interfaces.

pub unsafe fn GetName(&self, aName: &mut nsAString) -> nsresult

/**
 * nsIHandlerApp represents an external application that can handle content
 * of some sort (either a MIME type or a protocol).
 *
 * FIXME: now that we've made nsIWebHandlerApp inherit from nsIHandlerApp,
 * we should also try to make nsIWebContentHandlerInfo inherit from or possibly
 * be replaced by nsIWebHandlerApp (bug 394710).
 */
/**
     * Human readable name for the handler
     */

attribute AString name;

pub unsafe fn SetName(&self, aName: &nsAString) -> nsresult

/**
 * nsIHandlerApp represents an external application that can handle content
 * of some sort (either a MIME type or a protocol).
 *
 * FIXME: now that we've made nsIWebHandlerApp inherit from nsIHandlerApp,
 * we should also try to make nsIWebContentHandlerInfo inherit from or possibly
 * be replaced by nsIWebHandlerApp (bug 394710).
 */
/**
     * Human readable name for the handler
     */

attribute AString name;

pub unsafe fn GetDetailedDescription(
    &self,
    aDetailedDescription: &mut nsAString
) -> nsresult

/**
     * Detailed description for this handler. Suitable for
     * a tooltip or short informative sentence.
     */

attribute AString detailedDescription;

pub unsafe fn SetDetailedDescription(
    &self,
    aDetailedDescription: &nsAString
) -> nsresult

/**
     * Detailed description for this handler. Suitable for
     * a tooltip or short informative sentence.
     */

attribute AString detailedDescription;

pub unsafe fn Equals(
    &self,
    aHandlerApp: *const nsIHandlerApp,
    _retval: *mut bool
) -> nsresult

/**
     * Whether or not the given handler app is logically equivalent to the
     * invokant (i.e. they represent the same app).
     *
     * Two apps are the same if they are both either local or web handlers
     * and their executables/URI templates and command line parameters are
     * the same.
     *
     * @param aHandlerApp the handler app to compare to the invokant
     *
     * @returns true if the two are logically equivalent, false otherwise
     */

boolean equals (in nsIHandlerApp aHandlerApp);

pub unsafe fn LaunchWithURI(
    &self,
    aURI: *const nsIURI,
    aWindowContext: *const nsIInterfaceRequestor
) -> nsresult

/**
     * Launches the application with the specified URI.
     *
     * @param aURI
     *        The URI to launch this application with
     *
     * @param aWindowContext
     *
     *        Currently only relevant to web-handler apps.  If given, this
     *        represents the docshell to load the handler in and is passed
     *        through to nsIURILoader.openURI.  If this parameter is null or
     *        not present, the web handler app implementation will attempt to
     *        find/create a place to load the handler and do so.  As of this
     *        writing, it tries to load the web handler in a new window using
     *        nsIBrowserDOMWindow.openURI.  In the future, it may attempt to
     *        have a more comprehensive strategy which could include handing
     *        off to the system default browser (bug 394479).
     */

void launchWithURI (in nsIURI aURI, [optional] in nsIInterfaceRequestor aWindowContext);

Trait Implementations

impl XpCom for nsIWebHandlerApp

const IID: nsIID

IID: nsIID = nsID(1965138067, 50328, 17870, [180, 98, 223, 123, 160, 216, 130, 246])

fn query_interface<T: XpCom>(&self) -> Option<RefPtr<T>>

Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise.

impl RefCounted for nsIWebHandlerApp

unsafe fn addref(&self)

Increment the reference count.

unsafe fn release(&self)

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIWebHandlerApp

type Target = nsIHandlerApp

The resulting type after dereferencing.

fn deref(&self) -> &nsIHandlerApp

Dereferences the value.