dbaccess/source/ui/inc/datasourceconnector.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <com/sun/star/uno/XComponentContext.hpp>
  23 #include <com/sun/star/sdbc/XConnection.hpp>
  24 #include <com/sun/star/sdbc/XDataSource.hpp>
  25
  26 namespace dbtools
  27 {
  28     class SQLExceptionInfo;
  29 }
  30
  31 namespace weld { class Window; }
  32 namespace dbaui
  33 {
  34
  35     // ODatasourceConnector
  36     class ODatasourceConnector final
  37     {
  38         weld::Window*  m_pErrorMessageParent;
  39         css::uno::Reference< css::uno::XComponentContext >
  40                              m_xContext;
  41         OUString             m_sContextInformation;
  42
  43     public:
  44         ODatasourceConnector(
  45             const css::uno::Reference< css::uno::XComponentContext >& _rxContext,
  46             weld::Window* _pMessageParent
  47         );
  48         ODatasourceConnector(
  49             const css::uno::Reference< css::uno::XComponentContext >& _rxContext,
  50             weld::Window* _pMessageParent,
  51             OUString _sContextInformation
  52         );
  53
  54         /// returns <TRUE/> if the object is able to create data source connections
  55         bool    isValid() const { return m_xContext.is(); }
  56
  57         /** creates a connection to the data source, displays the possible error to the user, or returns it
  58         */
  59         css::uno::Reference< css::sdbc::XConnection >
  60                     connect(
  61                         const OUString& _rDataSourceName,
  62                         ::dbtools::SQLExceptionInfo* _pErrorInfo
  63                     ) const;
  64
  65         /** creates a connection to the data source, displays the possible error to the user, or returns it
  66         */
  67         css::uno::Reference< css::sdbc::XConnection >
  68                     connect(
  69                         const css::uno::Reference< css::sdbc::XDataSource>& _xDataSource,
  70                         ::dbtools::SQLExceptionInfo* _pErrorInfo
  71                     ) const;
  72     };
  73
  74 }   // namespace dbaui
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */