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

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