blob: 4a755096a8d394f96f00a9694ec757a9ab0a39b7 (
plain)
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
|
/* -*- 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 .
*/
#pragma once
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <memory>
#include "abptypes.hxx"
namespace com::sun::star {
namespace beans {
class XPropertySet;
}
}
namespace weld { class Window; }
namespace abp
{
struct ODataSourceContextImpl;
class ODataSource;
/// a non-UNO wrapper for the data source context
class ODataSourceContext
{
private:
std::unique_ptr<ODataSourceContextImpl> m_pImpl;
public:
explicit ODataSourceContext(
const css::uno::Reference< css::uno::XComponentContext >& _rxORB
);
~ODataSourceContext();
/// retrieves the names of all data sources
void getDataSourceNames( StringBag& _rNames ) const;
/// disambiguates the given name by appending successive numbers
void disambiguate(OUString& _rDataSourceName);
/// creates a new Thunderbird data source
ODataSource createNewThunderbird( const OUString& _rName );
/// creates a new Evolution local data source
ODataSource createNewEvolution( const OUString& _rName );
/// creates a new Evolution LDAP data source
ODataSource createNewEvolutionLdap( const OUString& _rName );
/// creates a new Evolution GROUPWISE data source
ODataSource createNewEvolutionGroupwise( const OUString& _rName );
/// creates a new KDE address book data source
ODataSource createNewKab( const OUString& _rName );
/// creates a new macOS address book data source
ODataSource createNewMacab( const OUString& _rName );
/// creates a new Other data source; tdf117101: Spreadsheet by default
ODataSource createNewOther( const OUString& _rName );
};
struct ODataSourceImpl;
struct AddressSettings;
/** a non-UNO wrapper for a data source
<p>This class allows to access data sources without the need to compile the respective file with
exception handling enabled (hopefully :).</p>
<p>In addition to wrapping a UNO data source, an instance of this class can handle at most
one valid connection, as obtained from the data source.</p>
*/
class ODataSource
{
private:
std::unique_ptr<ODataSourceImpl> m_pImpl;
public:
// - ctor/dtor/assignment
/// constructs an object which is initially invalid
explicit ODataSource(
const css::uno::Reference< css::uno::XComponentContext >& _rxORB
);
/// copy ctor
ODataSource( const ODataSource& _rSource );
/// dtor
~ODataSource( );
/// copy assignment
ODataSource& operator=( const ODataSource& _rSource );
/// move assignment
ODataSource& operator=(ODataSource&& _rSource) noexcept;
/// checks whether or not the object represents a valid data source
bool isValid() const;
/// removes the data source represented by the object from the data source context
void remove();
// TODO: put this into the context class
/// returns the name of the data source
const OUString &
getName() const;
/// renames the data source
bool rename( const OUString& _rName );
// TODO: put this into the context class
// - connection handling
/** connects to the data source represented by this object
@param _pMessageParent
the window to use as parent for any error messages. If this is <NULL/>, no messages are displayed
at all.
@see isConnected
*/
bool connect(weld::Window* _pMessageParent);
/// returns <TRUE/> if the object has a valid connection, obtained from its data source
bool isConnected( ) const;
/// disconnects from the data source (i.e. disposes the UNO connection hold internally)
void disconnect( );
/// stores the database file
void store(const AddressSettings& rSettings);
/// register the data source under the given name in the configuration
void registerDataSource( const OUString& _sRegisteredDataSourceName );
/** retrieves the tables names from the connection
<p>to be called when <method>isConnected</method> returns <TRUE/> only</p>
*/
const StringBag& getTableNames() const;
/** determines whether a given table exists
*/
bool hasTable( const OUString& _rTableName ) const;
/// return the internal data source object
css::uno::Reference< css::beans::XPropertySet > getDataSource() const;
/** set a new data source.
<p>Available to selected clients only</p>
*/
void setDataSource(
const css::uno::Reference< css::beans::XPropertySet >& _rxDS
,const OUString& _sName
);
};
} // namespace abp
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
