offapi/com/sun/star/ui/UIConfigurationManager.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_ui_UIConfigurationManager_idl__
  28 #define __com_sun_star_ui_UIConfigurationManager_idl__
  29
  30 #ifndef __com_sun_star_lang_XComponent_idl__
  31 #include <com/sun/star/lang/XComponent.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_ui_XUIConfiguration_idl__
  35 #include <com/sun/star/ui/XUIConfiguration.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_ui_XUIConfigurationManager_idl__
  39 #include <com/sun/star/ui/XUIConfigurationManager.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_ui_XUIConfigurationPersistence_idl__
  43 #include <com/sun/star/ui/XUIConfigurationPersistence.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_ui_XUIConfigurationStorage_idl__
  47 #include <com/sun/star/ui/XUIConfigurationStorage.idl>
  48 #endif
  49
  50 module com { module sun { module star { module ui {
  51
  52 /** specifies a user interface configuration manager which controls
  53     all customizeable user interface elements of an object.
  54
  55     @since OOo 2.0.0
  56 */
  57
  58 service UIConfigurationManager
  59 {
  60     /** provides access to set a storage and to check if a storage has been
  61         associated to the user interface configuration manager.
  62     */
  63     interface com::sun::star::ui::XUIConfigurationStorage;
  64
  65     /** provides access to persistence functions to load/store user interface configuration
  66         data from a storage.
  67     */
  68     interface com::sun::star::ui::XUIConfigurationPersistence;
  69
  70     /** provides functions to change, insert and remove user interface elements
  71         from a user interface configuration manager.
  72     */
  73     interface com::sun::star::ui::XUIConfigurationManager;
  74
  75     /** provides functions to add and remove listeners for changes within a user
  76         interface configuration manager.
  77     */
  78     interface com::sun::star::ui::XUIConfiguration;
  79
  80     /** allows controlling or observing the lifetime of a user interface configuration manager
  81         instance.
  82
  83     <p>The owner of the object may dispose of this object using
  84     <member scope="com::sun::star::lang">XComponent::dispose()</member>.
  85     </p>
  86     */
  87     interface ::com::sun::star::lang::XComponent;
  88 };
  89
  90 //=============================================================================
  91
  92 }; }; }; };
  93
  94 #endif