1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir#ifndef __com_sun_star_ui_UIElementSettings_idl__ 25cdf0e10cSrcweir#define __com_sun_star_ui_UIElementSettings_idl__ 26cdf0e10cSrcweir 27cdf0e10cSrcweir#ifndef __com_sun_star_container_XIndexAccess_idl__ 28cdf0e10cSrcweir#include <com/sun/star/container/XIndexAccess.idl> 29cdf0e10cSrcweir#endif 30cdf0e10cSrcweir 31cdf0e10cSrcweir#ifndef __com_sun_star_lang_XSingleComponentFactory_idl__ 32cdf0e10cSrcweir#include <com/sun/star/lang/XSingleComponentFactory.idl> 33cdf0e10cSrcweir#endif 34cdf0e10cSrcweir 35cdf0e10cSrcweir//============================================================================= 36cdf0e10cSrcweir 37cdf0e10cSrcweirmodule com { module sun { module star { module ui { 38cdf0e10cSrcweir 39cdf0e10cSrcweir//============================================================================= 40cdf0e10cSrcweir 41cdf0e10cSrcweir/** 42cdf0e10cSrcweir describes the internal structure of a configurable user interface element. 43cdf0e10cSrcweir 44cdf0e10cSrcweir <p> 45cdf0e10cSrcweir No assumption is made about any graphical representation: 46cdf0e10cSrcweir You could have a menu or a toolbar working with the same UIElementSettings 47cdf0e10cSrcweir although limitations based on the real user interface element may be visible. 48cdf0e10cSrcweir </p> 49cdf0e10cSrcweir 50cdf0e10cSrcweir @since OOo 2.0 51cdf0e10cSrcweir*/ 52cdf0e10cSrcweirservice UIElementSettings 53cdf0e10cSrcweir{ 54cdf0e10cSrcweir /** provides access to the structure of the user interface element. 55cdf0e10cSrcweir 56cdf0e10cSrcweir <p> 57cdf0e10cSrcweir The container contains the items of the user interface element. Every 58cdf0e10cSrcweir item is stored as a sequence of <type scope="com::sun::star::beans">PropertyValue</type>. 59cdf0e10cSrcweir The properties insides the sequence are defined by the service <type scope="com::sun::star::ui">ItemDescriptor</type>. 60cdf0e10cSrcweir It depends on the function which provides these service if the container is shareable read-only or exclusive writeable. 61cdf0e10cSrcweir 62cdf0e10cSrcweir @see com::sun::star::ui::ItemDescriptor 63cdf0e10cSrcweir @see com::sun::star::ui::ItemType 64cdf0e10cSrcweir @see com::sun::star::ui::ItemStyle 65cdf0e10cSrcweir </p> 66cdf0e10cSrcweir */ 67cdf0e10cSrcweir interface ::com::sun::star::container::XIndexAccess; 68cdf0e10cSrcweir 69cdf0e10cSrcweir 70cdf0e10cSrcweir /** provides access to an optional factory interface to create sub container. 71cdf0e10cSrcweir 72cdf0e10cSrcweir <p> 73cdf0e10cSrcweir The factory should be used to create sub container within this user interface element settings. This interface is only 74cdf0e10cSrcweir available if the container is exclusive writable. 75cdf0e10cSrcweir </p> 76cdf0e10cSrcweir */ 77cdf0e10cSrcweir [optional] interface ::com::sun::star::lang::XSingleComponentFactory; 78cdf0e10cSrcweir 79cdf0e10cSrcweir /** determine an optional user interface name of the user interface element. 80cdf0e10cSrcweir 81cdf0e10cSrcweir <p> 82cdf0e10cSrcweir A toolbar can show a its user interface name on the window title, when it is in floating mode. 83cdf0e10cSrcweir </p> 84cdf0e10cSrcweir */ 85cdf0e10cSrcweir [optional, property] string UIName; 86cdf0e10cSrcweir}; 87cdf0e10cSrcweir 88cdf0e10cSrcweir}; }; }; }; 89cdf0e10cSrcweir 90cdf0e10cSrcweir#endif 91