Interface nsIStandaloneNativeMenuType

Platform-independent interface to platform native menu objects.

Hierarchy

Methods

AddRef QueryInterface Release activateNativeMenuItemAt dump forceUpdateNativeMenuAt init menuWillOpen

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

activateNativeMenuItemAt

  • Activate the native menu item specified by |anIndexString|. This method is intended to be used by the test suite.

    Parameters

    • anIndexString: string

      string containing a list of indices separated by pipe ('|') characters

    Returns void

dump

  • Print information about the menu structure to stdout. Only used for debugging.

    Returns void

forceUpdateNativeMenuAt

  • Force an update of the native menu item specified by |anIndexString|. This method is intended to be used by the test suite.

    Parameters

    • anIndexString: string

      string containing a list of indices separated by pipe ('|') characters

    Returns void

init

  • Initialize the native menu using given XUL DOM element.

    Parameters

    • aElement: Element

    Returns void

menuWillOpen

  • This method must be called before the menu is opened and displayed to the user. It allows the platform code to update the menu and also determine whether the menu should even be shown.

    Returns

    true if the menu can be shown, false if it should not be shown

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc