dbaccess/source/ui/inc/JoinTableView.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 #pragma once
  20
  21 #include <svtools/scrolladaptor.hxx>
  22 #include <vcl/window.hxx>
  23 #include <vcl/timer.hxx>
  24 #include <vcl/idle.hxx>
  25 #include <vcl/vclptr.hxx>
  26 #include <vcl/transfer.hxx>
  27
  28 #include "callbacks.hxx"
  29 #include "TableConnectionData.hxx"
  30 #include "TableWindowData.hxx"
  31
  32 #include <map>
  33 #include <vector>
  34
  35 struct AcceptDropEvent;
  36 struct ExecuteDropEvent;
  37 class SfxUndoAction;
  38
  39 namespace dbaui
  40 {
  41     class OTableConnection;
  42     class OTableWindow;
  43     struct OJoinExchangeData;
  44     class OJoinDesignView;
  45     class OTableWindowData;
  46     class OJoinDesignViewAccess;
  47
  48     // this class contains only the scrollbars to avoid that
  49     // the tablewindows clip the scrollbars
  50     class OJoinTableView;
  51     class OScrollWindowHelper : public vcl::Window
  52     {
  53         VclPtr<ScrollAdaptor>      m_aHScrollBar;
  54         VclPtr<ScrollAdaptor>      m_aVScrollBar;
  55         VclPtr<OJoinTableView>     m_pTableView;
  56
  57     protected:
  58         virtual void Resize() override;
  59
  60     public:
  61         OScrollWindowHelper( vcl::Window* pParent);
  62         virtual ~OScrollWindowHelper() override;
  63         virtual void dispose() override;
  64
  65         void setTableView(OJoinTableView* _pTableView);
  66
  67         void resetRange(const Point& _aSize);
  68
  69         // own methods
  70         ScrollAdaptor& GetHScrollBar() { return *m_aHScrollBar; }
  71         ScrollAdaptor& GetVScrollBar() { return *m_aVScrollBar; }
  72     };
  73
  74
  75     class OJoinTableView : public vcl::Window,
  76                            public IDragTransferableListener,
  77                            public DropTargetHelper
  78     {
  79         friend class OJoinMoveTabWinUndoAct;
  80
  81     public:
  82         typedef std::map<OUString, VclPtr<OTableWindow> > OTableWindowMap;
  83
  84     private:
  85         OTableWindowMap     m_aTableMap;
  86         std::vector<VclPtr<OTableConnection> >    m_vTableConnection;
  87
  88         Idle                m_aDragScrollIdle;
  89         tools::Rectangle           m_aDragRect;
  90         tools::Rectangle           m_aSizingRect;
  91         Point               m_aDragOffset;
  92         Point               m_aScrollOffset;
  93         Point               m_ptPrevDraggingPos;
  94         Size                m_aOutputSize;
  95
  96
  97         VclPtr<OTableWindow>           m_pDragWin;
  98         VclPtr<OTableWindow>           m_pSizingWin;
  99         VclPtr<OTableConnection>       m_pSelectedConn;
 100
 101
 102         DECL_LINK(OnDragScrollTimer, Timer*, void);
 103
 104     protected:
 105         VclPtr<OTableWindow>               m_pLastFocusTabWin;
 106         VclPtr<OJoinDesignView>            m_pView;
 107         rtl::Reference<OJoinDesignViewAccess> m_pAccessible;
 108
 109     public:
 110         OJoinTableView( vcl::Window* pParent, OJoinDesignView* pView );
 111         virtual ~OJoinTableView() override;
 112         virtual void dispose() override;
 113
 114         // window override
 115         virtual void StateChanged( StateChangedType nStateChange ) override;
 116         virtual void GetFocus() override;
 117         virtual void LoseFocus() override;
 118         virtual void KeyInput( const KeyEvent& rEvt ) override;
 119         // Accessibility
 120         virtual css::uno::Reference< css::accessibility::XAccessible > CreateAccessible() override;
 121
 122         // own methods
 123         ScrollAdaptor& GetHScrollBar() { return static_cast<OScrollWindowHelper*>(GetParent())->GetHScrollBar(); }
 124         ScrollAdaptor& GetVScrollBar() { return static_cast<OScrollWindowHelper*>(GetParent())->GetVScrollBar(); }
 125         DECL_LINK(VertScrollHdl, weld::Scrollbar&, void);
 126         DECL_LINK(HorzScrollHdl, weld::Scrollbar&, void);
 127
 128         void DrawConnections(vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect);
 129         void InvalidateConnections();
 130
 131         void BeginChildMove( OTableWindow* pTabWin, const Point& rMousePos );
 132         void BeginChildSizing( OTableWindow* pTabWin, PointerStyle nPointer );
 133
 134         void NotifyTitleClicked( OTableWindow* pTabWin, const Point& rMousePos );
 135
 136         virtual void AddTabWin(const OUString& _rComposedName, const OUString& rWinName, bool bNewTable = false);
 137         virtual void RemoveTabWin( OTableWindow* pTabWin );
 138
 139         // hide all TabWins (does NOT delete them; they are put in an UNDO action)
 140         void HideTabWins();
 141
 142         virtual void AddConnection(const OJoinExchangeData& jxdSource, const OJoinExchangeData& jxdDest) = 0;
 143
 144         /** RemoveConnection allows to remove connections from join table view
 145
 146             it implies that the same as addConnection
 147
 148             @param  rConnection the connection which should be removed
 149             @param  bDelete     when true then the connection will be deleted
 150
 151             @return an iterator to next valid connection, so it can be used in any loop
 152         */
 153         virtual bool RemoveConnection(VclPtr<OTableConnection>& rConnection, bool bDelete);
 154
 155         /** allows to add new connections to join table view
 156
 157             it implies an invalidation of the features ID_BROWSER_ADDTABLE and
 158             SID_RELATION_ADD_RELATION also the modified flag will be set to true
 159
 160             @param  _pConnection the connection which should be added
 161             @param  _bAddData    when true then the data should also be appended
 162         */
 163         void addConnection(OTableConnection* _pConnection,bool _bAddData = true);
 164
 165         bool ScrollPane( tools::Long nDelta, bool bHoriz, bool bPaintScrollBars );
 166         sal_Int64 GetTabWinCount() const;
 167         const Point& GetScrollOffset() const { return m_aScrollOffset; }
 168
 169         OJoinDesignView* getDesignView() const { return m_pView; }
 170         OTableWindow* GetTabWindow( const OUString& rName );
 171
 172         VclPtr<OTableConnection>& GetSelectedConn() { return m_pSelectedConn; }
 173         /** @note NULL is explicitly allowed (then no-op) */
 174         void DeselectConn(OTableConnection* pConn);
 175         void SelectConn(OTableConnection* pConn);
 176
 177         OTableWindowMap& GetTabWinMap() { return m_aTableMap; }
 178
 179         /** gives a read only access to the connection vector
 180         */
 181         const std::vector<VclPtr<OTableConnection> >& getTableConnections() const { return m_vTableConnection; }
 182
 183         bool ExistsAConn(const OTableWindow* pFromWin) const;
 184
 185         /** search for all connections of a table
 186
 187             @param  _pFromWin   the table for which connections should be found
 188             @return an iterator which can be used to travel all connections of the table
 189         */
 190         std::vector<VclPtr<OTableConnection> >::const_iterator getTableConnections(const OTableWindow* _pFromWin) const;
 191
 192         /** how many connection belongs to single table
 193
 194             @param  _pFromWin the table for which connections should be found
 195             @return the count of connections which belongs to this table
 196         */
 197         sal_Int32 getConnectionCount(const OTableWindow* _pFromWin) const;
 198
 199         OTableConnection* GetTabConn(const OTableWindow* pLhs,const OTableWindow* pRhs,bool _bSuppressCrossOrNaturalJoin = false) const;
 200
 201         /** clear the window map and connection vector without destroying it
 202
 203             that means that the data of the windows and connection will be
 204             untouched
 205          */
 206         void clearLayoutInformation();
 207
 208         /** set the focus to that tab win which most recently had it
 209             (or to the first available one) **/
 210         void GrabTabWinFocus();
 211
 212         /** take all WinData and ConnData from the document and create the
 213             corresponding Wins and Conns */
 214         virtual void ReSync() { }
 215
 216         /** Hard deletion
 217
 218             That means that all Conns and Wins are deleted from their respective
 219             lists and the corresponding Data removed from the document */
 220         virtual void ClearAll();
 221
 222         /** @note used by AddTabDlg to see if more tables can be added */
 223         virtual bool IsAddAllowed();
 224         virtual bool PreNotify(NotifyEvent& rNEvt) override;
 225
 226         // DnD stuff
 227         virtual sal_Int8 AcceptDrop( const AcceptDropEvent& rEvt ) override;
 228         virtual sal_Int8 ExecuteDrop( const ExecuteDropEvent& rEvt ) override;
 229
 230         /** @note can be used for special ui handling after d&d */
 231         virtual void lookForUiActivities();
 232
 233         /** Hook that is called after moving/resizing TabWins
 234
 235             The position is 'virtual': the container has a virtual area of
 236             which only a part - changeable by scroll bar - is visible.
 237             Therefore: ptOldPosition is always positive, even if it represents
 238             a point with a negative physical ordinate above the visible area
 239
 240             @note The standard implementation just passes the new data to the
 241                   Wins
 242          */
 243         void TabWinMoved(OTableWindow* ptWhich, const Point& ptOldPosition);
 244
 245         void TabWinSized(OTableWindow* ptWhich, const Point& ptOldPosition, const Size& szOldSize);
 246
 247         void modified();
 248
 249         /** check if the given window is visible.
 250
 251             @param _rPoint  The Point to check
 252             @param _rSize   The Size to be check as well
 253             @return true if the area is visible, false otherwise
 254         */
 255         bool isMovementAllowed(const Point& _rPoint,const Size& _rSize);
 256
 257         const Size& getRealOutputSize() const { return m_aOutputSize; }
 258
 259         virtual void EnsureVisible(const OTableWindow* _pWin);
 260         void EnsureVisible(const Point& _rPoint,const Size& _rSize);
 261
 262         TTableWindowData::value_type createTableWindowData(const OUString& _rComposedName
 263                                             ,const OUString& _sTableName
 264                                             ,const OUString& _rWinName);
 265
 266     protected:
 267         virtual void MouseButtonUp( const MouseEvent& rEvt ) override;
 268         virtual void MouseButtonDown( const MouseEvent& rEvt ) override;
 269         virtual void Tracking( const TrackingEvent& rTEvt ) override;
 270         virtual void Paint( vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect ) override;
 271         virtual void ConnDoubleClicked(VclPtr<OTableConnection>& rConnection);
 272         void SetDefaultTabWinPosSize( OTableWindow* pTabWin );
 273         virtual void DataChanged( const DataChangedEvent& rDCEvt ) override;
 274
 275         virtual void Resize() override;
 276
 277         virtual void dragFinished( ) override;
 278         /// @note here the physical position (that can be changed while
 279         ///     resizing) is used, as no scrolling can take place while resizing
 280         virtual void Command(const CommandEvent& rEvt) override;
 281
 282         virtual std::shared_ptr<OTableWindowData> CreateImpl(const OUString& _rComposedName
 283                                             ,const OUString& _sTableName
 284                                             ,const OUString& _rWinName);
 285
 286         /** factory method to create table windows
 287
 288             @param _pData The data corresponding to the window.
 289             @return The new TableWindow
 290         */
 291         virtual VclPtr<OTableWindow> createWindow(const TTableWindowData::value_type& _pData) = 0;
 292
 293         /** determines whether the classes Init method should accept a query
 294             name, or only table names */
 295         virtual bool allowQueries() const;
 296
 297         /** called when init fails at the tablewindowdata because the m_xTable
 298             object could not provide columns, but no exception was thrown.
 299             Expected to throw. */
 300         virtual void onNoColumns_throw();
 301
 302         virtual bool suppressCrossNaturalJoin(const TTableConnectionData::value_type& _pData) const;
 303
 304     private:
 305         void InitColors();
 306         void ScrollWhileDragging();
 307
 308         /** opens the context menu to delete a connection
 309             @param _aPos the position where the popup menu should appear
 310             @param _pSelConnection the connection which should be deleted
 311         */
 312         void executePopup(const Point& _aPos, VclPtr<OTableConnection>& rSelConnection);
 313
 314         /** invalidates this window without children and set the controller
 315             modified
 316             @param _pAction a possible undo action to add at the controller
 317         */
 318         void invalidateAndModify(std::unique_ptr<SfxUndoAction> _pAction);
 319
 320     private:
 321         using Window::Scroll;
 322     };
 323 }
 324
 325 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */