1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir#ifndef __com_sun_star_ui_ConfigurableUIElement_idl__ 29*cdf0e10cSrcweir#define __com_sun_star_ui_ConfigurableUIElement_idl__ 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir#ifndef __com_sun_star_ui_UIElement_idl__ 32*cdf0e10cSrcweir#include <com/sun/star/ui/UIElement.idl> 33*cdf0e10cSrcweir#endif 34*cdf0e10cSrcweir 35*cdf0e10cSrcweir#ifndef __com_sun_star_ui_XUIElementSettings_idl__ 36*cdf0e10cSrcweir#include <com/sun/star/ui/XUIElementSettings.idl> 37*cdf0e10cSrcweir#endif 38*cdf0e10cSrcweir 39*cdf0e10cSrcweir#ifndef __com_sun_star_beans_XPropertySet_idl__ 40*cdf0e10cSrcweir#include <com/sun/star/beans/XPropertySet.idl> 41*cdf0e10cSrcweir#endif 42*cdf0e10cSrcweir 43*cdf0e10cSrcweir#ifndef __com_sun_star_ui_UIElementType_idl__ 44*cdf0e10cSrcweir#include <com/sun/star/ui/UIElementType.idl> 45*cdf0e10cSrcweir#endif 46*cdf0e10cSrcweir 47*cdf0e10cSrcweir#ifndef __com_sun_star_ui_XUIConfigurationManager_idl__ 48*cdf0e10cSrcweir#include <com/sun/star/ui/XUIConfigurationManager.idl> 49*cdf0e10cSrcweir#endif 50*cdf0e10cSrcweir 51*cdf0e10cSrcweir#ifndef __com_sun_star_frame_XFrame_idl__ 52*cdf0e10cSrcweir#include <com/sun/star/frame/XFrame.idl> 53*cdf0e10cSrcweir#endif 54*cdf0e10cSrcweir 55*cdf0e10cSrcweir#ifndef __com_sun_star_lang_XInitialization_idl__ 56*cdf0e10cSrcweir#include <com/sun/star/lang/XInitialization.idl> 57*cdf0e10cSrcweir#endif 58*cdf0e10cSrcweir 59*cdf0e10cSrcweir//============================================================================= 60*cdf0e10cSrcweir 61*cdf0e10cSrcweirmodule com { module sun { module star { module ui { 62*cdf0e10cSrcweir 63*cdf0e10cSrcweir//============================================================================= 64*cdf0e10cSrcweir 65*cdf0e10cSrcweir/** specifies a configurable user interface element that supports persistence. 66*cdf0e10cSrcweir 67*cdf0e10cSrcweir <p> 68*cdf0e10cSrcweir Configurable user interface elements are: 69*cdf0e10cSrcweir <ul> 70*cdf0e10cSrcweir <li>menubar</li> 71*cdf0e10cSrcweir <li>popupmenu<li> 72*cdf0e10cSrcweir <li>toolbar</li> 73*cdf0e10cSrcweir <li>statusbar</li> 74*cdf0e10cSrcweir </ul> 75*cdf0e10cSrcweir </p> 76*cdf0e10cSrcweir 77*cdf0e10cSrcweir @since OOo 2.0 78*cdf0e10cSrcweir*/ 79*cdf0e10cSrcweir 80*cdf0e10cSrcweirservice ConfigurableUIElement 81*cdf0e10cSrcweir{ 82*cdf0e10cSrcweir /** provides properties and functions to initialize and identify a user 83*cdf0e10cSrcweir interface element. 84*cdf0e10cSrcweir 85*cdf0e10cSrcweir <p> 86*cdf0e10cSrcweir A configurable user interface element must be initialized using 87*cdf0e10cSrcweir <member scope=com::sun::star::lang>XInitialization::initialize</member> before 88*cdf0e10cSrcweir it can be used. The following properties must be provided: 89*cdf0e10cSrcweir <ul> 90*cdf0e10cSrcweir <li><b>ResourceURL</b><br>specifies the user interface name.</li> 91*cdf0e10cSrcweir <li><b>Frame</b><br>specifies to which frame instance the user interface belongs to.</li> 92*cdf0e10cSrcweir <li><b>ConfigurationSource</b><br>specifies to which configuration manager a user interface 93*cdf0e10cSrcweir element instance is bound to.</li> 94*cdf0e10cSrcweir </ul> 95*cdf0e10cSrcweir </p> 96*cdf0e10cSrcweir 97*cdf0e10cSrcweir A user interface element factory creates and initializes every user interface element 98*cdf0e10cSrcweir correctly. 99*cdf0e10cSrcweir 100*cdf0e10cSrcweir @see com::sun::star::ui::UIElementFactory 101*cdf0e10cSrcweir */ 102*cdf0e10cSrcweir service UIElement; 103*cdf0e10cSrcweir 104*cdf0e10cSrcweir /** provides functions to retrieve and change the user interface element structure data and to 105*cdf0e10cSrcweir update its visible representation. 106*cdf0e10cSrcweir */ 107*cdf0e10cSrcweir interface com::sun::star::ui::XUIElementSettings; 108*cdf0e10cSrcweir 109*cdf0e10cSrcweir /** specifies if the user interface element stores changes of its structure to its creator 110*cdf0e10cSrcweir source defined by the property <member>ConfigurationSource</member>. */ 111*cdf0e10cSrcweir [property] boolean Persistent; 112*cdf0e10cSrcweir 113*cdf0e10cSrcweir /** specifies the configuration source of this user interface element. 114*cdf0e10cSrcweir 115*cdf0e10cSrcweir <p> 116*cdf0e10cSrcweir If the property <member>Persistent</member> is <TRUE/> changes on the structure of 117*cdf0e10cSrcweir the user interface element are written back to configuration source. When this property is 118*cdf0e10cSrcweir changed, afterwards <member>XUIElementSettings::updateSettings</member> must be called so 119*cdf0e10cSrcweir the user interface element tries to retrieve its settings from the new user interface 120*cdf0e10cSrcweir configuration manager. 121*cdf0e10cSrcweir </p> 122*cdf0e10cSrcweir */ 123*cdf0e10cSrcweir [property] com::sun::star::ui::XUIConfigurationManager ConfigurationSource; 124*cdf0e10cSrcweir}; 125*cdf0e10cSrcweir 126*cdf0e10cSrcweir}; }; }; }; 127*cdf0e10cSrcweir 128*cdf0e10cSrcweir#endif 129