1XmStringDrawUnderline(library call)        XmStringDrawUnderline(library call)
2
3
4

NAME

6       XmStringDrawUnderline  —  A  compound string function that underlines a
7       string drawn in an X Window
8

SYNOPSIS

10       #include <Xm/Xm.h>
11       void XmStringDrawUnderline(
12       Display * d,
13       Window w,
14       XmRenderTable rendertable,
15       XmString string,
16       GC gc,
17       Position x,
18       Position y,
19       Dimension width,
20       unsigned char alignment,
21       unsigned char layout_direction,
22       XRectangle * clip,
23       XmString underline);
24

DESCRIPTION

26       XmStringDrawUnderline draws a compound string in an X  Window.  If  the
27       substring  identified  by  underline can be matched in string, the sub‐
28       string will be underlined.  Once  a  match  has  occurred,  no  further
29       matches  or underlining will be done.  Only the first text component of
30       underline is used for matching.
31
32       If a compound string segment uses a rendition that contains a font set,
33       the graphic context passed to this routine will have the GC font member
34       left in an  undefined  state.  The  underlying  XmbStringDraw  function
35       called by this routine modifies the font ID field of the GC passed into
36       it and does not attempt to restore the font ID to the  incoming  value.
37       If  the  compound  string  segment  is  not drawn using a font set, the
38       graphic context must contain a valid font member. Graphic contexts cre‐
39       ated  by XtGetGC are not accepted by this routine; instead, use XtAllo‐
40       cateGC to create a graphic context.
41
42       d         Specifies the display.
43
44       w         Specifies the window.
45
46       rendertable
47                 Specifies the render table.
48
49       string    Specifies the string.
50
51       gc        Specifies the graphics context to use.
52
53       x         Specifies a coordinate of the rectangle that will contain the
54                 displayed compound string.
55
56       y         Specifies a coordinate of the rectangle that will contain the
57                 displayed compound string.
58
59       width     Specifies the width of the rectangle that  will  contain  the
60                 displayed compound string.
61
62       alignment Specifies how the string will be aligned within the specified
63                 rectangle.  It  is  one  of  XmALIGNMENT_BEGINNING,  XmALIGN‐
64                 MENT_CENTER, or XmALIGNMENT_END.
65
66       layout_direction
67                 Controls  the direction in which the segments of the compound
68                 string will be laid out. It also determines  the  meaning  of
69                 the alignment parameter.
70
71       clip      Allows  the  application  to restrict the area into which the
72                 compound string will be drawn.  If it is NULL, clipping  will
73                 be determined by the GC.
74
75       underline Specifies the substring to be underlined.
76

78       XmStringCreate(3).
79
80
81
82                                           XmStringDrawUnderline(library call)
Impressum