Add to git.
[monolith.git] / src / ml_form_submit.h
1 /* Monolith form submit button 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_submit.h,v 1.2 2002/08/29 17:34:18 rich Exp $
19  */
20
21 #ifndef ML_FORM_SUBMIT_H
22 #define ML_FORM_SUBMIT_H
23
24 #include "monolith.h"
25 #include "ml_form.h"
26
27 struct ml_form_submit;
28 typedef struct ml_form_submit *ml_form_submit;
29
30 /* Function: new_ml_form_submit - monolith form submit button widget
31  *
32  * This is a submit button, which can only be used within forms (see
33  * @code{new_ml_form(3)}).
34  *
35  * @code{new_ml_form_submit} creates a new form submit button. The
36  * form into which this widget is being embedded is passed as the
37  * @code{form} parameter. The @code{value}
38  * parameter is what is displayed on the button.
39  *
40  * See also: @ref{new_ml_form(3)}, @ref{ml_form_input_get_value(3)}.
41  */
42 extern ml_form_submit new_ml_form_submit (pool pool, ml_form form, const char *value);
43
44 #endif /* ML_FORM_SUBMIT_H */