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