include/svl/SfxBroadcaster.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_SVL_BRDCST_HXX
  20 #define INCLUDED_SVL_BRDCST_HXX
  21
  22 #include <svl/svldllapi.h>
  23 #include <memory>
  24 #include <vector>
  25
  26 class SfxListener;
  27 class SfxHint;
  28 class SfxBroadcasterTest;
  29
  30 class SVL_DLLPUBLIC SfxBroadcaster
  31 {
  32     /** Contains the positions of removed listeners. */
  33     std::vector<size_t>     m_RemovedPositions;
  34     std::vector<SfxListener*> m_Listeners;
  35
  36 private:
  37     void                    AddListener( SfxListener& rListener );
  38     void                    RemoveListener( SfxListener& rListener );
  39     const SfxBroadcaster&   operator=(const SfxBroadcaster &) = delete;
  40
  41 protected:
  42     void                    Forward(SfxBroadcaster& rBC, const SfxHint& rHint);
  43
  44 public:
  45
  46                             SfxBroadcaster() {}
  47                             SfxBroadcaster( const SfxBroadcaster &rBC );
  48     virtual                 ~SfxBroadcaster() COVERITY_NOEXCEPT_FALSE;
  49
  50     void                    Broadcast( const SfxHint &rHint );
  51     bool                    HasListeners() const;
  52
  53     /** Get the number of listeners which are registered at this broadcaster */
  54     size_t                  GetListenerCount() const;
  55
  56     /** Get the size of the internally stored vector.
  57      * Use it to iterate over all listeners.
  58      */
  59     size_t GetSizeOfVector() const;
  60
  61     /** Get a listener by its position in the internally stored vector.
  62      * Note that this method may return NULL
  63      */
  64     SfxListener* GetListener( size_t nNo ) const;
  65
  66     friend class SfxListener;
  67     friend class ::SfxBroadcasterTest;
  68 };
  69
  70 #endif
  71
  72 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */