nsIXULTreeBuilderObserver

IID:a5480e0d-ac7c-42e5-aca5-d7f0bbffa207
Inherits From:nsISupports

Constants

PRInt32 DROP_BEFORE = -1
PRInt32 DROP_ON = 0
PRInt32 DROP_AFTER = 1

Methods

PRBool canDrop ( PRInt32 index , PRInt32 orientation ) void onCycleCell ( PRInt32 row , PRUnichar* colID ) void onCycleHeader ( PRUnichar* colID , nsIDOMElement elt ) void onDrop ( PRInt32 row , PRInt32 orientation ) void onPerformAction ( PRUnichar* action ) void onPerformActionOnCell ( PRUnichar* action , PRInt32 row , PRUnichar* colID ) void onPerformActionOnRow ( PRUnichar* action , PRInt32 row ) void onSelectionChanged ( ) void onToggleOpenState ( PRInt32 index )

PRBool canDrop ( PRInt32 index , PRInt32 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.

Arguments:
index
orientation

void onCycleCell ( PRInt32 row , PRUnichar* colID )

Called when a cell in a non-selectable cycling column (e.g. unread/flag/etc.) is clicked.

Arguments:
row
colID

void onCycleHeader ( PRUnichar* colID , nsIDOMElement elt )

Called when a header is clicked.

Arguments:
colID
elt

void onDrop ( PRInt32 row , PRInt32 orientation )

Called when the user drops something on this view. The orientation param specifies before/on/after the given row.

Arguments:
row
orientation

void onPerformAction ( PRUnichar* action )

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.

Arguments:
action

void onPerformActionOnCell ( PRUnichar* action , PRInt32 row , PRUnichar* colID )

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

Arguments:
action
row
colID

void onPerformActionOnRow ( PRUnichar* action , PRInt32 row )

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

Arguments:
action
row

void onSelectionChanged ( )

Called when selection in the tree changes


void onToggleOpenState ( PRInt32 index )

Called when an item is opened or closed.

Arguments:
index

References

This interface is passed as an argument to the following methods:

nsIXULTreeBuilder.addObserver, nsIXULTreeBuilder.removeObserver

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
February 13, 2005, 6:51 am gomita dot mail at gmail dot com
There are some changes in Firefox 1.1 and Mozilla 1.8+
canDropBeforeAfter, canDropOn -> canDrop
inDropBefore (0) -> DROP_BEFORE (-1)
inDropOn (1) -> DROP_ON (0)
inDropAfter (2) -> DROP_AFTER (1)

Copyright © 1999 - 2005 XULPlanet.com