XtParseTranslationTable.man   [plain text]

.\" $Xorg: XtParTTab.man,v 1.3 2000/08/17 19:42:02 cpqbld 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.
.\"
.\" $XFree86: xc/doc/man/Xt/XtParTTab.man,v 1.2 2001/01/27 18:20:28 dawes Exp $
.\"
.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-Translation-Table XtAugment-Translations XtOverride-Translations XtUninstall-Translations 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 XtParseTranslationTable __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
.SH NAME
XtParseTranslationTable, XtAugmentTranslations, XtOverrideTranslations, XtUninstallTranslations \- manage translation tables
.SH SYNTAX
.HP
XtTranslations XtParseTranslationTable(String \fItable\fP); 
.HP
void XtAugmentTranslations(Widget \fIw\fP, XtTranslations \fItranslations\fP);
.HP
void XtOverrideTranslations(Widget \fIw\fP, XtTranslations
\fItranslations\fP); 
.HP
void XtUninstallTranslations(Widget \fIw\fP); 
.SH ARGUMENTS
.IP \fItable\fP 1i
Specifies the translation table to compile.
.IP \fItranslations\fP 1i
Specifies the compiled translation table to merge in (must not be NULL).
.ds Wi into which the new translations are to be merged or removed
.IP \fIw\fP 1i
Specifies the widget \*(Wi.
.SH DESCRIPTION
The
.ZN XtParseTranslationTable
function compiles the translation table into the opaque internal representation
of type
.ZN XtTranslations .
Note that if an empty translation table is required for any purpose,
one can be obtained by calling
.ZN XtParseTranslationTable
and passing an empty string.
.LP
The
.ZN XtAugmentTranslations
function nondestructively merges the new translations into the existing widget
translations.
If the new translations contain an event or event sequence that
already exists in the widget's translations,
the new translation is ignored.
.LP
The
.ZN XtOverrideTranslations
function destructively merges the new translations into the existing widget
translations.
If the new translations contain an event or event sequence that
already exists in the widget's translations,
the new translation is merged in and override the widget's translation.
.LP
To replace a widget's translations completely, use
.ZN XtSetValues
on the XtNtranslations resource and specify a compiled translation table
as the value.
.LP
The
.ZN XtUninstallTranslations
function causes the entire translation table for widget to be removed.
.SH "SEE ALSO"
XtAppAddActions(3Xt),
XtCreatePopupShell(3Xt),
XtParseAcceleratorTable(3Xt),
XtPopup(3Xt)
.br
\fI\*(xT\fP
.br
\fI\*(xL\fP