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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
|
/*************************************************************************
*
* $RCSfile: UITools.hxx,v $
*
* $Revision: 1.21 $
*
* last change: $Author: obo $ $Date: 2003-09-04 08:33:04 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an AS IS basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef DBAUI_TOOLS_HXX
#define DBAUI_TOOLS_HXX
#ifndef _DBHELPER_DBEXCEPTION_HXX_
#include <connectivity/dbexception.hxx>
#endif
#ifndef _COMPHELPER_STLTYPES_HXX_
#include <comphelper/stl_types.hxx>
#endif
#ifndef DBAUI_TYPEINFO_HXX
#include "TypeInfo.hxx"
#endif
#ifndef _SVX_SVXENUM_HXX
#include <svx/svxenum.hxx>
#endif
#ifndef _SV_TASKPANELIST_HXX
#include <vcl/taskpanelist.hxx>
#endif
#ifndef _CONNECTIVITY_DBTOOLS_HXX_
#include <connectivity/dbtools.hxx>
#endif
// we only need forward decl here
namespace com { namespace sun { namespace star {
namespace beans { class XPropertySet;}
namespace container { class XNameAccess;}
namespace lang
{
class XEventListener;
class XMultiServiceFactory;
}
namespace awt
{
struct FontDescriptor;
}
namespace sdbc
{
class XDatabaseMetaData;
class XConnection;
}
namespace util
{
struct URL;
class XNumberFormatter;
}
}}}
namespace svt
{
class EditBrowseBox;
}
class Window;
class ToolBox;
class Font;
class SvNumberFormatter;
// .........................................................................
namespace dbaui
{
// .........................................................................
/** compose a complete table name from it's up to three parts, regarding to the database meta data composing rules
the PropertySet must be support the service com::sun::star::sdbc::table
*/
void composeTableName( const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XDatabaseMetaData >& _rxMetaData,
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxTable,
::rtl::OUString& _rComposedName,
sal_Bool _bQuote,
::dbtools::EComposeRule _eRule = ::dbtools::eInDataManipulation);
/** creates a new connection and appends the eventlistener
@param _rsDataSourceName name of the datasource
@param _xDatabaseContext the database context
@param _rEvtLst the eventlistener which will be added to the new created connection
@param _rOUTConnection this parameter will be filled with the new created connection
@return SQLExceptionInfo contains a SQLException, SQLContext or a SQLWarning when they araised else .isValid() will return false
*/
::dbtools::SQLExceptionInfo createConnection(
const ::rtl::OUString& _rsDataSourceName,
const ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess >& _xDatabaseContext,
const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rMF,
::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener>& _rEvtLst,
::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>& _rOUTConnection );
/** creates a error dialog which displays the SQLExceptionInfo. Also it supports a "more" button where detailed information are available
@param _rInfo the error which should be shown, if the info is not valid no error dialog will appear
@param _pParent the parent of the error dialog
@param _xFactory need to create the dialog
*/
void showError( const ::dbtools::SQLExceptionInfo& _rInfo,
Window* _pParent,
const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _xFactory);
/** return a vector which contains all key columns for the @see com::sun::star::sdbc::KeyType _nKeyType
@param _rxTable the table which must be a @see com::sun::star::sdbcx::XColumnsSupplier
@param _nKeyType @see com::sun::star::sdbc::KeyType
*/
::std::vector< ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess> >
getKeyColumns( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxTable,
sal_Int32 _nKeyType);
/** fills a map and a vector with localized type names
@param _rxConnection the connection to acces the metadata
@param _rsTypeNames a list of localized type names seperated with ';'
@param _rTypeInfoMap the filled map with the type names
@param _rTypeInfoIters the vector filled with map iterators
*/
void fillTypeInfo( const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>& _rxConnection,
const String& _rsTypeNames,
OTypeInfoMap& _rTypeInfoMap,
::std::vector<OTypeInfoMap::iterator>& _rTypeInfoIters);
/** fill a column with data of a field description
@param _rxColumn the column which should be filled
@param _pFieldDesc the source of the data
*/
class OFieldDescription;
void setColumnProperties( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _rxColumn,
const OFieldDescription* _pFieldDesc);
::rtl::OUString createDefaultName( const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XDatabaseMetaData>& _xMetaData,
const ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess>& _xTables,
const ::rtl::OUString& _sName);
/** checks if the given name exists in the database context
*/
sal_Bool checkDataSourceAvailable( const ::rtl::OUString& _sDataSourceName,
const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _xFactory_xORB);
/** maps SvxCellHorJustify to com::sun::star::awt::TextAlign
@param SvxCellHorJustify& _eAlignment
@return the corresponding com::sun::star::awt::TextAlign
*/
sal_Int32 mapTextAllign(const SvxCellHorJustify& _eAlignment);
/** maps com::sun::star::awt::TextAlign to SvxCellHorJustify
@param com::sun::star::awt::TextAlign& _nAlignment
@return the corresponding SvxCellHorJustify
*/
SvxCellHorJustify mapTextJustify(const sal_Int32& _nAlignment);
/** fill a column with ui data of a field description
@param _rxColumn the column which should be filled
@param _pFieldDesc the source of the data
*/
void setColumnUiProperties( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _rxColumn,
const OFieldDescription* _pFieldDesc);
/** convert Font to ::com::sun::star::awt::FontDescriptor
@param _rFont Font to be converted
@return the new FontDescriptor
*/
::com::sun::star::awt::FontDescriptor CreateFontDescriptor( const Font& _rFont );
/** call teh format dialog and set the selected format at the column
@param _xAffectedCol Font to be converted
@param _xField Font to be converted
*/
void callColumnFormatDialog(const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _xAffectedCol,
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _xField,
SvNumberFormatter* _pFormatter,
Window* _pParent);
/** second variant of the function before
*/
sal_Bool callColumnFormatDialog(Window* _pParent,
SvNumberFormatter* _pFormatter,
sal_Int32 _nDataType,
sal_Int32& _nFormatKey,
SvxCellHorJustify& _eJustify,
sal_uInt16& _nFlags,
sal_Bool _bHasFormat);
/** append a name to tablefilter of a datasource
@param _xConnection the connection is need to get the datasource
@param _sName the name which should be appended
@param _xFactory needed to check if datasource is available
@param _pParent needed when an error must be shown
@return false when datsource is not available otherwise true
*/
sal_Bool appendToFilter(const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>& _xConnection,
const ::rtl::OUString& _sName,
const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _xFactory,
Window* _pParent);
/** notifySystemWindow adds or remove the given window _pToRegister at the Systemwindow found when search _pWindow.
@param _pWindow
The window which is used to search for the SystemWindow.
@param _pToRegister
The window which should be added or removed on the TaskPaneList.
@param _rMemFunc
The member function which should be called at the SystemWindow when found.
Possible values are:
::comphelper::mem_fun(&TaskPaneList::AddWindow)
::comphelper::mem_fun(&TaskPaneList::RemoveWindow)
*/
void notifySystemWindow(Window* _pWindow,
Window* _pToRegister,
::comphelper::mem_fun1_t<TaskPaneList,Window*> _rMemFunc);
/** adjustToolBoxSize checks if the size of the ToolBox is still valid. If not it will be resized.
@param _pToolBox
The Toolbox which should be resized.
*/
void adjustToolBoxSize(ToolBox* _pToolBox);
/** isHiContrast check if we are in hi contrast mode.
@param _pWindow
The window we have to check on.
@return
<TRUE/> if so, otherwise <FALSE/>
*/
sal_Bool isHiContrast(Window* _pWindow);
void adjustBrowseBoxColumnWidth( ::svt::EditBrowseBox* _pBox, sal_uInt16 _nColId );
/** check if SQL92 name checking is enabled
@param _xConnection
Used to get the datasource as parent from the connection.
@return
<TRUE/> if so otherwise <FALSE/>
*/
sal_Bool isSQL92CheckEnabled(const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>& _xConnection);
/** check if the alias name of the table should be added at select statements
@param _xConnection
Used to get the datasource as parent from the connection.
@return
<TRUE/> if so otherwise <FALSE/>
*/
sal_Bool isAppendTableAliasEnabled(const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>& _xConnection);
/** check if a specific property is enabled in the info sequence
@param _xConnection
Used to get the datasource as parent from the connection.
@param _sProperty
The property to search in the info property of the data source.
@param _bDefault
This value will be returned, if the property doesn't exist in the data source.
@return
<TRUE/> if so otherwise <FALSE/>
*/
sal_Bool isDataSourcePropertyEnabled(const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>& _xConnection
,const ::rtl::OUString& _sProperty,
sal_Bool _bDefault = sal_False);
/** fills the bool and string value with information out of the datasource info property
@param _xDatasource
Asked for the properties.
@param _rAutoIncrementValueEnabled
<OUT/> Set to TRUE when the property was set in the datasource.
@param _rsAutoIncrementValue
<OUT/> Set to the value when the property was set in the datasource.
*/
void fillAutoIncrementValue(const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _xDatasource
,sal_Bool& _rAutoIncrementValueEnabled
,::rtl::OUString& _rsAutoIncrementValue);
/** fills the bool and string value with information out of the datasource info property
@param _xConnection
Used to get the datasource as parent from the connection.
@param _rAutoIncrementValueEnabled
<OUT/> Set to TRUE when the property was set in the datasource.
@param _rsAutoIncrementValue
<OUT/> Set to the value when the property was set in the datasource.
*/
void fillAutoIncrementValue(const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>& _xConnection
,sal_Bool& _rAutoIncrementValueEnabled
,::rtl::OUString& _rsAutoIncrementValue);
/** creates the URL or the help agent
@param _sModuleName
@param _nHelpId
@return
The URL for the help agent to dispatch.
*/
::com::sun::star::util::URL createHelpAgentURL(const ::rtl::OUString& _sModuleName,const sal_Int32 _nHelpId);
/** set the evaluation flag at the number formatter
@param _rxFormatter
*/
void setEvalDateFormatForFormatter(::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatter >& _rxFormatter);
/** query for a type info which can be used to create a primary key column
@param _rTypeInfo
The map which contains all available types.
@return
The type info which can be used to create a primary key column.
*/
TOTypeInfoSP queryPrimaryKeyType(const OTypeInfoMap& _rTypeInfo);
/** query for a specific type.
@param _nDataType
The type we are searching.
@param _rTypeInfo
The map which contains all available types.
@return
The type or <NULL/> if we can't find it.
*/
TOTypeInfoSP queryTypeInfoByType(sal_Int32 _nDataType,const OTypeInfoMap& _rTypeInfo);
/** returns the configuration node name of user defined drivers.
@return
the configuration node name of user defined drivers.
*/
::rtl::OUString getUserDefinedDriverNodeName();
/** returns the configuration node name of user defined driver type display name.
@return
the configuration node name of user defined driver type display name.
*/
::rtl::OUString getDriverTypeDisplayNodeName();
/** returns the configuration node name of user defined driver DSN prefix.
@return
the configuration node name of user defined driver DSN prefix.
*/
::rtl::OUString getDriverDsnPrefixNodeName();
// .........................................................................
}
// .........................................................................
#endif // DBAUI_TOOLS_HXX
|
