1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sdb_ErrorMessageDialog_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_sdb_ErrorMessageDialog_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_ui_dialogs_XExecutableDialog_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/ui/dialogs/XExecutableDialog.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_awt_XWindow_idl__ 32*b1cdbd2cSJim Jagielski#include <com/sun/star/awt/XWindow.idl> 33*b1cdbd2cSJim Jagielski#endif 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_XInitialization_idl__ 36*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/XInitialization.idl> 37*b1cdbd2cSJim Jagielski#endif 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_beans_XPropertySet_idl__ 40*b1cdbd2cSJim Jagielski#include <com/sun/star/beans/XPropertySet.idl> 41*b1cdbd2cSJim Jagielski#endif 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski//============================================================================= 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module sdb { 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski 48*b1cdbd2cSJim Jagielski/** provides a dialog for displaying database related exceptions. 49*b1cdbd2cSJim Jagielski <p> 50*b1cdbd2cSJim Jagielski If applications use any of the functionality provided in the modules 51*b1cdbd2cSJim Jagielski <module scope="com.sun.star"> 52*b1cdbd2cSJim Jagielski sdbc 53*b1cdbd2cSJim Jagielski </module> 54*b1cdbd2cSJim Jagielski , 55*b1cdbd2cSJim Jagielski <module scope="com.sun.star"> 56*b1cdbd2cSJim Jagielski sdbcx 57*b1cdbd2cSJim Jagielski </module> 58*b1cdbd2cSJim Jagielski and 59*b1cdbd2cSJim Jagielski <module scope="com.sun.star"> 60*b1cdbd2cSJim Jagielski sdb 61*b1cdbd2cSJim Jagielski </module> 62*b1cdbd2cSJim Jagielski , 63*b1cdbd2cSJim Jagielski they will - sooner or later - encounter 64*b1cdbd2cSJim Jagielski <type scope="com::sun::star::sdbc">SQLException</type> 65*b1cdbd2cSJim Jagielski 's. 66*b1cdbd2cSJim Jagielski <br/> 67*b1cdbd2cSJim Jagielski These exceptions can be chained, so the information wrapped in one single 68*b1cdbd2cSJim Jagielski <type scope="com::sun::star::sdbc">SQLException</type> 69*b1cdbd2cSJim Jagielski can be rather complex (e.g., every instance where such an exception is passing before it is finally caught, could 70*b1cdbd2cSJim Jagielski append a 71*b1cdbd2cSJim Jagielski <type scope="com::sun::star::sdb">SQLContext</type> 72*b1cdbd2cSJim Jagielski to explain what it was doing), and they should be 73*b1cdbd2cSJim Jagielski presented to the user in a consistent way. 74*b1cdbd2cSJim Jagielski <br/> 75*b1cdbd2cSJim Jagielski This can be reached by using this service. 76*b1cdbd2cSJim Jagielski @see com.sun.star.sdb.InteractionHandler 77*b1cdbd2cSJim Jagielski </p> 78*b1cdbd2cSJim Jagielski*/ 79*b1cdbd2cSJim Jagielskipublished service ErrorMessageDialog 80*b1cdbd2cSJim Jagielski{ 81*b1cdbd2cSJim Jagielski /** the title of the (dialog) window 82*b1cdbd2cSJim Jagielski */ 83*b1cdbd2cSJim Jagielski [property] string Title; 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski /** parent window to use for the dialog 86*b1cdbd2cSJim Jagielski <p> 87*b1cdbd2cSJim Jagielski This property can't be set while the dialog is being displayed. 88*b1cdbd2cSJim Jagielski </p> 89*b1cdbd2cSJim Jagielski */ 90*b1cdbd2cSJim Jagielski [property] com::sun::star::awt::XWindow ParentWindow; 91*b1cdbd2cSJim Jagielski 92*b1cdbd2cSJim Jagielski /** is the exception displayed by the dialog 93*b1cdbd2cSJim Jagielski <p> 94*b1cdbd2cSJim Jagielski This should contain a 95*b1cdbd2cSJim Jagielski <type scope="com::sun::star::sdbc">SQLException</type> 96*b1cdbd2cSJim Jagielski instance, or an instance 97*b1cdbd2cSJim Jagielski of any class derived from this exception. 98*b1cdbd2cSJim Jagielski </p> 99*b1cdbd2cSJim Jagielski <p> 100*b1cdbd2cSJim Jagielski This property can't be set while the dialog is being displayed. 101*b1cdbd2cSJim Jagielski </p> 102*b1cdbd2cSJim Jagielski */ 103*b1cdbd2cSJim Jagielski [property] any SQLException; 104*b1cdbd2cSJim Jagielski 105*b1cdbd2cSJim Jagielski /** specifies the URL to the help topic to associate with the dialog. 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski <p>If This URL is not empty, then the dialog will get a "Help" button, which 108*b1cdbd2cSJim Jagielski directs the user to the given help topic.</p> 109*b1cdbd2cSJim Jagielski */ 110*b1cdbd2cSJim Jagielski [optional, property] string HelpURL; 111*b1cdbd2cSJim Jagielski 112*b1cdbd2cSJim Jagielski /** allows access to the properties of the object 113*b1cdbd2cSJim Jagielski */ 114*b1cdbd2cSJim Jagielski interface com::sun::star::beans::XPropertySet; 115*b1cdbd2cSJim Jagielski 116*b1cdbd2cSJim Jagielski /** allows starting execution of the dialog 117*b1cdbd2cSJim Jagielski */ 118*b1cdbd2cSJim Jagielski interface com::sun::star::ui::dialogs::XExecutableDialog; 119*b1cdbd2cSJim Jagielski 120*b1cdbd2cSJim Jagielski /** allows initializing the dialog 121*b1cdbd2cSJim Jagielski <p> 122*b1cdbd2cSJim Jagielski You do not need to call the initialize method directly, instead you may use the createInstanceWithArguments 123*b1cdbd2cSJim Jagielski method of your 124*b1cdbd2cSJim Jagielski <type scope="com::sun::star::lang">XMultiServiceFactory</type> 125*b1cdbd2cSJim Jagielski . 126*b1cdbd2cSJim Jagielski </p> 127*b1cdbd2cSJim Jagielski <p> 128*b1cdbd2cSJim Jagielski You specify a parameter by passing one (or more) 129*b1cdbd2cSJim Jagielski <type scope="com::sun::star::beans">PropertyValue</type> 130*b1cdbd2cSJim Jagielski object(s) to the initialize method, where the <em>Name</em> field contains a string describing which aspect 131*b1cdbd2cSJim Jagielski you want to affect, and the <em>Value</em> field containing a value. 132*b1cdbd2cSJim Jagielski <br/> 133*b1cdbd2cSJim Jagielski Imagine the initialization values, as if you use 134*b1cdbd2cSJim Jagielski <method scope="com::sun::star::beans">XPropertySet::setPropertyValue() 135*b1cdbd2cSJim Jagielski </method> 136*b1cdbd2cSJim Jagielski of the 137*b1cdbd2cSJim Jagielski <type scope="com::sun::star::beans">XPropertySet</type> 138*b1cdbd2cSJim Jagielski interface ... 139*b1cdbd2cSJim Jagielski <br/> 140*b1cdbd2cSJim Jagielski allowed parameters are 141*b1cdbd2cSJim Jagielski <ul> 142*b1cdbd2cSJim Jagielski <li><b>Title</b><br/> 143*b1cdbd2cSJim Jagielski String describing the initial title of the dialog. If not specified, a default title is used. 144*b1cdbd2cSJim Jagielski </li> 145*b1cdbd2cSJim Jagielski <li><b>ParentWindow</b><br/> 146*b1cdbd2cSJim Jagielski <type scope="com::sun::star::awt">XWindow</type> 147*b1cdbd2cSJim Jagielski describing the parent window to use for the dialog. 148*b1cdbd2cSJim Jagielski </li> 149*b1cdbd2cSJim Jagielski <li><b>SQLException</b><br/> 150*b1cdbd2cSJim Jagielski <type scope="com::sun::star::sdbc">SQLException</type> 151*b1cdbd2cSJim Jagielski describing the error which is beeing displayed.<br/> 152*b1cdbd2cSJim Jagielski When initializing this value, you may use any derivative of 153*b1cdbd2cSJim Jagielski <type scope="com::sun::star::sdbc">SQLException</type> 154*b1cdbd2cSJim Jagielski . 155*b1cdbd2cSJim Jagielski </li> 156*b1cdbd2cSJim Jagielski </ul> 157*b1cdbd2cSJim Jagielski </p> 158*b1cdbd2cSJim Jagielski */ 159*b1cdbd2cSJim Jagielski interface com::sun::star::lang::XInitialization; 160*b1cdbd2cSJim Jagielski}; 161*b1cdbd2cSJim Jagielski 162*b1cdbd2cSJim Jagielski//============================================================================= 163*b1cdbd2cSJim Jagielski 164*b1cdbd2cSJim Jagielski}; }; }; }; 165*b1cdbd2cSJim Jagielski 166*b1cdbd2cSJim Jagielski#endif 167*b1cdbd2cSJim Jagielski 168