'\" t
...\" TxtFindA.sgm /main/10 1996/09/25 14:51:36 cdedoc $
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl			\" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl			\" prolog
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie     \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie     !\\*(f4 \{\
.	ft \\*(f4
.	ds f4\"
'	br \}
.el .ie !\\*(f3 \{\
.	ft \\*(f3
.	ds f3\"
'	br \}
.el .ie !\\*(f2 \{\
.	ft \\*(f2
.	ds f2\"
'	br \}
.el .ie !\\*(f1 \{\
.	ft \\*(f1
.	ds f1\"
'	br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
.TH "XmTextFindString" "library call"
.SH "NAME"
\fBXmTextFindString\fP \(em A Text function that finds the beginning position of a text string
.iX "XmTextFindString"
.iX "Text functions" "XmTextFindString"
.SH "SYNOPSIS"
.PP
.nf
#include <Xm/Xm\&.h>
\fBBoolean \fBXmTextFindString\fP\fR(
\fBWidget \fBwidget\fR\fR,
\fBXmTextPosition \fBstart\fR\fR,
\fBchar *\fBstring\fR\fR,
\fBXmTextDirection \fBdirection\fR\fR,
\fBXmTextPosition *\fBposition\fR\fR);
.fi
.SH "DESCRIPTION"
.PP
\fBXmTextFindString\fP locates the beginning position of a specified
text string\&. This routine searches forward or backward for the first
occurrence of the string starting from the given start position\&.
If it finds a match, the function
returns the position of the first character of the string in \fIposition\fP\&.
If the match string begins at the current position, this routine returns the current position\&.
.IP "\fIwidget\fP" 10
Specifies the Text widget ID\&.
.IP "\fIstart\fP" 10
Specifies the character position from which the search proceeds\&. This
is an integer number of characters from the beginning of the text
buffer\&. The first character position is 0 (zero)\&.
.IP "\fIstring\fP" 10
Specifies the search string\&.
.IP "\fIdirection\fP" 10
Indicates the search direction\&. It is relative to the primary
direction of the text\&. The possible values are
.RS
.IP "\fBXmTEXT_FORWARD\fP" 10
The search proceeds toward the end of the text buffer\&.
.IP "\fBXmTEXT_BACKWARD\fP" 10
The search proceeds toward the beginning of the text buffer\&.
.RE
.IP "\fIposition\fP" 10
Specifies the pointer in which the first character position
of the string match is returned\&. This is an integer number
of characters from the beginning of the buffer\&. The first
character position is 0 (zero)\&. If the function returns False,
this value is undefined\&.
.PP
For a complete definition of Text and its associated resources,
see \fBXmText\fP(3)\&.
.SH "RETURN"
.PP
Returns True if a string match is found; otherwise, returns False\&.
.SH "RELATED"
.PP
\fBXmText\fP(3) and \fBXmTextFindStringWcs\fP(3)\&.
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:35