xref: /AOO41X/main/offapi/com/sun/star/form/component/HTMLForm.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_form_component_HTMLForm_idl__
24#define __com_sun_star_form_component_HTMLForm_idl__
25
26#ifndef __com_sun_star_form_component_Form_idl__
27#include <com/sun/star/form/component/Form.idl>
28#endif
29
30#ifndef __com_sun_star_form_XReset_idl__
31#include <com/sun/star/form/XReset.idl>
32#endif
33
34#ifndef __com_sun_star_form_XSubmit_idl__
35#include <com/sun/star/form/XSubmit.idl>
36#endif
37
38#ifndef __com_sun_star_form_FormSubmitMethod_idl__
39#include <com/sun/star/form/FormSubmitMethod.idl>
40#endif
41
42#ifndef __com_sun_star_form_FormSubmitEncoding_idl__
43#include <com/sun/star/form/FormSubmitEncoding.idl>
44#endif
45
46
47//=============================================================================
48
49 module com {  module sun {  module star {  module form {  module component {
50
51//=============================================================================
52
53/** This service specifies the special kind of <type>Form</type>s for HTML documents.
54
55    <p>An HTMLForm fulfills the specification of forms in HTML. It supplies
56    the possibility of submitting or resetting the contents of a form.
57    For more information on HTML forms, please see the documentation of HTML.</p>
58 */
59published service HTMLForm
60{
61    service com::sun::star::form::component::Form;
62
63    /** resets the control.
64    */
65    interface com::sun::star::form::XReset;
66
67    /** allows to submit changes.
68
69        <p>When a form is submitted, the data contained in the form is sent
70        to the target URL as a series of name/value pairs. The name portion
71        of each pair is the name of a form component as specified by its NAME
72        attribute. In most cases the value portion is the value displayed
73        by the element, for example, the text displayed in a text field.</p>
74    */
75    interface com::sun::star::form::XSubmit;
76
77    /** describes the frame, where to open the document specified by the TargetURL.
78     */
79    [property] string TargetFrame;
80
81    //-------------------------------------------------------------------------
82
83    /** specifies the URL, which should be used for submission.
84     */
85    [property] string TargetURL;
86    //-------------------------------------------------------------------------
87
88    /** specifies the kind of submission.
89     */
90    [property] com::sun::star::form::FormSubmitMethod SubmitMethod;
91    //-------------------------------------------------------------------------
92
93    /** specifies the kind of encoding for submission.
94     */
95    [property] com::sun::star::form::FormSubmitEncoding SubmitEncoding;
96};
97
98//=============================================================================
99
100}; }; }; }; };
101
102#endif
103