CanvasRenderer: Add missing parentheses for @copydoc
[platform/core/uifw/dali-adaptor.git] / dali / internal / canvas-renderer / common / drawable-group-impl.h
1 #ifndef DALI_INTERNAL_DRAWABLE_GROUP_IMPL_H
2 #define DALI_INTERNAL_DRAWABLE_GROUP_IMPL_H
3
4 /*
5  * Copyright (c) 2021 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 // EXTERNAL INCLUDES
22 #include <dali/public-api/object/base-object.h>
23
24 // INTERNAL INCLUDES
25 #include <dali/devel-api/adaptor-framework/canvas-renderer-drawable-group.h>
26 #include <dali/internal/canvas-renderer/common/drawable-impl.h>
27
28 namespace Dali
29 {
30 namespace Internal
31 {
32 namespace Adaptor
33 {
34 /**
35  * Dali internal DrawableGroup.
36  */
37 class DrawableGroup : public Internal::Adaptor::Drawable
38 {
39 public:
40   /**
41    * @brief List of drawables.
42    */
43   using DrawableVector = std::vector<Dali::CanvasRenderer::Drawable>;
44
45   /**
46    * @brief Constructor
47    */
48   DrawableGroup();
49
50   /**
51    * @brief Destructor.
52    */
53   ~DrawableGroup() override;
54
55   /**
56    * @copydoc Dali::CanvasRenderer::DrawableGroup::AddDrawable()
57    */
58   virtual bool AddDrawable(Dali::CanvasRenderer::Drawable& drawable);
59
60   /**
61    * @copydoc Dali::CanvasRenderer::DrawableGroup::Clear()
62    */
63   virtual bool Clear();
64
65   /**
66    * @brief Get list of drawables that added this group.
67    * @return Returns list of drawables.
68    */
69   virtual DrawableVector GetDrawables() const;
70
71   DrawableGroup(const DrawableGroup&) = delete;
72   DrawableGroup& operator=(DrawableGroup&) = delete;
73   DrawableGroup(DrawableGroup&&)           = delete;
74   DrawableGroup& operator=(DrawableGroup&&) = delete;
75 };
76
77 } // namespace Adaptor
78
79 } // namespace Internal
80
81 inline static Internal::Adaptor::DrawableGroup& GetImplementation(Dali::CanvasRenderer::DrawableGroup& drawablegroup)
82 {
83   DALI_ASSERT_ALWAYS(drawablegroup && "DrawableGroup handle is empty.");
84
85   BaseObject& handle = drawablegroup.GetBaseObject();
86
87   return static_cast<Internal::Adaptor::DrawableGroup&>(handle);
88 }
89
90 inline static const Internal::Adaptor::DrawableGroup& GetImplementation(const Dali::CanvasRenderer::DrawableGroup& drawablegroup)
91 {
92   DALI_ASSERT_ALWAYS(drawablegroup && "DrawableGroup handle is empty.");
93
94   const BaseObject& handle = drawablegroup.GetBaseObject();
95
96   return static_cast<const Internal::Adaptor::DrawableGroup&>(handle);
97 }
98
99 } // namespace Dali
100
101 #endif // DALI_INTERNAL_DRAWABLE_GROUP_IMPL_H