/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_frame_XConfigManager_idl__
#define __com_sun_star_frame_XConfigManager_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_beans_XPropertyChangeListener_idl__
#include <com/sun/star/beans/XPropertyChangeListener.idl>
#endif

//============================================================================

 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 <member>XConfigManager::substituteVariables()</member>
        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
    */
    [oneway] 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
     */
    [oneway] 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 <type scope="com::sun::star::registry">XSimpleRegistry</type>
        and make no sense without that
        @deprecated
     */
    [oneway] void flush();

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

#endif
