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

FreeBSD Manual Pages

  
 
  

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

NAME
       XmStringDrawImage  --  A	compound string	function that draws a compound
       string in an X Window and creates an image

SYNOPSIS
       #include	<Xm/Xm.h>
       void XmStringDrawImage(
       Display * d,
       Window w,
       XmRenderTable rendertable,
       XmString	string,
       GC gc,
       Position	x,
       Position	y,
       Dimension width,
       unsigned	char alignment,
       unsigned	char layout_direction,
       XRectangle * clip);

DESCRIPTION
       XmStringDrawImage draws a compound string in an	X  Window  and	paints
       both  the  foreground and background bits of each character.  If	a com-
       pound string segment uses a rendition that contains  a  font  set,  the
       graphic	context	 passed	 to  this routine will have the	GC font	member
       left in an  undefined  state.  The  underlying  XmbStringDraw  function
       called by this routine modifies the font	ID field of the	GC passed into
       it and does not attempt to restore the font ID to the  incoming	value.
       If  the	compound  string  segment  is  not drawn using a font set, the
       graphic context must contain a valid font member. Graphic contexts cre-
       ated  by	XtGetGC	are not	accepted by this routine; instead, use XtAllo-
       cateGC to create	a graphic context.

       d	 Specifies the display.

       w	 Specifies the window.

       rendertable
		 Specifies the render table.

       string	 Specifies the string.

       gc	 Specifies the graphics	context	to use.

       x	 Specifies a coordinate	of the rectangle that will contain the
		 displayed compound string.

       y	 Specifies a coordinate	of the rectangle that will contain the
		 displayed compound string.

       width	 Specifies the width of	the rectangle that  will  contain  the
		 displayed compound string.

       alignment Specifies how the string will be aligned within the specified
		 rectangle.   It  is  either  XmALIGNMENT_BEGINNING,  XmALIGN-
		 MENT_CENTER, or XmALIGNMENT_END.

       layout_direction
		 Controls  the direction in which the segments of the compound
		 string	will be	laid out. It also determines  the  meaning  of
		 the alignment parameter.

       clip	 Allows	 the  application  to restrict the area	into which the
		 compound string will be drawn.	 If NULL, clipping will	be de-
		 termined by the GC.

RELATED
       XmStringCreate(3).

							  XmStringDrawImage(3)

NAME | SYNOPSIS | DESCRIPTION | RELATED

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=XmStringDrawImage&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help