Struct xpcom::interfaces::nsIControllerCommandTable [] [src]

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

interface nsIControllerCommandTable : nsISupports

/**
 * nsIControllerCommandTable
 *
 * An interface via which a controller can maintain a series of commands,
 * and efficiently dispatch commands to their respective handlers.
 *
 * Controllers that use an nsIControllerCommandTable should support
 * nsIInterfaceRequestor, and be able to return an interface to their
 * controller command table via getInterface().
 *
 */

Methods

impl nsIControllerCommandTable
[src]

[src]

Cast this nsIControllerCommandTable to one of its base interfaces.

impl nsIControllerCommandTable
[src]

[src]

/**
   * Make this command table immutable, so that commands cannot
   * be registered or unregistered. Some command tables are made
   * mutable after command registration so that they can be
   * used as singletons.
   */

void makeImmutable ();

[src]

/**
   * Register and unregister commands with the command table.
   *
   * @param aCommandName  the name of the command under which to register or
   *                      unregister the given command handler.
   *
   * @param aCommand      the handler for this command.
   */

void registerCommand (in string aCommandName, in nsIControllerCommand aCommand);

[src]

void unregisterCommand (in string aCommandName, in nsIControllerCommand aCommand);

[src]

/**
   * Find the command handler which has been registered to handle the named command.
   *
   * @param aCommandName  the name of the command to find the handler for.
   */

nsIControllerCommand findCommandHandler (in string aCommandName);

[src]

/**
   * Get whether the named command is enabled.
   *
   * @param aCommandName    the name of the command to test
   * @param aCommandRefCon  the command context data
   */

boolean isCommandEnabled (in string aCommandName, in nsISupports aCommandRefCon);

[src]

/**
   * Tell the command to update its state (if it is a state updating command)
   *
   * @param aCommandName    the name of the command to update
   * @param aCommandRefCon  the command context data
   */

void updateCommandState (in string aCommandName, in nsISupports aCommandRefCon);

[src]

/**
   * Get whether the named command is supported.
   *
   * @param aCommandName    the name of the command to test
   * @param aCommandRefCon  the command context data
   */

boolean supportsCommand (in string aCommandName, in nsISupports aCommandRefCon);

[src]

/**
   * Execute the named command.
   *
   * @param aCommandName    the name of the command to execute
   * @param aCommandRefCon  the command context data
   */

void doCommand (in string aCommandName, in nsISupports aCommandRefCon);

[src]

void doCommandParams (in string aCommandName, in nsICommandParams aParam, in nsISupports aCommandRefCon);

[src]

void getCommandState (in string aCommandName, in nsICommandParams aParam, in nsISupports aCommandRefCon);

[src]

void getSupportedCommands (out unsigned long count, [array, size_is (count), retval] out string commands);

Methods from Deref<Target = nsISupports>

[src]

Cast this nsISupports to one of its base interfaces.

[src]

void QueryInterface (in nsIIDRef uuid, [iid_is (uuid), retval] out nsQIResult result);

[src]

[noscript,notxpcom] nsrefcnt AddRef ();

[src]

[noscript,notxpcom] nsrefcnt Release ();

Trait Implementations

impl XpCom for nsIControllerCommandTable
[src]

IID: nsIID = nsID(3360160014, 47347, 18907, [164, 223, 136, 103, 131, 31, 40, 0])

[src]

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. Read more

impl RefCounted for nsIControllerCommandTable
[src]

[src]

Increment the reference count.

[src]

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIControllerCommandTable
[src]

The resulting type after dereferencing.

[src]

Dereferences the value.