offapi/com/sun/star/frame/XConfigManager.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: XConfigManager.idl,v $
  10  * $Revision: 1.9 $
  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_frame_XConfigManager_idl__
  31 #define __com_sun_star_frame_XConfigManager_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_XPropertyChangeListener_idl__
  38 #include <com/sun/star/beans/XPropertyChangeListener.idl>
  39 #endif
  40
  41 //============================================================================
  42
  43  module com {
  44   module sun {
  45    module star {
  46     module frame {
  47
  48 //============================================================================
  49 /** @deprecated
  50  */
  51 published interface XConfigManager: com::sun::star::uno::XInterface
  52 {
  53     //-------------------------------------------------------------------------
  54     /** add a listener to notify changes on well known variables
  55         inside the real implementation
  56
  57         <p>
  58         Listener can update his text values by calling <member>XConfigManager::substituteVariables()</member>
  59         again. If <var>KeyName</var> specifies a group of keys, the listener gets one notify for each subkey.
  60         </p>
  61
  62         @param KeyName
  63             specifies variable about listener will be informed on changes
  64
  65         @param Listener
  66             listener which will be informed
  67
  68         @see XConfigManager::removePropertyChangeListener()
  69
  70         @deprecated
  71     */
  72     [oneway] void addPropertyChangeListener(
  73         [in] string KeyName,
  74         [in] com::sun::star::beans::XPropertyChangeListener Listener );
  75
  76     //-------------------------------------------------------------------------
  77     /** remove a registered listener
  78
  79         @param KeyName
  80             specifies variable on which listener was registered
  81
  82         @param Listener
  83             listener which will be deregistered
  84
  85         @see XConfigManager::addPropertyChangeListener()
  86
  87         @deprecated
  88      */
  89     [oneway] void removePropertyChangeListener(
  90         [in] string KeyName,
  91         [in] com::sun::star::beans::XPropertyChangeListener Listener);
  92
  93     //-------------------------------------------------------------------------
  94     /** substitute variables (place holder) inside given parameter <var>Text</var>
  95
  96         <p>
  97         The value of <var>Text</var> is NOT changed.
  98         </p>
  99
 100         @param Text
 101             original value including variables
 102
 103         @return
 104             changed copy of <var>Text</var> without any variables
 105      */
 106     string substituteVariables( [in] string Text );
 107
 108     //-------------------------------------------------------------------------
 109     /** was designed for additional functionality for interface <type scope="com::sun::star::registry">XSimpleRegistry</type>
 110         and make no sense without that
 111         @deprecated
 112      */
 113     [oneway] void flush();
 114
 115 }; //XConfigManager
 116 }; //frame
 117 }; //star
 118 }; //sun
 119 }; //com
 120
 121 #endif