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
|
/* -*- 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 INCLUDED_DBACCESS_DBSUBCOMPONENTCONTROLLER_HXX
#define INCLUDED_DBACCESS_DBSUBCOMPONENTCONTROLLER_HXX
#include <memory>
#include <com/sun/star/document/XScriptInvocationContext.hpp>
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/util/XModifiable.hpp>
#include <cppuhelper/implbase.hxx>
#include <dbaccess/dbaccessdllapi.h>
#include <dbaccess/genericcontroller.hxx>
#include <rtl/ustring.hxx>
#include <sal/types.h>
namespace com::sun::star {
namespace beans { class XPropertySet; }
namespace frame { class XModel; }
namespace sdbc { class XConnection; }
namespace sdbc { class XDatabaseMetaData; }
namespace uno { class XComponentContext; }
namespace util { class XNumberFormatter; }
}
namespace dbtools {
class DatabaseMetaData;
class SQLExceptionInfo;
}
namespace dbaui
{
//= DBSubComponentController
typedef ::cppu::ImplInheritanceHelper< OGenericUnoController
, css::document::XScriptInvocationContext
, css::util::XModifiable
> DBSubComponentController_Base;
struct DBSubComponentController_Impl;
class UNLESS_MERGELIBS_MORE(DBACCESS_DLLPUBLIC) DBSubComponentController : public DBSubComponentController_Base
{
private:
::std::unique_ptr<DBSubComponentController_Impl> m_pImpl;
private:
/** forces usage of a connection which we do not own
<p>To be used from within XInitialization::initialize, resp. impl_initialize, only.</p>
*/
void initializeConnection( const css::uno::Reference< css::sdbc::XConnection >& _rxForeignConn );
protected:
// OGenericUnoController - initialization
virtual void impl_initialize(const ::comphelper::NamedValueCollection& rArguments) override;
// OGenericUnoController
virtual void Execute(sal_uInt16 nId, const css::uno::Sequence< css::beans::PropertyValue>& aArgs) override;
virtual css::uno::Reference< css::frame::XModel > getPrivateModel() const override;
bool impl_isModified() const;
virtual void impl_onModifyChanged();
public:
bool isReadOnly() const;
bool isEditable() const;
void setEditable(bool _bEditable);
// asking for connection-related stuff
bool isConnected() const;
css::uno::Reference< css::sdbc::XDatabaseMetaData >
getMetaData( ) const;
// access to the data source / document
OUString getDataSourceName() const;
const css::uno::Reference< css::beans::XPropertySet >&
getDataSource() const;
bool haveDataSource() const;
css::uno::Reference< css::frame::XModel >
getDatabaseDocument() const;
/** provides access to the SDB-level database meta data of the current connection
*/
const ::dbtools::DatabaseMetaData& getSdbMetaData() const;
/** appends an error in the current environment.
*/
void appendError( const OUString& _rErrorMessage );
/** clears the error state.
*/
void clearError();
/** @return
<TRUE/> when an error was set otherwise <FALSE/>
*/
bool hasError() const;
/** returns the current error
*/
const ::dbtools::SQLExceptionInfo& getError() const;
/** displays the current error, or does nothing if there is no current error
*/
void displayError();
/** shows an info box with the string connection lost.
*/
void connectionLostMessage() const;
/** gives access to the currently used connection
@return
the currently used connection.
*/
const css::uno::Reference< css::sdbc::XConnection >&
getConnection() const;
/** returns the number formatter
*/
css::uno::Reference< css::util::XNumberFormatter > const & getNumberFormatter() const;
// css::frame::XController
virtual sal_Bool SAL_CALL suspend(sal_Bool bSuspend) override;
virtual sal_Bool SAL_CALL attachModel(const css::uno::Reference< css::frame::XModel > & xModel) override;
// XScriptInvocationContext
virtual css::uno::Reference< css::document::XEmbeddedScripts > SAL_CALL getScriptContainer() override;
// XModifiable
virtual sal_Bool SAL_CALL isModified( ) override;
virtual void SAL_CALL setModified( sal_Bool bModified ) override;
// XModifyBroadcaster
virtual void SAL_CALL addModifyListener( const css::uno::Reference< css::util::XModifyListener >& aListener ) override;
virtual void SAL_CALL removeModifyListener( const css::uno::Reference< css::util::XModifyListener >& aListener ) override;
// XTitle
virtual OUString SAL_CALL getTitle( ) override;
protected:
DBSubComponentController(const css::uno::Reference< css::uno::XComponentContext>& _rxORB);
virtual ~DBSubComponentController() override;
void disconnect();
virtual void reconnect( bool _bUI );
bool ensureConnected() {
if ( !isConnected() ) reconnect( false );
return isConnected();
}
/** called when our connection is being disposed
<p>The default implementation does a reconnect</p>
*/
virtual void losingConnection( );
protected:
// XEventListener
virtual void SAL_CALL disposing(const css::lang::EventObject& Source) override;
// OComponentHelper
virtual void SAL_CALL disposing() override;
// XInterface
virtual css::uno::Any SAL_CALL queryInterface(const css::uno::Type& _rType) override;
// XTypeProvider
virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes( ) override;
protected:
sal_Int32 getCurrentStartNumber() const;
};
} // namespace dbaui
#endif // INCLUDED_DBACCESS_DBSUBCOMPONENTCONTROLLER_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|