dbaccess/source/ui/inc/TableConnectionData.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_TABLECONNECTIONDATA_HXX
  20 #define INCLUDED_DBACCESS_SOURCE_UI_INC_TABLECONNECTIONDATA_HXX
  21
  22 #include "ConnectionLineData.hxx"
  23 #include "TableWindowData.hxx"
  24 #include <vector>
  25 #include <memory>
  26
  27 namespace dbaui
  28 {
  29     //===========================================//
  30     // ConnData     ---------->*    ConnLineData //
  31     //    ^1                            ^1       //
  32     //    |                             |        //
  33     //  Conn        ---------->*    ConnLine     //
  34     //===========================================//
  35
  36     /** Contains all connection data which exists between two windows */
  37     class OTableConnectionData
  38     {
  39     protected:
  40         TTableWindowData::value_type m_pReferencingTable;
  41         TTableWindowData::value_type m_pReferencedTable;
  42         OUString m_aConnName;
  43
  44         OConnectionLineDataVec m_vConnLineData;
  45
  46         void    Init();
  47
  48         virtual OConnectionLineDataRef CreateLineDataObj();
  49
  50         OTableConnectionData& operator=( const OTableConnectionData& rConnData );
  51     public:
  52         OTableConnectionData();
  53         OTableConnectionData( const TTableWindowData::value_type& _pReferencingTable,
  54                               const TTableWindowData::value_type& _pReferencedTable,
  55                               const OUString& rConnName = OUString() );
  56         OTableConnectionData( const OTableConnectionData& rConnData );
  57         virtual ~OTableConnectionData();
  58
  59         /// initialise from a source (more comfortable than a virtual assignment operator)
  60         virtual void CopyFrom(const OTableConnectionData& rSource);
  61
  62         /** deliver a new instance of my own type
  63
  64             derived classes have to deliver an instance of their own type
  65
  66             @note does NOT have to be initialised
  67          */
  68         virtual OTableConnectionData* NewInstance() const;
  69
  70         void SetConnLine( sal_uInt16 nIndex, const OUString& rSourceFieldName, const OUString& rDestFieldName );
  71         bool AppendConnLine( const OUString& rSourceFieldName, const OUString& rDestFieldName );
  72         /** Deletes list of ConnLines
  73         */
  74         void ResetConnLines();
  75
  76         /** moves the empty lines to the back
  77             removes duplicated empty lines
  78
  79             caller is responsible for repainting them
  80
  81             @return index of first changed line, or one-past-the-end if no change
  82          */
  83         OConnectionLineDataVec::size_type normalizeLines();
  84
  85         const OConnectionLineDataVec& GetConnLineDataList() const { return m_vConnLineData; }
  86         OConnectionLineDataVec& GetConnLineDataList() { return m_vConnLineData; }
  87
  88         const TTableWindowData::value_type& getReferencingTable() const { return m_pReferencingTable; }
  89         const TTableWindowData::value_type& getReferencedTable()  const { return m_pReferencedTable;  }
  90
  91         inline void setReferencingTable(const TTableWindowData::value_type& _pTable) { m_pReferencingTable = _pTable; }
  92         inline void setReferencedTable(const TTableWindowData::value_type& _pTable)  { m_pReferencedTable  = _pTable; }
  93
  94         const OUString& GetConnName() const { return m_aConnName; }
  95
  96         /** Update create a new connection
  97
  98             @return true if successful
  99         */
 100         virtual bool Update(){ return true; }
 101     };
 102
 103     typedef ::std::vector< ::std::shared_ptr<OTableConnectionData> >  TTableConnectionData;
 104
 105 }
 106 #endif
 107
 108 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */