Back to index

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

import "nsITreeSelection.idl";

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

List of all members.

Public Member Functions

boolean isSelected (in long index)
 Indicates whether or not the row at the specified index is part of the selection.
void select (in long index)
 Deselect all rows and select the row at the specified index.
void timedSelect (in long index, in long delay)
 Perform a timed select.
void toggleSelect (in long index)
 Toggle the selection state of the row at the specified index.
void rangedSelect (in long startIndex, in long endIndex, in boolean augment)
 Select the range specified by the indices.
void clearRange (in long startIndex, in long endIndex)
 Clears the range.
void clearSelection ()
 Clears the selection.
void invertSelection ()
 Inverts the selection.
void selectAll ()
 Selects all rows.
long getRangeCount ()
 Iterate the selection using these methods.
void getRangeAt (in long i, out long min, out long max)
void invalidateSelection ()
 Can be used to invalidate the selection.
void adjustSelection (in long index, in long count)
 Called when the row count changes to adjust selection indices.

Public Attributes

attribute nsITreeBoxObject tree
 The tree widget for this selection.
readonly attribute boolean single
 This attribute is a boolean indicating single selection.
readonly attribute long count
 The number of rows currently selected in this tree.
attribute boolean selectEventsSuppressed
 This attribute is a boolean indicating whether or not the "select" event should fire when the selection is changed using one of our methods.
attribute long currentIndex
 The current item (the one that gets a focus rect in addition to being selected).
readonly attribute long shiftSelectPivot
 The selection "pivot".

Detailed Description

Definition at line 45 of file nsITreeSelection.idl.


Member Function Documentation

Called when the row count changes to adjust selection indices.

void nsITreeSelection::clearRange ( in long  startIndex,
in long  endIndex 
)

Clears the range.

Clears the selection.

Iterate the selection using these methods.

Can be used to invalidate the selection.

Inverts the selection.

Indicates whether or not the row at the specified index is part of the selection.

void nsITreeSelection::rangedSelect ( in long  startIndex,
in long  endIndex,
in boolean  augment 
)

Select the range specified by the indices.

If augment is true, then we add the range to the selection without clearing out anything else. If augment is false, everything is cleared except for the specified range.

Deselect all rows and select the row at the specified index.

Selects all rows.

void nsITreeSelection::timedSelect ( in long  index,
in long  delay 
)

Perform a timed select.

Toggle the selection state of the row at the specified index.


Member Data Documentation

The number of rows currently selected in this tree.

Definition at line 60 of file nsITreeSelection.idl.

The current item (the one that gets a focus rect in addition to being selected).

Definition at line 139 of file nsITreeSelection.idl.

This attribute is a boolean indicating whether or not the "select" event should fire when the selection is changed using one of our methods.

A view can use this to temporarily suppress the selection while manipulating all of the indices, e.g., on a sort.

Definition at line 133 of file nsITreeSelection.idl.

The selection "pivot".

This is the first item the user selected as part of a ranged select.

Definition at line 145 of file nsITreeSelection.idl.

This attribute is a boolean indicating single selection.

Definition at line 55 of file nsITreeSelection.idl.

The tree widget for this selection.

Definition at line 50 of file nsITreeSelection.idl.


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