summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/form/component/HTMLForm.idl
blob: acb40e5df95aa76159412cad4bd2f759f6e375e3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_form_component_HTMLForm_idl__
#define __com_sun_star_form_component_HTMLForm_idl__

#include <com/sun/star/form/component/Form.idl>

#include <com/sun/star/form/XReset.idl>

#include <com/sun/star/form/XSubmit.idl>

#include <com/sun/star/form/FormSubmitMethod.idl>

#include <com/sun/star/form/FormSubmitEncoding.idl>



 module com {  module sun {  module star {  module form {  module component {


/** This service specifies the special kind of Forms for HTML documents.

    <p>An HTMLForm fulfills the specification of forms in HTML. It supplies
    the possibility of submitting or resetting the contents of a form.
    For more information on HTML forms, please see the documentation of HTML.</p>
 */
published service HTMLForm
{
    service com::sun::star::form::component::Form;

    /** resets the control.
    */
    interface com::sun::star::form::XReset;

    /** allows to submit changes.

        <p>When a form is submitted, the data contained in the form is sent
        to the target URL as a series of name/value pairs. The name portion
        of each pair is the name of a form component as specified by its NAME
        attribute. In most cases the value portion is the value displayed
        by the element, for example, the text displayed in a text field.</p>
    */
    interface com::sun::star::form::XSubmit;

    /** describes the frame, where to open the document specified by the TargetURL.
     */
    [property] string TargetFrame;


    /** specifies the URL, which should be used for submission.
     */
    [property] string TargetURL;

    /** specifies the kind of submission.
     */
    [property] com::sun::star::form::FormSubmitMethod SubmitMethod;

    /** specifies the kind of encoding for submission.
     */
    [property] com::sun::star::form::FormSubmitEncoding SubmitEncoding;
};


}; }; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */