src/ml_form_text.h

   1 /* Monolith form text input class.
   2  * - by Richard W.M. Jones <rich@annexia.org>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the Free
  16  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17  *
  18  * $Id: ml_form_text.h,v 1.3 2002/11/23 16:46:06 rich Exp $
  19  */
  20
  21 #ifndef ML_FORM_TEXT_H
  22 #define ML_FORM_TEXT_H
  23
  24 #include "monolith.h"
  25 #include "ml_form.h"
  26
  27 struct ml_form_text;
  28 typedef struct ml_form_text *ml_form_text;
  29
  30 /* Function: new_ml_form_text - monolith form text input widget
  31  * Function: ml_form_text_focus
  32  *
  33  * This is a single line text input field, which can only be used
  34  * within forms (see @code{new_ml_form(3)}).
  35  *
  36  * @code{new_ml_form_text} creates a new form text input widget. The
  37  * form into which this widget is being embedded is passed as the
  38  * @code{form} parameter.
  39  *
  40  * The following properties can be changed on form text input widgets
  41  * (see @ref{ml_widget_set_property(3)}):
  42  *
  43  * @code{form.text.size}: Size (ie. width) of the input box. The default is
  44  * @code{-1} which is a browser-specific width.
  45  *
  46  * @code{form.text.maxlength}: Maximum number of characters which
  47  * may be entered into the input box (do not rely on this: always
  48  * check the length). The default is @code{-1} which means unlimited.
  49  *
  50  * If @code{ml_form_text_focus} is called on the input widget, then
  51  * it will attempt to grab keyboard focus when displayed. (NB. This
  52  * is a temporary function, very likely to change in future when I
  53  * come up with a better way to handle focus).
  54  *
  55  * See also: @ref{new_ml_form(3)}, @ref{ml_form_input_get_value(3)}.
  56  */
  57 extern ml_form_text new_ml_form_text (pool pool, ml_form form);
  58 extern void ml_form_text_focus (ml_form_text w);
  59
  60 #endif /* ML_FORM_TEXT_H */