Impressum ConfigurableUIElement.idl

/* -*- 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 .
 */


module com { module sun { module star { module ui {


/** specifies a configurable user interface element that supports persistence.

    <p>
    Configurable user interface elements are:
    <ul>
        <li>menubar</li>
        <li>popupmenu<li>
        <li>toolbar</li>
        <li>statusbar</li>
    </ul>
    </p>

    @since OOo 2.0
*/

service ConfigurableUIElement
{
    /** provides properties and functions to initialize and identify a user
        interface element.

        <p>
        A configurable user interface element must be initialized using
        com::sun::star::lang::XInitialization::initialize() before
        it can be used. The following properties must be provided:
        <ul>
            <li><b>ResourceURL</b><br>specifies the user interface name.</li>
            <li><b>Frame</b><br>specifies to which frame instance the user interface belongs to.</li>
            <li><b>ConfigurationSource</b><br>specifies to which configuration manager a user interface
            element instance is bound to.</li>
        </ul>
        </p>

        A user interface element factory creates and initializes every user interface element
        correctly.

        @see com::sun::star::ui::UIElementFactory
    */
    service UIElement;

    /** provides functions to retrieve and change the user interface element structure data and to
        update its visible representation.
    */
    interface com::sun::star::ui::XUIElementSettings;

    /** specifies if the user interface element stores changes of its structure to its creator
        source defined by the property #ConfigurationSource. */
    [property] boolean Persistent;

    /** specifies the configuration source of this user interface element.

        <p>
        If the property #Persistent is `TRUE` changes on the structure of
        the user interface element are written back to configuration source. When this property is
        changed, afterwards XUIElementSettings::updateSettings()  must be called so
        the user interface element tries to retrieve its settings from the new user interface
        configuration manager.
        </p>
    */
    [property] com::sun::star::ui::XUIConfigurationManager ConfigurationSource;
};

}; }; }; };

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