1XmDirectionMatch(library call)                  XmDirectionMatch(library call)
2
3
4

NAME

6       XmDirectionMatch  —  A  function  that checks for a specified direction
7       component
8

SYNOPSIS

10       #include <Xm/Xm.h>
11       Boolean XmDirectionMatch (d1, d2)
12               XmDirection     d1;
13               XmDirection     d2;
14       (void)
15

DESCRIPTION

17       XmDirectionMatch compares two XmDirection values.  The function returns
18       a  Boolean  value  depending  on  whether  or  not the two input values
19       "match."  The simplest match is when d1 and d2 are identical.  However,
20       other matches are possible.  XmDirectionMatch attempts to compare spec‐
21       ified bits only; nonspecified bits automatically match.
22
23       For example, suppose that d1 equals  XmTOP_TO_BOTTOM_RIGHT_TO_LEFT.  In
24       this   case,  the  function  will  return  True  if  d2  equals  either
25       XmRIGHT_TO_LEFT or XmTOP_TO_BOTTOM. However, the function  will  return
26       False    if    d2    equals    XmTOP_TO_BOTTOM_LEFT_TO_RIGHT,    XmBOT‐
27       TOM_TO_TOP_RIGHT_TO_LEFT, or XmBOTTOM_TO_TOP_LEFT_TO_RIGHT.
28
29       Note that direction can be thought of as  having  three  components,  a
30       horizontal  component,  a  vertical component, and the precedence among
31       them. This means that in addition to the  previously  mentioned  direc‐
32       tions,  the function will still return False if d1 equals XmTOP_TO_BOT‐
33       TOM_RIGHT_TO_LEFT and d2 equals XmRIGHT_TO_LEFT_TOP_TO_BOTTOM.
34
35       d1        Specifies an XmDirection value.
36
37       d2        Specifies an XmDirection value.
38

RETURN VALUES

40       Returns True if d1 "matches" d2; otherwise, returns False.
41

43       XmDirection(3),  XmDirectionMatchPartial(3),  XmDirectionToStringDirec‐
44       tion(3),  XmString(3), XmStringDirection(3), and XmStringDirectionToDi‐
45       rection(3).
46
47
48
49                                                XmDirectionMatch(library call)
Impressum