1 .\" ***** BEGIN LICENSE BLOCK *****
2 .\" Version: MPL 1.1/GPL 2.0/LGPL 2.1
3 .\"
4 .\" The contents of this file are subject to the Mozilla Public License Version
5 .\" 1.1 (the "License"); you may not use this file except in compliance with
6 .\" the License. You may obtain a copy of the License at
7 .\" http://www.mozilla.org/MPL/
8 .\"
9 .\" Software distributed under the License is distributed on an "AS IS" basis,
10 .\" WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11 .\" for the specific language governing rights and limitations under the
12 .\" License.
13 .\"
14 .\" The Original Code is the Microline Widget Library, originally made available under the NPL by Neuron Data <http://www.neurondata.com>.
15 .\"
16 .\" The Initial Developer of the Original Code is
17 .\" Netscape Communications Corporation.
18 .\" Portions created by the Initial Developer are Copyright (C) 1998
19 .\" the Initial Developer. All Rights Reserved.
20 .\"
21 .\" Contributor(s):
22 .\"
23 .\" Alternatively, the contents of this file may be used under the terms of
24 .\" either the GNU General Public License Version 2 or later (the "GPL"), or
25 .\" the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
26 .\" in which case the provisions of the GPL or the LGPL are applicable instead
27 .\" of those above. If you wish to allow use of your version of this file only
28 .\" under the terms of either the GPL or the LGPL, and not to allow others to
29 .\" use your version of this file under the terms of the MPL, indicate your
30 .\" decision by deleting the provisions above and replace them with the notice
31 .\" and other provisions required by the GPL or the LGPL. If you do not delete
32 .\" the provisions above, a recipient may use your version of this file under
33 .\" the terms of any one of the MPL, the GPL or the LGPL.
34 .\"
35 .\" In addition, as a special exception to the GNU GPL, the copyright holders
36 .\" give permission to link the code of this program with the Motif and Open
37 .\" Motif libraries (or with modified versions of these that use the same
38 .\" license), and distribute linked combinations including the two. You
39 .\" must obey the GNU General Public License in all respects for all of
40 .\" the code used other than linking with Motif/Open Motif. If you modify
41 .\" this file, you may extend this exception to your version of the file,
42 .\" but you are not obligated to do so. If you do not wish to do so,
43 .\" delete this exception statement from your version.
44 .\"
45 .\" ***** END LICENSE BLOCK *****
46 .TH XmLStringDrawDirection 3X "R1" "XML1" "XML"
47 .SH NAME
48 XmLStringDrawDirection \- draws a string in the given direction
49 .SH SYNTAX
50 void XmLStringDrawDirection(\fIdpy\fP, \fIwin\fP, \fIfontList\fP, \
51 \fIstring\fP, \fIgc\fP, \fIx\fP, \fIy\fP, \fIwidth\fP, \
52 \fIalignment\fP, \fIlayout_direction\fP, \fIdrawing_direction\fP)
53 .br
54 Display *\fIdpy\fP;
55 .br
56 Window \fIwin\fP;
57 .br
58 XmFontList \fIfontList\fP;
59 .br
60 XmString \fIstring\fP;
61 .br
62 GC \fIgc\fP;
63 .br
64 int \fIx\fP;
65 .br
66 int \fIy\fP;
67 .br
68 Dimension \fIwidth\fP;
69 .br
70 unsigned char \fIalignment\fP;
71 .br
72 unsigned char \fIlayout_direction\fP;
73 .br
74 unsigned char \fIdrawing_direction\fP;
75 .LP
76 .SH ARGUMENTS
77 .IP \fIdpy\fP 1i
78 destination display
79 .IP \fIwin\fP 1i
80 destination window
81 .IP \fIfontList\fP 1i
82 font list used to draw string
83 .IP \fIstring\fP 1i
84 string to draw
85 .IP \fIgc\fP 1i
86 graphics context for drawing
87 .IP \fIx\fP 1i
88 x position
89 .IP \fIy\fP 1i
90 y position
91 .IP \fIwidth\fP 1i
92 width for alignment
93 .IP \fIalignment\fP 1i
94 alignment
95 .IP \fIlayout_direction\fP 1i
96 layout direction for drawing
97 .IP \fIdrawing_direction\fP 1i
98 direction to draw
99 .SH DESCRIPTION
100 Draws a \fIstring\fP in the direction \fIdrawing_direction\fP
101 using the font list \fIfontList\fP and the GC \fIgc\fP in the window
102 \fIwin\fP on the display \fIdpy\fP. The string is drawn at the
103 \fIx\fP and \fIy\fP location given. The \fIwidth\fP parameter is
104 used solely for determining alignment. The \fIalignment\fP parameter
105 must be one of: XmALIGNMENT_BEGINNING, XmALIGNMENT_CENTER or
106 XmALIGNMENT_END. The \fIlayout_direction\fP parameter is used to
107 draw the string right or left for internationalization (see
108 XmStringDraw). The \fIdrawing_direction\fP parameter must be one
109 of: XmSTRING_UP, XmSTRING_DOWN, XmSTRING_LEFT or XmSTRING_RIGHT.
110 .SH "SEE ALSO"
111 XmLStringDraw(3x), XmLPixmapDraw(3X)
112