1 #ifndef DALI_TOOLKIT_PAGE_TURN_VIEW_H
2 #define DALI_TOOLKIT_PAGE_TURN_VIEW_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 // Forward declarations
31 namespace Internal DALI_INTERNAL
37 * @brief PageTurnView is a base class of different mode of pageTurnViews ( portrait or landscape )
39 * Page actors are provided from an external PageFactory
40 * PanGesture is used to activate the page bending, streching and tuning forward/backward
42 * Signal usage: There are four signals. Two matching pairs for panning and page turning:
43 * PagePanStarted/PagePanFinished and PageTurnStarted/PageTurnFinished. Panning relates to user interaction with
44 * the screen while page turning refers to animation of the page. There are three scenarios for these
45 * events: normal page turn (forwards or backwards), aborted page turn (forwards or backwards)
46 * and pan with no animation. The order of events is as follows:
47 * 1) Normal page turn: PagePanStarted -> PageTurnStarted direction -> PagePanFinished -> PageTurnFinished direction
48 * 2) Aborted page turn: PagePanStarted -> PageTurnStarted direction -> PageTurnStarted opposite direction
49 * -> PagePanFinished -> PageTurnFinished opposite direction
50 * 3) Pan with no animation: PagePanStarted -> PagePanFinished
51 * Pan with no animation will occur when the user touches the page in an area that does not start the
55 * | %Signal Name | Method |
56 * |------------------|-------------------------------|
57 * | pageTurnStarted | @ref PageTurnStartedSignal() |
58 * | pageTurnFinished | @ref PageTurnFinishedSignal() |
59 * | pagePanStarted | @ref PagePanStartedSignal() |
60 * | pagePanFinished | @ref PagePanFinishedSignal() |
64 class DALI_TOOLKIT_API PageTurnView : public Control
68 * @brief The start and end property ranges for this control.
73 PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_1.4
74 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices @SINCE_1_1.4
81 VIEW_PAGE_SIZE = PROPERTY_START_INDEX, ///< name "viewPageSize", type Vector2 @SINCE_1_1.4
82 CURRENT_PAGE_ID, ///< name "currentPageId", type Integer @SINCE_1_1.4
85 * The two values are the major&minor radius (in pixels) to form an ellipse shape.
86 * The top-left quarter of this ellipse is used to calculate spine normal for simulating shadow.
88 SPINE_SHADOW, ///< name "spineShadow", type Vector2 @SINCE_1_1.4
93 * @brief Creates an empty PageTurnView handle. Only derived versions can be instantiated.
94 * Calling member function with an uninitialized handle is not allowed.
100 * @brief Copy constructor. Creates another handle that points to the same real object
102 * @param[in] handle Handle to copy from
104 PageTurnView(const PageTurnView& handle);
107 * @brief Assignment operator. Changes this handle to point to another real object
110 PageTurnView& operator=(const PageTurnView& handle);
115 * This is non-virtual since derived Handle types must not contain data or virtual methods.
121 * @brief Downcast an Object handle to PageTurnView.
122 * If handle points to an PageTurnView the downcast produces valid handle.
123 * If not the returned handle is left uninitialized.
125 * @param[in] handle Handle to an object
126 * @return handle to a PageTurnView or an uninitialized handle
128 static PageTurnView DownCast(BaseHandle handle);
131 // Page Turned signal, with page index and boolean turning direction (true = forward, false = backward)
132 typedef Signal<void(PageTurnView, unsigned int, bool)> PageTurnSignal;
133 typedef Signal<void(PageTurnView)> PagePanSignal;
136 * @brief Signal emitted when a page has started to turn over.
137 * A callback of the following type may be connected:
139 * void YourCallBackName( PageTurnView pageTurnView, unsigned int pageIndex, bool isTurningForward );
142 * @return The signal to connect to
144 PageTurnSignal& PageTurnStartedSignal();
147 * @brief Signal emitted when a page has finished turning over.
148 * A callback of the following type may be connected:
150 * void YourCallBackName( PageTurnView pageTurnView, unsigned int pageIndex, bool isTurningForward );
153 * @return The signal to connect to
155 PageTurnSignal& PageTurnFinishedSignal();
158 * @brief Signal emitted when a page pan has commenced
159 * A callback of the following type may be connected:
161 * void YourCallBackName( PageTurnView pageTurnView );
164 * @return The signal to connect to
166 PagePanSignal& PagePanStartedSignal();
169 * @brief Signal emitted when a page pan has finished
170 * A callback of the following type may be connected:
172 * void YourCallBackName( PageTurnView pageTurnView );
175 * @return The signal to connect to
177 PagePanSignal& PagePanFinishedSignal();
179 public: // Not intended for application developers
182 * @brief Creates a handle using the Toolkit::Internal implementation.
184 * @param[in] implementation The Control implementation.
186 DALI_INTERNAL PageTurnView(Internal::PageTurnView& implementation);
189 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
191 * @param[in] internal A pointer to the internal CustomActor.
193 explicit DALI_INTERNAL PageTurnView(Dali::Internal::CustomActor* internal);
197 } // namespace Toolkit
201 #endif /* DALI_TOOLKIT_PAGE_TURN_VIEW_H */