include/svl/lstner.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_LSTNER_HXX
  20 #define INCLUDED_SVL_LSTNER_HXX
  21
  22 #include <svl/svldllapi.h>
  23 #include <memory>
  24
  25 class SfxBroadcaster;
  26 class SfxHint;
  27
  28 //StartListening duplicate handling options
  29 //Prevent only adds the listener if it's not already added
  30 //Allow allows duplicate listeners
  31 //Unexpected, the default, is for the usual case where the
  32 //listener should only be added once and duplicates are
  33 //unexpected. In dbgutil mode this tracks where the original
  34 //listener was added from and reports the duplicate addition
  35 //as an error
  36 enum class DuplicateHandling { Unexpected, Prevent, Allow };
  37
  38 class SVL_DLLPUBLIC SfxListener
  39 {
  40     struct Impl;
  41     std::unique_ptr<Impl> mpImpl;
  42
  43 private:
  44     const SfxListener&  operator=(const SfxListener &) = delete;
  45
  46 public:
  47
  48                         SfxListener();
  49                         SfxListener( const SfxListener &rCopy );
  50     virtual             ~SfxListener() COVERITY_NOEXCEPT_FALSE;
  51
  52     void                StartListening(SfxBroadcaster& rBroadcaster, DuplicateHandling eDuplicateHanding = DuplicateHandling::Unexpected);
  53     void                EndListening( SfxBroadcaster& rBroadcaster, bool bRemoveAllDuplicates = false );
  54     void                EndListeningAll();
  55     bool                IsListening( SfxBroadcaster& rBroadcaster ) const;
  56
  57     sal_uInt16          GetBroadcasterCount() const;
  58     SfxBroadcaster*     GetBroadcasterJOE( sal_uInt16 nNo ) const;
  59
  60     virtual void        Notify( SfxBroadcaster& rBC, const SfxHint& rHint );
  61
  62     void                RemoveBroadcaster_Impl( SfxBroadcaster& rBC );
  63 };
  64
  65 #endif
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */