offapi/com/sun/star/frame/XConfigManager.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_frame_XConfigManager_idl__
  20 #define __com_sun_star_frame_XConfigManager_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/beans/XPropertyChangeListener.idl>
  24
  25
  26  module com {
  27   module sun {
  28    module star {
  29     module frame {
  30
  31 /** @deprecated
  32  */
  33 published interface XConfigManager: com::sun::star::uno::XInterface
  34 {
  35     /** add a listener to notify changes on well known variables
  36         inside the real implementation
  37
  38         <p>
  39         Listener can update his text values by calling XConfigManager::substituteVariables()
  40         again. If <var>KeyName</var> specifies a group of keys, the listener gets one notify for each subkey.
  41         </p>
  42
  43         @param KeyName
  44             specifies variable about listener will be informed on changes
  45
  46         @param Listener
  47             listener which will be informed
  48
  49         @see XConfigManager::removePropertyChangeListener()
  50
  51         @deprecated
  52     */
  53     void addPropertyChangeListener(
  54         [in] string KeyName,
  55         [in] com::sun::star::beans::XPropertyChangeListener Listener );
  56
  57     /** remove a registered listener
  58
  59         @param KeyName
  60             specifies variable on which listener was registered
  61
  62         @param Listener
  63             listener which will be deregistered
  64
  65         @see XConfigManager::addPropertyChangeListener()
  66
  67         @deprecated
  68      */
  69     void removePropertyChangeListener(
  70         [in] string KeyName,
  71         [in] com::sun::star::beans::XPropertyChangeListener Listener);
  72
  73     /** substitute variables (place holder) inside given parameter <var>Text</var>
  74
  75         <p>
  76         The value of <var>Text</var> is NOT changed.
  77         </p>
  78
  79         @param Text
  80             original value including variables
  81
  82         @return
  83             changed copy of <var>Text</var> without any variables
  84      */
  85     string substituteVariables( [in] string Text );
  86
  87     /** was designed for additional functionality for interface com::sun::star::registry::XSimpleRegistry
  88         and make no sense without that
  89         @deprecated
  90      */
  91     void flush();
  92
  93 }; //XConfigManager
  94 }; //frame
  95 }; //star
  96 }; //sun
  97 }; //com
  98
  99 #endif
 100
 101 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */