<!-- $XConsortium: DirectD.sgm /main/7 1996/08/30 15:07:40 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.MAN203.rsml.1">
<RefMeta>
<RefEntryTitle>XmDirectionToStringDirection</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmDirectionToStringDirection</Function></RefName>
<RefPurpose>A function that converts an XmDirection value to an XmStringDirection value
<IndexTerm>
<Primary>XmDirectionToStringDirection</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-->
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/Xm.h>
XmStringDirection XmDirectionToStringDirection (<Replaceable>dir</Replaceable>)
        XmDirection     <Replaceable>dir</Replaceable>;
</FuncSynopsisInfo>
<FuncDef></FuncDef>
<void>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmDirectionToStringDirection</Function> converts the specified
<StructName Role="typedef">XmDirection</StructName>
direction value to its equivalent <StructName Role="typedef">XmStringDirection</StructName> value.
Basically, if the <StructName Role="typedef">XmDirection</StructName> value has a horizontal direction
specification,
that horizontal element is used; otherwise, the
<StructName Role="typedef">XmStringDirection</StructName> value is interpreted as
<SystemItem Class="Constant">XmSTRING_DIRECTION_L_TO_R</SystemItem>.
This function provides backward compatibility with the
<StructName Role="typedef">XmStringDirection</StructName> data type.
</Para>
<Para>Note that the Motif toolkit also contains an
<Function>XmStringDirectionToDirection</Function> routine to convert an
<StructName Role="typedef">XmStringDirection</StructName> value to its <StructName Role="typedef">XmDirection</StructName> equivalent.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">dir</Symbol></Term>
<ListItem>
<Para>Specifies the <StructName Role="typedef">XmDirection</StructName> value to be converted.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Returns the following <StructName Role="typedef">XmStringDirection</StructName> values:
</Para>
<VariableList>
<VarListEntry>
<Term><SystemItem Class="Constant">XmSTRING_DIRECTION_R_TO_L</SystemItem></Term>
<ListItem>
<Para>If the <Symbol Role="Variable">dir</Symbol> argument has a right to left horizontal direction
value in it, for
example <SystemItem Class="Constant">XmRIGHT_TO_LEFT_TOP_TO_BOTTOM</SystemItem>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="Constant">XmSTRING_DIRECTION_L_TO_R</SystemItem></Term>
<ListItem>
<Para>If the <Symbol Role="Variable">dir</Symbol> argument has a left to right horizontal direction in
it, for example <SystemItem Class="Constant">XmLEFT_TO_RIGHT_TOP_TO_BOTTOM</SystemItem>, or if the
horizontal direction value in the <Symbol Role="Variable">dir</Symbol> argument is ambiguous,
such as in the <SystemItem Class="Constant">XmTOP_TO_BOTTOM</SystemItem> value.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="Constant">XmSTRING_DIRECTION_DEFAULT</SystemItem></Term>
<ListItem>
<Para>If there was no horizontal direction specified.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RELATED INFORMATION</Title>
<Para>&cdeman.XmDirection;, &cdeman.XmDirectionMatch;,
&cdeman.XmDirectionMatchPartial;,
&cdeman.XmDirectionToStringDirection;, &cdeman.XmString;,
&cdeman.XmStringDirection;, and
&cdeman.XmStringDirectionToDirection;,
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
