Formatted API
[platform/core/uifw/dali-core.git] / dali / public-api / signals / connection-tracker.h
1 #ifndef DALI_CONNECTION_TRACKER_H
2 #define DALI_CONNECTION_TRACKER_H
3
4 /*
5  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  */
20
21 // INTERNAL INCLUDES
22 #include <dali/public-api/common/dali-common.h>
23 #include <dali/public-api/common/dali-vector.h>
24 #include <dali/public-api/signals/connection-tracker-interface.h>
25
26 namespace Dali
27 {
28 /**
29  * @addtogroup dali_core_signals
30  * @{
31  */
32
33 class CallbackBase;
34 class SlotObserver;
35 class SlotConnection;
36
37 /**
38  * @brief Connection tracker concrete implementation.
39  * @SINCE_1_0.0
40  */
41 class DALI_CORE_API ConnectionTracker : public ConnectionTrackerInterface
42 {
43 public:
44   /**
45    * @brief Constructor.
46    * @SINCE_1_0.0
47    */
48   ConnectionTracker();
49
50   /**
51    * @brief Virtual destructor.
52    * @SINCE_1_0.0
53    */
54   ~ConnectionTracker() override;
55
56   /**
57    * @brief Disconnects all signals from this object.
58    * @SINCE_1_0.0
59    */
60   void DisconnectAll();
61
62   /**
63    * @copydoc ConnectionTrackerInterface::SignalConnected
64    */
65   void SignalConnected(SlotObserver* slotObserver, CallbackBase* callback) override;
66
67   /**
68    * @copydoc ConnectionTrackerInterface::SignalDisconnected
69    */
70   void SignalDisconnected(SlotObserver* slotObserver, CallbackBase* callback) override;
71
72   /**
73    * @brief Returns the connection count.
74    * @SINCE_1_0.0
75    * @return The connection count
76    */
77   std::size_t GetConnectionCount() const;
78
79 private:
80   ConnectionTracker(const ConnectionTracker&) = delete;            ///< Deleted copy constructor. @SINCE_1_0.0
81   ConnectionTracker(ConnectionTracker&&)      = delete;            ///< Deleted move constructor. @SINCE_1_9.25
82   ConnectionTracker& operator=(const ConnectionTracker&) = delete; ///< Deleted copy assignment operator. @SINCE_1_0.0
83   ConnectionTracker& operator=(ConnectionTracker&&) = delete;      ///< Deleted move assignment operator. @SINCE_1_9.25
84
85 private:
86   Dali::Vector<SlotConnection*> mConnections; ///< Vector of connection pointers
87 };
88
89 /**
90  * @}
91  */
92 } // namespace Dali
93
94 #endif // DALI_CONNECTION_TRACKER_H