Blame doc/man/man3/XmTextGetTopCharacter.3

Packit b099d7
'\" t
Packit b099d7
...\" TxtGetTo.sgm /main/8 1996/09/08 21:18:16 rws $
Packit b099d7
.de P!
Packit b099d7
.fl
Packit b099d7
\!!1 setgray
Packit b099d7
.fl
Packit b099d7
\\&.\"
Packit b099d7
.fl
Packit b099d7
\!!0 setgray
Packit b099d7
.fl			\" force out current output buffer
Packit b099d7
\!!save /psv exch def currentpoint translate 0 0 moveto
Packit b099d7
\!!/showpage{}def
Packit b099d7
.fl			\" prolog
Packit b099d7
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
Packit b099d7
\!!psv restore
Packit b099d7
.
Packit b099d7
.de pF
Packit b099d7
.ie     ?\\*(f1?? .ds f1 \\n(.f
Packit b099d7
.el .ie ?\\*(f2?? .ds f2 \\n(.f
Packit b099d7
.el .ie ?\\*(f3?? .ds f3 \\n(.f
Packit b099d7
.el .ie ?\\*(f4?? .ds f4 \\n(.f
Packit b099d7
.el .tm ? font overflow
Packit b099d7
.ft \\$1
Packit b099d7
..
Packit b099d7
.de fP
Packit b099d7
.ie     !?\\*(f4?? \{\
Packit b099d7
.	ft \\*(f4
Packit b099d7
.	ds f4\"
Packit b099d7
'	br \}
Packit b099d7
.el .ie !?\\*(f3?? \{\
Packit b099d7
.	ft \\*(f3
Packit b099d7
.	ds f3\"
Packit b099d7
'	br \}
Packit b099d7
.el .ie !?\\*(f2?? \{\
Packit b099d7
.	ft \\*(f2
Packit b099d7
.	ds f2\"
Packit b099d7
'	br \}
Packit b099d7
.el .ie !?\\*(f1?? \{\
Packit b099d7
.	ft \\*(f1
Packit b099d7
.	ds f1\"
Packit b099d7
'	br \}
Packit b099d7
.el .tm ? font underflow
Packit b099d7
..
Packit b099d7
.ds f1\"
Packit b099d7
.ds f2\"
Packit b099d7
.ds f3\"
Packit b099d7
.ds f4\"
Packit b099d7
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
Packit b099d7
.TH "XmTextGetTopCharacter" "library call"
Packit b099d7
.SH "NAME"
Packit b099d7
\fBXmTextGetTopCharacter\fP \(em A Text function that accesses the position of the first character displayed
Packit b099d7
.iX "XmTextGetTopCharacter"
Packit b099d7
.iX "Text functions" "XmTextGetTopCharacter"
Packit b099d7
.SH "SYNOPSIS"
Packit b099d7
.PP
Packit b099d7
.nf
Packit b099d7
#include <Xm/Text\&.h>
Packit b099d7
\fBXmTextPosition \fBXmTextGetTopCharacter\fP\fR(
Packit b099d7
\fBWidget \fBwidget\fR\fR);
Packit b099d7
.fi
Packit b099d7
.SH "DESCRIPTION"
Packit b099d7
.PP
Packit b099d7
\fBXmTextGetTopCharacter\fP accesses the position of the text at the top
Packit b099d7
of the Text widget\&.
Packit b099d7
If there is no text in the Text widget (in other words,
Packit b099d7
\fBXmNvalue\fP contains an empty string),
Packit b099d7
then \fBXmTextGetTopCharacter\fP returns 0\&.
Packit b099d7
.PP
Packit b099d7
Suppose that the \fBXmNtopCharacter\fP resource has been
Packit b099d7
set to a value greater than the number of characters in
Packit b099d7
the text widget\&. In this case,
Packit b099d7
\fBXmTextGetTopCharacter\fP returns an
Packit b099d7
\fBXmTextPosition\fR value identifying
Packit b099d7
the position of the first character in the last line of text in a
Packit b099d7
multiline case; otherwise, it identifies the position of the last
Packit b099d7
character in the line\&.
Packit b099d7
.IP "\fIwidget\fP" 10
Packit b099d7
Specifies the Text widget ID
Packit b099d7
.PP
Packit b099d7
For a complete definition of Text and its associated resources, see
Packit b099d7
\fBXmText\fP(3)\&.
Packit b099d7
.SH "RETURN"
Packit b099d7
.PP
Packit b099d7
Returns an \fBXmTextPosition\fR value that indicates the state of the
Packit b099d7
\fBXmNtopCharacter\fP resource\&. This is an integer number of characters
Packit b099d7
from the beginning of the text buffer\&. The first character position is
Packit b099d7
0 (zero)\&.
Packit b099d7
.SH "RELATED"
Packit b099d7
.PP
Packit b099d7
\fBXmText\fP(3)\&.
Packit b099d7
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:35