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