CanvasRenderer: Add missing parentheses for @copydoc
[platform/core/uifw/dali-adaptor.git] / dali / internal / canvas-renderer / generic / drawable-impl-generic.h
1 #ifndef DALI_INTERNAL_GENERIC_DRAWABLE_IMPL_GENERIC_H
2 #define DALI_INTERNAL_GENERIC_DRAWABLE_IMPL_GENERIC_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 #ifdef THORVG_SUPPORT
23 #include <thorvg.h>
24 #endif
25 #include <dali/public-api/object/base-object.h>
26
27 // INTERNAL INCLUDES
28 #include <dali/devel-api/adaptor-framework/canvas-renderer-drawable.h>
29 #include <dali/devel-api/adaptor-framework/canvas-renderer.h>
30 #include <dali/internal/canvas-renderer/common/drawable-impl.h>
31
32 namespace Dali
33 {
34 namespace Internal
35 {
36 namespace Adaptor
37 {
38 /**
39  * Dali internal Drawable.
40  */
41 class DrawableGeneric : public Dali::Internal::Adaptor::Drawable
42 {
43 public:
44   /**
45    * @brief Creates a Drawable object.
46    * @return A pointer to a newly allocated Drawable
47    */
48   static DrawableGeneric* New();
49
50   /**
51    * @copydoc Dali::CanvasRenderer::Drawable::SetOpacity()
52    */
53   bool SetOpacity(float opacity) override;
54
55   /**
56    * @copydoc Dali::CanvasRenderer::Drawable::GetOpacity()
57    */
58   float GetOpacity() const override;
59
60   /**
61    * @copydoc Dali::CanvasRenderer::Drawable::Rotate()
62    */
63   bool Rotate(Degree degree) override;
64
65   /**
66    * @copydoc Dali::CanvasRenderer::Drawable::Scale()
67    */
68   bool Scale(float factor) override;
69
70   /**
71    * @copydoc Dali::CanvasRenderer::Drawable::Translate()
72    */
73   bool Translate(Vector2 translate) override;
74
75   /**
76    * @copydoc Dali::CanvasRenderer::Drawable::Transform()
77    */
78   bool Transform(const Dali::Matrix3& matrix) override;
79
80   /**
81    * @copydoc Dali::CanvasRenderer::Drawable::GetBoundingBox()
82    */
83   Rect<float> GetBoundingBox() const override;
84
85   /**
86    * @copydoc Internal::Adaptor::Drawable::SetAdded()
87    */
88   void SetAdded(bool added) override;
89
90   /**
91    * @copydoc Internal::Adaptor::Drawable::IsAdded()
92    */
93   bool IsAdded() const override;
94
95   /**
96    * @copydoc Internal::Adaptor::Drawable::SetObject()
97    */
98   void SetObject(const void* object) override;
99
100   /**
101    * @copydoc Internal::Adaptor::Drawable::GetObject()
102    */
103   void* GetObject() const override;
104
105   /**
106    * @copydoc Internal::Adaptor::Drawable::SetChanged()
107    */
108   void SetChanged(bool changed);
109
110   /**
111    * @copydoc Internal::Adaptor::Drawable::GetChanged()
112    */
113   bool GetChanged() const;
114
115   DrawableGeneric(const DrawableGeneric&) = delete;
116   DrawableGeneric& operator=(DrawableGeneric&) = delete;
117   DrawableGeneric(DrawableGeneric&&)           = delete;
118   DrawableGeneric& operator=(DrawableGeneric&&) = delete;
119
120 protected:
121   /**
122    * @brief Constructor
123    */
124   DrawableGeneric();
125
126   /**
127    * @brief Destructor.
128    */
129   virtual ~DrawableGeneric() override;
130 };
131
132 } // namespace Adaptor
133
134 } // namespace Internal
135
136 } // namespace Dali
137
138 #endif // DALI_INTERNAL_GENERIC_DRAWABLE_IMPL_GENERIC_H