1 #ifndef DALI_TOOLKIT_CONTROL_DEVEL_H
2 #define DALI_TOOLKIT_CONTROL_DEVEL_H
5 * Copyright (c) 2016 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>
30 namespace DevelControl
45 STYLE_NAME = Control::Property::STYLE_NAME,
46 BACKGROUND_COLOR = Control::Property::BACKGROUND_COLOR,
47 BACKGROUND_IMAGE = Control::Property::BACKGROUND_IMAGE,
48 KEY_INPUT_FOCUS = Control::Property::KEY_INPUT_FOCUS,
49 BACKGROUND = Control::Property::BACKGROUND,
52 * @brief Displays a tooltip when the control is hovered over.
53 * @details Name "tooltip", type Property::STRING, Property::ARRAY or Property::MAP.
54 * If Property::STRING, then the style specified in the stylesheet is used.
55 * If Property::ARRAY of Visuals then all are displayed in one row.
56 * If Property::MAP, then it should be a map of Tooltip properties.
57 * @note The tooltip is only activated if display content is received, i.e. a string (text) or visual to show.
58 * The rest is used to just build up the style of the tooltip (i.e. background, text color/point-size etc.)
59 * @note When retrieved, a Property::MAP is returned.
60 * @see Toolkit::Tooltip
62 TOOLTIP = BACKGROUND + 1,
65 * @brief The current state of the control.
66 * @details Name "state", type DevelControl::State ( Property::INTEGER ) or Property::STRING
68 * @see DevelControl::State
70 STATE = BACKGROUND + 2,
73 * @brief The current sub state of the control.
74 * @details Name "subState", type Property::INTEGER or Property::STRING. The enumeration used is dependent on the derived control.
76 * @see DevelControl::State
78 SUB_STATE = BACKGROUND + 3,
81 * @brief The actor ID of the left focusable control.
82 * @details Name "leftFocusableActorId", type Property::INTEGER.
85 LEFT_FOCUSABLE_ACTOR_ID = BACKGROUND + 4,
88 * @brief The actor ID of the right focusable control.
89 * @details Name "rightFocusableActorId", type Property::INTEGER.
92 RIGHT_FOCUSABLE_ACTOR_ID = BACKGROUND + 5,
95 * @brief The actor ID of the up focusable control.
96 * @details Name "upFocusableActorId", type Property::INTEGER.
99 UP_FOCUSABLE_ACTOR_ID = BACKGROUND + 6,
102 * @brief The actor ID of the down focusable control.
103 * @details Name "downFocusableActorId", type Property::INTEGER.
106 DOWN_FOCUSABLE_ACTOR_ID = BACKGROUND + 7
109 } // namespace Property
111 /// @brief ResourceReady signal type;
112 typedef Signal<void ( Control ) > ResourceReadySignalType;
115 * @brief This signal is emitted after all resources required
116 * by a control are loaded and ready.
117 * Most resources are only loaded when the control is placed on stage.
119 * A callback of the following type may be connected:
121 * void YourCallbackName( Control control );
124 ResourceReadySignalType& ResourceReadySignal( Control& control );
127 * @brief Query if all resources required by a control are loaded and ready.
128 * Most resources are only loaded when the control is placed on stage.
129 * @return true if the resources are loaded and ready, false otherwise
132 bool IsResourceReady( const Control& control );
134 } // namespace DevelControl
136 } // namespace Toolkit
140 #endif // DALI_TOOLKIT_CONTROL_DEVEL_H