/* -*- 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_sdb_DatasourceAdministrationDialog_idl__
#define __com_sun_star_sdb_DatasourceAdministrationDialog_idl__

#include <com/sun/star/ui/dialogs/XExecutableDialog.idl>
#include <com/sun/star/awt/XWindow.idl>
#include <com/sun/star/lang/XInitialization.idl>
#include <com/sun/star/beans/XPropertySet.idl>


module com {  module sun {  module star {  module sdb {


/** provides a user interface for administrating the system wide registered data sources.
    <p>
    Here, <em>system wide registered</em> means registered on the (one and only) instance
    of the
    com::sun::star::sdb::DatabaseContext
    service.
    </p>
*/
published service DatasourceAdministrationDialog
{
    /** the title of the (dialog) window
    */
    [property] string Title;

    /** parent window to use for the administration dialog
        <p>
        This property can't be set while the dialog is being displayed.
        </p>
    */
    [property] com::sun::star::awt::XWindow ParentWindow;

    /** allows access to the properties of the object
    */
    interface com::sun::star::beans::XPropertySet;

    /** allows starting execution of the administration dialog
    */
    interface com::sun::star::ui::dialogs::XExecutableDialog;

    /** allows initializing the dialog
        <p>
        You do not need to call the initialize method directly, instead you may use the createInstanceWithArguments
        method of your com::sun::star::lang::XMultiServiceFactory.
        </p>

        <p>
        You specify a parameter by passing one (or more)
        com::sun::star::beans::PropertyValue
        object(s) to the initialize method, where the <em>Name</em> field contains a string describing which aspect
        you want to affect, and the <em>Value</em> field containing a value.
        <br/>
        Imagine the initialization values as if you use setPropertyValue of the
        com::sun::star::beans::XPropertySet
        interface ...
        <br/>
        allowed parameters are
        <ul>
            <li><b>Title</b><br/>
                String describing the initial title of the dialog.
                If not specified, a default title is used.
            </li>
            <li><b>ParentWindow</b><br/>
                com::sun::star::awt::XWindow
                describing the parent window to use for the dialog.
            </li>
            <li><b>InitialSelection</b><br/>
                String or XDataSource describing which data source should be selected initially.
                This String name must be known to the
                com::sun::star::sdb::DatabaseContext.
            </li>
        </ul>
        </p>
    */
    interface com::sun::star::lang::XInitialization;
};


}; }; }; };

#endif

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