offapi/com/sun/star/form/FormComponent.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_FormComponent_idl__
  20 #define __com_sun_star_form_FormComponent_idl__
  21
  22 #include <com/sun/star/form/XFormComponent.idl>
  23 #include <com/sun/star/lang/XComponent.idl>
  24 #include <com/sun/star/container/XNamed.idl>
  25 #include <com/sun/star/beans/XPropertySet.idl>
  26 #include <com/sun/star/io/XPersistObject.idl>
  27 #include <com/sun/star/beans/XPropertyBag.idl>
  28
  29
  30
  31  module com {  module sun {  module star {  module form {
  32
  33
  34 /** specifies a component which can be part of a form.
  35
  36     @see FormControlModel
  37     @see com::sun::star::form::component::Form
  38  */
  39 published service FormComponent
  40 {
  41     /** identifies the component as a candidate for being part of a form.
  42         <p>This interface also provides the access to the component's parent.</p>
  43      */
  44     interface com::sun::star::form::XFormComponent;
  45
  46
  47     /** allows life-time control of form components.
  48      */
  49     interface com::sun::star::lang::XComponent;
  50
  51
  52     /** Each FormComponent must supply a name for identification.
  53      */
  54     interface com::sun::star::container::XNamed;
  55
  56     /** gives access to the properties.
  57     */
  58     interface com::sun::star::beans::XPropertySet;
  59
  60
  61     /** Each FormComponent must be able to be stored into and read from a stream.
  62      */
  63     interface com::sun::star::io::XPersistObject;
  64
  65     /** allows to associate arbitrary properties with the form component
  66
  67         <p>Every concrete form component - i.e. every service which includes
  68         the <code>FormComponent</code> service - has a set of properties which
  69         are available as long as the component lives - the so-called <em>static
  70         properties</em>.</p>
  71
  72         <p>Additionally, you can add more properties to the component as needed,
  73         using the com::sun::star::beans::XPropertyContainer interface.
  74         Those properties are called <em>dynamic properties</em>.</p>
  75
  76         <p>Dynamic properties are not evaluated by the component itself,
  77         nor by the form's runtime environment. They're only remembered and available for
  78         use by other instances.</p>
  79
  80         <p>Note that dynamic properties added to a form component are, by definition,
  81         removable. That is, the com::sun::star::beans::PropertyAttribute::REMOVABLE
  82         will always be set, even if you do not specify it in the
  83         com::sun::star::beans::XPropertyContainer::addProperty() call.</p>
  84
  85         @since OOo 2.3
  86     */
  87     [optional] interface com::sun::star::beans::XPropertyBag;
  88
  89
  90     /** the name of the component.
  91
  92         <p>Note that the name accessed here is the same as when using the
  93         com::sun::star::container::XNamed interface.</p>
  94      */
  95     [property] string Name;
  96
  97 };
  98
  99
 100 }; }; }; };
 101
 102 #endif
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */