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 XmLGridCopyPos 3X "R1" "XML1" "XML"
47 .SH NAME
48 XmLGridCopyPos \- copy the string contents of cells in a Grid at a
49 given location to the clipboard
50 .SH SYNTAX
51 Boolean XmLGridCopyPos(\fIwidget\fP, \fItime\fP, \fIrowType\fP, \fIrow\fP, \
52 \fIcolumnType\fP, \fIcolumn\fP, \fInrow\fP, \fIncolumn\fP)
53 .br
54 Widget \fIwidget\fP;
55 .br
56 Time \fItime\fP;
57 .br
58 unsigned char \fIrowType\fP;
59 .br
60 int \fIrow\fP;
61 .br
62 unsigned char \fIcolumnType\fP;
63 .br
64 int \fIcolumn\fP;
65 .br
66 int \fInrow\fP;
67 .br
68 int \fIncolumn\fP;
69 .LP
70 .SH ARGUMENTS
71 .IP \fIwidget\fP 1i
72 Grid widget ID
73 .IP \fItime\fP 1i
74 Time of event
75 .IP \fIrowType\fP 1i
76 type of first row
77 .IP \fIrow\fP 1i
78 location of first row
79 .IP \fIcolumnType\fP 1i
80 type of first column
81 .IP \fIcolumn\fP 1i
82 location of first column
83 .IP \fInrow\fP 1i
84 number of rows
85 .IP \fIncolumn\fP 1i
86 number of columns
87 .SH DESCRIPTION
88 Copies the contents of cells in \fInrow\fP number of rows and
89 \fIncolumn\fP number of columns to the clipboard
90 starting at the row and column specified by
91 \fIrowType\fP, \fIrow\fP, \fIcolumnType\fP, and \fIcolumn\fP.
92 The \fItime\fP parameter should be set to the time of the event
93 (most likely CurrentTime).
94 .SH RETURN VALUE
95 A value of True is returned upon success, and False is returned
96 upon failure.
97 .SH "SEE ALSO"
98 XmLGridCopySelected(3X) XmLGridPaste(3X)
99