XmLArrayAdd.3x- XmLArrayDel.3x
- XmLArrayFree.3x
- XmLArrayGet.3x
- XmLArrayGetCount.3x
- XmLArrayMove.3x
- XmLArrayNew.3x
- XmLArrayReorder.3x
- XmLArraySet.3x
- XmLArraySort.3x
- XmLCreateFolder.3x
- XmLCreateGrid.3x
- XmLCreateProgress.3x
- XmLCreateTree.3x
- XmLCvtStringToUChar.3x
- XmLDateDaysInMonth.3x
- XmLDateWeekDay.3x
- XmLDrawnButtonSetType.3x
- XmLFolder.3x
- XmLFolderAddBitmapTab.3x
- XmLFolderAddBitmapTabForm.3x
- XmLFolderAddTab.3x
- XmLFolderAddTabForm.3x
- XmLFolderSetActiveTab.3x
- XmLFontListCopyDefault.3x
- XmLFontListGetDimensions.3x
- XmLGrid.3x
- XmLGridAddColumns.3x
- XmLGridAddRows.3x
- XmLGridColumnIsVisible.3x
- XmLGridCopyPos.3x
- XmLGridCopySelected.3x
- XmLGridDeleteAllColumns.3x
- XmLGridDeleteAllRows.3x
- XmLGridDeleteColumns.3x
- XmLGridDeleteRows.3x
- XmLGridDeselectAllCells.3x
- XmLGridDeselectAllColumns.3x
- XmLGridDeselectAllRows.3x
- XmLGridDeselectCell.3x
- XmLGridDeselectColumn.3x
- XmLGridDeselectRow.3x
- XmLGridEditBegin.3x
- XmLGridEditCancel.3x
- XmLGridEditComplete.3x
- XmLGridGetColumn.3x
- XmLGridGetFocus.3x
- XmLGridGetRow.3x
- XmLGridGetSelectedCellCount.3x
- XmLGridGetSelectedCells.3x
- XmLGridGetSelectedColumnCount.3x
- XmLGridGetSelectedColumns.3x
- XmLGridGetSelectedRow.3x
- XmLGridGetSelectedRowCount.3x
- XmLGridGetSelectedRows.3x
- XmLGridMoveColumns.3x
- XmLGridMoveRows.3x
- XmLGridPaste.3x
- XmLGridPastePos.3x
- XmLGridRead.3x
- XmLGridReadPos.3x
- XmLGridRedrawAll.3x
- XmLGridRedrawCell.3x
- XmLGridRedrawColumn.3x
- XmLGridRedrawRow.3x
- XmLGridReorderColumns.3x
- XmLGridReorderRows.3x
- XmLGridRowColumnToXY.3x
- XmLGridRowIsVisible.3x
- XmLGridSelectAllCells.3x
- XmLGridSelectAllColumns.3x
- XmLGridSelectAllRows.3x
- XmLGridSelectCell.3x
- XmLGridSelectColumn.3x
- XmLGridSelectRow.3x
- XmLGridSetFocus.3x
- XmLGridSetStrings.3x
- XmLGridSetStringsPos.3x
- XmLGridWrite.3x
- XmLGridWritePos.3x
- XmLGridXYToRowColumn.3x
- XmLMessageBox.3x
- XmLPixmapDraw.3x
- XmLProgress.3x
- XmLRectIntersect.3x
- XmLShellOfWidget.3x
- XmLSort.3x
- XmLStringDraw.3x
- XmLStringDrawDirection.3x
- XmLTree.3x
- XmLTreeAddRow.3x
- XmLTreeAddRows.3x
- XmLWarning.3x
1 .\" ***** BEGIN LICENSE BLOCK *****
2 .\" Version: MPL 1.1/GPL 2.0/LGPL 2.1
3 .\"
4 .\" The contents of this file are subject to the Mozilla Public License Version
5 .\" 1.1 (the "License"); you may not use this file except in compliance with
6 .\" the License. You may obtain a copy of the License at
7 .\" http://www.mozilla.org/MPL/
8 .\"
9 .\" Software distributed under the License is distributed on an "AS IS" basis,
10 .\" WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11 .\" for the specific language governing rights and limitations under the
12 .\" License.
13 .\"
14 .\" The Original Code is the Microline Widget Library, originally made available under the NPL by Neuron Data <http://www.neurondata.com>.
15 .\"
16 .\" The Initial Developer of the Original Code is
17 .\" Netscape Communications Corporation.
18 .\" Portions created by the Initial Developer are Copyright (C) 1998
19 .\" the Initial Developer. All Rights Reserved.
20 .\"
21 .\" Contributor(s):
22 .\"
23 .\" Alternatively, the contents of this file may be used under the terms of
24 .\" either the GNU General Public License Version 2 or later (the "GPL"), or
25 .\" the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
26 .\" in which case the provisions of the GPL or the LGPL are applicable instead
27 .\" of those above. If you wish to allow use of your version of this file only
28 .\" under the terms of either the GPL or the LGPL, and not to allow others to
29 .\" use your version of this file under the terms of the MPL, indicate your
30 .\" decision by deleting the provisions above and replace them with the notice
31 .\" and other provisions required by the GPL or the LGPL. If you do not delete
32 .\" the provisions above, a recipient may use your version of this file under
33 .\" the terms of any one of the MPL, the GPL or the LGPL.
34 .\"
35 .\" In addition, as a special exception to the GNU GPL, the copyright holders
36 .\" give permission to link the code of this program with the Motif and Open
37 .\" Motif libraries (or with modified versions of these that use the same
38 .\" license), and distribute linked combinations including the two. You
39 .\" must obey the GNU General Public License in all respects for all of
40 .\" the code used other than linking with Motif/Open Motif. If you modify
41 .\" this file, you may extend this exception to your version of the file,
42 .\" but you are not obligated to do so. If you do not wish to do so,
43 .\" delete this exception statement from your version.
44 .\"
45 .\" ***** END LICENSE BLOCK *****
46 .TH XmLTree 3X "R1" "XML1" "XML"
47 .SH NAME
48 XmLTree
49 .SH SYNOPSIS
50 #include <XmL/Tree.h>
51 .LP
52 .SH DESCRIPTION
53 A Tree is a subclass of the Grid widget which displays a hierarchical
54 tree with a Pixmap, XmString, connecting lines and
55 possibly an expand/collapse graphic in the cells of its first column.
56 Each row in the Tree has a position and level which is
57 used to determine its relationship to other rows in the Tree. Rows
58 may be expanded or collapsed by clicking on an expand/collapse graphic
59 or by activating a row with the keyboard. The Tree inherits
60 all the abilities of the Grid widget, allowing it to contain
61 multiple columns and rows of varying types, heading and fixed rows and
62 columns, interactive row and column resizing, cell borders, etc.
63 .SS Class Information
64 Tree inherits from XmLGrid, XmManager, Constraint, Composite and Core.
65 Its class pointer is xmlTreeWidgetClass. Its class name is XmLTree.
66 .SS New Resources
67 The Tree resources defined below affect its overall layout and
68 appearance. Definitions of resources affecting rows, columns
69 and cells follow the Tree resource definitions.
70
71 .nf
72 .ft B
73 Name Class
74 Type Default Access
75 .ft P
76 XmNconnectingLineColor XmCConnectingLineColor
77 Pixel Dynamic CSG
78 XmNlevelSpacing XmCLevelSpacing
79 Dimension 11 CSG
80 XmNplusMinusColor XmCPlusMinusColor
81 Pixel Dynamic CSG
82 .fi
83 .IP XmNconnectingLineColor
84 The color of the line which is drawn connecting parents, children
85 and siblings in the first column of the Tree. This values defaults
86 to the foreground color of the Tree.
87 .IP XmNlevelSpacing
88 The indent in pixels for each level in the Tree.
89 .IP XmNplusMinusColor
90 The color of the plus and minus expand/collapse graphics drawn
91 next to parent nodes which may be expanded. This value defaults
92 to the foreground color of the Tree.
93 .SS Row/Column/Cell Resources
94 Tree defines the resources in the table below affecting rows. In addition
95 to these row resources, the Tree inherits all the row, column and cell
96 resources which exist in the Grid.
97
98 .nf
99 .ft B
100 Name Class
101 Type Default Access
102 .ft P
103 XmNrowExpands XmCRowExpands
104 Boolean False SG
105 XmNrowIsExpanded XmCRowIsExpanded
106 Boolean True SG
107 XmNrowLevel XmCRowLevel
108 int 0 SG
109 .fi
110 .IP XmNrowExpands
111 True if the row may expand (it is a parent) and False otherwise.
112 .IP XmNrowIsExpanded
113 True if the row is currently expanded and False otherwise. If this
114 resource is set to False, the Tree will hide all children of this
115 row. Children of this row are determined to be all rows which are
116 of a level greater than this row's until we find the next row
117 which is of this row's level or less (a sibling or parent of this
118 row). Rows are hidden by setting their XmNrowHeight to 0. If
119 this resource is set to True, the Tree will show all children of
120 this row. Rows are shown by setting their XmNrowHeight to 1.
121 The value of this resource has no meaning if XmNrowExpands is False.
122 .IP XmNrowLevel
123 The level of the row in the Tree.
124 .SS Callback Resources
125 Tree defines the following callback resources.
126
127 .nf
128 .ft B
129 Callback Reasons Called When
130 .ft P
131 XmNcollapseCallback XmCR_COLLAPSE_ROW Row is collapsed by activate
132 or by clicking on collapse
133 graphic
134 XmNexpandCallback XmCR_EXPAND_ROW Row is expanded by activate
135 or by clicking on expand
136 graphic
137 .fi
138 .SS Callback Structure
139 Each callback function is passed a pointer to a XmLGridCallbackStruct
140 structure. See the XmLGrid's Callback Structure section for the
141 full structure definition.
142
143 The following table shows which values are set for which callback
144 reasons. Elements not set will have undefined values.
145
146 .nf
147 .ft B
148 Reason Values Set
149 .ft P
150 XmCR_COLLAPSE_ROW event, rowType, row
151 XmCR_EXPAND_ROW event, rowType, row
152 .ni
153 .SS Inherited Resources
154 Tree inherits the resources shown below.
155
156 .nf
157 .ft B
158 Resource From Resource From
159 .ft P
160 XmNaccelerators Core XmNimmediateDraw Grid
161 XmNallowColumnHide Grid XmNinitialResourcePersist Core
162 XmNallowColumnResize Grid XmNinsertPosition Composite
163 XmNallowDragSelected Grid XmNlayoutFrozen Grid
164 XmNallowDrop Grid XmNleftFixedCount Grid
165 XmNallowRowHide Grid XmNleftFixedMargin Grid
166 XmNallowRowResize Grid XmNmappedWhenManaged Core
167 XmNancestorSensitive Core XmNnavagationType Manager
168 XmNautoSelect Grid XmNnumChildren Composite
169 XmNbackground Core XmNrightFixedCount Grid
170 XmNbackgroundPixmap Core XmNrightFixedMargin Grid
171 XmNblankBackground Grid XmNrows Grid
172 XmNborderColor Core XmNscreen Core
173 XmNborderPixmap Core XmNscrollBarMargin Grid
174 XmNborderWidth Core XmNscrollColumn Grid
175 XmNbottomFixedCount Grid XmNscrollRow Grid
176 XmNbottomFixedMargin Grid XmNselectBackground Grid
177 XmNbottomShadowColor Manager XmNselectForeground Grid
178 XmNbottomShadowPixmap Manager XmNselectionPolicy Grid
179 XmNchildren Composite XmNsensitive Core
180 XmNcolormap Core XmNshadowRegions Grid
181 XmNcolumns Grid XmNshadowThicknses Manager
182 XmNdebugLevel Grid XmNshadowType Grid
183 XmNdepth Core XmNsimpleHeadings Grid
184 XmNdestroyCallback Core XmNsimpleWidths Grid
185 XmNeditTranslations Grid XmNstringDirection Manager
186 XmNfontList Grid XmNtextWidget Grid
187 XmNfooterColumns Grid XmNtopFixedCount Grid
188 XmNfooterRows Grid XmNtopFixedMargin Grid
189 XmNforeground Manager XmNtopShadowColor Manager
190 XmNglobalPixmapHeight Grid XmNtopShadowPixmap Manager
191 XmNglobalPixmapWidth Grid XmNtranslations Core
192 XmNheadingColumns Grid XmNtraversalOn Manager
193 XmNheadingRows Grid XmNtraverseTranslations Grid
194 XmNheight Core XmNunitType Manager
195 XmNhelpCallback Manager XmNuseAverageFontWidth Grid
196 XmNhiddenColumns Grid XmNuserData Manager
197 XmNhiddenRows Grid XmNverticalScrollBar Grid
198 XmNhighlightColor Manager XmNverticalSizePolicy Grid
199 XmNhighlightThickness Grid XmNvisibleColumns Grid
200 XmNhighlightPixmap Manager XmNvisibleRows Grid
201 XmNhighlightRowMode Grid XmNvsbDisplayPolicy Grid
202 XmNhorizontalScrollBar Grid XmNwidth Core
203 XmNhorizontalSizePolicy Grid XmNx Core
204 XmNhsbDisplayPolicy Grid XmNy Core
205
206 .fi
207 .SS Inherited Row/Column/Cell Resources
208 Tree inherits the row/column and cell resources shown below.
209
210 .nf
211 .ft B
212 Resource From Resource From
213 .ft P
214 XmNcellAlignment Grid XmNcellTopBorderColor Grid
215 XmNcellBackground Grid XmNcellTopBorderType Grid
216 XmNcellBottomBorderColor Grid XmNcellType Grid
217 XmNcellBottomBorderType Grid XmNcellUserData Grid
218 XmNcellColumnSpan Grid XmNcolumn Grid
219 XmNcellDefaults Grid XmNcolumnPtr Grid
220 XmNcellEditable Grid XmNcolumnRangeEnd Grid
221 XmNcellFontList Grid XmNcolumnRangeStart Grid
222 XmNcellForeground Grid XmNcolumnSizePolicy Grid
223 XmNcellLeftBorderColor Grid XmNcolumnStep Grid
224 XmNcellLeftBorderType Grid XmNcolumnType Grid
225 XmNcellMarginBottom Grid XmNcolumnWidth Grid
226 XmNcellMarginLeft Grid XmNcolumnUserData Grid
227 XmNcellMarginRight Grid XmNrow Grid
228 XmNcellMarginTop Grid XmNrowHeight Grid
229 XmNcellPixmap Grid XmNrowPtr Grid
230 XmNcellPixmapMask Grid XmNrowRangeEnd Grid
231 XmNcellRightBorderColor Grid XmNrowRangeStart Grid
232 XmNcellRightBorderType Grid XmNrowSizePolicy Grid
233 XmNcellRowSpan Grid XmNrowStep Grid
234 XmNcellString Grid XmNrowType Grid
235 .fi
236 .SH "SEE ALSO"
237 XmLTreeAddRow(3X) XmLTreeAddRows(3X) XmLGridAddColumns(3X)
238 XmLGridColumnIsVisible(3X) XmLGridDeleteAllColumns(3X) XmLGridDeleteAllRows(3X) XmLGridDeleteColumns(3X) XmLGridDeleteRows(3X) XmLGridDeselectAllCells(3X)
239 XmLGridDeselectAllColumns(3X) XmLGridDeselectAllRows(3X)
240 XmLGridDeselectCell(3X) XmLGridDeselectColumn(3X) XmLGridDeselectRow(3X)
241 XmLGridEditBegin(3X) XmLGridEditCancel(3X) XmLGridEditComplete(3X)
242 XmLGridGetColumn(3X) XmLGridGetFocus(3X)
243 XmLGridGetRow(3X) XmLGridGetSelectedCellCount(3X) XmLGridGetSelectedCells(3X)
244 XmLGridGetSelectedColumnCount(3X) XmLGridGetSelectedColumns(3X)
245 XmLGridGetSelectedRow(3X) XmLGridGetSelectedRowCount(3X)
246 XmLGridGetSelectedRows(3X) XmLGridMoveColumns(3X) XmLGridMoveRows(3X)
247 XmLGridRead(3X) XmLGridReadPos(3X) XmLGridRedrawAll(3X) XmLGridRedrawCell(3X)
248 XmLGridRedrawColumn(3X) XmLGridRedrawRow(3X) XmLGridReorderColumns(3X)
249 XmLGridReorderRows(3X) XmLGridRowColumnToXY(3X) XmLGridRowlsVisible(3X)
250 XmLGridSelectAllCells(3X) XmLGridSelectAllColumns(3X) XmLGridSelectAllRows(3X)
251 XmLGridSelectCell(3X) XmLGridSelectColumn(3X) XmLGridSelectRow(3X)
252 XmLGridSetFocus(3X) XmLGridSetStrings(3X) XmLGridSetStringsPos(3X)
253 XmLGridWrite(3X) XmLGridWritePos(3X) XmLGridXYToRowColumn(3X)
254