Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
XmTextPosToXY(3)	   Library Functions Manual	      XmTextPosToXY(3)

NAME
       XmTextPosToXY  -- A Text	function that accesses the x and y position of
       a character position

SYNOPSIS
       #include	<Xm/Text.h>
       Boolean XmTextPosToXY(
       Widget widget,
       XmTextPosition position,
       Position	*x,
       Position	*y);

DESCRIPTION
       XmTextPosToXY accesses the x and	y position, relative to	the upper left
       corner of the Text widget, of a given character position	 in  the  text
       buffer.

       In  the	case  of horizontal writing, the position is the origin	of the
       character. In the case of vertical writing, the position	is the	verti-
       cal origin of the character.

       widget	 Specifies the Text widget ID

       position	 Specifies  the	character position in the text for which the x
		 and y position	is accessed. This  is  an  integer  number  of
		 characters  from the beginning	of the buffer. The first char-
		 acter position	is 0 (zero).

       x	 Specifies the pointer in which	the x  position	 is  returned.
		 The  returned	position is the	distance from the left side of
		 the widget to the left	border of the character.   This	 value
		 is meaningful only if the function returns True.

       y	 Specifies  the	 pointer  in which the y position is returned.
		 The returned position is the distance from  the  top  of  the
		 widget	to the character's baseline.  This value is meaningful
		 only if the function returns True.

       For a complete definition of Text and its associated resources, see Xm-
       Text(3).

RETURN
       This  function  returns	True if	the character position is displayed in
       the Text	widget;	otherwise, it returns False, and no x or  y  value  is
       returned.

RELATED
       XmText(3).

							      XmTextPosToXY(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=XmTextPosToXY&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help