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 XmLGridGetSelectedCells 3X "R1" "XML1" "XML" 47 .SH NAME 48 XmLGridGetSelectedCells \- retrieve positions of currently selected cells 49 .SH SYNTAX 50 int XmLGridGetSelectedCells(\fIwidget\fP, \fIrowPositions\fP, \ 51 \fIcolumnPositions\fP, \fIcount\fP) 52 .br 53 Widget \fIwidget\fP; 54 .br 55 int *\fIrowPositions\fP; 56 .br 57 int *\fIcolumnPositions\fP; 58 .br 59 int \fIcount\fP; 60 .LP 61 .SH ARGUMENTS 62 .IP \fIwidget\fP 1i 63 Grid widget ID 64 .IP \fIrowPositions\fP 1i 65 position of content rows 66 .IP \fIcolumnPositions\fP 1i 67 positions of content columns 68 .IP \fIcount\fP 1i 69 number of position pairs 70 .SH DESCRIPTION 71 Returns the row and column positions of the currently selected 72 cells. The \fIcount\fP value passed to this function must equal the 73 number of currently selected cells. The number of currently 74 selected cells can be found by calling 75 XmLGridGetSelectedCellCount(). The \fIrowPositions\fP and 76 \fIcolumnPositions\fP arrays must be allocated before calling this 77 function and must have enough space to hold the positions which 78 will be returned. This function does not allocate memory; it is 79 the application's responsibility to allocate and deallocate 80 the space used to hold the row and column positions. 81 .SH RETURN VALUE 82 0 is returned upon successful completion. A value of 83 -1 is returned and an error message is generated if count 84 does not equal the number of currently selected cells. 85 .SH "SEE ALSO" 86 XmLGridGetSelectedCellCount(3X) 87