Blob Blame History Raw
.\" Motif
.\"
.\" Copyright (c) 1987-2012, The Open Group. All rights reserved.
.\"
.\" These libraries and programs are free software; you can
.\" redistribute them and/or modify them under the terms of the GNU
.\" Lesser General Public License as published by the Free Software
.\" Foundation; either version 2 of the License, or (at your option)
.\" any later version.
.\"
.\" These libraries and programs are distributed in the hope that
.\" they will be useful, but WITHOUT ANY WARRANTY; without even the
.\" implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
.\" PURPOSE. See the GNU Lesser General Public License for more
.\" details.
.\"
.\" You should have received a copy of the GNU Lesser General Public
.\" License along with these librararies and programs; if not, write
.\" to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
.\" Floor, Boston, MA 02110-1301 USA
...\" 
...\" 
...\" HISTORY
# $XConsortium: ComponentList.3X /main/4 1995/07/13 19:58:32 drk $
...\" **
...\" **  (c) Copyright 1991, 1992 by Open Software Foundation, Inc.
...\" **      All Rights Reserved.
...\" **
...\" **
.TH ComponentList 3X
.SH NAME
\*LComponentList \*O\(em List of available Components for Automation
.SH DESCRIPTION
The
\*LComponentList\*O
is a List of the available component regions
for use with Automation. A component
describes a particular region of the widget in question. A component is 
usually another widget inside a composite widget. An example of a component
is the Help Button in a MessageBox. This component is actually a Push Button,
but we need know only its component name, not its actual \*LXtName\*L,
to reference it.
The following is a list of valid components for all Motif widgets.
There is some overlap in the components. All component names start with a
capital R.
.SH XmCommand:
.IP "\*VRSelectionList\*O" 10n
Describes the Command's List widget.
.IP "\*VRSelectionListItem\*O" 10n
Describes a List item within the Command's List widget.
.IP "\*VRSelectionText\*O" 
Describes the Command's Text widget.
.IP "\*VRSelectionTextChar\*O" 
Describes a Text character within the Command's Text widget.
.IP "\*VRLabel\*O"
Describes the Label above the Command's Text widget.
.IP "\*VRSelectListHorizScrollBarLeftArrow\*O"
Describes the horizontal ScrollBar's left arrow (if it exists).
.IP "\*VRSelectListHorizScrollBarRightArrow\*O"
Describes the horizontal ScrollBar's right arrow (if it exists).
.IP "\*VRSelectListHorizScrollBarLeftSliderArea\*O"
Describes the area in the horizontal ScrollBar's trough to the left
of the current slider position (if it exists).
.IP "\*VRSelectListHorizScrollBarRightSliderArea\*O"
Describes the area in the horizontal ScrollBar's trough to the right
of the current slider position (if it exists).
.IP "\*VRSelectListHorizScrollBarSlider\*O"
Describes the midpoint of the horizontal ScrollBar's slider (if it exists).
.IP "\*VRSelectListVertScrollBarUpArrow\*O"
Describes the vertical ScrollBar's up arrow (if it exists).
.IP "\*VRSelectListVertScrollBarDownArrow\*O"
Describes the vertical ScrollBar's down arrow (if it exists).
.IP "\*VRSelectListVertScrollBarLeftSliderArea\*O"
Describes the area in the vertical ScrollBar's trough to the left
of the current slider position (if it exists).
.IP "\*VRSelectListVertScrollBarRightSliderArea\*O"
Describes the area in the vertical ScrollBar's trough to the right
of the current slider position (if it exists).
.IP "\*VRSelectListVertScrollBarSlider\*O"
Describes the midpoint of the vertical ScrollBar's slider (if it exists).
.SH XmFileSelectionBox:
.IP "\*VRFileSelectionText\*O"
Describes the text region for displaying and editing a filename.
.IP "\*VRFileSelectionTextChar\*O"
Describes a character within the selection Text Widget. Characters are numbered
starting at 0.
.IP "\*VRFileSelectionLabel\*O"
Describes the label above the selection Text Widget.
.IP "\*VRFileFilterText\*O"
Describes the text region for displaying and editing a directory mask used to
select the files to be displayed.
.IP "\*VRFileFilterTextChar\*O"
Describes a character within the filter Text Widget. Characters are numbered
starting at 0.
.IP "\*VRFileFilterLabel\*O"
Describes the label above the filter Text Widget.
.IP "\*VRFileList\*O"
Describes the scrollable List which contains filenames.
.IP "\*VRFileListLabel\*O"
Describes the label above the filenames List.
.IP "\*VRFileListItem\*O"
Describes a List item in the filenames List. 0 defines the first item
position in the List.
.IP "\*VRDirList\*O"
Describes the scrollable List which contains subdirectories.
.IP "\*VRDirListLabel\*O"
Describes the label above the directory List.
.IP "\*VRDirListItem\*O"
Describes a List item in the directory List. 0 defines the first item
position in the List.
.IP "\*VRSeparator\*O"
Describes the Separator widget.
.IP "\*VROkButton\*O"
Describes the FileSelectionBox's OK PushButton.
.IP "\*VRCancelButton\*O"
Describes the FileSelectionBox's Cancel PushButton.
.IP "\*VRFilterButton\*O"
Describes the FileSelectionBox's Filter (Apply) PushButton.
.IP "\*VRHelpButton\*O"
Describes the FileSelectionBox's Help PushButton.
.IP "\*VRFileListHorizScrollBarLeftArrow\*O"
Describes the File List's horizontal ScrollBar's left arrow.
.IP "\*VRFileListHorizScrollBarRightArrow\*O"
Describes the File List's horizontal ScrollBar's right arrow.
.IP "\*VRFileListHorizScrollBarLeftSliderArea\*O"
Describes the area in the File List's horizontal ScrollBar's trough to
the left of the current slider position.
.IP "\*VRFileListHorizScrollBarRightSliderArea\*O"
Describes the area in the File List's horizontal ScrollBar's trough to
the right of the current slider position.
.IP "\*VRFileListHorizScrollBarSlider\*O"
Describes the midpoint of the File List's horizontal ScrollBar's slider.
.IP "\*VRFileListVertScrollBarUpArrow\*O"
Describes the File List's vertical ScrollBar's up arrow.
.IP "\*VRFileListVertScrollBarDownArrow\*O"
Describes the File List's vertical ScrollBar's down arrow.
.IP "\*VRFileListVertScrollBarLeftSliderArea\*O"
Describes the area in the File List's vertical ScrollBar's trough to the left
of the current slider position.
.IP "\*VRFileListVertScrollBarRightSliderArea\*O"
Describes the area in the File List's vertical ScrollBar's trough to the right
of the current slider position.
.IP "\*VRFileListVertScrollBarSlider\*O"
Describes the midpoint of the File List's vertical ScrollBar's slider.
.IP "\*VRDirListHorizScrollBarLeftArrow\*O"
Describes the Dir List's horizontal ScrollBar's left arrow.
.IP "\*VRDirListHorizScrollBarRightArrow\*O"
Describes the Dir List's horizontal ScrollBar's right arrow.
.IP "\*VRDirListHorizScrollBarLeftSliderArea\*O"
Describes the area in the Dir List's horizontal ScrollBar's trough to
the left of the current slider position.
.IP "\*VRDirListHorizScrollBarRightSliderArea\*O"
Describes the area in the Dir List's horizontal ScrollBar's trough to
the right of the current slider position.
.IP "\*VRDirListHorizScrollBarSlider\*O"
Describes the midpoint of the Dir List's horizontal ScrollBar's slider.
.IP "\*VRDirListVertScrollBarUpArrow\*O"
Describes the Dir List's vertical ScrollBar's up arrow.
.IP "\*VRDirListVertScrollBarDownArrow\*O"
Describes the Dir List's vertical ScrollBar's down arrow.
.IP "\*VRDirListVertScrollBarLeftSliderArea\*O"
Describes the area in the Dir List's vertical ScrollBar's trough to the left
of the current slider position.
.IP "\*VRDirListVertScrollBarRightSliderArea\*O"
Describes the area in the Dir List's vertical ScrollBar's trough to the right
of the current slider position.
.IP "\*VRDirListVertScrollBarSlider\*O"
Describes the midpoint of the Dir List's vertical ScrollBar's slider.
.SH XmList:
.IP "\*VRListItem\*O"
Describes an item contained in a List. 0 defines the first item
position in the List.
.IP "\*VRHorizScrollBarLeftArrow\*O"
Describes the horizontal ScrollBar's left arrow (if it exists).
.IP "\*VRHorizScrollBarRightArrow\*O"
Describes the horizontal ScrollBar's right arrow (if it exists).
.IP "\*VRHorizScrollBarLeftSliderArea\*O"
Describes the area in the horizontal ScrollBar's trough to the left
of the current slider position (if it exists).
.IP "\*VRHorizScrollBarRightSliderArea\*O"
Describes the area in the horizontal ScrollBar's trough to the right
of the current slider position (if it exists).
.IP "\*VRHorizScrollBarSlider\*O"
Describes the midpoint of the horizontal ScrollBar's slider (if it exists).
.IP "\*VRVertScrollBarUpArrow\*O"
Describes the vertical ScrollBar's up arrow (if it exists).
.IP "\*VRVertScrollBarDownArrow\*O"
Describes the vertical ScrollBar's down arrow (if it exists).
.IP "\*VRVertScrollBarUpSliderArea\*O"
Describes the area in the vertical ScrollBar's trough above the slider
of the current slider position (if it exists).
.IP "\*VRVertScrollBarDownSliderArea\*O"
Describes the area in the vertical ScrollBar's trough below the slider
of the current slider position (if it exists).
.IP "\*VRVertScrollBarSlider\*O"
Describes the midpoint of the vertical ScrollBar's slider (if it exists).
.SH XmMainWindow:
.IP "\*VRCommandWindow\*O"
Describes the command widget associated with the MainWindow.
.IP "\*VRMessageWindow\*O"
Describes the message widget associated with the MainWindow.
.IP "\*VRMenuBar\*O"
Describes the MenuBar widget associated with the MainWindow.
.IP "\*VRWorkWindow\*O"
Describes the work area widget associated with the MainWindow.
.IP "\*VRSeparator\*O"
Describes the Separator widgets associated with the MainWindow. 
.IP "\*VRVertScrollBar\*O"
Describes the vertical ScrollBar widget associated with the MainWindow.
.IP "\*VRHorizScrollBar\*O"
Describes the horizontal ScrollBar widget associated with the MainWindow.
.SH XmMessageBox:
.IP "\*VROkButton\*O
Describes the MessageBox's OK button.
.IP "\*VRCancelButton\*O
Describes the MessageBox's Cancel button.
.IP "\*VRHelpButton\*O
Describes the MessageBox's Help button.
.IP "\*VRMessageLabel\*O
Describes the MessageBox's Message label string.
.IP "\*VRSeparator\*O
Describes the MessageBox's Separator.
.IP "\*VRSymbolLabel\*O
Describes the MessageBox's message symbol.
.SH XmOptionMenu:
.IP "\*VROptionButton\*O
Describes the Option menu's selection area.
.IP "\*VRLabel\*O
Describes the Option menu's Label.
.SH XmPanedWindow:
.IP "\*VRSash\*O
Describes the sashes contained in the PanedWindow. Sash 0 is the poition of
the first sash in the PanedWindow.
.SH XmPulldown:
.IP "\*VRTearOffButton\*O
Describes the TearOffButton associated with the Pulldown menu (If it exists).
.SH XmPopupMenu:
.IP "\*VRTearOffButton\*O
Describes the TearOffButton associated with the Popup menu (If it exists).
.SH XmScale:
.IP "\*VRScaleLabel\*O
Describes the Label associated with the Scale.
.IP "\*VRScaleUpOrLeftSliderArea\*O
Describes the region of the Scale to the left or above the slider in the trough
(depending on the Scale's orientation).
.IP "\*VRScaleDownOrRightSliderArea\*O.
Describes the region of the Scale to the right or below the slider in the trough
(depending on the Scale's orientation).
.IP "\*VRScaleSlider\*O
Describes the midpoint of the Scale's slider.
.SH XmScrollBar:
.IP "\*VRUpOrLeftSliderArea\*O
Describes the region of the Scale to the left or above the slider in the trough
(depending on the ScrollBars's orientation).
.IP "\*VRDownOrRightSliderArea\*O
Describes the region of the Scale to the right or below the slider in the trough
(depending on the ScrollBars's orientation).
.IP "\*VRSlider\*O
Describes the midpoint of the Scale's slider.
.IP "\*VRDownOrRightArrow\*O
Describes the Top or Right arrow in ScrollBar (depending on the ScrollBars's
orientation).
.IP "\*VRUpOrLeftArrow\*O
Describes the Bottom or Left arrow in ScrollBar (depending on the ScrollBars's
orientation).
.SH XmScrolledWindow:
.IP "\*VRHorizScrollBarLeftArrow\*O"
Describes the horizontal ScrollBar's left arrow (if it exists).
.IP "\*VRHorizScrollBarRightArrow\*O"
Describes the horizontal ScrollBar's right arrow (if it exists).
.IP "\*VRHorizScrollBarLeftSliderArea\*O"
Describes the area in the horizontal ScrollBar's trough to the left
of the current slider position (if it exists).
.IP "\*VRHorizScrollBarRightSliderArea\*O"
Describes the area in the horizontal ScrollBar's trough to the right
of the current slider position (if it exists).
.IP "\*VRHorizScrollBarSlider\*O"
Describes the midpoint of the horizontal ScrollBar's slider (if it exists).
.IP "\*VRVertScrollBarUpArrow\*O"
Describes the vertical ScrollBar's up arrow (if it exists).
.IP "\*VRVertScrollBarDownArrow\*O"
Describes the vertical ScrollBar's down arrow (if it exists).
.IP "\*VRVertScrollBarDownSliderArea\*O"
Describes the area in the vertical ScrollBar's trough to the below
of the current slider position (if it exists).
.IP "\*VRVertScrollBarUpSliderArea\*O"
Describes the area in the vertical ScrollBar's trough to the above
of the current slider position (if it exists).
.IP "\*VRVertScrollBarSlider\*O"
Describes the midpoint of the vertical ScrollBar's slider (if it exists).
.SH XmSelectionBox:
.IP "\*VRSelectionList\*O"
Describes the SelectionBox's ScrolledList of alternatives.
.IP "\*VRSelectionListItem\*O"
Describes a List item in the selection List. 0 defines the first item
position in the List.
.IP "\*VRSelectListHorizScrollBarLeftArrow\*O"
Describes the SelectionBox List's horizontal Scrollbar left 
arrow (if it exists).
.IP "\*VRSelectListHorizScrollBarRightArrow\*O"
Describes the SelectionBox List's horizontal Scrollbar right 
arrow (if it exists).
.IP "\*VRSelectListHorizScrollBarLeftSliderArea\*O"
Describes the area in the SelectionBox List's horizontal ScrollBar's trough to
the left of the current slider position.
.IP "\*VRSelectListHorizScrollBarRightSliderArea\*O"
Describes the area in the SelectionBox List's horizontal ScrollBar's trough to
the right of the current slider position.
.IP "\*VRSelectListHorizScrollBarSlider\*O"
Describes the midpoint of the SelectionBox List's horizontal ScrollBar's slider.
.IP "\*VRSelectListVertScrollBarUpArrow\*O"
Describes the SelectionBox List's vertical Scrollbar up 
arrow (if it exists).
.IP "\*VRSelectListVertScrollBarDownArrow\*O"
Describes the SelectionBox List's vertical Scrollbar down 
arrow (if it exists).
.IP "\*VRSelectListVertScrollBarUpSliderArea\*O"
Describes the area in the SelectionBox List's vertical ScrollBar's trough
above the current slider position.
.IP "\*VRSelectListVertScrollBarDownSliderArea\*O"
Describes the area in the SelectionBox List's vertical ScrollBar's trough
below the current slider position.
.IP "\*VRSelectListVertScrollBarSlider\*O"
Describes the midpoint of the SelectionBox List's vertical ScrollBar's slider.
.IP "\*VRSelectionListLabel\*O"
Describes the Label associated with the SelectionBox's List.
.IP "\*VRSelectionText\*O"
Describes the SelectionBox's Text widget for the selected alternative.
.IP "\*VRSelectionTextChar\*O"
Describes a character in the SelectionBox's Text widget.
.IP "\*VRSelectionLabel\*O"
Describes the label for the SelctionBox's Text widget.
.IP "\*VROkButton\*O"
Describes the SelectionBox's OK PushButton.
.IP "\*VRCancelButton\*O"
Describes the SelectionBox's Cancel PushButton.
.IP "\*VRHelpButton\*O"
Describes the SelectionBox's Help PushButton.
.IP "\*VRApplyButton\*O"
Describes the SelectionBox's Apply PushButton.
.IP "\*VRSeparator\*O"
Describes the SelectionBox's Separators
.SH XmText:
.IP "\*VRTextChar\*O"
Describes a single character in the Text widget. Characters are numbered
starting at 0.
.IP "\*VRHorizScrollBarLeftArrow\*O"
Describes the horizontal ScrollBar's left arrow (if it exists).
.IP "\*VRHorizScrollBarRightArrow\*O"
Describes the horizontal ScrollBar's right arrow (if it exists).
.IP "\*VRHorizScrollBarLeftSliderArea\*O"
Describes the area in the horizontal ScrollBar's trough to the left
of the current slider position (if it exists).
.IP "\*VRHorizScrollBarRightSliderArea\*O"
Describes the area in the horizontal ScrollBar's trough to the right
of the current slider position (if it exists).
.IP "\*VRHorizScrollBarSlider\*O"
Describes the midpoint of the horizontal ScrollBar's slider (if it exists).
.IP "\*VRVertScrollBarUpArrow\*O"
Describes the vertical ScrollBar's up arrow (if it exists).
.IP "\*VRVertScrollBarDownArrow\*O"
Describes the vertical ScrollBar's down arrow (if it exists).
.IP "\*VRVertScrollBarLeftSliderArea\*O"
Describes the area in the vertical ScrollBar's trough to the left
of the current slider position (if it exists).
.IP "\*VRVertScrollBarRightSliderArea\*O"
Describes the area in the vertical ScrollBar's trough to the right
of the current slider position (if it exists).
.IP "\*VRVertScrollBarSlider\*O"
Describes the midpoint of the vertical ScrollBar's slider (if it exists).
.PP
For more information about \*LButtonList\*O, see
the \*EOSF/Motif Quality Assurance Test Suite User's Guide\*O.
.PP
.SH "RELATED INFORMATION"
.na
\*LLocatePointer(3X)\*O, \*LDragComponent(3X)\*O
.ad