<!-- $XConsortium: StrDrB.sgm /main/9 1996/09/08 21:04:26 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.MAN420.rsml.1">
<RefMeta>
<RefEntryTitle>XmStringDrawImage</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmStringDrawImage</Function></RefName>
<RefPurpose>A compound string function that draws a compound string in an X Window and creates an image
<IndexTerm>
<Primary>XmStringDrawImage</Primary>
</IndexTerm><IndexTerm>
<Primary>compound string functions</Primary>
<Secondary>XmStringDrawImage</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-->
<!-- -->
<!-- **-->
<!-- **-->
<!-- **  (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>XmStringDrawImage</Function></FuncDef>
<!--<ParamDef><Replaceable>d, w, rendertable, string, gc, x, y, width, alignment, layout_direction, clip</Replaceable></ParamDef>-->
<ParamDef>Display <Parameter>* d</Parameter></ParamDef>
<ParamDef>Window <Parameter>w</Parameter></ParamDef>
<ParamDef>XmRenderTable <Parameter>rendertable</Parameter></ParamDef>
<ParamDef>XmString <Parameter>string</Parameter></ParamDef>
<ParamDef>GC <Parameter>gc</Parameter></ParamDef>
<ParamDef>Position <Parameter>x</Parameter></ParamDef>
<ParamDef>Position <Parameter>y</Parameter></ParamDef>
<ParamDef>Dimension <Parameter>width</Parameter></ParamDef>
<ParamDef>unsigned char <Parameter>alignment</Parameter></ParamDef>
<ParamDef>unsigned char <Parameter>layout_direction</Parameter></ParamDef>
<ParamDef>XRectangle <Parameter>* clip</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmStringDrawImage</Function>
draws a compound string in an X Window and paints both the
foreground and background bits of each character.
If a compound string segment uses a
rendition
that
contains
a font set, the graphic context passed to this
routine will have the GC font member left in an undefined
state. The underlying <Literal>XmbStringDraw</Literal> function called
by this routine modifies the font ID field of the GC passed
into it and does not attempt to restore the font ID to the
incoming value. If the compound string segment is not drawn using
a font set, the graphic context must contain a valid font
member. Graphic contexts created by <Function>XtGetGC</Function> are not
accepted by this routine; instead, use <Function>XtAllocateGC</Function>
to create a graphic context.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">d</Symbol></Term>
<ListItem>
<Para>Specifies the display.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">w</Symbol></Term>
<ListItem>
<Para>Specifies the window.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">rendertable</Symbol></Term>
<ListItem>
<Para>Specifies the render table.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">string</Symbol></Term>
<ListItem>
<Para>Specifies the string.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">gc</Symbol></Term>
<ListItem>
<Para>Specifies the graphics context to use.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>x</Emphasis></Term>
<ListItem>
<Para>Specifies a coordinate of the rectangle that will contain the displayed
compound string.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>y</Emphasis></Term>
<ListItem>
<Para>Specifies a coordinate of the rectangle that will contain the displayed
compound string.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">width</Symbol></Term>
<ListItem>
<Para>Specifies the width of the rectangle that will contain the
displayed compound string.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">alignment</Symbol></Term>
<ListItem>
<Para>Specifies how the string will be aligned within the specified rectangle.
It is either <SystemItem Class="Constant">XmALIGNMENT_BEGINNING</SystemItem>, <SystemItem Class="Constant">XmALIGNMENT_CENTER</SystemItem>, or
<SystemItem Class="Constant">XmALIGNMENT_END</SystemItem>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">layout_direction</Symbol></Term>
<ListItem>
<Para>Controls the direction in which the segments of the compound string will
be laid out. It also determines the meaning of the <Symbol Role="Variable">alignment</Symbol> parameter.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">clip</Symbol></Term>
<ListItem>
<Para>Allows the application to restrict the area into which the compound string
will be drawn.
If NULL, clipping will be determined by the GC.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmStringCreate;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
