offapi/com/sun/star/ui/XUIConfiguration.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: XUIConfiguration.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
  31 #ifndef __com_sun_star_ui_XUIConfiguration_idl__
  32 #define __com_sun_star_ui_XUIConfiguration_idl__
  33
  34 #ifndef __com_sun_star_ui_XUIConfigurationListener_idl__
  35 #include <com/sun/star/ui/XUIConfigurationListener.idl>
  36 #endif
  37
  38 module com { module sun { module star { module ui {
  39
  40 /** supports to notify other implementations about changes of a user
  41     interface configuration manager.
  42
  43     <p>
  44     The <type>XUIConfiguration</type> interface is provided for user
  45     interface configuration managers which need to broadcast changes
  46     within the container; that means the actions of adding, replacing
  47     and removing elements are broadcast to listeners.
  48     </p>
  49
  50     <p>This can be useful for UI to enable/disable some functions without
  51     actually accessing the data.</p>
  52
  53     @since OOo 2.0.0
  54 */
  55
  56 interface XUIConfiguration : ::com::sun::star::uno::XInterface
  57 {
  58     /** adds the specified listener to receive events when elements are
  59         changed, inserted or removed.
  60
  61         <p>
  62         It is suggested to allow multiple registration of the same
  63         listener, thus for each time a listener is added, it has to be
  64         removed.
  65
  66         @see XUIConfigurationListener
  67         </p>
  68     */
  69     void addConfigurationListener( [in] ::com::sun::star::ui::XUIConfigurationListener Listener );
  70
  71     /** removes the specified listener so it does not receive any events
  72         from this user interface configuration manager.
  73
  74         <p>It is suggested to allow multiple registration of the same
  75         listener, thus for each time a listener is added, it has to be
  76         removed.
  77
  78         @see XUIConfigurationListener
  79         </p>
  80      */
  81     void removeConfigurationListener( [in] ::com::sun::star::ui::XUIConfigurationListener Listener );
  82 };
  83
  84 //=============================================================================
  85
  86 }; }; }; };
  87
  88 #endif