1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_sdb_application_XTableUIProvider_idl__
#define __com_sun_star_sdb_application_XTableUIProvider_idl__
#include <com/sun/star/graphic/XGraphic.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>
#include <com/sun/star/lang/WrappedTargetException.idl>
module com { module sun { module star { module sdb { module application {
interface XDatabaseDocumentUI;
/** is used by the database application to obtain non-default user
interface information and/or components for database tables.
@see com::sun::star::sdb::Connection
@since OOo 2.2
*/
interface XTableUIProvider
{
/** provides the icon which should be used to represent the table in the
database application window.
<p>The icon will usually be requested once per table, and cached. It
might be requested again if the application settings change, for instance,
if another desktop theme has been activated.</p>
@param TableName
denotes the fully qualified name of the database table.
@param ColorMode
denotes the color mode of the graphic to retrieve, being one of the
com::sun::star::graphic::GraphicColorMode constants.
@return
the icon which should be used to represent the table in the
database application window, or `NULL` if the default icon
should be used.
*/
com::sun::star::graphic::XGraphic getTableIcon(
[in] string TableName, [in] long ColorMode );
/** returns a component which can be used to edit the definition of an
existing table.
@param DocumentUI
provides access to the UI in which the database document is
currently displayed.<br/>
In particular, this parameter provides access to the application's main
window, which is needed in case the table editor should be a dialog.
@param TableName
denotes the fully qualified name of an existing table.
@return
a component which can be used to edit the definition of an
existing table, or `NULL` if the default component should
be used.<br/>
Two component types are supported so far
<ul><li>modal dialogs<br/>
If the returned component supports the
com::sun::star::ui::dialogs::XExecutableDialog
interface, the dialog will be executed modally.</li>
<li>modeless frames<br/>
If the returned component supports the
com::sun::star::frame::XController
interface, it is assumed that it represents a controller,
loaded into a new frame, which is a modeless and, in its lifetime,
depends on the application main window.</li>
</ul>
If the returned component does not support any of the above-mentioned
interfaces, it's discarded.
@throws ::com::sun::star::lang::IllegalArgumentException
if the given TableName does not denote an existing table
@throws ::com::sun::star::lang::WrappedTargetException
if an error occurs while creating the table editor component.
*/
com::sun::star::uno::XInterface getTableEditor(
[in] XDatabaseDocumentUI DocumentUI,
[in] string TableName )
raises (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException);
};
}; }; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
