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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: DatasourceAdministrationDialog.idl,v $
  10  * $Revision: 1.14 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_sdb_DatasourceAdministrationDialog_idl__
  32 #define __com_sun_star_sdb_DatasourceAdministrationDialog_idl__
  33
  34 #ifndef __com_sun_star_ui_dialogs_XExecutableDialog_idl__
  35 #include <com/sun/star/ui/dialogs/XExecutableDialog.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_awt_XWindow_idl__
  39 #include <com/sun/star/awt/XWindow.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_lang_XInitialization_idl__
  43 #include <com/sun/star/lang/XInitialization.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_beans_XPropertySet_idl__
  47 #include <com/sun/star/beans/XPropertySet.idl>
  48 #endif
  49
  50 //=============================================================================
  51
  52 module com {  module sun {  module star {  module sdb {
  53
  54
  55 /** provides a user interface for administrating the system wide registered data sources.
  56     <p>
  57     Here, <em>system wide registered</em> means registered on the (one and only) instance
  58     of the
  59     <type scope="com::sun::star::sdb">
  60     DatabaseContext
  61     </type>
  62     service.
  63     </p>
  64 */
  65 published service DatasourceAdministrationDialog
  66 {
  67     /** the title of the (dialog) window
  68     */
  69     [property] string Title;
  70
  71     /** parent window to use for the administration dialog
  72         <p>
  73         This property can't be set while the dialog is being displayed.
  74         </p>
  75     */
  76     [property] com::sun::star::awt::XWindow ParentWindow;
  77
  78     /** allows access to the properties of the object
  79     */
  80     interface com::sun::star::beans::XPropertySet;
  81
  82     /** allows starting execution of the administration dialog
  83     */
  84     interface com::sun::star::ui::dialogs::XExecutableDialog;
  85
  86     /** allows initializing the dialog
  87         <p>
  88         You do not need to call the initialize method directly, instead you may use the createInstanceWithArguments
  89         method of your
  90         <type scope="com::sun::star::lang">XMultiServiceFactory</type>
  91         .
  92         </p>
  93
  94         <p>
  95         You specify a parameter by passing one (or more)
  96         <type scope="com::sun::star::beans">PropertyValue</type>
  97         object(s) to the initialize method, where the <em>Name</em> field contains a string describing which aspect
  98         you want to affect, and the <em>Value</em> field containing a value.
  99         <br/>
 100         Imagine the initialization values as if you use setPropertyValue of the
 101         <type scope="com::sun::star::beans">XPropertySet</type>
 102         interface ...
 103         <br/>
 104         allowed parameters are
 105         <ul>
 106             <li><b>Title</b><br/>
 107                 String describing the initial title of the dialog.
 108                 If not specified, a default title is used.
 109             </li>
 110             <li><b>ParentWindow</b><br/>
 111                 <type scope="com::sun::star::awt">XWindow</type>
 112                 describing the parent window to use for the dialog.
 113             </li>
 114             <li><b>InitialSelection</b><br/>
 115                 String or XDataSource describing which data source should be selected initially.
 116                 This String name must be known to the
 117                 <type scope="com::sun::star::sdb">
 118                 DatabaseContext
 119                 </type>
 120                 .
 121             </li>
 122         </ul>
 123         </p>
 124     */
 125     interface com::sun::star::lang::XInitialization;
 126 };
 127
 128 //=============================================================================
 129
 130 }; }; }; };
 131
 132 #endif