Struct xpcom::interfaces::nsILocalHandlerApp

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

interface nsILocalHandlerApp : nsIHandlerApp

/**
 * nsILocalHandlerApp is a local OS-level executable
 */

Methods

impl nsILocalHandlerApp

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

Cast this nsILocalHandlerApp to one of its base interfaces.

impl nsILocalHandlerApp

pub unsafe fn GetExecutable(&self, aExecutable: *mut *const nsIFile) -> nsresult

/**
     * Pointer to the executable file used to handle content
     */

attribute nsIFile executable;

pub unsafe fn SetExecutable(&self, aExecutable: *const nsIFile) -> nsresult

/**
     * Pointer to the executable file used to handle content
     */

attribute nsIFile executable;

pub unsafe fn GetParameterCount(
    &self,
    aParameterCount: *mut uint32_t
) -> nsresult

/**
     * Returns the current number of command line parameters.
     */

readonly attribute unsigned long parameterCount;

pub unsafe fn ClearParameters(&self) -> nsresult

/**
     * Clears the current list of command line parameters.
     */

void clearParameters ();

pub unsafe fn AppendParameter(&self, param: &nsAString) -> nsresult

/**
     * Appends a command line parameter to the command line
     * parameter list.
     *
     * @param param the parameter to add.
     */

void appendParameter (in AString param);

pub unsafe fn GetParameter(
    &self,
    parameterIndex: uint32_t,
    _retval: &mut nsAString
) -> nsresult

/**
     * Retrieves a specific command line parameter.
     *
     * @param param the index of the parameter to return.
     *
     * @return the parameter string.
     *
     * @throw NS_ERROR_INVALID_ARG if the index is out of range.
     */

AString getParameter (in unsigned long parameterIndex);

pub unsafe fn ParameterExists(
    &self,
    param: &nsAString,
    _retval: *mut bool
) -> nsresult

/**
     * Checks to see if a parameter exists in the command line
     * parameter list.
     *
     * @param param the parameter to search for.
     *
     * @return TRUE if the parameter exists in the current list.
     */

boolean parameterExists (in AString param);

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 nsILocalHandlerApp

const IID: nsIID

IID: nsIID = nsID(3547030313, 21166, 20293, [128, 244, 178, 83, 106, 229, 248, 178])

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 nsILocalHandlerApp

unsafe fn addref(&self)

Increment the reference count.

unsafe fn release(&self)

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsILocalHandlerApp

type Target = nsIHandlerApp

The resulting type after dereferencing.

fn deref(&self) -> &nsIHandlerApp

Dereferences the value.