Modify doxygen group names
[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) 2015 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  */
40 class DALI_IMPORT_API ConnectionTracker : public ConnectionTrackerInterface
41 {
42 public:
43
44   /**
45    * @brief Constructor.
46    */
47   ConnectionTracker();
48
49   /**
50    * @brief Virtual destructor.
51    */
52   virtual ~ConnectionTracker();
53
54   /**
55    * @brief Disconnect all signals from this object.
56    */
57   void DisconnectAll();
58
59   /**
60    * @copydoc ConnectionTrackerInterface::SignalConnected
61    */
62   virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
63
64   /**
65    * @copydoc ConnectionTrackerInterface::SignalDisconnected
66    */
67   virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
68
69   /**
70    * @brief returns the connection count
71    * @return the connection count
72    */
73   std::size_t GetConnectionCount() const;
74
75 private:
76
77   ConnectionTracker( const ConnectionTracker& );            ///< undefined copy constructor
78   ConnectionTracker& operator=( const ConnectionTracker& ); ///< undefined assignment operator
79
80 private:
81
82   Dali::Vector< SlotConnection* > mConnections; ///< Vector of connection pointers
83 };
84
85 /**
86  * @}
87  */
88 } // namespace Dali
89
90 #endif // __DALI_CONNECTION_TRACKER_H__