


XmStringDrawUnderline(3X)			    XmStringDrawUnderline(3X)
OSF/Motif							    OSF/Motif



NAME
  XXmmSSttrriinnggDDrraawwUUnnddeerrlliinnee	- A compound string function that underlines a string
  drawn	in an X	Window

SYNOPSIS


  ##iinncclluuddee <<XXmm//XXmm..hh>>
  vvooiidd XXmmSSttrriinnggDDrraawwUUnnddeerrlliinnee ((_d, _w, _f_o_n_t_l_i_s_t, _s_t_r_i_n_g, _g_c, _x, _y,	_w_i_d_t_h,
	    _a_l_i_g_n_m_e_n_t, _l_a_y_o_u_t__d_i_r_e_c_t_i_o_n, _c_l_i_p, _u_n_d_e_r_l_i_n_e))
       DDiissppllaayy	 * _d;;
       WWiinnddooww	 _w;;
       XXmmFFoonnttLLiisstt_f_o_n_t_l_i_s_t;;
       XXmmSSttrriinngg	 _s_t_r_i_n_g;;
       GGCC	 _g_c;;
       PPoossiittiioonn	 _x;;
       PPoossiittiioonn	 _y;;
       DDiimmeennssiioonn _w_i_d_t_h;;
       uunnssiiggnneedd	cchhaarr_a_l_i_g_n_m_e_n_t;;
       uunnssiiggnneedd	cchhaarr_l_a_y_o_u_t__d_i_r_e_c_t_i_o_n;;
       XXRReeccttaannggllee* _c_l_i_p;;
       XXmmSSttrriinngg	 _u_n_d_e_r_l_i_n_e;;

DESCRIPTION
  XXmmSSttrriinnggDDrraawwUUnnddeerrlliinnee	draws a	compound string	in an X	Window.	 If the	sub-
  string identified by _u_n_d_e_r_l_i_n_e can be	matched	in _s_t_r_i_n_g, the substring will
  be underlined.  Once a match has occurred, no	further	matches	or underlin-
  ing will be done.

  If a compound	string segment uses a font list	entry that defines a font
  set, the graphic context passed to this routine will have the	GC font
  member left in an undefined state.  The underlying XXmmbbSSttrriinnggDDrraaww 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 created by XXttGGeettGGCC are
  not accepted by this routine;	instead, use XXttAAllllooccaatteeGGCC to create a graphic
  context.

  _d	      Specifies	the display.

  _w	      Specifies	the window.

  _f_o_n_t_l_i_s_t    Specifies	the font list.

  _s_t_r_i_n_g      Specifies	the string.

  _g_c	      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.

  _w_i_d_t_h	      Specifies	the width of the rectangle that	will contain the
	      displayed	compound string.

  _a_l_i_g_n_m_e_n_t   Specifies	how the	string will be aligned within the specified
	      rectangle.  It is	one of XXmmAALLIIGGNNMMEENNTT__BBEEGGIINNNNIINNGG,
	      XXmmAALLIIGGNNMMEENNTT__CCEENNTTEERR, or XXmmAALLIIGGNNMMEENNTT__EENNDD.

  _l_a_y_o_u_t__d_i_r_e_c_t_i_o_n
	      Controls the direction in	which the segments of the compound
	      string will be laid out.	It also	determines the meaning of the
	      _a_l_i_g_n_m_e_n_t	parameter.

  _c_l_i_p	      Allows the application to	restrict the area into which the com-
	      pound string will	be drawn.  If NULL, no clipping	will be	done.

  _u_n_d_e_r_l_i_n_e   Specifies	the substring to be underlined.

RELATED	INFORMATION
  XXmmSSttrriinnggCCrreeaattee((33XX)).


















































