Microline/man/XmLGridEditBegin.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 XmLGridEditBegin 3X "R1" "XML1" "XML"
  47 .SH NAME
  48 XmLGridEditBegin \- begin an edit in a cell
  49 .SH SYNTAX
  50 int XmLGridEditBegin(\fIwidget\fP, \fIinsert\fP, \fIrow\fP, \fIcolumn\fP)
  51 .br
  52 Widget \fIwidget\fP;
  53 .br
  54 Boolean \fIinsert\fP;
  55 .br
  56 int \fIrow\fP;
  57 .br
  58 int \fIcolumn\fP;
  59 .LP
  60 .SH ARGUMENTS
  61 .IP \fIwidget\fP 1i
  62 Grid widget ID
  63 .IP \fIinsert\fP 1i
  64 insert flag
  65 .IP \fIrow\fP 1i
  66 position of content row
  67 .IP \fIcolumn\fP 1i
  68 position of content column
  69 .SH DESCRIPTION
  70 Begin editing a cell at the given content \fIrow\fP and content
  71 \fIcolumn\fP. If \fIinsert\fP is True, the edit will begin with the
  72 text widget containing the existing cell contents.  If False, the text
  73 widget child of the Grid will be cleared when the edit begins.  If the
  74 function is successful, the Grid's XmNeditCallback callbacks will be called.
  75 .SH RETURN VALUE
  76 If the cell position specified is invalid or the cell
  77 can not be edited, a value of -1 will be returned.  A value of 0
  78 is returned if this function is successful.
  79 .SH "SEE ALSO"
  80 XmLGridEditCancel(3X) XmLGridEditComplete(3X)