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
.\" ***** BEGIN LICENSE BLOCK *****
.\" Version: MPL 1.1/GPL 2.0/LGPL 2.1
.\"
.\" The contents of this file are subject to the Mozilla Public License Version
.\" 1.1 (the "License"); you may not use this file except in compliance with
.\" the License. You may obtain a copy of the License at
.\" http://www.mozilla.org/MPL/
.\"
.\" Software distributed under the License is distributed on an "AS IS" basis,
.\" WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
.\" for the specific language governing rights and limitations under the
.\" License.
.\"
.\" The Original Code is the Microline Widget Library, originally made available under the NPL by Neuron Data <http://www.neurondata.com>.
.\"
.\" The Initial Developer of the Original Code is
.\" Netscape Communications Corporation.
.\" Portions created by the Initial Developer are Copyright (C) 1998
.\" the Initial Developer. All Rights Reserved.
.\"
.\" Contributor(s):
.\"
.\" Alternatively, the contents of this file may be used under the terms of
.\" either the GNU General Public License Version 2 or later (the "GPL"), or
.\" the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
.\" in which case the provisions of the GPL or the LGPL are applicable instead
.\" of those above. If you wish to allow use of your version of this file only
.\" under the terms of either the GPL or the LGPL, and not to allow others to
.\" use your version of this file under the terms of the MPL, indicate your
.\" decision by deleting the provisions above and replace them with the notice
.\" and other provisions required by the GPL or the LGPL. If you do not delete
.\" the provisions above, a recipient may use your version of this file under
.\" the terms of any one of the MPL, the GPL or the LGPL.
.\"
.\" In addition, as a special exception to the GNU GPL, the copyright holders
.\" give permission to link the code of this program with the Motif and Open
.\" Motif libraries (or with modified versions of these that use the same
.\" license), and distribute linked combinations including the two. You
.\" must obey the GNU General Public License in all respects for all of
.\" the code used other than linking with Motif/Open Motif. If you modify
.\" this file, you may extend this exception to your version of the file,
.\" but you are not obligated to do so. If you do not wish to do so,
.\" delete this exception statement from your version.
.\"
.\" ***** END LICENSE BLOCK *****
.TH XmLTree 3X "R1" "XML1" "XML"
.SH NAME
XmLTree
.SH SYNOPSIS
#include <XmL/Tree.h>
.LP
.SH DESCRIPTION
A Tree is a subclass of the Grid widget which displays a hierarchical
tree with a Pixmap, XmString, connecting lines and
possibly an expand/collapse graphic in the cells of its first column.
Each row in the Tree has a position and level which is
used to determine its relationship to other rows in the Tree. Rows
may be expanded or collapsed by clicking on an expand/collapse graphic
or by activating a row with the keyboard. The Tree inherits
all the abilities of the Grid widget, allowing it to contain
multiple columns and rows of varying types, heading and fixed rows and
columns, interactive row and column resizing, cell borders, etc.
.SS Class Information
Tree inherits from XmLGrid, XmManager, Constraint, Composite and Core.
Its class pointer is xmlTreeWidgetClass. Its class name is XmLTree.
.SS New Resources
The Tree resources defined below affect its overall layout and
appearance. Definitions of resources affecting rows, columns
and cells follow the Tree resource definitions.
.nf
.ft B
Name Class
Type Default Access
.ft P
XmNconnectingLineColor XmCConnectingLineColor
Pixel Dynamic CSG
XmNlevelSpacing XmCLevelSpacing
Dimension 11 CSG
XmNplusMinusColor XmCPlusMinusColor
Pixel Dynamic CSG
.fi
.IP XmNconnectingLineColor
The color of the line which is drawn connecting parents, children
and siblings in the first column of the Tree. This values defaults
to the foreground color of the Tree.
.IP XmNlevelSpacing
The indent in pixels for each level in the Tree.
.IP XmNplusMinusColor
The color of the plus and minus expand/collapse graphics drawn
next to parent nodes which may be expanded. This value defaults
to the foreground color of the Tree.
.SS Row/Column/Cell Resources
Tree defines the resources in the table below affecting rows. In addition
to these row resources, the Tree inherits all the row, column and cell
resources which exist in the Grid.
.nf
.ft B
Name Class
Type Default Access
.ft P
XmNrowExpands XmCRowExpands
Boolean False SG
XmNrowIsExpanded XmCRowIsExpanded
Boolean True SG
XmNrowLevel XmCRowLevel
int 0 SG
.fi
.IP XmNrowExpands
True if the row may expand (it is a parent) and False otherwise.
.IP XmNrowIsExpanded
True if the row is currently expanded and False otherwise. If this
resource is set to False, the Tree will hide all children of this
row. Children of this row are determined to be all rows which are
of a level greater than this row's until we find the next row
which is of this row's level or less (a sibling or parent of this
row). Rows are hidden by setting their XmNrowHeight to 0. If
this resource is set to True, the Tree will show all children of
this row. Rows are shown by setting their XmNrowHeight to 1.
The value of this resource has no meaning if XmNrowExpands is False.
.IP XmNrowLevel
The level of the row in the Tree.
.SS Callback Resources
Tree defines the following callback resources.
.nf
.ft B
Callback Reasons Called When
.ft P
XmNcollapseCallback XmCR_COLLAPSE_ROW Row is collapsed by activate
or by clicking on collapse
graphic
XmNexpandCallback XmCR_EXPAND_ROW Row is expanded by activate
or by clicking on expand
graphic
.fi
.SS Callback Structure
Each callback function is passed a pointer to a XmLGridCallbackStruct
structure. See the XmLGrid's Callback Structure section for the
full structure definition.
The following table shows which values are set for which callback
reasons. Elements not set will have undefined values.
.nf
.ft B
Reason Values Set
.ft P
XmCR_COLLAPSE_ROW event, rowType, row
XmCR_EXPAND_ROW event, rowType, row
.ni
.SS Inherited Resources
Tree inherits the resources shown below.
.nf
.ft B
Resource From Resource From
.ft P
XmNaccelerators Core XmNimmediateDraw Grid
XmNallowColumnHide Grid XmNinitialResourcePersist Core
XmNallowColumnResize Grid XmNinsertPosition Composite
XmNallowDragSelected Grid XmNlayoutFrozen Grid
XmNallowDrop Grid XmNleftFixedCount Grid
XmNallowRowHide Grid XmNleftFixedMargin Grid
XmNallowRowResize Grid XmNmappedWhenManaged Core
XmNancestorSensitive Core XmNnavagationType Manager
XmNautoSelect Grid XmNnumChildren Composite
XmNbackground Core XmNrightFixedCount Grid
XmNbackgroundPixmap Core XmNrightFixedMargin Grid
XmNblankBackground Grid XmNrows Grid
XmNborderColor Core XmNscreen Core
XmNborderPixmap Core XmNscrollBarMargin Grid
XmNborderWidth Core XmNscrollColumn Grid
XmNbottomFixedCount Grid XmNscrollRow Grid
XmNbottomFixedMargin Grid XmNselectBackground Grid
XmNbottomShadowColor Manager XmNselectForeground Grid
XmNbottomShadowPixmap Manager XmNselectionPolicy Grid
XmNchildren Composite XmNsensitive Core
XmNcolormap Core XmNshadowRegions Grid
XmNcolumns Grid XmNshadowThicknses Manager
XmNdebugLevel Grid XmNshadowType Grid
XmNdepth Core XmNsimpleHeadings Grid
XmNdestroyCallback Core XmNsimpleWidths Grid
XmNeditTranslations Grid XmNstringDirection Manager
XmNfontList Grid XmNtextWidget Grid
XmNfooterColumns Grid XmNtopFixedCount Grid
XmNfooterRows Grid XmNtopFixedMargin Grid
XmNforeground Manager XmNtopShadowColor Manager
XmNglobalPixmapHeight Grid XmNtopShadowPixmap Manager
XmNglobalPixmapWidth Grid XmNtranslations Core
XmNheadingColumns Grid XmNtraversalOn Manager
XmNheadingRows Grid XmNtraverseTranslations Grid
XmNheight Core XmNunitType Manager
XmNhelpCallback Manager XmNuseAverageFontWidth Grid
XmNhiddenColumns Grid XmNuserData Manager
XmNhiddenRows Grid XmNverticalScrollBar Grid
XmNhighlightColor Manager XmNverticalSizePolicy Grid
XmNhighlightThickness Grid XmNvisibleColumns Grid
XmNhighlightPixmap Manager XmNvisibleRows Grid
XmNhighlightRowMode Grid XmNvsbDisplayPolicy Grid
XmNhorizontalScrollBar Grid XmNwidth Core
XmNhorizontalSizePolicy Grid XmNx Core
XmNhsbDisplayPolicy Grid XmNy Core
.fi
.SS Inherited Row/Column/Cell Resources
Tree inherits the row/column and cell resources shown below.
.nf
.ft B
Resource From Resource From
.ft P
XmNcellAlignment Grid XmNcellTopBorderColor Grid
XmNcellBackground Grid XmNcellTopBorderType Grid
XmNcellBottomBorderColor Grid XmNcellType Grid
XmNcellBottomBorderType Grid XmNcellUserData Grid
XmNcellColumnSpan Grid XmNcolumn Grid
XmNcellDefaults Grid XmNcolumnPtr Grid
XmNcellEditable Grid XmNcolumnRangeEnd Grid
XmNcellFontList Grid XmNcolumnRangeStart Grid
XmNcellForeground Grid XmNcolumnSizePolicy Grid
XmNcellLeftBorderColor Grid XmNcolumnStep Grid
XmNcellLeftBorderType Grid XmNcolumnType Grid
XmNcellMarginBottom Grid XmNcolumnWidth Grid
XmNcellMarginLeft Grid XmNcolumnUserData Grid
XmNcellMarginRight Grid XmNrow Grid
XmNcellMarginTop Grid XmNrowHeight Grid
XmNcellPixmap Grid XmNrowPtr Grid
XmNcellPixmapMask Grid XmNrowRangeEnd Grid
XmNcellRightBorderColor Grid XmNrowRangeStart Grid
XmNcellRightBorderType Grid XmNrowSizePolicy Grid
XmNcellRowSpan Grid XmNrowStep Grid
XmNcellString Grid XmNrowType Grid
.fi
.SH "SEE ALSO"
XmLTreeAddRow(3X) XmLTreeAddRows(3X) XmLGridAddColumns(3X)
XmLGridColumnIsVisible(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)
XmLGridRead(3X) XmLGridReadPos(3X) XmLGridRedrawAll(3X) XmLGridRedrawCell(3X)
XmLGridRedrawColumn(3X) XmLGridRedrawRow(3X) XmLGridReorderColumns(3X)
XmLGridReorderRows(3X) XmLGridRowColumnToXY(3X) XmLGridRowlsVisible(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)