UNIXworkcode

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 XmLPixmapDraw 3X "R1" "XML1" "XML" 47 .SH NAME 48 XmLPixmapDraw \- draws a pixmap clipped and aligned in a widget 49 .SH SYNTAX 50 void XmLPixmapDraw(\fIwidget\fP, \fIpixmap\fP, \fIpixmask\fP, \ 51 \fIpixmapWidth\fP, \fIpixmapHeight\fP, \fIalignment\fP, \ 52 \fIgc\fP, \fIrect\fP, \fIclipRect\fP) 53 .br 54 Widget \fIwidget\fP; 55 .br 56 Pixmap \fIpixmap\fP; 57 .br 58 Pixmap \fIpixmask\fP; 59 .br 60 int \fIpixmapWidth\fP; 61 .br 62 int \fIpixmapHeight\fP; 63 .br 64 unsigned char \fIalignment\fP; 65 .br 66 GC \fIgc\fP; 67 .br 68 XRectangle *\fIrect\fP; 69 .br 70 XRectangle *\fIclipRect\fP; 71 .LP 72 .SH ARGUMENTS 73 .IP \fIwidget\fP 1i 74 drawing destination widget 75 .IP \fIpixmap\fP 1i 76 pixmap to draw 77 .IP \fIpixmask\fP 1i 78 pixmap mask for drawing 79 .IP \fIpixmapWidth\fP 1i 80 width of pixmap in pixels 81 .IP \fIpixmapHeight\fP 1i 82 height of pixmap in pixels 83 .IP \fIalignment\fP 1i 84 alignment 85 .IP \fIgc\fP 1i 86 graphics context for drawing 87 .IP \fIrect\fP 1i 88 source rectangle 89 .IP \fIclipRect\fP 1i 90 destination/clipping rectangle 91 .SH DESCRIPTION 92 Draws a \fIpixmap\fP of width \fIpixmapWidth\fP and height \fIpixmapHeight\fP 93 using the GC \fIgc\fP in the window of the \fIwidget\fP given. The 94 \fIpixmask\fP parameter must be either set to XmUNSPECIFIED_PIXMAP 95 or a Pixmap of depth one. If a Pixmap is specified, it is used as a 96 mask to restrict the area drawn. 97 The \fIrect\fP parameter indicates the rectangle used to 98 determine alignment. The \fIclipRect\fP rectangle parameter given 99 indicates the rectangle used to clip the drawing. 100 \fIAlignment\fP must be one of the following: 101 XmALIGNMENT_TOP_LEFT, XmALIGNMENT_TOP, XmALIGNMENT_TOP_RIGHT, 102 XmALIGNMENT_LEFT, XmALIGNMENT_CENTER, XmALIGNMENT_RIGHT, 103 XmALIGNMENT_BOTTOM_LEFT, XmALIGNMENT_BOTTOM or XmALIGNMENT_BOTTOM_RIGHT 104 .SH "SEE ALSO" 105 XmLStringDraw(3X) 106