dbaccess/source/ui/inc/JoinController.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 #ifndef INCLUDED_DBACCESS_SOURCE_UI_INC_JOINCONTROLLER_HXX
  20 #define INCLUDED_DBACCESS_SOURCE_UI_INC_JOINCONTROLLER_HXX
  21
  22 #include "singledoccontroller.hxx"
  23 #include <com/sun/star/beans/XPropertySet.hpp>
  24 #include "moduledbu.hxx"
  25 #include "JoinTableView.hxx"
  26 #include "JoinDesignView.hxx"
  27 #include "TableConnectionData.hxx"
  28 #include "TableWindowData.hxx"
  29 #include <tools/fract.hxx>
  30 #include <memory>
  31
  32 namespace comphelper
  33 {
  34     class NamedValueCollection;
  35 }
  36
  37 namespace dbaui
  38 {
  39     class OAddTableDlg;
  40     class AddTableDialogContext;
  41     class OTableWindow;
  42     typedef OSingleDocumentController OJoinController_BASE;
  43
  44     class OJoinController : public OJoinController_BASE
  45     {
  46         OModuleClient                    m_aModuleClient;
  47     protected:
  48         TTableConnectionData m_vTableConnectionData;
  49         TTableWindowData     m_vTableData;
  50
  51         ::dbtools::SQLExceptionInfo             m_aExceptionInfo;
  52
  53         VclPtr<OAddTableDlg>                          m_pAddTableDialog;
  54         ::std::unique_ptr< AddTableDialogContext >    m_pDialogContext;
  55         Point                                   m_aMinimumTableViewSize;
  56
  57         // state of a feature. 'feature' may be the handle of a css::util::URL somebody requested a dispatch interface for OR a toolbar slot.
  58         virtual FeatureState    GetState(sal_uInt16 nId) const override;
  59         // execute a feature
  60         virtual void            Execute(sal_uInt16 nId, const css::uno::Sequence< css::beans::PropertyValue>& aArgs) override;
  61
  62         /** loads the information for the windows.
  63             @param  i_rViewSettings
  64                 The properties which comes from the layout information.
  65         */
  66         void loadTableWindows( const ::comphelper::NamedValueCollection& i_rViewSettings );
  67
  68         /** loads the information for one window.
  69             @param  _rTable
  70                 The properties which comes from the layout information.
  71         */
  72         void loadTableWindow( const ::comphelper::NamedValueCollection& i_rTableWindowSettings );
  73
  74         /** saves the TableWindows structure in a sequence of property values
  75             @param  _rViewProps
  76                 Contains the new sequence.
  77         */
  78         void saveTableWindows( ::comphelper::NamedValueCollection& o_rViewSettings ) const;
  79
  80         virtual ~OJoinController();
  81     public:
  82         OJoinController(const css::uno::Reference< css::uno::XComponentContext >& _rM);
  83
  84         // attribute access
  85         inline TTableWindowData&        getTableWindowData()     { return m_vTableData; }
  86         inline TTableConnectionData&    getTableConnectionData() { return m_vTableConnectionData;}
  87         inline OAddTableDlg*            getAddTableDialog()const { return m_pAddTableDialog; }
  88
  89         // OSingleDocumentController overridables
  90         virtual void        reconnect( bool _bUI ) override;
  91         virtual void        impl_onModifyChanged() override;
  92
  93         // own overridables
  94         /** determines whether or not it's allowed for database views to participate in the game
  95         */
  96         virtual bool allowViews() const = 0;
  97
  98         /** determines whether or not it's allowed for queries to participate in the game
  99         */
 100         virtual bool allowQueries() const = 0;
 101
 102         /** provides access to the OJoinDesignView belonging to the controller, which might
 103             or might not be the direct view (getView)
 104         */
 105         virtual OJoinDesignView*    getJoinView();
 106
 107         /** erase the data in the data vector
 108             @param  _pData
 109                     the data which should be erased
 110         */
 111         void    removeConnectionData(const TTableConnectionData::value_type& _pData);
 112
 113         void    SaveTabWinsPosSize( OJoinTableView::OTableWindowMap* pTabWinList, long nOffsetX, long nOffsetY );
 114
 115         static void SaveTabWinPosSize(OTableWindow* pTabWin, long nOffsetX, long nOffsetY);
 116
 117         // UNO interface overridables
 118         // XEventListener
 119         virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) throw(css::uno::RuntimeException, std::exception) override;
 120
 121         // css::lang::XComponent
 122         virtual void    SAL_CALL disposing() override;
 123         // css::frame::XController
 124         virtual sal_Bool SAL_CALL suspend(sal_Bool bSuspend) throw( css::uno::RuntimeException, std::exception ) override;
 125
 126         // misc
 127         /** only defines a method to save a SQLException in d&d methods to show the error at a later state
 128             set the internal member m_aExceptionInfo to _rInfo
 129         */
 130         void setErrorOccurred(const ::dbtools::SQLExceptionInfo& _rInfo)
 131         {
 132             m_aExceptionInfo = _rInfo;
 133         }
 134         /**
 135             just returns the internal member and clears it
 136         */
 137         ::dbtools::SQLExceptionInfo clearOccurredError()
 138         {
 139             ::dbtools::SQLExceptionInfo aInfo = m_aExceptionInfo;
 140             m_aExceptionInfo = ::dbtools::SQLExceptionInfo();
 141             return aInfo;
 142         }
 143
 144     protected:
 145         TTableWindowData::value_type createTableWindowData(const OUString& _sComposedName,const OUString& _sTableName,const OUString& _sWindowName);
 146         // ask the user if the design should be saved when it is modified
 147         virtual short saveModified() = 0;
 148         // called when the orignal state should be reseted (first time load)
 149         virtual void reset()         = 0;
 150         virtual void describeSupportedFeatures() override;
 151
 152         AddTableDialogContext&  impl_getDialogContext() const;
 153     };
 154 }
 155 #endif // INCLUDED_DBACCESS_SOURCE_UI_INC_JOINCONTROLLER_HXX
 156
 157 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */