Microline/man/XmLGridWritePos.3x

   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 XmLGridWritePos 3X "R1" "XML1" "XML"
  47 .SH NAME
  48 XmLGridWritePos \- write the string contents of cells in a Grid at a
  49 given location into a file
  50 .SH SYNTAX
  51 int XmLGridWritePos(\fIwidget\fP, \fIfile\fP, \fIformat\fP,
  52 \fIdelimiter\fP, \fIskipHidden\fP, \fIrowType\fP, \fIrow\fP, \
  53 \fIcolumnType\fP, \fIcolumn\fP, \fInrow\fP, \fIncolumn\fP)
  54 .br
  55 Widget \fIwidget\fP;
  56 .br
  57 FILE *\fIfile\fP;
  58 .br
  59 int \fIformat\fP;
  60 .br
  61 char \fIdelimiter\fP;
  62 .br
  63 Boolean \fIskipHidden\fP;
  64 .br
  65 unsigned char \fIrowType\fP;
  66 .br
  67 int \fIrow\fP;
  68 .br
  69 unsigned char \fIcolumnType\fP;
  70 .br
  71 int \fIcolumn\fP;
  72 .br
  73 int \fInrow\fP;
  74 .br
  75 int \fIncolumn\fP;
  76 .LP
  77 .SH ARGUMENTS
  78 .IP \fIwidget\fP 1i
  79 Grid widget ID
  80 .IP \fIfile\fP 1i
  81 file to write to
  82 .IP \fIformat\fP 1i
  83 format of the file
  84 .IP \fIdelimiter\fP 1i
  85 delimiter if format is XmFORMAT_DELIMITED
  86 .IP \fIskipHidden\fP 1i
  87 if True, skip hidden rows and columns
  88 .IP \fIrowType\fP 1i
  89 type of first row
  90 .IP \fIrow\fP 1i
  91 location of first row
  92 .IP \fIcolumnType\fP 1i
  93 type of first column
  94 .IP \fIcolumn\fP 1i
  95 location of first column
  96 .IP \fInrow\fP 1i
  97 number of rows
  98 .IP \fIncolumn\fP 1i
  99 number of columns
 100 .SH DESCRIPTION
 101 Writes the contents of cells in \fInrow\fP number of rows and
 102 \fIncolumn\fP number of columns to a \fIfile\fP in the given
 103 \fIformat\fP starting at the row and column specified by
 104 \fIrowType\fP, \fIrow\fP, \fIcolumnType\fP, and \fIcolumn\fP. If
 105 \fIskipHidden\fP is True, data in hidden rows or columns
 106 will not be included. Format must be one of the following:
 107 XmFORMAT_XL, where tabs separate columns and cell data is
 108 possibly surrounded by double-quotes, XmFORMAT_PAD,
 109 where columns are padded with spaces or XmFORMAT_DELIMITED,
 110 where data is delimited by the \fIdelimiter\fP given.
 111 .SH RETURN VALUE
 112 A value of 0 is returned upon success, and a value of -1 is
 113 returned upon failure.
 114 .SH "SEE ALSO"
 115 XmLGridWrite(3X)