offapi/com/sun/star/sdb/ErrorMessageDialog.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: ErrorMessageDialog.idl,v $
  10  * $Revision: 1.13 $
  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_ErrorMessageDialog_idl__
  32 #define __com_sun_star_sdb_ErrorMessageDialog_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 dialog for displaying database related exceptions.
  56     <p>
  57     If applications use any of the functionality provided in the modules
  58     <module scope="com.sun.star">
  59     sdbc
  60     </module>
  61     ,
  62     <module scope="com.sun.star">
  63     sdbcx
  64     </module>
  65      and
  66      <module scope="com.sun.star">
  67      sdb
  68      </module>
  69      ,
  70     they will - sooner or later - encounter
  71     <type scope="com::sun::star::sdbc">SQLException</type>
  72     's.
  73     <br/>
  74     These exceptions can be chained, so the information wrapped in one single
  75     <type scope="com::sun::star::sdbc">SQLException</type>
  76     can be rather complex (e.g., every instance where such an exception is passing before it is finally caught, could
  77     append a
  78     <type scope="com::sun::star::sdb">SQLContext</type>
  79     to explain what it was doing), and they should be
  80     presented to the user in a consistent way.
  81     <br/>
  82     This can be reached by using this service.
  83     @see com.sun.star.sdb.InteractionHandler
  84     </p>
  85 */
  86 published service ErrorMessageDialog
  87 {
  88     /** the title of the (dialog) window
  89     */
  90     [property] string Title;
  91
  92     /** parent window to use for the dialog
  93         <p>
  94         This property can't be set while the dialog is being displayed.
  95         </p>
  96     */
  97     [property] com::sun::star::awt::XWindow ParentWindow;
  98
  99     /** is the exception displayed by the dialog
 100         <p>
 101         This should contain a
 102         <type scope="com::sun::star::sdbc">SQLException</type>
 103         instance, or an instance
 104         of any class derived from this exception.
 105         </p>
 106         <p>
 107         This property can't be set while the dialog is being displayed.
 108         </p>
 109     */
 110     [property] any SQLException;
 111
 112     /** specifies the URL to the help topic to associate with the dialog.
 113
 114         <p>If This URL is not empty, then the dialog will get a "Help" button, which
 115         directs the user to the given help topic.</p>
 116     */
 117     [optional, property] string HelpURL;
 118
 119     /** allows access to the properties of the object
 120     */
 121     interface com::sun::star::beans::XPropertySet;
 122
 123     /** allows starting execution of the dialog
 124     */
 125     interface com::sun::star::ui::dialogs::XExecutableDialog;
 126
 127     /** allows initializing the dialog
 128         <p>
 129         You do not need to call the initialize method directly, instead you may use the createInstanceWithArguments
 130         method of your
 131         <type scope="com::sun::star::lang">XMultiServiceFactory</type>
 132         .
 133         </p>
 134         <p>
 135         You specify a parameter by passing one (or more)
 136         <type scope="com::sun::star::beans">PropertyValue</type>
 137         object(s) to the initialize method, where the <em>Name</em> field contains a string describing which aspect
 138         you want to affect, and the <em>Value</em> field containing a value.
 139         <br/>
 140         Imagine the initialization values, as if you use
 141         <method scope="com::sun::star::beans">XPropertySet::setPropertyValue()
 142         </method>
 143          of the
 144         <type scope="com::sun::star::beans">XPropertySet</type>
 145         interface ...
 146         <br/>
 147         allowed parameters are
 148         <ul>
 149             <li><b>Title</b><br/>
 150                 String describing the initial title of the dialog. If not specified, a default title is used.
 151             </li>
 152             <li><b>ParentWindow</b><br/>
 153                 <type scope="com::sun::star::awt">XWindow</type>
 154                 describing the parent window to use for the dialog.
 155             </li>
 156             <li><b>SQLException</b><br/>
 157                 <type scope="com::sun::star::sdbc">SQLException</type>
 158                 describing the error which is beeing displayed.<br/>
 159                 When initializing this value, you may use any derivative of
 160                 <type scope="com::sun::star::sdbc">SQLException</type>
 161                 .
 162             </li>
 163         </ul>
 164         </p>
 165     */
 166     interface com::sun::star::lang::XInitialization;
 167 };
 168
 169 //=============================================================================
 170
 171 }; }; }; };
 172
 173 #endif
 174