diff options
Diffstat (limited to 'app/viewres/man/viewres.man')
| -rw-r--r-- | app/viewres/man/viewres.man | 217 |
1 files changed, 217 insertions, 0 deletions
diff --git a/app/viewres/man/viewres.man b/app/viewres/man/viewres.man new file mode 100644 index 000000000..672aff8f9 --- /dev/null +++ b/app/viewres/man/viewres.man @@ -0,0 +1,217 @@ +.\" $XConsortium: viewres.man,v 1.8 94/04/17 20:43:25 gildea Exp $ +.\" Copyright (c) 1994 X Consortium +.\" +.\" Permission is hereby granted, free of charge, to any person obtaining +.\" a copy of this software and associated documentation files (the +.\" "Software"), to deal in the Software without restriction, including +.\" without limitation the rights to use, copy, modify, merge, publish, +.\" distribute, sublicense, and/or sell copies of the Software, and to +.\" permit persons to whom the Software is furnished to do so, subject to +.\" the following conditions: +.\" +.\" The above copyright notice and this permission notice shall be included +.\" in all copies or substantial portions of the Software. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR +.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, +.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +.\" OTHER DEALINGS IN THE SOFTWARE. +.\" +.\" Except as contained in this notice, the name of the X Consortium shall +.\" not be used in advertising or otherwise to promote the sale, use or +.\" other dealings in this Software without prior written authorization +.\" from the X Consortium. +.\" +.\" $XFree86: xc/programs/viewres/viewres.man,v 1.3 2001/01/27 18:21:07 dawes Exp $ +.\" +.TH VIEWRES 1 __xorgversion__ +.SH NAME +viewres - graphical class browser for Xt +.SH SYNOPSIS +.B "viewres" +[-option ...] +.SH DESCRIPTION +.PP +The \fIviewres\fP program displays a tree showing the widget class hierarchy of +the Athena Widget Set. Each node in the tree can be expanded to show the +resources that the corresponding class adds (i.e. does not inherit from its +parent) when a widget is created. This application allows the user to visually +examine the structure and inherited resources for the Athena Widget Set. +.SH OPTIONS +\fIViewres\fP accepts all of the standard toolkit command line options as +well as the following: +.TP 8 +.B \-top \fIname\fP +This option specifies the name of the highest widget in the hierarchy to +display. This is typically used to limit the display to a subset of the +tree. The default is \fIObject\fP. +.TP 8 +.B \-variable +This option indicates that the widget variable names (as declared in +header files) should be displayed in the nodes rather than the widget +class name. This is sometimes useful to distinguish widget classes that +share the same name (such as \fIText\fP). +.TP 8 +.B \-vertical +This option indicates that the tree should be displayed top to bottom +rather left to right. +.SH "VIEW MENU" +The way in which the tree is displayed may be changed through the +entries in the \fBView\fP menu: +.TP 8 +.B "Show Variable Names" +This entry causes the node labels to be set to the variable names used +to declare the corresponding widget class. This operation may also be +performed with the \fBSetLabelType(variable)\fP translation. +.TP 8 +.B "Show Class Names" +This entry causes the node labels to be set to the class names used when +specifying resources. This operation may also be performed with the +\fBSetLabelType(class)\fP translation. +.TP 8 +.B "Layout Horizontal" +This entry causes the tree to be laid out from left to right. This operation +may also be performed with the \fISetOrientation(West)\fP translation. +.TP 8 +.B "Layout Vertical" +This entry causes the tree to be laid out from top to bottom. This operation +may also be performed with the \fISetOrientation(North)\fP translation. +.TP 8 +.B "Show Resource Boxes" +This entry expands the selected nodes (see next section) to show the +new widget and constraint resources. This operation +may also be performed with the \fIResources(on)\fP translation. +.TP 8 +.B "Hide Resource Boxes" +This entry removes the resource displays from the selected nodes (usually to +conserve space). This operation +may also be performed with the \fIResources(off)\fP translation. +.SH "SELECT MENU" +Resources for a single widget class can be displayed by clicking +\fBButton2\fP on the corresponding node, or by adding the node to the +selection list with \fBButton1\fP and using the \fBShow Resource Boxes\fP +entry in the \fBView\fP menu. Since \fBButton1\fP actually toggles the +selection state of a node, clicking on a selected node will cause it to be +removed from the selected list. +.PP +Collections of nodes may also be selected through the various entries in +the \fBSelect\fP menu: +.TP 8 +.B "Unselect All" +This entry removes all nodes from the selection list. This operation +may also be performed with the \fISelect(nothing)\fP translation. +.TP 8 +.B "Select All" +This entry adds all nodes to the selection list. This operation +may also be performed with the \fISelect(all)\fP translation. +.TP 8 +.B "Invert All" +This entry adds unselected nodes to, and removes selected nodes from, the +selection list. This operation +may also be performed with the \fISelect(invert)\fP translation. +.TP 8 +.B "Select Parent" +This entry selects the immediate parents of all selected nodes. This operation +may also be performed with the \fISelect(parent)\fP translation. +.TP 8 +.B "Select Ancestors" +This entry recursively selects all parents of all selected nodes. This +operation may also be performed with the \fISelect(ancestors)\fP translation. +.TP 8 +.B "Select Children" +This entry selects the immediate children of all selected nodes. This +operation may also be performed with the \fISelect(children)\fP translation. +.TP 8 +.B "Select Descendants" +This entry recursively selects all children of all selected nodes. This +operation may also be performed with the \fISelect(descendants)\fP translation. +.TP 8 +.B "Select Has Resources" +This entry selects all nodes that add new resources (regular or constraint) +to their corresponding widget classes. This operation +may also be performed with the \fISelect(resources)\fP translation. +.TP 8 +.B "Select Shown Resource Boxes" +This entry selects all nodes whose resource boxes are currently expanded +(usually so that they can be closed with \fBHide Resource Boxes\fP). This +operation may also be performed with the \fISelect(shown)\fP translation. +.SH "ACTIONS" +The following application actions are provided: +.TP 8 +.B "Quit()" +.br +This action causes \fIviewres\fP to exit. +.TP 8 +.B "SetLabelType(\fItype\fP)" +This action sets the node labels to display the widget \fIvariable\fP or +\fIclass\fP names, according to the argument \fItype\fP. +.TP 8 +.B "SetOrientation(\fIdirection\fP)" +This action sets the root of the tree to be one of the following areas of +the window: \fIWest\fP, \fINorth\fP, \fIEast\fP, or \fISouth\fP. +.TP 8 +.B "Select(\fIwhat\fP)" +This action selects the indicated nodes, as described in the \fBVIEW MENU\fP +section: \fInothing\fP (unselects all nodes), \fIinvert\fP, \fIparent\fP, +\fIancestors\fP, \fIchildren\fP, \fIdescendants\fP, \fIresources\fP, +\fIshown\fP. +.TP 8 +.B "Resources(\fIop\fP)" +This action turns \fIon\fP, \fIoff\fP, or \fItoggles\fP the resource boxes +for the selected nodes. +If invoked from within one of the nodes (through the keyboard or pointer), +only that node is used. +.SH "WIDGET HIERARCHY" +Resources may be specified for the following widgets: +.sp +.ft CW +.nf +Viewres viewres + Paned pane + Box buttonbox + Command quit + MenuButton view + SimpleMenu viewMenu + SmeBSB layoutHorizontal + SmeBSB layoutVertical + SmeLine line1 + SmeBSB namesVariable + SmeBSB namesClass + SmeLine line2 + SmeBSB viewResources + SmeBSB viewNoResources + MenuButton select + SimpleMenu selectMenu + SmeBSB unselect + SmeBSB selectAll + SmeBSB selectInvert + SmeLine line1 + SmeBSB selectParent + SmeBSB selectAncestors + SmeBSB selectChildren + SmeBSB selectDescendants + SmeLine line2 + SmeBSB selectHasResources + SmeBSB selectShownResources + Form treeform + Porthole porthole + Tree tree + Box \fIvariable-name\fP + Toggle \fIvariable-name\fP + List \fIvariable-name\fP + Panner panner +.fi +.ft +.sp +where \fIvariable-name\fP is the widget variable name of each node. +.SH "SEE ALSO" +X(__miscmansuffix__), xrdb(__appmansuffix__), listres(__appmansuffix__), editres(__appmansuffix__), appres(__appmansuffix__), appropriate widget documents +.SH COPYRIGHT +Copyright 1994 X Consortium +.br +See \fIX(__miscmansuffix__)\fP for a full statement of rights and permissions. +.SH AUTHOR +Jim Fulton, MIT X Consortium |