offapi/com/sun/star/form/XForms.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_XForms_idl__
  20 #define __com_sun_star_form_XForms_idl__
  21
  22 #include <com/sun/star/container/XNameContainer.idl>
  23 #include <com/sun/star/container/XIndexContainer.idl>
  24 #include <com/sun/star/container/XEnumerationAccess.idl>
  25 #include <com/sun/star/container/XContainer.idl>
  26 #include <com/sun/star/container/XChild.idl>
  27 #include <com/sun/star/lang/XComponent.idl>
  28 #include <com/sun/star/script/XEventAttacherManager.idl>
  29 #include <com/sun/star/util/XCloneable.idl>
  30
  31
  32 module com {  module sun {  module star {  module form {
  33
  34
  35 /**
  36     @since LibreOffice 4.1
  37  */
  38 published interface XForms
  39 {
  40     /** allows to register listeners to be notified of changes in the container.
  41     */
  42     interface com::sun::star::container::XContainer;
  43
  44     /** allows to add/remove elements by name.
  45     */
  46     interface com::sun::star::container::XNameContainer; // ->XNameReplace->XNameAccess->XElementAccess->XInterface
  47
  48     /** gives access to the elements by index.
  49     */
  50     interface com::sun::star::container::XIndexContainer; // ->XIndexReplace->XIndexAccess->XElementAccess->XInterface
  51
  52     /** creates an enumeration of the elements.
  53     */
  54     interface com::sun::star::container::XEnumerationAccess; // ->XElementAccess->XInterface
  55
  56     /** This interface has to be implemented to supply the scripting environment
  57         for the contained components.
  58
  59         <p>The interface allows managing of scripts associated with dependent components, accessed by index.
  60         However, as a client of the FormComponents service, there's no need to bother with
  61         the container aspect of the com::sun::star::script::XEventAttacherManager
  62         directly. A FormComponents container will automatically synchronize the elements
  63         you put into it with the scripting information obtained at the
  64         com::sun::star::script::XEventAttacherManager interface.</p>
  65
  66         <p>For instance, at any time you can obtain the events associated with
  67         the <code>n</code><sup>th</sup>
  68         element in the form components by calling
  69         com::sun::star::script::XEventAttacherManager::getScriptEvents()
  70         with parameter <code>n</code>. In particular, this invariant is always met, even after you
  71         inserted/removed elements into/from the container.</p>
  72      */
  73     interface com::sun::star::script::XEventAttacherManager; // ->XInterface
  74
  75     interface com::sun::star::container::XChild;
  76
  77     interface com::sun::star::util::XCloneable;
  78
  79     interface com::sun::star::lang::XComponent;
  80 };
  81
  82
  83 }; }; }; };
  84
  85 #endif
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */