1 #ifndef __DALI_CUSTOM_ACTOR_H__
2 #define __DALI_CUSTOM_ACTOR_H__
5 * Copyright (c) 2014 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/public-api/actors/actor.h>
23 #include <dali/public-api/actors/custom-actor-impl.h>
28 namespace Internal DALI_INTERNAL
34 * @brief CustomActor is a base class for custom UI controls.
36 * The implementation of the control must be supplied; see CustomActorImpl for more details.
38 class DALI_IMPORT_API CustomActor : public Actor
43 * @brief Create an uninitialized CustomActor handle.
45 * Only derived versions can be instantiated.
46 * Calling member functions with an uninitialized Dali::Object is not allowed.
51 * @brief Downcast an Object handle to CustomActor.
53 * If handle points to a CustomActor the downcast produces valid
54 * handle. If not the returned handle is left uninitialized.
56 * @param[in] handle to An object
57 * @return handle to a CustomActor or an uninitialized handle
59 static CustomActor DownCast( BaseHandle handle );
64 * This is non-virtual since derived Handle types must not contain data or virtual methods.
69 * @brief Retrieve the custom actor implementation.
71 * @return The implementation.
73 CustomActorImpl& GetImplementation();
76 * @brief Retrieve the custom actor implementation.
78 * @return The implementation.
80 const CustomActorImpl& GetImplementation() const;
83 * @brief Create an initialised CustomActor.
85 * @param[in] implementation The implementation for this custom actor.
86 * @return A handle to a newly allocated Dali resource.
88 CustomActor(CustomActorImpl& implementation);
91 * @brief Copy constructor
93 * @param [in] copy The actor to copy.
95 CustomActor(const CustomActor& copy);
98 * @brief Assignment operator
100 * @param [in] rhs The actor to copy.
102 CustomActor& operator=(const CustomActor& rhs);
104 public: // Not intended for application developers
107 * @brief This constructor is used internally to create additional CustomActor handles.
109 * @param [in] actor A pointer to a newly allocated Dali resource
111 CustomActor(Internal::CustomActor* actor);
116 #endif // __DALI_CUSTOM_ACTOR_H__