1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_form_FormComponents_idl__ 24cdf0e10cSrcweir#define __com_sun_star_form_FormComponents_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_container_XNameContainer_idl__ 27cdf0e10cSrcweir#include <com/sun/star/container/XNameContainer.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_container_XIndexContainer_idl__ 31cdf0e10cSrcweir#include <com/sun/star/container/XIndexContainer.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_container_XEnumerationAccess_idl__ 35cdf0e10cSrcweir#include <com/sun/star/container/XEnumerationAccess.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir#ifndef __com_sun_star_container_XContainer_idl__ 39cdf0e10cSrcweir#include <com/sun/star/container/XContainer.idl> 40cdf0e10cSrcweir#endif 41cdf0e10cSrcweir 42cdf0e10cSrcweir#include <com/sun/star/script/XEventAttacherManager.idl> 43cdf0e10cSrcweir 44cdf0e10cSrcweir//============================================================================= 45cdf0e10cSrcweir 46cdf0e10cSrcweir module com { module sun { module star { module form { 47cdf0e10cSrcweir 48cdf0e10cSrcweir//============================================================================= 49cdf0e10cSrcweir 50cdf0e10cSrcweir/** specifies the capabilities of a collection of <type>FormComponent</type>s. 51cdf0e10cSrcweir 52cdf0e10cSrcweir <p>The collection must provide the possibility of adding and removing 53cdf0e10cSrcweir components by name and by index. The name of a component is not 54cdf0e10cSrcweir necessarily unique, so the collection must be able to handle duplicate 55cdf0e10cSrcweir entry names.</p> 56cdf0e10cSrcweir 57cdf0e10cSrcweir @see FormComponent 58cdf0e10cSrcweir */ 59cdf0e10cSrcweirpublished service FormComponents 60cdf0e10cSrcweir{ 61cdf0e10cSrcweir /** allows to register listeners to be notified of changes in the container. 62cdf0e10cSrcweir */ 63cdf0e10cSrcweir interface com::sun::star::container::XContainer; 64cdf0e10cSrcweir 65cdf0e10cSrcweir /** allows to add/remove elements by name. 66cdf0e10cSrcweir */ 67cdf0e10cSrcweir interface com::sun::star::container::XNameContainer; 68cdf0e10cSrcweir 69cdf0e10cSrcweir /** gives access to the elements by index. 70cdf0e10cSrcweir */ 71cdf0e10cSrcweir interface com::sun::star::container::XIndexContainer; 72cdf0e10cSrcweir 73cdf0e10cSrcweir /** creates an enumeration of the elements. 74cdf0e10cSrcweir */ 75cdf0e10cSrcweir interface com::sun::star::container::XEnumerationAccess; 76cdf0e10cSrcweir 77cdf0e10cSrcweir /** This interface has to be implemented to supply the scripting environment 78cdf0e10cSrcweir for the contained components. 79cdf0e10cSrcweir 80cdf0e10cSrcweir <p>The interface allows managing of scripts associated with dependent components, accessed by index. 81cdf0e10cSrcweir However, as a client of the <type>FormComponents</type> service, there's no need to bother with 82cdf0e10cSrcweir the container aspect of the <type scope="com::sun::star::script">XEventAttacherManager</type> 83cdf0e10cSrcweir directly. A <type>FormComponents</type> container will automatically synchronize the elements 84cdf0e10cSrcweir you put into it with the scripting information obtained at the 85cdf0e10cSrcweir <type scope="com::sun::star::script">XEventAttacherManager</type> interface.</p> 86cdf0e10cSrcweir 87cdf0e10cSrcweir <p>For instance, at any time you can obtain the events associated with the <code>n</code><super>th</super> 88cdf0e10cSrcweir element in the form components by calling 89cdf0e10cSrcweir <member scope="com::sun::star::script">XEventAttacherManager::getScriptEvents</member> 90*a893be29SPedro Giffuni with parameter <code>n</code>. In particular, this invariant is always met, even after you 91cdf0e10cSrcweir inserted/removed elements into/from the container.</p> 92cdf0e10cSrcweir */ 93cdf0e10cSrcweir interface com::sun::star::script::XEventAttacherManager; 94cdf0e10cSrcweir}; 95cdf0e10cSrcweir 96cdf0e10cSrcweir//============================================================================= 97cdf0e10cSrcweir 98cdf0e10cSrcweir}; }; }; }; 99cdf0e10cSrcweir 100cdf0e10cSrcweir/*============================================================================= 101cdf0e10cSrcweir 102cdf0e10cSrcweir=============================================================================*/ 103cdf0e10cSrcweir#endif 104