/************************************************************** * * 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 #endif #ifndef __com_sun_star_container_XIndexContainer_idl__ #include #endif #ifndef __com_sun_star_container_XEnumerationAccess_idl__ #include #endif #ifndef __com_sun_star_container_XContainer_idl__ #include #endif #include //============================================================================= module com { module sun { module star { module form { //============================================================================= /** specifies the capabilities of a collection of FormComponents.

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.

@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.

The interface allows managing of scripts associated with dependent components, accessed by index. However, as a client of the FormComponents service, there's no need to bother with the container aspect of the XEventAttacherManager directly. A FormComponents container will automatically synchronize the elements you put into it with the scripting information obtained at the XEventAttacherManager interface.

For instance, at any time you can obtain the events associated with the nth element in the form components by calling XEventAttacherManager::getScriptEvents with paramter n. In particular, this invariant is always met, even after you inserted/removed elements into/from the container.

*/ interface com::sun::star::script::XEventAttacherManager; }; //============================================================================= }; }; }; }; /*============================================================================= =============================================================================*/ #endif