<!-- $XConsortium: ImGetXIC.sgm /main/9 1996/09/08 20:47:33 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.MAN265.rsml.1">
<RefMeta>
<RefEntryTitle>XmImGetXIC</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmImGetXIC</Function></RefName>
<RefPurpose>An input manager function that obtains an XIC for a widget
<IndexTerm>
<Primary>XmImGetXIC</Primary>
</IndexTerm><IndexTerm>
<Primary>input manager functions</Primary>
<Secondary>XmImGetXIC</Secondary>
</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-->
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/XmIm.h>
</FuncSynopsisInfo>
<FuncDef>XIC <Function>XmImGetXIC</Function></FuncDef>
<!--<ParamDef><Replaceable>widget, input_policy, args, num_args</Replaceable></ParamDef>-->
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
<ParamDef>XmInputPolicy <Parameter>input_policy</Parameter></ParamDef>
<ParamDef>ArgList <Parameter>args</Parameter></ParamDef>
<ParamDef>Cardinal <Parameter>num_args</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmImGetXIC</Function> creates and registers an X Input Context (XIC)
with the specified
arguments for <Symbol Role="Variable">widget</Symbol>. If <SystemItem Class="Constant">XmINHERIT_POLICY</SystemItem> is specified
for <Symbol Role="Variable">input_policy</Symbol>, a new XIC will be created only if
required to by the arguments or by the <Classname>VendorShell</Classname> input policy.
Any existing XIC registered with <Symbol Role="Variable">widget</Symbol> is unregistered.
</Para>
<Para>Refer to the <Classname>VendorShell</Classname> reference page for further details.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">widget</Symbol></Term>
<ListItem>
<Para>Specifies the ID of a widget for which an Input Context is to be
created.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">input_policy</Symbol></Term>
<ListItem>
<Para>Specifies the type of input policy. It accepts the following values:
</Para>
<VariableList>
<VarListEntry>
<Term><SystemItem Class="Constant">XmINHERIT_POLICY</SystemItem></Term>
<ListItem>
<Para>Inherits the policy from <Classname>VendorShell</Classname>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="Constant">XmPER_WIDGET</SystemItem></Term>
<ListItem>
<Para>Creates a new XIC for this widget.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="Constant">XmPER_SHELL</SystemItem></Term>
<ListItem>
<Para>Creates a new XIC for the shell, if needed.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">args</Symbol></Term>
<ListItem>
<Para>Specifies an <Symbol>XtArgList</Symbol> parameter to use for creating the XIC.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">num_args</Symbol></Term>
<ListItem>
<Para>Specifies the number of arguments in the <Symbol Role="Variable">args</Symbol> parameter.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Returns the created XIC.
The application is responsible for freeing the returned XIC
by calling <Function>XmImFreeXIC</Function>.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmImSetXIC; and
&cdeman.XmImFreeXIC;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
