summaryrefslogtreecommitdiffstats
path: root/include/svl/SfxBroadcaster.hxx
blob: bacef8d2d3ce2654b9b8b831056dd65b262c4e68 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef INCLUDED_SVL_BRDCST_HXX
#define INCLUDED_SVL_BRDCST_HXX

#include <svl/svldllapi.h>
#include <memory>

class SfxListener;
class SfxHint;
class SfxBroadcasterTest;

class SVL_DLLPUBLIC SfxBroadcaster
{
    struct Impl;
    std::unique_ptr<Impl> mpImpl;

private:
    void                    AddListener( SfxListener& rListener );
    void                    RemoveListener( SfxListener& rListener );
    const SfxBroadcaster&   operator=(const SfxBroadcaster &) = delete;

protected:
    void                    Forward(SfxBroadcaster& rBC, const SfxHint& rHint);

public:

                            SfxBroadcaster();
                            SfxBroadcaster( const SfxBroadcaster &rBC );
    virtual                 ~SfxBroadcaster() COVERITY_NOEXCEPT_FALSE;

    void                    Broadcast( const SfxHint &rHint );
    bool                    HasListeners() const;

    /** Get the number of listeners which are registered at this broadcaster */
    size_t                  GetListenerCount() const;

    /** Get the size of the internally stored vector.
     * Use it to iterate over all listeners.
     */
    size_t GetSizeOfVector() const;

    /** Get a listener by its position in the internally stored vector.
     * Note that this method may return NULL
     */
    SfxListener* GetListener( size_t nNo ) const;

    friend class SfxListener;
    friend class ::SfxBroadcasterTest;
};

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */