| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| #ifndef __com_sun_star_form_FormComponents_idl__ |
| #define __com_sun_star_form_FormComponents_idl__ |
| |
| #ifndef __com_sun_star_container_XNameContainer_idl__ |
| #include <com/sun/star/container/XNameContainer.idl> |
| #endif |
| |
| #ifndef __com_sun_star_container_XIndexContainer_idl__ |
| #include <com/sun/star/container/XIndexContainer.idl> |
| #endif |
| |
| #ifndef __com_sun_star_container_XEnumerationAccess_idl__ |
| #include <com/sun/star/container/XEnumerationAccess.idl> |
| #endif |
| |
| #ifndef __com_sun_star_container_XContainer_idl__ |
| #include <com/sun/star/container/XContainer.idl> |
| #endif |
| |
| #include <com/sun/star/script/XEventAttacherManager.idl> |
| |
| //============================================================================= |
| |
| module com { module sun { module star { module form { |
| |
| //============================================================================= |
| |
| /** specifies the capabilities of a collection of <type>FormComponent</type>s. |
| |
| <p>The collection must provide the possibility of adding and removing |
| components by name and by index. The name of a component is not |
| necessarily unique, so the collection must be able to handle duplicate |
| entry names.</p> |
| |
| @see FormComponent |
| */ |
| published service FormComponents |
| { |
| /** allows to register listeners to be notified of changes in the container. |
| */ |
| interface com::sun::star::container::XContainer; |
| |
| /** allows to add/remove elements by name. |
| */ |
| interface com::sun::star::container::XNameContainer; |
| |
| /** gives access to the elements by index. |
| */ |
| interface com::sun::star::container::XIndexContainer; |
| |
| /** creates an enumeration of the elements. |
| */ |
| interface com::sun::star::container::XEnumerationAccess; |
| |
| /** This interface has to be implemented to supply the scripting environment |
| for the contained components. |
| |
| <p>The interface allows managing of scripts associated with dependent components, accessed by index. |
| However, as a client of the <type>FormComponents</type> service, there's no need to bother with |
| the container aspect of the <type scope="com::sun::star::script">XEventAttacherManager</type> |
| directly. A <type>FormComponents</type> container will automatically synchronize the elements |
| you put into it with the scripting information obtained at the |
| <type scope="com::sun::star::script">XEventAttacherManager</type> interface.</p> |
| |
| <p>For instance, at any time you can obtain the events associated with the <code>n</code><super>th</super> |
| element in the form components by calling |
| <member scope="com::sun::star::script">XEventAttacherManager::getScriptEvents</member> |
| with paramter <code>n</code>. In particular, this invariant is always met, even after you |
| inserted/removed elements into/from the container.</p> |
| */ |
| interface com::sun::star::script::XEventAttacherManager; |
| }; |
| |
| //============================================================================= |
| |
| }; }; }; }; |
| |
| /*============================================================================= |
| |
| =============================================================================*/ |
| #endif |