sc/inc/broadcast.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
  10 #pragma once
  11
  12 #include "address.hxx"
  13
  14 #include <map>
  15 #include <variant>
  16 #include <ostream>
  17
  18 class ScFormulaCell;
  19 class SvtListener;
  20
  21 namespace sc
  22 {
  23 class FormulaGroupAreaListener;
  24
  25 struct BroadcasterState
  26 {
  27     enum class CellListenerType
  28     {
  29         FormulaCell,
  30         Generic,
  31     };
  32
  33     enum class AreaListenerType
  34     {
  35         FormulaCell,
  36         FormulaGroup,
  37         Generic,
  38     };
  39
  40     struct CellListener
  41     {
  42         using DataType = std::variant<const ScFormulaCell*, const SvtListener*>;
  43
  44         CellListenerType eType;
  45         DataType pData;
  46
  47         CellListener(const ScFormulaCell* p);
  48         CellListener(const SvtListener* p);
  49     };
  50
  51     struct AreaListener
  52     {
  53         using DataType = std::variant<const ScFormulaCell*, const sc::FormulaGroupAreaListener*,
  54                                       const SvtListener*>;
  55
  56         AreaListenerType eType;
  57         DataType pData;
  58
  59         AreaListener(const ScFormulaCell* p);
  60         AreaListener(const sc::FormulaGroupAreaListener* p);
  61         AreaListener(const SvtListener* p);
  62     };
  63
  64     std::map<ScAddress, std::vector<CellListener>> aCellListenerStore;
  65     std::map<ScRange, std::vector<AreaListener>> aAreaListenerStore;
  66
  67     /**
  68      * Check if a formula cell listens on a single cell.
  69      */
  70     bool hasFormulaCellListener(const ScAddress& rBroadcasterPos,
  71                                 const ScAddress& rFormulaPos) const;
  72
  73     /**
  74      * Check if a formula cell listens on a single range.
  75      */
  76     bool hasFormulaCellListener(const ScRange& rBroadcasterRange,
  77                                 const ScAddress& rFormulaPos) const;
  78
  79     /**
  80      * Dump all broadcaster state in YAML format.
  81      */
  82     void dump(std::ostream& rStrm, const ScDocument* pDoc = nullptr) const;
  83 };
  84 }
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */