1 #ifndef __DALI_TOOLKIT_PAGE_TURN_VIEW_H__
2 #define __DALI_TOOLKIT_PAGE_TURN_VIEW_H__
5 * Copyright (c) 2015 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 // Forward declarations
33 namespace Internal DALI_INTERNAL
39 * @brief PageTurnView is a base class of different mode of pageTurnViews ( portrait or landscape )
41 * Page actors are provided from an external PageFactory
42 * PanGesture is used to activate the page bending, streching and tuning forward/backward
44 * Signal usage: There are four signals. Two matching pairs for panning and page turning:
45 * PagePanStarted/PagePanFinished and PageTurnStarted/PageTurnFinished. Panning relates to user interaction with
46 * the screen while page turning refers to animation of the page. There are three scenarios for these
47 * events: normal page turn (forwards or backwards), aborted page turn (forwards or backwards)
48 * and pan with no animation. The order of events is as follows:
49 * 1) Normal page turn: PagePanStarted -> PageTurnStarted direction -> PagePanFinished -> PageTurnFinished direction
50 * 2) Aborted page turn: PagePanStarted -> PageTurnStarted direction -> PageTurnStarted opposite direction
51 * -> PagePanFinished -> PageTurnFinished opposite direction
52 * 3) Pan with no animation: PagePanStarted -> PagePanFinished
53 * Pan with no animation will occur when the user touches the page in an area that does not start the
57 * | %Signal Name | Method |
58 * |------------------|-------------------------------|
59 * | pageTurnStarted | @ref PageTurnStartedSignal() |
60 * | pageTurnFinished | @ref PageTurnFinishedSignal() |
61 * | pagePanStarted | @ref PagePanStartedSignal() |
62 * | pagePanFinished | @ref PagePanFinishedSignal() |
66 class DALI_IMPORT_API PageTurnView : public Control
71 * @brief The start and end property ranges for this control.
76 PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_1.4
77 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices @SINCE_1_1.4
84 PAGE_SIZE = PROPERTY_START_INDEX, ///< name "pageSize", type Vector2 @SINCE_1_1.4
85 CURRENT_PAGE_ID, ///< name "currentPageId", type Integer @SINCE_1_1.4
88 * The two values are the major&minor radius (in pixels) to form an ellipse shape.
89 * The top-left quarter of this ellipse is used to calculate spine normal for simulating shadow.
91 SPINE_SHADOW, ///< name "spineShadow", type Vector2 @SINCE_1_1.4
96 * @brief Creates an empty PageTurnView handle. Only derived versions can be instantiated.
97 * Calling member function with an uninitialized handle is not allowed.
103 * @brief Copy constructor. Creates another handle that points to the same real object
105 * @param[in] handle Handle to copy from
107 PageTurnView( const PageTurnView& handle );
110 * @brief Assignment operator. Changes this handle to point to another real object
113 PageTurnView& operator=( const PageTurnView& handle );
118 * This is non-virtual since derived Handle types must not contain data or virtual methods.
124 * @brief Downcast an Object handle to PageTurnView.
125 * If handle points to an PageTurnView the downcast produces valid handle.
126 * If not the returned handle is left uninitialized.
128 * @param[in] handle Handle to an object
129 * @return handle to a PageTurnView or an uninitialized handle
131 static PageTurnView DownCast( BaseHandle handle );
135 // Page Turned signal, with page index and boolean turning direction (true = forward, false = backward)
136 typedef Signal< void ( PageTurnView, unsigned int, bool ) > PageTurnSignal;
137 typedef Signal< void ( PageTurnView ) > PagePanSignal;
140 * @brief Signal emitted when a page has started to turn over.
141 * A callback of the following type may be connected:
143 * void YourCallBackName( PageTurnView pageTurnView, unsigned int pageIndex, bool isTurningForward );
146 * @return The signal to connect to
148 PageTurnSignal& PageTurnStartedSignal();
151 * @brief Signal emitted when a page has finished turning over.
152 * A callback of the following type may be connected:
154 * void YourCallBackName( PageTurnView pageTurnView, unsigned int pageIndex, bool isTurningForward );
157 * @return The signal to connect to
159 PageTurnSignal& PageTurnFinishedSignal();
162 * @brief Signal emitted when a page pan has commenced
163 * A callback of the following type may be connected:
165 * void YourCallBackName( PageTurnView pageTurnView );
168 * @return The signal to connect to
170 PagePanSignal& PagePanStartedSignal();
173 * @brief Signal emitted when a page pan has finished
174 * A callback of the following type may be connected:
176 * void YourCallBackName( PageTurnView pageTurnView );
179 * @return The signal to connect to
181 PagePanSignal& PagePanFinishedSignal();
183 public: // Not intended for application developers
186 * @brief Creates a handle using the Toolkit::Internal implementation.
188 * @param[in] implementation The Control implementation.
190 DALI_INTERNAL PageTurnView(Internal::PageTurnView& implementation);
193 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
195 * @param[in] internal A pointer to the internal CustomActor.
197 explicit DALI_INTERNAL PageTurnView(Dali::Internal::CustomActor* internal);
200 } // namespace Toolkit
204 #endif /* __DALI_TOOLKIT_PAGE_TURN_VIEW_H__ */