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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_form_component_HTMLForm_idl__
  28 #define __com_sun_star_form_component_HTMLForm_idl__
  29
  30 #ifndef __com_sun_star_form_component_Form_idl__
  31 #include <com/sun/star/form/component/Form.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_form_XReset_idl__
  35 #include <com/sun/star/form/XReset.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_form_XSubmit_idl__
  39 #include <com/sun/star/form/XSubmit.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_form_FormSubmitMethod_idl__
  43 #include <com/sun/star/form/FormSubmitMethod.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_form_FormSubmitEncoding_idl__
  47 #include <com/sun/star/form/FormSubmitEncoding.idl>
  48 #endif
  49
  50
  51 //=============================================================================
  52
  53  module com {  module sun {  module star {  module form {  module component {
  54
  55 //=============================================================================
  56
  57 /** This service specifies the special kind of <type>Form</type>s for HTML documents.
  58
  59     <p>An HTMLForm fulfills the specification of forms in HTML. It supplies
  60     the possibility of submitting or resetting the contents of a form.
  61     For more information on HTML forms, please see the documentation of HTML.</p>
  62  */
  63 published service HTMLForm
  64 {
  65     service com::sun::star::form::component::Form;
  66
  67     /** resets the control.
  68     */
  69     interface com::sun::star::form::XReset;
  70
  71     /** allows to submit changes.
  72
  73         <p>When a form is submitted, the data contained in the form is sent
  74         to the target URL as a series of name/value pairs. The name portion
  75         of each pair is the name of a form component as specified by its NAME
  76         attribute. In most cases the value portion is the value displayed
  77         by the element, for example, the text displayed in a text field.</p>
  78     */
  79     interface com::sun::star::form::XSubmit;
  80
  81     /** describes the frame, where to open the document specified by the TargetURL.
  82      */
  83     [property] string TargetFrame;
  84
  85     //-------------------------------------------------------------------------
  86
  87     /** specifies the URL, which should be used for submission.
  88      */
  89     [property] string TargetURL;
  90     //-------------------------------------------------------------------------
  91
  92     /** specifies the kind of submission.
  93      */
  94     [property] com::sun::star::form::FormSubmitMethod SubmitMethod;
  95     //-------------------------------------------------------------------------
  96
  97     /** specifies the kind of encoding for submission.
  98      */
  99     [property] com::sun::star::form::FormSubmitEncoding SubmitEncoding;
 100 };
 101
 102 //=============================================================================
 103
 104 }; }; }; }; };
 105
 106 #endif