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
  20
  21  module com {
  22   module sun {
  23    module star {
  24     module frame {
  25
  26 /** @deprecated
  27  */
  28 published interface XConfigManager: com::sun::star::uno::XInterface
  29 {
  30     /** add a listener to notify changes on well known variables
  31         inside the real implementation
  32
  33         <p>
  34         Listener can update his text values by calling XConfigManager::substituteVariables()
  35         again. If <var>KeyName</var> specifies a group of keys, the listener gets one notify for each subkey.
  36         </p>
  37
  38         @param KeyName
  39             specifies variable about listener will be informed on changes
  40
  41         @param Listener
  42             listener which will be informed
  43
  44         @see XConfigManager::removePropertyChangeListener()
  45
  46         @deprecated
  47     */
  48     void addPropertyChangeListener(
  49         [in] string KeyName,
  50         [in] com::sun::star::beans::XPropertyChangeListener Listener );
  51
  52     /** remove a registered listener
  53
  54         @param KeyName
  55             specifies variable on which listener was registered
  56
  57         @param Listener
  58             listener which will be deregistered
  59
  60         @see XConfigManager::addPropertyChangeListener()
  61
  62         @deprecated
  63      */
  64     void removePropertyChangeListener(
  65         [in] string KeyName,
  66         [in] com::sun::star::beans::XPropertyChangeListener Listener);
  67
  68     /** substitute variables (place holder) inside given parameter <var>Text</var>
  69
  70         <p>
  71         The value of <var>Text</var> is NOT changed.
  72         </p>
  73
  74         @param Text
  75             original value including variables
  76
  77         @return
  78             changed copy of <var>Text</var> without any variables
  79      */
  80     string substituteVariables( [in] string Text );
  81
  82     /** was designed for additional functionality for interface com::sun::star::registry::XSimpleRegistry
  83         and make no sense without that
  84         @deprecated
  85      */
  86     void flush();
  87
  88 }; //XConfigManager
  89 }; //frame
  90 }; //star
  91 }; //sun
  92 }; //com
  93
  94 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */