summaryrefslogtreecommitdiff
path: root/man/XtParseAcceleratorTable.man
diff options
context:
space:
mode:
authorKaleb Keithley <kaleb@freedesktop.org>2003-11-14 15:54:39 +0000
committerKaleb Keithley <kaleb@freedesktop.org>2003-11-14 15:54:39 +0000
commit0117b0b441d8835a11a2886f3c8aed937dcffa9d (patch)
treef4acfebbb67f382f645fb876acb0278891a6a91a /man/XtParseAcceleratorTable.man
R6.6 is the Xorg base-lineXORG-MAIN
Diffstat (limited to 'man/XtParseAcceleratorTable.man')
-rw-r--r--man/XtParseAcceleratorTable.man185
1 files changed, 185 insertions, 0 deletions
diff --git a/man/XtParseAcceleratorTable.man b/man/XtParseAcceleratorTable.man
new file mode 100644
index 0000000..7585473
--- /dev/null
+++ b/man/XtParseAcceleratorTable.man
@@ -0,0 +1,185 @@
+.\" $Xorg: XtParATab.man,v 1.4 2001/03/16 17:53:52 pookie Exp $
+.\"
+.\" Copyright 1993 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.
+.ds tk X Toolkit
+.ds xT X Toolkit Intrinsics \- C Language Interface
+.ds xI Intrinsics
+.ds xW X Toolkit Athena Widgets \- C Language Interface
+.ds xL Xlib \- C Language X Interface
+.ds xC Inter-Client Communication Conventions Manual
+.ds Rn 3
+.ds Vn 2.2
+.hw XtParse-Accelerator-Table XtInstall-Accelerators XtInstall-All-Accelerators wid-get
+.na
+.de Ds
+.nf
+.\\$1D \\$2 \\$1
+.ft 1
+.ps \\n(PS
+.\".if \\n(VS>=40 .vs \\n(VSu
+.\".if \\n(VS<=39 .vs \\n(VSp
+..
+.de De
+.ce 0
+.if \\n(BD .DF
+.nr BD 0
+.in \\n(OIu
+.if \\n(TM .ls 2
+.sp \\n(DDu
+.fi
+..
+.de FD
+.LP
+.KS
+.TA .5i 3i
+.ta .5i 3i
+.nf
+..
+.de FN
+.fi
+.KE
+.LP
+..
+.de IN \" send an index entry to the stderr
+..
+.de C{
+.KS
+.nf
+.D
+.\"
+.\" choose appropriate monospace font
+.\" the imagen conditional, 480,
+.\" may be changed to L if LB is too
+.\" heavy for your eyes...
+.\"
+.ie "\\*(.T"480" .ft L
+.el .ie "\\*(.T"300" .ft L
+.el .ie "\\*(.T"202" .ft PO
+.el .ie "\\*(.T"aps" .ft CW
+.el .ft R
+.ps \\n(PS
+.ie \\n(VS>40 .vs \\n(VSu
+.el .vs \\n(VSp
+..
+.de C}
+.DE
+.R
+..
+.de Pn
+.ie t \\$1\fB\^\\$2\^\fR\\$3
+.el \\$1\fI\^\\$2\^\fP\\$3
+..
+.de ZN
+.ie t \fB\^\\$1\^\fR\\$2
+.el \fI\^\\$1\^\fP\\$2
+..
+.de NT
+.ne 7
+.ds NO Note
+.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
+.if \\n(.$ .if !'\\$1'C' .ds NO \\$1
+.ie n .sp
+.el .sp 10p
+.TB
+.ce
+\\*(NO
+.ie n .sp
+.el .sp 5p
+.if '\\$1'C' .ce 99
+.if '\\$2'C' .ce 99
+.in +5n
+.ll -5n
+.R
+..
+. \" Note End -- doug kraft 3/85
+.de NE
+.ce 0
+.in -5n
+.ll +5n
+.ie n .sp
+.el .sp 10p
+..
+.ny0
+.TH XtParseAcceleratorTable 3Xt "Release 6.6" "X Version 11" "XT FUNCTIONS"
+.SH NAME
+XtParseAcceleratorTable, XtInstallAccelerators, XtInstallAllAccelerators \- managing accelerator tables
+.SH SYNTAX
+XtAccelerators XtParseAcceleratorTable(\fIsource\fP)
+.br
+ String \fIsource\fP;
+.LP
+void XtInstallAccelerators(\fIdestination\fP, \fIsource\fP)
+.br
+ Widget \fIdestination\fP;
+.br
+ Widget \fIsource\fP;
+.LP
+void XtInstallAllAccelerators(\fIdestination\fP, \fIsource\fP)
+.br
+ Widget \fIdestination\fP;
+.br
+ Widget \fIsource\fP;
+.SH ARGUMENTS
+.ds So to compile
+.IP \fIsource\fP 1i
+Specifies the accelerator table \*(So.
+.IP \fIdestination\fP 1i
+Specifies the widget on which the accelerators are to be installed.
+.ds Sr widget or the root widget of the widget tree
+.IP \fIsource\fP 1i
+Specifies the \*(Sr from which the accelerators are to come.
+.SH DESCRIPTION
+The
+.ZN XtParseAcceleratorTable
+function compiles the accelerator table into the opaque internal representation.
+.LP
+The
+.ZN XtInstallAccelerators
+function installs the accelerators from source onto destination
+by augmenting the destination translations with the source accelerators.
+If the source display_accelerator method is non-NULL,
+.ZN XtInstallAccelerators
+calls it with the source widget and a string representation
+of the accelerator table,
+which indicates that its accelerators have been installed
+and that it should display them appropriately.
+The string representation of the accelerator table is its
+canonical translation table representation.
+.LP
+The
+.ZN XtInstallAllAccelerators
+function recursively descends the widget tree rooted at source
+and installs the accelerators of each widget encountered onto destination.
+A common use os to call
+.ZN XtInstallAllAccelerators
+and pass the application main window as the source.
+.SH "SEE ALSO"
+XtParseTranslationTable(1)
+.br
+\fI\*(xT\fP
+.br
+\fI\*(xL\fP