1 #ifndef DALI_TOOLKIT_CONTROL_WRAPPER_H
2 #define DALI_TOOLKIT_CONTROL_WRAPPER_H
5 * Copyright (c) 2020 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali-toolkit/public-api/controls/control.h>
28 namespace Internal DALI_INTERNAL
34 * @brief ControlWrapper is a base class for custom UI controls developed in managed code (i.e. C#.NET).
36 * The implementation of the ControlWrapper must be supplied; see Internal::ControlWrapper for more details.
38 class DALI_TOOLKIT_API ControlWrapper : public Control
42 * @brief Create a new instance of a ControlWrapper.
44 * @param[in] typeName The name of the type that is registered with this control
45 * @param[in] implementation The implementation of this control
47 * @return A handle to a new ControlWrapper.
49 static ControlWrapper New(const std::string& typeName, Internal::ControlWrapper& implementation);
52 * @brief Creates an empty ControlWrapper handle.
59 * This is non-virtual since derived Handle types must not contain data or virtual methods.
64 * @brief Copy constructor.
66 * Creates another handle that points to the same real object
67 * @param[in] handle Handle to the copied object
69 ControlWrapper(const ControlWrapper& handle);
72 * @brief Assignment operator.
74 * Changes this handle to point to another real object
75 * @param[in] handle Handle to the object
76 * @return A reference to this
78 ControlWrapper& operator=(const ControlWrapper& handle);
81 * @brief Downcast an Object handle to ControlWrapper.
83 * If handle points to a ControlWrapper the
84 * downcast produces valid handle. If not the returned handle is left uninitialized.
85 * @param[in] handle Handle to an object
86 * @return handle to a ControlWrapper or an uninitialized handle
88 static ControlWrapper DownCast(BaseHandle handle);
90 public: // Not intended for application developers
92 * @brief Creates a handle using the Toolkit::Internal implementation.
94 * @param[in] implementation The Control implementation.
96 ControlWrapper(Internal::ControlWrapper& implementation);
99 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
101 * @param[in] internal A pointer to the internal CustomActor.
103 explicit ControlWrapper(Dali::Internal::CustomActor* internal);
106 } // namespace Toolkit
110 #endif // DALI_TOOLKIT_CONTROL_WRAPPER_H