1 #ifndef DALI_DEMO_TABLEVIEW_H
2 #define DALI_DEMO_TABLEVIEW_H
5 * Copyright (c) 2019 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.
21 #include <dali/dali.h>
22 #include <dali-toolkit/dali-toolkit.h>
23 #include <dali-toolkit/devel-api/controls/popup/popup.h>
27 typedef std::vector<Example> ExampleList;
28 typedef ExampleList::iterator ExampleListIter;
29 typedef ExampleList::const_iterator ExampleListConstIter;
31 typedef std::vector<Dali::Animation> AnimationList;
32 typedef AnimationList::iterator AnimationListIter;
33 typedef AnimationList::const_iterator AnimationListConstIter;
38 * Represents a single Example.
45 * @param[in] name unique name of example
46 * @param[in] title The caption for the example to appear on a tile button.
48 Example(std::string name, std::string title)
60 std::string name; ///< unique name of example
61 std::string title; ///< title (caption) of example to appear on tile button.
69 class DaliTableView : public Dali::ConnectionTracker
73 DaliTableView(Dali::Application& application);
79 * Adds an Example to our demo showcase
81 * @param[in] example The Example description.
83 * @note Should be called before the Application MainLoop is started.
85 void AddExample(Example example);
88 * Sorts the example list alphabetically by Title if parameter is true.
90 * @param[in] sortAlphabetically If true, example list is sorted alphabetically.
92 * @note Should be called before the Application MainLoop is started.
93 * @note By default the examples are NOT sorted alphabetically by Title.
95 void SortAlphabetically( bool sortAlphabetically );
97 private: // Application callbacks & implementation
99 static const unsigned int FOCUS_ANIMATION_ACTOR_NUMBER = 2; ///< The number of elements used to form the custom focus effect
102 * Shape enum for create function
111 * Initialize application.
113 * @param[in] app Application instance
115 void Initialize( Dali::Application& app );
118 * Populates the contents (ScrollView) with all the
119 * Examples that have been Added using the AddExample(...)
125 * Rotates RootActor orientation to that specified.
127 * @param[in] degrees The requested angle.
129 void Rotate( unsigned int degrees );
132 * Creates a tile for the main menu.
134 * @param[in] name The unique name for this Tile
135 * @param[in] title The text caption that appears on the Tile
136 * @param[in] parentSize Tile's parent size.
137 * @param[in] position The tiles relative position within a page
139 * @return The Actor for the created tile.
141 Dali::Actor CreateTile( const std::string& name, const std::string& title, const Dali::Vector3& sizeMultiplier, Dali::Vector2& position );
146 * Signal emitted when any tile has been pressed
148 * @param[in] actor The Actor representing this tile.
149 * @param[in] event The Touch information.
151 * @return Consume flag
153 bool OnTilePressed( Dali::Actor actor, const Dali::TouchData& event );
156 * Called by OnTilePressed & Accessibility to do the appropriate action.
158 * @param[in] actor The Actor representing this tile.
159 * @param[in] state The Touch state
161 * @return Consume flag
163 bool DoTilePress( Dali::Actor actor, Dali::PointState::Type state );
166 * Signal emitted when any tile has been hovered
168 * @param[in] actor The Actor representing this tile.
169 * @param[in] event The HoverEvent
171 * @return Consume flag
173 bool OnTileHovered( Dali::Actor actor, const Dali::HoverEvent& event );
176 * Signal emitted when the pressed animation has completed.
178 * @param[in] source The animation source.
180 void OnPressedAnimationFinished(Dali::Animation& source);
183 * Signal emitted when the button has been clicked
185 * @param[in] button The Button that is clicked.
187 * @return Consume flag
189 bool OnButtonClicked( Dali::Toolkit::Button& button );
192 * Signal emitted when scrolling has started.
194 * @param[in] position The current position of the scroll contents.
196 void OnScrollStart(const Dali::Vector2& position);
199 * Signal emitted when scrolling has completed.
201 * @param[in] position The current position of the scroll contents.
203 void OnScrollComplete(const Dali::Vector2& position);
206 * Signal emitted when any Sensitive Actor has been touched
207 * (other than those touches consumed by OnTilePressed)
209 * @param[in] actor The Actor touched.
210 * @param[in] event The Touch information.
212 * @return Consume flag
214 bool OnScrollTouched( Dali::Actor actor, const Dali::TouchData& event );
217 * Setup the effect on the scroll view
219 void ApplyScrollViewEffect();
222 * Apply the cube effect to all the page actors
224 void ApplyCubeEffectToPages();
227 * Setup the inner cube effect
229 void SetupInnerPageCubeEffect();
232 * Apply a shader effect to a table tile
234 void ApplyEffectToTile(Dali::Actor tile);
237 * Apply effect to the content of a tile
239 void ApplyEffectToTileContent(Dali::Actor tileContent);
244 void OnKeyEvent( const Dali::KeyEvent& event );
247 * Create a depth field background
249 * @param[in] bubbleLayer Add the graphics to this layer
251 void SetupBackground( Dali::Actor bubbleLayer );
254 * Create background actors for the given layer
256 * @param[in] layer The layer to add the actors to
257 * @param[in] count The number of actors to generate
259 void AddBackgroundActors( Dali::Actor layer, int count );
262 * Timer handler for ending background animation
264 * @return Return value for timer handler
266 bool PauseBackgroundAnimation();
269 * Pause all animations
271 void PauseAnimation();
274 * Resume all animations
276 void PlayAnimation();
279 * @brief Creates and sets up the custom effect used for the keyboard (and mouse) focus.
281 void CreateFocusEffect();
284 * Callback when the keyboard focus is going to be changed.
286 * @param[in] current The current focused actor
287 * @param[in] proposed The actor proposed by the keyboard focus manager to move the focus to
288 * @param[in] direction The direction to move the focus
289 * @return The actor to move the keyboard focus to.
291 Dali::Actor OnKeyboardPreFocusChange( Dali::Actor current, Dali::Actor proposed, Dali::Toolkit::Control::KeyboardFocus::Direction direction );
294 * Callback when the keyboard focused actor is activated.
296 * @param[in] activatedActor The activated actor
298 void OnFocusedActorActivated( Dali::Actor activatedActor );
301 * Callback when the keyboard focus indicator is enabled.
303 * @param[in] actor The keyboard focus indicator.
305 void OnFocusIndicatorEnabled( Dali::Actor actor );
308 * Callback when the keyboard focus indicator is disabled.
310 * @param[in] actor The keyboard focus indicator.
312 void OnFocusIndicatorDisabled( Dali::Actor actor );
315 * Called when the logo is tapped
317 * @param[in] actor The tapped actor
318 * @param[in] tap The tap information.
320 void OnLogoTapped( Dali::Actor actor, const Dali::TapGesture& tap );
325 void HideVersionPopup();
328 * @brief Callback called when the buttons page actor is relaid out
330 * @param[in] actor The page actor
332 void OnButtonsPageRelayout( const Dali::Actor& actor );
335 * @brief The is connected to the keyboard focus highlight actor, and called when it is placed on stage.
336 * @param[in] actor The actor that has been placed on stage.
338 void OnStageConnect( Dali::Actor actor );
341 * @brief Callback called to set up background actors
343 * @param[in] actor The actor raising the callback
345 void InitialiseBackgroundActors( Dali::Actor actor );
349 Dali::Application& mApplication; ///< Application instance.
350 Dali::Toolkit::Control mRootActor; ///< All content (excluding background is anchored to this Actor)
351 Dali::Animation mRotateAnimation; ///< Animation to rotate and resize mRootActor.
352 Dali::Animation mPressedAnimation; ///< Button press scaling animation.
353 Dali::Toolkit::ScrollView mScrollView; ///< ScrollView container (for all Examples)
354 Dali::Toolkit::ScrollViewEffect mScrollViewEffect; ///< Effect to be applied to the scroll view
355 Dali::Toolkit::RulerPtr mScrollRulerX; ///< ScrollView X (horizontal) ruler
356 Dali::Toolkit::RulerPtr mScrollRulerY; ///< ScrollView Y (vertical) ruler
357 Dali::Actor mPressedActor; ///< The currently pressed actor.
358 Dali::Timer mAnimationTimer; ///< Timer used to turn off animation after a specific time period
359 Dali::TapGestureDetector mLogoTapDetector; ///< To detect taps on the logo
360 Dali::Toolkit::Popup mVersionPopup; ///< Displays DALi library version information
363 * This struct encapsulates all data relevant to each of the elements used within the custom keyboard focus effect.
367 Dali::Toolkit::ImageView actor; ///< The parent keyboard focus highlight actor
368 Dali::Animation animation; ///< The animation for the parent keyboard focus highlight actor
370 FocusEffect mFocusEffect[FOCUS_ANIMATION_ACTOR_NUMBER]; ///< The elements used to create the custom focus effect
372 std::vector< Dali::Actor > mPages; ///< List of pages.
373 AnimationList mBackgroundAnimations; ///< List of background bubble animations
374 ExampleList mExampleList; ///< List of examples.
376 float mPageWidth; ///< The width of a page within the scroll-view, used to calculate the domain
377 int mTotalPages; ///< Total pages within scrollview.
379 bool mScrolling:1; ///< Flag indicating whether view is currently being scrolled
380 bool mSortAlphabetically:1; ///< Sort examples alphabetically.
381 bool mBackgroundAnimsPlaying:1; ///< Are background animations playing
385 #endif // DALI_DEMO_TABLEVIEW_H