1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "nsISupports.idl"
interface nsITreeSelection;
webidl DataTransfer;
webidl TreeColumn;
webidl XULTreeElement;
[scriptable, uuid(091116f0-0bdc-4b32-b9c8-c8d5a37cb088)]
interface nsITreeView : nsISupports
{
/**
* The total number of rows in the tree (including the offscreen rows).
*/
readonly attribute long rowCount;
/**
* The selection for this view.
*/
attribute nsITreeSelection selection;
/**
* A whitespace delimited list of properties. For each property X the view
* gives back will cause the pseudoclasses ::-moz-tree-cell(x),
* ::-moz-tree-row(x), ::-moz-tree-twisty(x), ::-moz-tree-image(x),
* ::-moz-tree-cell-text(x). to be matched on the pseudoelement
* ::moz-tree-row.
*/
AString getRowProperties(in long index);
/**
* A whitespace delimited list of properties for a given cell. Each
* property, x, that the view gives back will cause the pseudoclasses
* ::-moz-tree-cell(x), ::-moz-tree-row(x), ::-moz-tree-twisty(x),
* ::-moz-tree-image(x), ::-moz-tree-cell-text(x). to be matched on the
* cell.
*/
AString getCellProperties(in long row, in TreeColumn col);
/**
* Called to get properties to paint a column background. For shading the sort
* column, etc.
*/
AString getColumnProperties(in TreeColumn col);
/**
* Methods that can be used to test whether or not a twisty should be drawn,
* and if so, whether an open or closed twisty should be used.
*/
boolean isContainer(in long index);
boolean isContainerOpen(in long index);
boolean isContainerEmpty(in long index);
/**
* isSeparator is used to determine if the row at index is a separator.
* A value of true will result in the tree drawing a horizontal separator.
* The tree uses the ::moz-tree-separator pseudoclass to draw the separator.
*/
boolean isSeparator(in long index);
/**
* Specifies if there is currently a sort on any column. Used mostly by dragdrop
* to affect drop feedback.
*/
boolean isSorted();
const short DROP_BEFORE = -1;
const short DROP_ON = 0;
const short DROP_AFTER = 1;
/**
* 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 when
* the orientation is not DROP_ON.
*/
boolean canDrop(in long index, in long orientation, in DataTransfer dataTransfer);
/**
* Called when the user drops something on this view. The |orientation| param
* specifies before/on/after the given |row|.
*/
void drop(in long row, in long orientation, in DataTransfer dataTransfer);
/**
* Methods used by the tree to draw thread lines in the tree.
* getParentIndex is used to obtain the index of a parent row.
* If there is no parent row, getParentIndex returns -1.
*/
long getParentIndex(in long rowIndex);
/**
* hasNextSibling is used to determine if the row at rowIndex has a nextSibling
* that occurs *after* the index specified by afterIndex. Code that is forced
* to march down the view looking at levels can optimize the march by starting
* at afterIndex+1.
*/
boolean hasNextSibling(in long rowIndex, in long afterIndex);
/**
* The level is an integer value that represents
* the level of indentation. It is multiplied by the width specified in the
* :moz-tree-indentation pseudoelement to compute the exact indendation.
*/
long getLevel(in long index);
/**
* The image path for a given cell. For defining an icon for a cell.
* If the empty string is returned, the :moz-tree-image pseudoelement
* will be used.
*/
AString getImageSrc(in long row, in TreeColumn col);
/**
* The value for a given cell. This method is only called for columns
* of type other than |text|.
*/
AString getCellValue(in long row, in TreeColumn col);
/**
* The text for a given cell. If a column consists only of an image, then
* the empty string is returned.
*/
AString getCellText(in long row, in TreeColumn col);
/**
* Called during initialization to link the view to the front end box object.
*/
void setTree(in XULTreeElement tree);
/**
* Called on the view when an item is opened or closed.
*/
void toggleOpenState(in long index);
/**
* Called on the view when a header is clicked.
*/
void cycleHeader(in TreeColumn col);
/**
* Should be called from a XUL onselect handler whenever the selection changes.
*/
[binaryname(SelectionChangedXPCOM)]
void selectionChanged();
/**
* Called on the view when a cell in a non-selectable cycling column (e.g., unread/flag/etc.) is clicked.
*/
void cycleCell(in long row, in TreeColumn col);
/**
* isEditable is called to ask the view if the cell contents are editable.
* A value of true will result in the tree popping up a text field when
* the user tries to inline edit the cell.
*/
boolean isEditable(in long row, in TreeColumn col);
/**
* setCellValue is called when the value of the cell has been set by the user.
* This method is only called for columns of type other than |text|.
*/
void setCellValue(in long row, in TreeColumn col, in AString value);
/**
* setCellText is called when the contents of the cell have been edited by the user.
*/
void setCellText(in long row, in TreeColumn col, in AString value);
};
|
