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

NAME

6       XmTextFindString — A Text function that finds the beginning position of
7       a text string
8

SYNOPSIS

10       #include <Xm/Xm.h>
11       Boolean XmTextFindString(
12       Widget widget,
13       XmTextPosition start,
14       char *string,
15       XmTextDirection direction,
16       XmTextPosition *position);
17

DESCRIPTION

19       XmTextFindString locates the beginning position  of  a  specified  text
20       string.  This routine searches forward or backward for the first occur‐
21       rence of the string starting from the  given  start  position.   If  it
22       finds a match, the function returns the position of the first character
23       of the string in position.  If the match string begins at  the  current
24       position, this routine returns the current position.
25
26       widget    Specifies the Text widget ID.
27
28       start     Specifies  the  character position from which the search pro‐
29                 ceeds. This is an  integer  number  of  characters  from  the
30                 beginning of the text buffer. The first character position is
31                 0 (zero).
32
33       string    Specifies the search string.
34
35       direction Indicates the search direction. It is relative to the primary
36                 direction of the text. The possible values are
37
38                 XmTEXT_FORWARD
39                           The search proceeds toward the end of the text buf‐
40                           fer.
41
42                 XmTEXT_BACKWARD
43                           The search proceeds toward  the  beginning  of  the
44                           text buffer.
45
46       position  Specifies  the  pointer in which the first character position
47                 of the string match is returned. This is an integer number of
48                 characters  from the beginning of the buffer. The first char‐
49                 acter position is 0 (zero). If the  function  returns  False,
50                 this value is undefined.
51
52       For  a  complete  definition  of Text and its associated resources, see
53       XmText(3).
54

RETURN

56       Returns True if a string match is found; otherwise, returns False.
57

59       XmText(3) and XmTextFindStringWcs(3).
60
61
62
63                                                XmTextFindString(library call)
Impressum