XmDirectionMatch(3X) UNIX System V XmDirectionMatch(3X)
NAME
XmDirectionMatch - A function that checks for a specified
direction component
SYNOPSIS
#include <Xm/Xm.h>
Boolean XmDirectionMatch (d1, d2)
XmDirection d1;
XmDirection d2;
(void)
VERSION
This page documents Motif 2.1.
DESCRIPTION
XmDirectionMatch compares two XmDirection values. The
function returns a Boolean value depending on whether or not
the two input values "match." The simplest match is when d1
and d2 are identical. However, other matches are possible.
XmDirectionMatch attempts to compare specified bits only;
nonspecified bits automatically match.
For example, suppose that d1 equals
XmTOP_TO_BOTTOM_RIGHT_TO_LEFT. In this case, the function
will return True if d2 equals either XmRIGHT_TO_LEFT or
XmTOP_TO_BOTTOM. However, the function will return False if
d2 equals XmTOP_TO_BOTTOM_LEFT_TO_RIGHT,
XmBOTTOM_TO_TOP_RIGHT_TO_LEFT, or
XmBOTTOM_TO_TOP_LEFT_TO_RIGHT.
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 d1 equals
XmTOP_TO_BOTTOM_RIGHT_TO_LEFT and d2 equals
XmRIGHT_TO_LEFT_TOP_TO_BOTTOM.
d1 Specifies an XmDirection value.
d2 Specifies an XmDirection value.
RETURN VALUES
Returns True if d1 "matches" d2; otherwise, returns False.
RELATED INFORMATION
XmDirection(3), XmDirectionMatchPartial(3),
XmDirectionToStringDirection(3), XmString(3),
XmStringDirection(3), and XmStringDirectionToDirection(3).
Page 1 (printed 7/20/06)
