<!-- $XConsortium: DirectB.sgm /main/8 1996/09/08 20:39:00 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.MAN201.rsml.1">
<RefMeta>
<RefEntryTitle>XmDirectionMatch</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmDirectionMatch</Function></RefName>
<RefPurpose>A function that checks for a specified direction component
<IndexTerm>
<Primary>XmDirectionMatch</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-->
<!-- @OSF_COPYRIGHT@-->
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/Xm.h>
Boolean XmDirectionMatch (<Replaceable>d1, d2</Replaceable>)
        XmDirection     <Replaceable>d1</Replaceable>;
        XmDirection     <Replaceable>d2</Replaceable>;
</FuncSynopsisInfo>
<FuncDef></FuncDef>
<void>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmDirectionMatch</Function> compares two <StructName Role="typedef">XmDirection</StructName> values.
The function returns a Boolean value depending on whether or
not the two input values "match."
The simplest match is when <Symbol Role="Variable">d1</Symbol> and <Symbol Role="Variable">d2</Symbol> are identical.
However, other matches are possible.
<Function>XmDirectionMatch</Function> attempts to compare specified bits only;
nonspecified bits automatically match.
</Para>
<Para>For example, suppose that <Symbol Role="Variable">d1</Symbol> equals
<SystemItem Class="Constant">XmTOP_TO_BOTTOM_RIGHT_TO_LEFT</SystemItem>. In this case, the function will
return True if <Symbol Role="Variable">d2</Symbol> equals either <SystemItem Class="Constant">XmRIGHT_TO_LEFT</SystemItem> or
<SystemItem Class="Constant">XmTOP_TO_BOTTOM</SystemItem>. However, the function will return False if
<Symbol Role="Variable">d2</Symbol> equals <SystemItem Class="Constant">XmTOP_TO_BOTTOM_LEFT_TO_RIGHT</SystemItem>,
<SystemItem Class="Constant">XmBOTTOM_TO_TOP_RIGHT_TO_LEFT</SystemItem>, or
<SystemItem Class="Constant">XmBOTTOM_TO_TOP_LEFT_TO_RIGHT</SystemItem>.
</Para>
<Para>Note that direction can be thought of as having three components, a
horizontal component, a vertical component, and the precedence among
them. This means that in addition to the previously mentioned
directions, the function will still return False if <Symbol Role="Variable">d1</Symbol> equals
<SystemItem Class="Constant">XmTOP_TO_BOTTOM_RIGHT_TO_LEFT</SystemItem> and <Symbol Role="Variable">d2</Symbol> equals
<SystemItem Class="Constant">XmRIGHT_TO_LEFT_TOP_TO_BOTTOM</SystemItem>.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">d1</Symbol></Term>
<ListItem>
<Para>Specifies an <StructName Role="typedef">XmDirection</StructName> value.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">d2</Symbol></Term>
<ListItem>
<Para>Specifies an <StructName Role="typedef">XmDirection</StructName> value.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN VALUES</Title>
<Para>Returns True if <Symbol Role="Variable">d1</Symbol> "matches" <Symbol Role="Variable">d2</Symbol>; otherwise, returns False.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED INFORMATION</Title>
<Para>&cdeman.XmDirection;,
&cdeman.XmDirectionMatchPartial;,
&cdeman.XmDirectionToStringDirection;, &cdeman.XmString;,
&cdeman.XmStringDirection;, and
&cdeman.XmStringDirectionToDirection;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
