offapi/com/sun/star/form/component/Form.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: Form.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_Form_idl__
  31 #define __com_sun_star_form_component_Form_idl__
  32
  33 #ifndef __com_sun_star_form_FormComponent_idl__
  34 #include <com/sun/star/form/FormComponent.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_form_FormComponents_idl__
  38 #include <com/sun/star/form/FormComponents.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_form_XForm_idl__
  42 #include <com/sun/star/form/XForm.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_awt_XTabControllerModel_idl__
  46 #include <com/sun/star/awt/XTabControllerModel.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_script_XEventAttacherManager_idl__
  50 #include <com/sun/star/script/XEventAttacherManager.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 a form which is a group of FormComponents.
  61
  62     <p>A form fulfills several tasks, like storing the structure of its
  63     form components, storing the information concerning tab ordering
  64     and control grouping, and last but not least, it provides the
  65     event environment for its contained elements.</p>
  66
  67     <p>A form acts on the one hand like a container of FormComponents
  68     and on the other hand like a FormComponent. This generic
  69     construction allows the definition of hierarchies of forms and their
  70     dependent subforms.</p>
  71
  72     @see com::sun::star::form::FormControlModel
  73  */
  74 published service Form
  75 {
  76     service com::sun::star::form::FormComponent;
  77
  78     service com::sun::star::form::FormComponents;
  79
  80     /** identifies a component as form.
  81      */
  82     interface com::sun::star::form::XForm;
  83
  84
  85     /** This interface has to be implemented to supply the information for tab ordering and component grouping.
  86
  87         @see com::sun::star::form::FormControlModel::TabIndex
  88      */
  89     interface com::sun::star::awt::XTabControllerModel;
  90 };
  91
  92 //=============================================================================
  93
  94 }; }; }; }; };
  95
  96 #endif