/* -*- 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_ui_UIElementSettings_idl__
#define __com_sun_star_ui_UIElementSettings_idl__

#include <com/sun/star/container/XIndexAccess.idl>
#include <com/sun/star/lang/XSingleComponentFactory.idl>


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


/**
    describes the internal structure of a configurable user interface element.

    <p>
    No assumption is made about any graphical representation:
    You could have a menu or a toolbar working with the same UIElementSettings
    although limitations based on the real user interface element may be visible.
    </p>

    @since OOo 2.0
*/
service UIElementSettings
{
    /** provides access to the structure of the user interface element.

        <p>
        The container contains the items of the user interface element. Every
        item is stored as a sequence of com::sun::star::beans::PropertyValue.
        The properties insides the sequence are defined by the service com::sun::star::ui::ItemDescriptor.
        It depends on the function which provides these service if the container is shareable read-only or exclusive writable.

        @see com::sun::star::ui::ItemDescriptor
        @see com::sun::star::ui::ItemType
        @see com::sun::star::ui::ItemStyle
        </p>
    */
    interface ::com::sun::star::container::XIndexAccess;


    /** provides access to an optional factory interface to create sub container.

        <p>
        The factory should be used to create sub container within this user interface element settings. This interface is only
        available if the container is exclusive writable.
        </p>
    */
    [optional] interface ::com::sun::star::lang::XSingleComponentFactory;

    /** determine an optional user interface name of the user interface element.

        <p>
        A toolbar can show a its user interface name on the window title, when it is in floating mode.
        </p>
    */
    [optional, property] string UIName;
};

}; }; }; };

#endif

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