summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/frame/XConfigManager.idl
blob: c0e894aaa44e781f377858e6d38bbe00948d5165 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_frame_XConfigManager_idl__
#define __com_sun_star_frame_XConfigManager_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/beans/XPropertyChangeListener.idl>


 module com {
  module sun {
   module star {
    module frame {

/** @deprecated
 */
published interface XConfigManager: com::sun::star::uno::XInterface
{
    /** add a listener to notify changes on well known variables
        inside the real implementation

        <p>
        Listener can update his text values by calling XConfigManager::substituteVariables()
        again. If <var>KeyName</var> specifies a group of keys, the listener gets one notify for each subkey.
        </p>

        @param KeyName
            specifies variable about listener will be informed on changes

        @param Listener
            listener which will be informed

        @see XConfigManager::removePropertyChangeListener()

        @deprecated
    */
    void addPropertyChangeListener(
        [in] string KeyName,
        [in] com::sun::star::beans::XPropertyChangeListener Listener );

    /** remove a registered listener

        @param KeyName
            specifies variable on which listener was registered

        @param Listener
            listener which will be deregistered

        @see XConfigManager::addPropertyChangeListener()

        @deprecated
     */
    void removePropertyChangeListener(
        [in] string KeyName,
        [in] com::sun::star::beans::XPropertyChangeListener Listener);

    /** substitute variables (place holder) inside given parameter <var>Text</var>

        <p>
        The value of <var>Text</var> is NOT changed.
        </p>

        @param Text
            original value including variables

        @return
            changed copy of <var>Text</var> without any variables
     */
    string substituteVariables( [in] string Text );

    /** was designed for additional functionality for interface com::sun::star::registry::XSimpleRegistry
        and make no sense without that
        @deprecated
     */
    void flush();

}; //XConfigManager
}; //frame
}; //star
}; //sun
}; //com

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */