offapi/com/sun/star/form/FormComponent.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: FormComponent.idl,v $
  10  * $Revision: 1.11 $
  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_FormComponent_idl__
  31 #define __com_sun_star_form_FormComponent_idl__
  32
  33 #ifndef __com_sun_star_form_XFormComponent_idl__
  34 #include <com/sun/star/form/XFormComponent.idl>
  35 #endif
  36 #ifndef __com_sun_star_lang_XComponent_idl__
  37 #include <com/sun/star/lang/XComponent.idl>
  38 #endif
  39 #ifndef __com_sun_star_container_XNamed_idl__
  40 #include <com/sun/star/container/XNamed.idl>
  41 #endif
  42 #ifndef __com_sun_star_beans_XPropertySet_idl__
  43 #include <com/sun/star/beans/XPropertySet.idl>
  44 #endif
  45 #ifndef __com_sun_star_io_XPersistObject_idl__
  46 #include <com/sun/star/io/XPersistObject.idl>
  47 #endif
  48 #ifndef __com_sun_star_beans_PropertyBag_idl__
  49 #include <com/sun/star/beans/PropertyBag.idl>
  50 #endif
  51
  52
  53 //=============================================================================
  54
  55  module com {  module sun {  module star {  module form {
  56
  57 //=============================================================================
  58
  59 /** specifies a component which can be part of a form.
  60
  61     @see FormControlModel
  62     @see com::sun::star::form::component::Form
  63  */
  64 published service FormComponent
  65 {
  66     /** identifies the component as a candidate for being part of a form.
  67         <p>This interface also provides the access to the component's parent.</p>
  68      */
  69     interface com::sun::star::form::XFormComponent;
  70
  71
  72     /** allows life-time control of form components.
  73      */
  74     interface com::sun::star::lang::XComponent;
  75
  76
  77     /** Each FormComponent must supply a name for identification.
  78      */
  79     interface com::sun::star::container::XNamed;
  80
  81     /** gives access to the properties.
  82     */
  83     interface com::sun::star::beans::XPropertySet;
  84
  85
  86     /** Each FormComponent must be able to be stored into and read from a stream.
  87      */
  88     interface com::sun::star::io::XPersistObject;
  89
  90     /** allows to associate arbitrary properties with the form component
  91
  92         <p>Every concrete form component - i.e. every service which includes
  93         the <code>FormComponent</code> service - has a set of properties which
  94         are available as long as the component lives - the so-called <em>static
  95         properties</em>.</p>
  96
  97         <p>Additionally, you can add more properties to the component as needed,
  98         using the <type scope="com::sun::star::beans">XPropertyContainer</type> interface.
  99         Those properties are called <em>dynamic properties</em>.</p>
 100
 101         <p>Dynamic properties are not evaluated by the component itself,
 102         nor by the form's runtime environment. They're only remembered and available for
 103         use by other instances.</p>
 104
 105         <p>Note that dynamic properties added to a form component are, by definition,
 106         removeable. That is, the <member scope="com::sun::star::beans">PropertyAttribute::REMOVEABLE</member>
 107         will always be set, even if you do not specify it in the
 108         <member scope="com::sun::star::beans">XPropertyContainer::addProperty</member> call.</p>
 109
 110         @since OpenOffice.org 2.3.0
 111     */
 112     [optional] service com::sun::star::beans::PropertyBag;
 113
 114     //-------------------------------------------------------------------------
 115
 116     /** the name of the component.
 117
 118         <p>Note that the name accessed here is the same as when using the
 119         <type scope="com::sun::star::container">XNamed</type> interface.</p>
 120      */
 121     [property] string Name;
 122
 123 };
 124
 125 //=============================================================================
 126
 127 }; }; }; };
 128
 129 /*=============================================================================
 130
 131 =============================================================================*/
 132 #endif