1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef DBAUI_SUBCOMPONENTCONTROLLER_HXX 25*b1cdbd2cSJim Jagielski #define DBAUI_SUBCOMPONENTCONTROLLER_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include "genericcontroller.hxx" 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielski /** === begin UNO includes === **/ 30*b1cdbd2cSJim Jagielski #include <com/sun/star/document/XScriptInvocationContext.hpp> 31*b1cdbd2cSJim Jagielski #include <com/sun/star/sdbc/XConnection.hpp> 32*b1cdbd2cSJim Jagielski #include <com/sun/star/sdbc/XDatabaseMetaData.hpp> 33*b1cdbd2cSJim Jagielski #include <com/sun/star/sdbc/XDataSource.hpp> 34*b1cdbd2cSJim Jagielski #include <com/sun/star/util/XNumberFormatter.hpp> 35*b1cdbd2cSJim Jagielski #include <com/sun/star/util/XModifiable.hpp> 36*b1cdbd2cSJim Jagielski /** === end UNO includes === **/ 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski #include <comphelper/broadcasthelper.hxx> 39*b1cdbd2cSJim Jagielski #include <comphelper/proparrhlp.hxx> 40*b1cdbd2cSJim Jagielski #include <comphelper/propertycontainer.hxx> 41*b1cdbd2cSJim Jagielski #include <connectivity/dbmetadata.hxx> 42*b1cdbd2cSJim Jagielski #include <cppuhelper/implbase2.hxx> 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski #include <memory> 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski //........................................................................ 47*b1cdbd2cSJim Jagielski namespace dbaui 48*b1cdbd2cSJim Jagielski { 49*b1cdbd2cSJim Jagielski //........................................................................ 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski //==================================================================== 52*b1cdbd2cSJim Jagielski //= DBSubComponentController 53*b1cdbd2cSJim Jagielski //==================================================================== 54*b1cdbd2cSJim Jagielski class DBSubComponentController; 55*b1cdbd2cSJim Jagielski 56*b1cdbd2cSJim Jagielski typedef ::cppu::ImplInheritanceHelper2 < OGenericUnoController 57*b1cdbd2cSJim Jagielski , ::com::sun::star::document::XScriptInvocationContext 58*b1cdbd2cSJim Jagielski , ::com::sun::star::util::XModifiable 59*b1cdbd2cSJim Jagielski > DBSubComponentController_Base; 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski struct DBSubComponentController_Impl; 62*b1cdbd2cSJim Jagielski class DBACCESS_DLLPUBLIC DBSubComponentController : public DBSubComponentController_Base 63*b1cdbd2cSJim Jagielski { 64*b1cdbd2cSJim Jagielski private: 65*b1cdbd2cSJim Jagielski ::std::auto_ptr<DBSubComponentController_Impl> m_pImpl; 66*b1cdbd2cSJim Jagielski 67*b1cdbd2cSJim Jagielski private: 68*b1cdbd2cSJim Jagielski /** forces usage of a connection which we do not own 69*b1cdbd2cSJim Jagielski <p>To be used from within XInitialization::initialize, resp. impl_initialize, only.</p> 70*b1cdbd2cSJim Jagielski */ 71*b1cdbd2cSJim Jagielski void initializeConnection( const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >& _rxForeignConn ); 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski protected: 74*b1cdbd2cSJim Jagielski // OGenericUnoController - initialization 75*b1cdbd2cSJim Jagielski virtual void impl_initialize(); 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski // OGenericUnoController 78*b1cdbd2cSJim Jagielski virtual void Execute(sal_uInt16 nId, const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue>& aArgs); 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski virtual ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel > getPrivateModel() const; 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski sal_Bool impl_isModified() const; 83*b1cdbd2cSJim Jagielski virtual void impl_onModifyChanged(); 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski public: 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski sal_Bool isReadOnly() const; 88*b1cdbd2cSJim Jagielski sal_Bool isEditable() const; 89*b1cdbd2cSJim Jagielski void setEditable(sal_Bool _bEditable); 90*b1cdbd2cSJim Jagielski 91*b1cdbd2cSJim Jagielski // ---------------------------------------------------------------- 92*b1cdbd2cSJim Jagielski // asking for connection-related stuff 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski sal_Bool isConnected() const; 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XDatabaseMetaData > 97*b1cdbd2cSJim Jagielski getMetaData( ) const; 98*b1cdbd2cSJim Jagielski 99*b1cdbd2cSJim Jagielski // ---------------------------------------------------------------- 100*b1cdbd2cSJim Jagielski // access to the data source / document 101*b1cdbd2cSJim Jagielski ::rtl::OUString getDataSourceName() const; 102*b1cdbd2cSJim Jagielski const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& 103*b1cdbd2cSJim Jagielski getDataSource() const; 104*b1cdbd2cSJim Jagielski sal_Bool haveDataSource() const; 105*b1cdbd2cSJim Jagielski 106*b1cdbd2cSJim Jagielski ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel > 107*b1cdbd2cSJim Jagielski getDatabaseDocument() const; 108*b1cdbd2cSJim Jagielski 109*b1cdbd2cSJim Jagielski /** provides access to the SDB-level database meta data of the current connection 110*b1cdbd2cSJim Jagielski */ 111*b1cdbd2cSJim Jagielski const ::dbtools::DatabaseMetaData& getSdbMetaData() const; 112*b1cdbd2cSJim Jagielski 113*b1cdbd2cSJim Jagielski /** appends an error in the current environment. 114*b1cdbd2cSJim Jagielski */ 115*b1cdbd2cSJim Jagielski void appendError( 116*b1cdbd2cSJim Jagielski const ::rtl::OUString& _rErrorMessage, 117*b1cdbd2cSJim Jagielski const ::dbtools::StandardSQLState _eSQLState = ::dbtools::SQL_GENERAL_ERROR, 118*b1cdbd2cSJim Jagielski const sal_Int32 _nErrorCode = 1000 119*b1cdbd2cSJim Jagielski ); 120*b1cdbd2cSJim Jagielski 121*b1cdbd2cSJim Jagielski /** clears the error state. 122*b1cdbd2cSJim Jagielski */ 123*b1cdbd2cSJim Jagielski void clearError(); 124*b1cdbd2cSJim Jagielski 125*b1cdbd2cSJim Jagielski /** @return 126*b1cdbd2cSJim Jagielski <TRUE/> when an error was set otherwise <FALSE/> 127*b1cdbd2cSJim Jagielski */ 128*b1cdbd2cSJim Jagielski sal_Bool hasError() const; 129*b1cdbd2cSJim Jagielski 130*b1cdbd2cSJim Jagielski /** returns the current error 131*b1cdbd2cSJim Jagielski */ 132*b1cdbd2cSJim Jagielski const ::dbtools::SQLExceptionInfo& getError() const; 133*b1cdbd2cSJim Jagielski 134*b1cdbd2cSJim Jagielski /** displays the current error, or does nothing if there is no current error 135*b1cdbd2cSJim Jagielski */ 136*b1cdbd2cSJim Jagielski void displayError(); 137*b1cdbd2cSJim Jagielski 138*b1cdbd2cSJim Jagielski /** shows an info box with the string conntection lost. 139*b1cdbd2cSJim Jagielski */ 140*b1cdbd2cSJim Jagielski void connectionLostMessage() const; 141*b1cdbd2cSJim Jagielski 142*b1cdbd2cSJim Jagielski /** gives access to the currently used connection 143*b1cdbd2cSJim Jagielski @return 144*b1cdbd2cSJim Jagielski the currently used connection. 145*b1cdbd2cSJim Jagielski */ 146*b1cdbd2cSJim Jagielski const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >& 147*b1cdbd2cSJim Jagielski getConnection() const; 148*b1cdbd2cSJim Jagielski 149*b1cdbd2cSJim Jagielski /** returns the number formatter 150*b1cdbd2cSJim Jagielski */ 151*b1cdbd2cSJim Jagielski ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatter > getNumberFormatter() const; 152*b1cdbd2cSJim Jagielski 153*b1cdbd2cSJim Jagielski // ::com::sun::star::frame::XController 154*b1cdbd2cSJim Jagielski virtual sal_Bool SAL_CALL suspend(sal_Bool bSuspend) throw( ::com::sun::star::uno::RuntimeException ); 155*b1cdbd2cSJim Jagielski virtual sal_Bool SAL_CALL attachModel(const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel > & xModel) throw( ::com::sun::star::uno::RuntimeException ); 156*b1cdbd2cSJim Jagielski 157*b1cdbd2cSJim Jagielski // XScriptInvocationContext 158*b1cdbd2cSJim Jagielski virtual ::com::sun::star::uno::Reference< ::com::sun::star::document::XEmbeddedScripts > SAL_CALL getScriptContainer() throw (::com::sun::star::uno::RuntimeException); 159*b1cdbd2cSJim Jagielski 160*b1cdbd2cSJim Jagielski // XModifiable 161*b1cdbd2cSJim Jagielski virtual ::sal_Bool SAL_CALL isModified( ) throw (::com::sun::star::uno::RuntimeException); 162*b1cdbd2cSJim Jagielski virtual void SAL_CALL setModified( ::sal_Bool bModified ) throw (::com::sun::star::beans::PropertyVetoException, ::com::sun::star::uno::RuntimeException); 163*b1cdbd2cSJim Jagielski 164*b1cdbd2cSJim Jagielski // XModifyBroadcaster 165*b1cdbd2cSJim Jagielski virtual void SAL_CALL addModifyListener( const ::com::sun::star::uno::Reference< ::com::sun::star::util::XModifyListener >& aListener ) throw (::com::sun::star::uno::RuntimeException); 166*b1cdbd2cSJim Jagielski virtual void SAL_CALL removeModifyListener( const ::com::sun::star::uno::Reference< ::com::sun::star::util::XModifyListener >& aListener ) throw (::com::sun::star::uno::RuntimeException); 167*b1cdbd2cSJim Jagielski 168*b1cdbd2cSJim Jagielski // XTitle 169*b1cdbd2cSJim Jagielski virtual ::rtl::OUString SAL_CALL getTitle( ) throw (::com::sun::star::uno::RuntimeException); 170*b1cdbd2cSJim Jagielski 171*b1cdbd2cSJim Jagielski protected: 172*b1cdbd2cSJim Jagielski DBSubComponentController(const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory>& _rxORB); 173*b1cdbd2cSJim Jagielski virtual ~DBSubComponentController(); 174*b1cdbd2cSJim Jagielski 175*b1cdbd2cSJim Jagielski virtual void disconnect(); 176*b1cdbd2cSJim Jagielski virtual void reconnect( sal_Bool _bUI ); ensureConnected(sal_Bool _bUI)177*b1cdbd2cSJim Jagielski sal_Bool ensureConnected( sal_Bool _bUI ) { if ( !isConnected() ) reconnect( _bUI ); return isConnected(); } 178*b1cdbd2cSJim Jagielski 179*b1cdbd2cSJim Jagielski /** called when our connection is beeing disposed 180*b1cdbd2cSJim Jagielski <p>The default implementation does a reconnect</p> 181*b1cdbd2cSJim Jagielski */ 182*b1cdbd2cSJim Jagielski virtual void losingConnection( ); 183*b1cdbd2cSJim Jagielski 184*b1cdbd2cSJim Jagielski protected: 185*b1cdbd2cSJim Jagielski // XEventListener 186*b1cdbd2cSJim Jagielski virtual void SAL_CALL disposing(const ::com::sun::star::lang::EventObject& Source) throw( ::com::sun::star::uno::RuntimeException ); 187*b1cdbd2cSJim Jagielski 188*b1cdbd2cSJim Jagielski // OComponentHelper 189*b1cdbd2cSJim Jagielski virtual void SAL_CALL disposing(); 190*b1cdbd2cSJim Jagielski 191*b1cdbd2cSJim Jagielski // XInterface 192*b1cdbd2cSJim Jagielski virtual ::com::sun::star::uno::Any SAL_CALL queryInterface(const ::com::sun::star::uno::Type& _rType) throw (::com::sun::star::uno::RuntimeException); 193*b1cdbd2cSJim Jagielski 194*b1cdbd2cSJim Jagielski // XTypeProvider 195*b1cdbd2cSJim Jagielski virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getTypes( ) throw (::com::sun::star::uno::RuntimeException); 196*b1cdbd2cSJim Jagielski 197*b1cdbd2cSJim Jagielski protected: 198*b1cdbd2cSJim Jagielski sal_Int32 getCurrentStartNumber() const; 199*b1cdbd2cSJim Jagielski 200*b1cdbd2cSJim Jagielski private: 201*b1cdbd2cSJim Jagielski DBSubComponentController(); // never implemented 202*b1cdbd2cSJim Jagielski }; 203*b1cdbd2cSJim Jagielski 204*b1cdbd2cSJim Jagielski //........................................................................ 205*b1cdbd2cSJim Jagielski } // namespace dbaui 206*b1cdbd2cSJim Jagielski //........................................................................ 207*b1cdbd2cSJim Jagielski 208*b1cdbd2cSJim Jagielski #endif // DBAUI_SUBCOMPONENTCONTROLLER_HXX 209*b1cdbd2cSJim Jagielski 210