summaryrefslogtreecommitdiff
path: root/dbaccess/source/ui/inc/databaseobjectview.hxx
blob: 46df991816277a393acf85e65c1397a364e2597a (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
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
/* -*- 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 <rtl/ustring.hxx>
#include <com/sun/star/sdbc/XConnection.hpp>
#include <com/sun/star/sdbc/XDataSource.hpp>
#include <com/sun/star/lang/XComponent.hpp>
#include <com/sun/star/frame/XComponentLoader.hpp>
#include <com/sun/star/frame/XFrame.hpp>
#include <com/sun/star/sdb/application/XDatabaseDocumentUI.hpp>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <comphelper/namedvaluecollection.hxx>

namespace dbaui
{
    /** encapsulates access to the view of a database object.

        @todo
            this is to be merged with the OLinkedDocumentAccess class
    */
    class DatabaseObjectView
    {
    private:
        css::uno::Reference< css::uno::XComponentContext >
                        m_xORB;
        css::uno::Reference< css::frame::XFrame >
                        m_xParentFrame;
        css::uno::Reference< css::frame::XComponentLoader >
                        m_xFrameLoader;
        css::uno::Reference< css::sdb::application::XDatabaseDocumentUI >
                        m_xApplication;
        OUString        m_sComponentURL;

    private:
        css::uno::Reference< css::lang::XComponent >
                doDispatch(
                    const ::comphelper::NamedValueCollection& i_rDispatchArgs
                );

    protected:
        /** creates the desired view

            The default implementation will call <member>fillDispatchArgs</member>, followed
            by <member>doDispatch</member>.

            @param _rDataSource
                the data source, as passed to the <member>createNew</member> or <member>openExisting</member> method.
            @param _rObjectName
                the name of the object for which the view is to be opened,
                or an empty string if a view for a new object should be created.
            @param _rCreationArgs
                the arguments for the view's creation
        */
        virtual css::uno::Reference< css::lang::XComponent > doCreateView(
            const css::uno::Any& _rDataSource,
            const OUString& _rObjectName,
            const ::comphelper::NamedValueCollection& i_rCreationArgs
        );

        virtual void fillDispatchArgs(
                          ::comphelper::NamedValueCollection& i_rDispatchArgs,
                    const css::uno::Any& _rDataSource,
                    const OUString& _rObjectName
                );

        const css::uno::Reference< css::sdb::application::XDatabaseDocumentUI >&
                getApplicationUI() const { return m_xApplication; }
        css::uno::Reference< css::sdbc::XConnection >
                getConnection() const;

    public:
        DatabaseObjectView(
            const css::uno::Reference< css::uno::XComponentContext >& _rxORB,
            const css::uno::Reference< css::sdb::application::XDatabaseDocumentUI >& _rxApplication,
            const css::uno::Reference< css::frame::XFrame >& _rxParentFrame,
            OUString _sComponentURL
        );
        virtual ~DatabaseObjectView(){}

        /** sets the target frame into which the view should be loaded.

            By default, the view is loaded into a top-level frame not being part of the
            Desktop.
        */
        void setTargetFrame( const css::uno::Reference< css::frame::XFrame >& _rxFrame )
        {
            m_xFrameLoader.set( _rxFrame, css::uno::UNO_QUERY );
        }

        /** opens a view for a to-be-created object

            @param _xDataSource
                the data source for which a new object is to be created
            @return
                the controller of the newly created document
        */
        css::uno::Reference< css::lang::XComponent >
            createNew(
                const css::uno::Reference< css::sdbc::XDataSource >& _xDataSource,
                const ::comphelper::NamedValueCollection& i_rDispatchArgs = ::comphelper::NamedValueCollection()
            );

        /** opens a view for an existent object

            @param _xDataSource
                the data source for which a new object is to be created
            @param _rObjectName
                the name of the object to be edited
            @param  _rArgs
                Additional settings which should be forwarded to the frame
            @return
                the frame into which the view has been loaded
        */
        css::uno::Reference< css::lang::XComponent >
            openExisting(
                const css::uno::Any& _aDataSource,
                const OUString& _rName,
                const ::comphelper::NamedValueCollection& i_rDispatchArgs
            );
    };

    // QueryDesigner
    class QueryDesigner final : public DatabaseObjectView
    {
        sal_Int32                           m_nCommandType;

        virtual void fillDispatchArgs(
                  ::comphelper::NamedValueCollection& i_rDispatchArgs,
            const css::uno::Any& _aDataSource,
            const OUString& _rObjectName
        ) override;

    public:
        QueryDesigner(
            const css::uno::Reference< css::uno::XComponentContext >& _rxORB,
            const css::uno::Reference< css::sdb::application::XDatabaseDocumentUI >& _rxApplication,
            const css::uno::Reference< css::frame::XFrame >& _rxParentFrame,
            bool _bCreateView
        );
    };

    // TableDesigner
    class TableDesigner : public DatabaseObjectView
    {
    protected:
        virtual void fillDispatchArgs(
                  ::comphelper::NamedValueCollection& i_rDispatchArgs,
            const css::uno::Any& _aDataSource,
            const OUString& _rObjectName
        ) override;

        virtual css::uno::Reference< css::lang::XComponent > doCreateView(
            const css::uno::Any& _rDataSource,
            const OUString& _rObjectName,
            const ::comphelper::NamedValueCollection& i_rCreationArgs
        ) override;

    public:
        TableDesigner(
            const css::uno::Reference< css::uno::XComponentContext >& _rxORB,
            const css::uno::Reference< css::sdb::application::XDatabaseDocumentUI >& _rxApplication,
            const css::uno::Reference< css::frame::XFrame >& _rxParentFrame
        );

    private:
        /** retrieves the table designer component as provided by the connection, if any
            @param  _rTableName
                the name of the table for which a designer is to be obtained
            @return
                the designer component, as provided by the connection, or <NULL/>, if the connection
                does not provide a specialized designer.
            @see css::sdb::application::XTableUIProvider
        */
        css::uno::Reference< css::uno::XInterface >
                impl_getConnectionProvidedDesigner_nothrow( const OUString& _rTableName );
    };

    // ResultSetBrowser
    class ResultSetBrowser : public DatabaseObjectView
    {
    private:
        bool    m_bTable;

    protected:
        virtual void fillDispatchArgs(
                  ::comphelper::NamedValueCollection& i_rDispatchArgs,
            const css::uno::Any& _aDataSource,
            const OUString& _rQualifiedName
        ) override;

    public:
        ResultSetBrowser(
            const css::uno::Reference< css::uno::XComponentContext >& _rxORB,
            const css::uno::Reference< css::sdb::application::XDatabaseDocumentUI >& _rxApplication,
            const css::uno::Reference< css::frame::XFrame >& _rxParentFrame,
            bool _bTable
        );

    };
    // RelationDesigner
    class RelationDesigner : public DatabaseObjectView
    {
    public:
        RelationDesigner(
            const css::uno::Reference< css::uno::XComponentContext >& _rxORB,
            const css::uno::Reference< css::sdb::application::XDatabaseDocumentUI >& _rxApplication,
            const css::uno::Reference< css::frame::XFrame >& _rxParentFrame
        );
    };
}   // namespace dbaui

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */