<!-- $XConsortium: Translat.sgm /main/9 1996/09/08 21:11:37 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->

<RefEntry Id="CDEMMA.MAN561.rsml.1">
<RefMeta>
<RefEntryTitle>XmTranslateKey</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmTranslateKey</Function></RefName>
<RefPurpose>The default keycode-to-keysym translator
<IndexTerm>
<Primary>XmTranslateKey</Primary>
</IndexTerm></RefPurpose>
</RefNameDiv>
<!-- -->
<!-- @OSF_COPYRIGHT@-->
<!-- COPYRIGHT NOTICE-->
<!-- Copyright (c) 1990, 1991, 1992, 1993 Open Software Foundation, Inc.-->
<!-- ALL RIGHTS RESERVED (MOTIF). See the file named COPY.MOTIF.DOC for-->
<!-- the full copyright text.-->
<!-- -->
<!-- HISTORY-->
<!-- -->
<!-- **-->
<!-- **-->
<!-- **  (c) Copyright 1989, 1990, 1992 by Open Software Foundation, Inc.-->
<!-- **      All Rights Reserved.-->
<!-- **-->
<!-- **  (c) Copyright 1987, 1988, 1989, by Hewlett-Packard Company-->
<!-- **-->
<!-- **  (c) Copyright 1987, 1988 by Digital Equipment Corporation,-->
<!-- **      Maynard, MA.  All Rights Reserved.-->
<!-- **-->
<!-- **-->
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/Xm.h>
</FuncSynopsisInfo>
<FuncDef>void <Function>XmTranslateKey</Function></FuncDef>
<!--<ParamDef><Replaceable>display, keycode, modifiers, modifiers_return, keysym_return</Replaceable></ParamDef>-->
<ParamDef>Display *<Parameter>display</Parameter></ParamDef>
<ParamDef>KeyCode <Parameter>keycode</Parameter></ParamDef>
<ParamDef>Modifiers <Parameter>modifiers</Parameter></ParamDef>
<ParamDef>Modifiers *<Parameter>modifiers_return</Parameter></ParamDef>
<ParamDef>KeySym *<Parameter>keysym_return</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmTranslateKey</Function> is the default <Symbol>XtKeyProc</Symbol> translation
procedure for Motif applications. The function takes a keycode
and modifiers and returns the corresponding keysym.
</Para>
<Para><Function>XmTranslateKey</Function> serves two main purposes: to enable new translators
with expanded functionality to get the default
Motif keycode-to-keysym translation in addition to whatever they add,
and to reinstall the default translator. This function enables
keysyms defined by the Motif virtual bindings to be used when an
application requires its own XtKeyProc to be installed.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">display</Symbol></Term>
<ListItem>
<Para>Specifies the display that the keycode is from
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">keycode</Symbol></Term>
<ListItem>
<Para>Specifies the keycode to translate
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">modifiers</Symbol></Term>
<ListItem>
<Para>Specifies the modifier keys to be applied to the keycode
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">modifiers_return</Symbol></Term>
<ListItem>
<Para>Specifies a mask of the modifier keys actually used to generate
the keysym (an AND of <Symbol Role="Variable">modifiers</Symbol> and any default modifiers
applied by the currently registered translator)
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">keysym_return</Symbol></Term>
<ListItem>
<Para>Specifies a pointer to the resulting keysym
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.VirtualBindings;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
