offapi/com/sun/star/form/component/HTMLForm.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_form_component_HTMLForm_idl__
  20 #define __com_sun_star_form_component_HTMLForm_idl__
  21
  22 #include <com/sun/star/form/component/Form.idl>
  23
  24 #include <com/sun/star/form/XReset.idl>
  25
  26 #include <com/sun/star/form/XSubmit.idl>
  27
  28 #include <com/sun/star/form/FormSubmitMethod.idl>
  29
  30 #include <com/sun/star/form/FormSubmitEncoding.idl>
  31
  32
  33
  34  module com {  module sun {  module star {  module form {  module component {
  35
  36
  37 /** This service specifies the special kind of Forms for HTML documents.
  38
  39     <p>An HTMLForm fulfills the specification of forms in HTML. It supplies
  40     the possibility of submitting or resetting the contents of a form.
  41     For more information on HTML forms, please see the documentation of HTML.</p>
  42  */
  43 published service HTMLForm
  44 {
  45     service com::sun::star::form::component::Form;
  46
  47     /** resets the control.
  48     */
  49     interface com::sun::star::form::XReset;
  50
  51     /** allows to submit changes.
  52
  53         <p>When a form is submitted, the data contained in the form is sent
  54         to the target URL as a series of name/value pairs. The name portion
  55         of each pair is the name of a form component as specified by its NAME
  56         attribute. In most cases the value portion is the value displayed
  57         by the element, for example, the text displayed in a text field.</p>
  58     */
  59     interface com::sun::star::form::XSubmit;
  60
  61     /** describes the frame, where to open the document specified by the TargetURL.
  62      */
  63     [property] string TargetFrame;
  64
  65
  66     /** specifies the URL, which should be used for submission.
  67      */
  68     [property] string TargetURL;
  69
  70     /** specifies the kind of submission.
  71      */
  72     [property] com::sun::star::form::FormSubmitMethod SubmitMethod;
  73
  74     /** specifies the kind of encoding for submission.
  75      */
  76     [property] com::sun::star::form::FormSubmitEncoding SubmitEncoding;
  77 };
  78
  79
  80 }; }; }; }; };
  81
  82 #endif
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */