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