offapi/com/sun/star/form/FormComponents.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  module com {  module sun {  module star {  module form {
  22
  23
  24 /** specifies the capabilities of a collection of FormComponents.
  25
  26     <p>The collection must provide the possibility of adding and removing
  27     components by name and by index. The name of a component is not
  28     necessarily unique, so the collection must be able to handle duplicate
  29     entry names.</p>
  30
  31     @see FormComponent
  32  */
  33 published service FormComponents
  34 {
  35     /** allows to register listeners to be notified of changes in the container.
  36     */
  37     interface com::sun::star::container::XContainer;
  38
  39     /** allows to add/remove elements by name.
  40     */
  41     interface com::sun::star::container::XNameContainer;
  42
  43     /** gives access to the elements by index.
  44     */
  45     interface com::sun::star::container::XIndexContainer;
  46
  47     /** creates an enumeration of the elements.
  48     */
  49     interface com::sun::star::container::XEnumerationAccess;
  50
  51     /** This interface has to be implemented to supply the scripting environment
  52         for the contained components.
  53
  54         <p>The interface allows managing of scripts associated with dependent components, accessed by index.
  55         However, as a client of the FormComponents service, there's no need to bother with
  56         the container aspect of the com::sun::star::script::XEventAttacherManager
  57         directly. A FormComponents container will automatically synchronize the elements
  58         you put into it with the scripting information obtained at the
  59         com::sun::star::script::XEventAttacherManager interface.</p>
  60
  61         <p>For instance, at any time you can obtain the events associated with
  62         the <code>n</code><sup>th</sup>
  63         element in the form components by calling
  64         com::sun::star::script::XEventAttacherManager::getScriptEvents()
  65         with parameter <code>n</code>. In particular, this invariant is always met, even after you
  66         inserted/removed elements into/from the container.</p>
  67      */
  68     interface com::sun::star::script::XEventAttacherManager;
  69 };
  70
  71
  72 }; }; }; };
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */