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