Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIXULCommand Class Reference

#include <nsIXULCommand.h>

Inheritance diagram for nsIXULCommand:
Inheritance graph
[legend]
Collaboration diagram for nsIXULCommand:
Collaboration graph
[legend]

List of all members.

Public Member Functions

NS_IMETHOD SetMenuItem (nsIMenuItem *aMenuItem)=0
 Sets the menu.
NS_IMETHOD AttributeHasBeenSet (const nsString &aAttr)=0
 Notifies that an attribute has been set.
NS_IMETHOD SetCommand (const nsString &aStrCmd)=0
 Sets the JavaScript Command to be invoked when a "gui" event occurs on a source widget.
NS_IMETHOD DoCommand ()=0
 Executes the "cached" JavaScript Command.
NS_IMETHOD SetDOMElement (nsIDOMElement *aDOMElement)=0
NS_IMETHOD GetDOMElement (nsIDOMElement **aDOMElement)=0
NS_IMETHOD SetDocShell (nsIDocShell *aDocShell)=0
virtual nsEventStatus MenuItemSelected (const nsMenuEvent &aMenuEvent)=0
 Processes a menu item selected event.
virtual nsEventStatus MenuSelected (const nsMenuEvent &aMenuEvent)=0
 Processes a menu selected event.
virtual nsEventStatus MenuDeselected (const nsMenuEvent &aMenuEvent)=0
 Processes a menu deselect event.
virtual nsEventStatus MenuConstruct (const nsMenuEvent &aMenuEvent, nsIWidget *aParentWindow, void *aNode, void *aDocShell)=0
virtual nsEventStatus MenuDestruct (const nsMenuEvent &aMenuEvent)=0
virtual nsEventStatus CheckRebuild (PRBool &aMenuEvent)=0
virtual nsEventStatus SetRebuild (PRBool aMenuEvent)=0

Detailed Description

Definition at line 60 of file nsIXULCommand.h.


Member Function Documentation

Notifies that an attribute has been set.

Parameters:
aAttrthat changed
Returns:
NS_OK
virtual nsEventStatus nsIMenuListener::CheckRebuild ( PRBool aMenuEvent) [pure virtual, inherited]

Executes the "cached" JavaScript Command.

Returns:
NS_OK if the command was executed properly, otherwise an error code
NS_IMETHOD nsIXULCommand::GetDOMElement ( nsIDOMElement **  aDOMElement) [pure virtual]
virtual nsEventStatus nsIMenuListener::MenuConstruct ( const nsMenuEvent aMenuEvent,
nsIWidget aParentWindow,
void aNode,
void aDocShell 
) [pure virtual, inherited]
virtual nsEventStatus nsIMenuListener::MenuDeselected ( const nsMenuEvent aMenuEvent) [pure virtual, inherited]

Processes a menu deselect event.

Parameters:
aMenuEventSee nsGUIEvent.h
Returns:
whether the event was consumed or ignored. See nsEventStatus

Implemented in nsMenuX, nsMenuBarX, nsMenuItemX, nsMenuBarX, nsMenuItemX, and nsMenuX.

virtual nsEventStatus nsIMenuListener::MenuDestruct ( const nsMenuEvent aMenuEvent) [pure virtual, inherited]
virtual nsEventStatus nsIMenuListener::MenuItemSelected ( const nsMenuEvent aMenuEvent) [pure virtual, inherited]

Processes a menu item selected event.

Parameters:
aMenuEventSee nsGUIEvent.h
Returns:
whether the event was consumed or ignored. See nsEventStatus

Implemented in nsMenuX, nsMenuBarX, nsMenuItemX, nsMenuBarX, nsMenuItemX, and nsMenuX.

virtual nsEventStatus nsIMenuListener::MenuSelected ( const nsMenuEvent aMenuEvent) [pure virtual, inherited]

Processes a menu selected event.

Parameters:
aMenuEventSee nsGUIEvent.h
Returns:
whether the event was consumed or ignored. See nsEventStatus

Implemented in nsMenuX, nsMenuBarX, nsMenuItemX, nsMenuBarX, nsMenuItemX, and nsMenuX.

Here is the caller graph for this function:

NS_IMETHOD nsIXULCommand::SetCommand ( const nsString aStrCmd) [pure virtual]

Sets the JavaScript Command to be invoked when a "gui" event occurs on a source widget.

Parameters:
aStrCmdthe JS command to be cached for later execution
Returns:
NS_OK
NS_IMETHOD nsIXULCommand::SetDocShell ( nsIDocShell aDocShell) [pure virtual]
NS_IMETHOD nsIXULCommand::SetDOMElement ( nsIDOMElement aDOMElement) [pure virtual]
NS_IMETHOD nsIXULCommand::SetMenuItem ( nsIMenuItem aMenuItem) [pure virtual]

Sets the menu.

Parameters:
aMenuItemthe menu
Returns:
NS_OK
virtual nsEventStatus nsIMenuListener::SetRebuild ( PRBool  aMenuEvent) [pure virtual, inherited]

The documentation for this class was generated from the following file: