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 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_ui_XModuleUIConfigurationManager_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_ui_XModuleUIConfigurationManager_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_XIndexContainer_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/container/XIndexContainer.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_XIndexAccess_idl__ 32*b1cdbd2cSJim Jagielski#include <com/sun/star/container/XIndexAccess.idl> 33*b1cdbd2cSJim Jagielski#endif 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_NoSuchElementException_idl__ 36*b1cdbd2cSJim Jagielski#include <com/sun/star/container/NoSuchElementException.idl> 37*b1cdbd2cSJim Jagielski#endif 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 40*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IllegalArgumentException.idl> 41*b1cdbd2cSJim Jagielski#endif 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_IllegalAccessException_idl__ 44*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IllegalAccessException.idl> 45*b1cdbd2cSJim Jagielski#endif 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module ui { 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski/** specifies specific functions of a module based user interface 50*b1cdbd2cSJim Jagielski configuration manager interface. 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski <p> 53*b1cdbd2cSJim Jagielski A module user interface configuration manager supports, unlike a 54*b1cdbd2cSJim Jagielski document based ui configration manager, two layers of configuration 55*b1cdbd2cSJim Jagielski settings data:<br/> 56*b1cdbd2cSJim Jagielski 1. Layer: A module default user interface configuration which 57*b1cdbd2cSJim Jagielski describe all user interface elements settings that are 58*b1cdbd2cSJim Jagielski used by OpenOffice. It is not possible to insert, remove 59*b1cdbd2cSJim Jagielski or changeelements settings in this layer through the 60*b1cdbd2cSJim Jagielski interfaces.</br> 61*b1cdbd2cSJim Jagielski 2. Layer: A module user interface configuration which only contains 62*b1cdbd2cSJim Jagielski customized user interface elements and user-defined ones. 63*b1cdbd2cSJim Jagielski All changes on user interface element settings are done on 64*b1cdbd2cSJim Jagielski this layer. This layer is the same as the document ui 65*b1cdbd2cSJim Jagielski configuration manager uses.</br> 66*b1cdbd2cSJim Jagielski </p> 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski @since OpenOffice 2.0 69*b1cdbd2cSJim Jagielski*/ 70*b1cdbd2cSJim Jagielski 71*b1cdbd2cSJim Jagielskiinterface XModuleUIConfigurationManager : ::com::sun::star::uno::XInterface 72*b1cdbd2cSJim Jagielski{ 73*b1cdbd2cSJim Jagielski /** determine if the settings of a user interface element is part 74*b1cdbd2cSJim Jagielski of the default layer of the user interface configuration manager. 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski @param ResourceURL 77*b1cdbd2cSJim Jagielski a resource URL which identifies the user interface element. A 78*b1cdbd2cSJim Jagielski resourcce URL must meet the following syntax: 79*b1cdbd2cSJim Jagielski "private:resource/$type/$name. It is only allowed to use ascii 80*b1cdbd2cSJim Jagielski characters for type and name. 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski @return 83*b1cdbd2cSJim Jagielski <TRUE/> if settings have been found in the default layer, 84*b1cdbd2cSJim Jagielski otherwise <FALSE/>. 85*b1cdbd2cSJim Jagielski */ 86*b1cdbd2cSJim Jagielski boolean isDefaultSettings( [in] string ResourceURL ) raises ( com::sun::star::lang::IllegalArgumentException ); 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski /** retrieves the settings from the default layer of the user interface 89*b1cdbd2cSJim Jagielski configuration manager if it has a default layer. 90*b1cdbd2cSJim Jagielski 91*b1cdbd2cSJim Jagielski @param ResourceURL 92*b1cdbd2cSJim Jagielski a resource URL which identifies the user interface element. A 93*b1cdbd2cSJim Jagielski resourcce URL must meet the following syntax: 94*b1cdbd2cSJim Jagielski "private:resource/$type/$name. It is only allowed to use ascii 95*b1cdbd2cSJim Jagielski characters for type and name. 96*b1cdbd2cSJim Jagielski 97*b1cdbd2cSJim Jagielski @return 98*b1cdbd2cSJim Jagielski <TRUE/> if default settings have been found in the default layer, 99*b1cdbd2cSJim Jagielski otherwise <FALSE/>. 100*b1cdbd2cSJim Jagielski */ 101*b1cdbd2cSJim Jagielski ::com::sun::star::container::XIndexAccess getDefaultSettings( [in] string ResourceURL ) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::IllegalArgumentException ); 102*b1cdbd2cSJim Jagielski 103*b1cdbd2cSJim Jagielski}; 104*b1cdbd2cSJim Jagielski 105*b1cdbd2cSJim Jagielski//============================================================================= 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski}; }; }; }; 108*b1cdbd2cSJim Jagielski 109*b1cdbd2cSJim Jagielski#endif 110