Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIXULTreeBuilderObserver Interface Reference

nsIXULTreeBuilderObserver This interface allows clients of the XULTreeBuilder to define domain specific handling of specific nsITreeView methods that XULTreeBuilder does not implement. More...

import "nsIXULTemplateBuilder.idl";

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

List of all members.

Public Member Functions

boolean canDrop (in long index, in long orientation)
 Methods used by the drag feedback code to determine if a drag is allowable at the current location.
void onDrop (in long row, in long orientation)
 Called when the user drops something on this view.
void onToggleOpenState (in long index)
 Called when an item is opened or closed.
void onCycleHeader (in wstring colID, in nsIDOMElement elt)
 Called when a header is clicked.
void onCycleCell (in long row, in wstring colID)
 Called when a cell in a non-selectable cycling column (e.g.
void onSelectionChanged ()
 Called when selection in the tree changes.
void onPerformAction (in wstring action)
 A command API that can be used to invoke commands on the selection.
void onPerformActionOnRow (in wstring action, in long row)
 A command API that can be used to invoke commands on a specific row.
void onPerformActionOnCell (in wstring action, in long row, in wstring colID)
 A command API that can be used to invoke commands on a specific cell.

Public Attributes

const long DROP_BEFORE = -1
const long DROP_ON = 0
const long DROP_AFTER = 1

Detailed Description

nsIXULTreeBuilderObserver This interface allows clients of the XULTreeBuilder to define domain specific handling of specific nsITreeView methods that XULTreeBuilder does not implement.

Definition at line 112 of file nsIXULTemplateBuilder.idl.


Member Function Documentation

boolean nsIXULTreeBuilderObserver::canDrop ( in long  index,
in long  orientation 
)

Methods used by the drag feedback code to determine if a drag is allowable at the current location.

To get the behavior where drops are only allowed on items, such as the mailNews folder pane, always return false whe the orientation is not DROP_ON.

void nsIXULTreeBuilderObserver::onCycleCell ( in long  row,
in wstring  colID 
)

Called when a cell in a non-selectable cycling column (e.g.

unread/flag/etc.) is clicked.

Called when a header is clicked.

void nsIXULTreeBuilderObserver::onDrop ( in long  row,
in long  orientation 
)

Called when the user drops something on this view.

The |orientation| param specifies before/on/after the given |row|.

A command API that can be used to invoke commands on the selection.

The tree will automatically invoke this method when certain keys are pressed. For example, when the DEL key is pressed, performAction will be called with the "delete" string.

void nsIXULTreeBuilderObserver::onPerformActionOnCell ( in wstring  action,
in long  row,
in wstring  colID 
)

A command API that can be used to invoke commands on a specific cell.

A command API that can be used to invoke commands on a specific row.

Called when selection in the tree changes.

Called when an item is opened or closed.


Member Data Documentation

Definition at line 116 of file nsIXULTemplateBuilder.idl.

Definition at line 114 of file nsIXULTemplateBuilder.idl.

Definition at line 115 of file nsIXULTemplateBuilder.idl.


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