tdf#130857 qt weld: Implement QtInstanceWidget::strip_mnemonic
[LibreOffice.git] / offapi / com / sun / star / sdb / ErrorMessageDialog.idl
blobbdf3e2512c97e0fe5bcbc604b42bead3362993af
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
20 module com { module sun { module star { module sdb {
22 /** provides a dialog for displaying database related exceptions.
23 <p>
24 If applications use any of the functionality provided in the modules
25 com.sun.star::sdbc, com.sun.star::sdbcx and com.sun.star::sdb,
26 they will - sooner or later - encounter
27 com::sun::star::sdbc::SQLException
28 's.
29 <br/>
30 These exceptions can be chained, so the information wrapped in one single
31 com::sun::star::sdbc::SQLException
32 can be rather complex (e.g., every instance where such an exception is passing before it is finally caught, could
33 append a
34 com::sun::star::sdb::SQLContext
35 to explain what it was doing), and they should be
36 presented to the user in a consistent way.
37 <br/>
38 This can be reached by using this service.
39 @see com::sun::star::sdb::InteractionHandler
40 </p>
42 published service ErrorMessageDialog : com::sun::star::ui::dialogs::XExecutableDialog
44 /** allows initializing the dialog
45 <p>
46 You do not need to call the initialize method directly, instead you may use the createInstanceWithArguments
47 method of your com::sun::star::lang::XMultiServiceFactory.
48 </p>
49 <p>
50 You specify a parameter by passing one (or more)
51 com::sun::star::beans::PropertyValue
52 object(s) to the initialize method, where the <em>Name</em> field contains a string describing which aspect
53 you want to affect, and the <em>Value</em> field containing a value.
54 <br/>
55 Imagine the initialization values, as if you use
56 com::sun::star::beans">XPropertySet::setPropertyValue()
57 of the
58 com::sun::star::beans::XPropertySet
59 interface ...
60 <br/>
61 allowed parameters are
62 <ul>
63 <li><b>title</b><br/>
64 String describing the initial title of the dialog. If not specified, a default title is used.
65 </li>
66 <li><b>parentWindow</b><br/>
67 com::sun::star::awt::XWindow
68 describing the parent window to use for the dialog.
69 </li>
70 <li><b>sqlException</b><br/>
71 com::sun::star::sdbc::SQLException
72 describing the error which is being displayed.<br/>
73 When initializing this value, you may use any derivative of
74 com::sun::star::sdbc::SQLException.
75 </li>
76 </ul>
77 </p>
79 create([in] string initialTitle, [in] com::sun::star::awt::XWindow parentWindow, [in] any sqlException);
83 }; }; }; };
85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */