diff options
author | Kurt Zenker <kz@openoffice.org> | 2005-03-01 17:29:22 +0000 |
---|---|---|
committer | Kurt Zenker <kz@openoffice.org> | 2005-03-01 17:29:22 +0000 |
commit | 338c199069dd3d57bb1a917d5c709f9732d76d52 (patch) | |
tree | 49b0cbcfd6ff7d94998e2dd1026762d5221fd803 /offapi/com/sun/star/ui | |
parent | 22a87b23c60da7495b2600b44f86137b1687b50f (diff) |
INTEGRATION: CWS removedrafts (1.1.2); FILE ADDED
2005/02/17 13:10:49 cd 1.1.2.1: #i42557# move UNOIDL types from drafts to com
Diffstat (limited to 'offapi/com/sun/star/ui')
-rw-r--r-- | offapi/com/sun/star/ui/XModuleUIConfigurationManager.idl | 147 |
1 files changed, 147 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ui/XModuleUIConfigurationManager.idl b/offapi/com/sun/star/ui/XModuleUIConfigurationManager.idl new file mode 100644 index 000000000..229c8f35f --- /dev/null +++ b/offapi/com/sun/star/ui/XModuleUIConfigurationManager.idl @@ -0,0 +1,147 @@ +/************************************************************************* + * + * $RCSfile: XModuleUIConfigurationManager.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: kz $ $Date: 2005-03-01 18:29:22 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_ui_XModuleUIConfigurationManager_idl__ +#define __com_sun_star_ui_XModuleUIConfigurationManager_idl__ + +#ifndef __com_sun_star_container_XIndexContainer_idl__ +#include <com/sun/star/container/XIndexContainer.idl> +#endif + +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif + +#ifndef __com_sun_star_container_NoSuchElementException_idl__ +#include <com/sun/star/container/NoSuchElementException.idl> +#endif + +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif + +#ifndef __com_sun_star_lang_IllegalAccessException_idl__ +#include <com/sun/star/lang/IllegalAccessException.idl> +#endif + +module com { module sun { module star { module ui { + +/** specifies specific functions of a module based user interface + configuration manager interface. + + <p> + A module user interface configuration manager supports, unlike a + document based ui configration manager, two layers of configuration + settings data:<br/> + 1. Layer: A module default user interface configuration which + describe all user interface elements settings that are + used by OpenOffice. It is not possible to insert, remove + or changeelements settings in this layer through the + interfaces.</br> + 2. Layer: A module user interface configuration which only contains + customized user interface elements and user-defined ones. + All changes on user interface element settings are done on + this layer. This layer is the same as the document ui + configuration manager uses.</br> + </p> + + @since OOo 2.0.0 +*/ + +interface XModuleUIConfigurationManager : ::com::sun::star::uno::XInterface +{ + /** determine if the settings of a user interface element is part + of the default layer of the user interface configuration manager. + + @param ResourceURL + a resource URL which identifies the user interface element. A + resourcce URL must meet the following syntax: + "private:resource/$type/$name. It is only allowed to use ascii + characters for type and name. + + @return + </TRUE> if settings have been found in the default layer, + otherwise </FALSE>. + */ + boolean isDefaultSettings( [in] string ResourceURL ) raises ( com::sun::star::lang::IllegalArgumentException ); + + /** retrieves the settings from the default layer of the user interface + configuration manager if it has a default layer. + + @param ResourceURL + a resource URL which identifies the user interface element. A + resourcce URL must meet the following syntax: + "private:resource/$type/$name. It is only allowed to use ascii + characters for type and name. + + @return + </TRUE> if default settings have been found in the default layer, + otherwise </FALSE>. + */ + ::com::sun::star::container::XIndexAccess getDefaultSettings( [in] string ResourceURL ) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::IllegalArgumentException ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif |