offapi/com/sun/star/sdb/DatasourceAdministrationDialog.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com {  module sun {  module star {  module sdb {
  22
  23
  24 /** provides a user interface for administrating the system wide registered data sources.
  25     <p>
  26     Here, <em>system wide registered</em> means registered on the (one and only) instance
  27     of the
  28     com::sun::star::sdb::DatabaseContext
  29     service.
  30     </p>
  31 */
  32 published service DatasourceAdministrationDialog
  33 {
  34     /** the title of the (dialog) window
  35     */
  36     [property] string Title;
  37
  38     /** parent window to use for the administration dialog
  39         <p>
  40         This property can't be set while the dialog is being displayed.
  41         </p>
  42     */
  43     [property] com::sun::star::awt::XWindow ParentWindow;
  44
  45     /** allows access to the properties of the object
  46     */
  47     interface com::sun::star::beans::XPropertySet;
  48
  49     /** allows starting execution of the administration dialog
  50     */
  51     interface com::sun::star::ui::dialogs::XExecutableDialog;
  52
  53     /** allows initializing the dialog
  54         <p>
  55         You do not need to call the initialize method directly, instead you may use the createInstanceWithArguments
  56         method of your com::sun::star::lang::XMultiServiceFactory.
  57         </p>
  58
  59         <p>
  60         You specify a parameter by passing one (or more)
  61         com::sun::star::beans::PropertyValue
  62         object(s) to the initialize method, where the <em>Name</em> field contains a string describing which aspect
  63         you want to affect, and the <em>Value</em> field containing a value.
  64         <br/>
  65         Imagine the initialization values as if you use setPropertyValue of the
  66         com::sun::star::beans::XPropertySet
  67         interface ...
  68         <br/>
  69         allowed parameters are
  70         <ul>
  71             <li><b>Title</b><br/>
  72                 String describing the initial title of the dialog.
  73                 If not specified, a default title is used.
  74             </li>
  75             <li><b>ParentWindow</b><br/>
  76                 com::sun::star::awt::XWindow
  77                 describing the parent window to use for the dialog.
  78             </li>
  79             <li><b>InitialSelection</b><br/>
  80                 String or XDataSource describing which data source should be selected initially.
  81                 This String name must be known to the
  82                 com::sun::star::sdb::DatabaseContext.
  83             </li>
  84         </ul>
  85         </p>
  86     */
  87     interface com::sun::star::lang::XInitialization;
  88 };
  89
  90
  91 }; }; }; };
  92
  93 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */