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