1 #ifndef __DALI_TOOLKIT_INTERNAL_POPUP_H__
2 #define __DALI_TOOLKIT_INTERNAL_POPUP_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/public-api/actors/image-actor.h>
23 #include <dali/public-api/actors/layer.h>
24 #include <dali/public-api/adaptor-framework/timer.h>
25 #include <dali/public-api/animation/animation.h>
26 #include <dali/devel-api/animation/animation-data.h>
29 #include <dali-toolkit/public-api/controls/control-impl.h>
30 #include <dali-toolkit/public-api/controls/table-view/table-view.h>
31 #include <dali-toolkit/devel-api/controls/popup/popup.h>
44 typedef IntrusivePtr< Popup > PopupPtr;
47 * @copydoc Toolkit::Popup
49 class Popup : public Control
55 * @return A public handle to the newly allocated Popup.
57 static Dali::Toolkit::Popup New();
62 * @copydoc Toolkit::Popup::SetPopupBackgroundImage
64 void SetPopupBackgroundImage( Actor image );
67 * @copydoc Toolkit::Popup::GetPopupBackgroundImage
69 Actor GetPopupBackgroundImage() const;
72 * @copydoc Toolkit::Popup::SetTitle( Actor titleActor )
74 void SetTitle( Actor titleActor );
77 * @copydoc Toolkit::Popup::GetTitle
79 Actor GetTitle() const;
82 * @copydoc Toolkit::Popup::SetContent
84 void SetContent( Actor content );
87 * @copydoc Toolkit::Popup::GetContent
89 Actor GetContent() const;
92 * @copydoc Toolkit::Popup::SetFooter
94 void SetFooter( Actor control );
97 * @copydoc Toolkit::Popup::GetFooter
99 Actor GetFooter() const;
102 * @copydoc Toolkit::Popup::SetDisplayState
104 void SetDisplayState( Toolkit::Popup::DisplayState displayState );
107 * @copydoc Toolkit::Popup::GetDisplayState
109 Toolkit::Popup::DisplayState GetDisplayState() const;
112 * @copydoc Toolkit::Popup::SetTailVisibility
114 void SetTailVisibility( bool visible );
117 * @copydoc Toolkit::Popup::IsTailVisible
119 const bool IsTailVisible() const;
122 * @copydoc Toolkit::Popup::SetTailPosition
124 void SetTailPosition( Vector3 position );
127 * @copydoc Toolkit::Popup::GetTailPosition
129 const Vector3& GetTailPosition() const;
132 * @copydoc Toolkit::Popup::SetContextualMode
134 void SetContextualMode( Toolkit::Popup::ContextualMode mode );
137 * @copydoc Toolkit::Popup::GetContextualMode
139 Toolkit::Popup::ContextualMode GetContextualMode() const;
142 * @copydoc Toolkit::Popup::SetAnimationDuration
144 void SetAnimationDuration( float duration );
147 * @copydoc Toolkit::Popup::GetAnimationDuration
149 float GetAnimationDuration() const;
152 * @copydoc Toolkit::Popup::SetAnimationMode
154 void SetAnimationMode( Toolkit::Popup::AnimationMode animationMode );
157 * @copydoc Toolkit::Popup::GetAnimationMode
159 Toolkit::Popup::AnimationMode GetAnimationMode() const;
162 * @copydoc Toolkit::Popup::SetAutoHideDelay
164 void SetAutoHideDelay( int delay );
167 * @copydoc Toolkit::Popup::GetAutoHideDelay
169 int GetAutoHideDelay() const;
172 * @copydoc Toolkit::Popup::SetBackingEnabled
174 void SetBackingEnabled( bool enabled );
177 * @copydoc Toolkit::Popup::IsBackingEnabled
179 const bool IsBackingEnabled() const;
182 * @copydoc Toolkit::Popup::SetBackingColor
184 void SetBackingColor( Vector4 color );
187 * @copydoc Toolkit::Popup::GetBackingColor
189 const Vector4& GetBackingColor() const;
192 * @copydoc Toolkit::Popup::SetTailUpImage
194 void SetTailUpImage( std::string image );
197 * @copydoc Toolkit::Popup::GetTailUpImage
199 const std::string& GetTailUpImage() const;
202 * @copydoc Toolkit::Popup::SetTailDownImage
204 void SetTailDownImage( std::string image );
207 * @copydoc Toolkit::Popup::GetTailDownImage
209 const std::string& GetTailDownImage() const;
212 * @copydoc Toolkit::Popup::SetTailLeftImage
214 void SetTailLeftImage( std::string image );
217 * @copydoc Toolkit::Popup::GetTailLeftImage
219 const std::string& GetTailLeftImage() const;
222 * @copydoc Toolkit::Popup::SetTailRightImage
224 void SetTailRightImage( std::string image );
227 * @copydoc Toolkit::Popup::GetTailRightImage
229 const std::string& GetTailRightImage() const;
232 * Called when a property of an object of this type is set.
233 * @param[in] object The object whose property is set.
234 * @param[in] propertyIndex The property index.
235 * @param[in] value The new property value.
237 static void SetProperty( BaseObject* object, Property::Index propertyIndex, const Property::Value& value );
240 * Called to retrieve a property of an object of this type.
241 * @param[in] object The object whose property is to be retrieved.
242 * @param[in] propertyIndex The property index.
243 * @return The current value of the property.
245 static Property::Value GetProperty( BaseObject* object, Property::Index propertyIndex );
250 * Construct a new Popup.
255 * A reference counted object may only be deleted by calling Unreference()
262 * @brief Creates the layout of the popup, to be done just before showing for the first time.
263 * Also calls OnLayoutSetup() to allow derived classes to perform layout at this stage.
268 * @brief Creates or destroys the popup tail based on the current TAIL_DISPLAYED property.
269 * Also uses the TAIL_POSITION property to position it.
274 * @brief Performs any relative positioning required based on the current contextual mode, if set.
275 * If contextual mode is not enabled, this method has no effect.
276 * @param[in] size The Popups current size (can be accessed from within the OnRelayout() method).
278 void LayoutContext( const Vector2& size );
281 * @brief All transition-in animation setup and layout is done here.
282 * Different types of animation mode require different layouts to work,
283 * this function encapsulates anything animation-mode specific.
284 * This is called once for multiple displays/hides of the pops.
285 * It is only re-called when the layout becomes dirty.
287 void LayoutAnimation();
290 * @brief Initiates a transition-in or transition-out animation based
291 * on the current animation settings.
292 * @param[in] transitionIn True to perform a transition-in, false for transition out.
293 * @param[in] instantaneous Optional - If set to true will override the duration to provide an instant animation.
295 void StartTransitionAnimation( bool transitionIn, bool instantaneous = false );
298 * @brief Invoked once a display state change has completed.
300 void DisplayStateChangeComplete();
303 * @brief This is called when the auto-hide timer finishes.
304 * It performs a display-state change to HIDDEN.
305 * @return True as signal is consumed.
307 bool OnAutoHideTimeReached();
310 * @brief Create Dimmed Backing (covers all content behind the dialog).
312 * @return The backing control.
314 Toolkit::Control CreateBacking();
317 * @brief Creates the lower area within the popup.
322 * @brief Sets if the popup allows touch events to pass through or not.
324 * @param[in] enabled Set to true to make the popup touch-transparent.
326 void SetTouchTransparent( bool enabled );
329 * @brief Returns if the popup allows touch events to pass through or not.
331 * @return True if the popup is touch-transparent.
333 const bool IsTouchTransparent() const;
336 * @brief Allows the popup entry animation to be setup from a Property::Map that could
337 * originate, for example, from a JSON file.
339 * @param[in] map A Property::Map containing a description of an animation
341 void SetEntryAnimationData( const Property::Map& map );
344 * @brief Allows the popup exit animation to be setup from a Property::Map that could
345 * originate, for example, from a JSON file.
347 * @param[in] map A Property::Map containing a description of an animation
349 void SetExitAnimationData( const Property::Map& map );
354 * @copydoc Dali::Toolkit::Popup::OutsideTouchedSignal()
356 Toolkit::Popup::TouchedOutsideSignalType& OutsideTouchedSignal();
359 * @copydoc Dali::Toolkit::Popup::ShowingSignal()
361 Toolkit::Popup::DisplayStateChangeSignalType& ShowingSignal();
364 * @copydoc Dali::Toolkit::Popup::ShownSignal()
366 Toolkit::Popup::DisplayStateChangeSignalType& ShownSignal();
369 * @copydoc Dali::Toolkit::Popup::HidingSignal()
371 Toolkit::Popup::DisplayStateChangeSignalType& HidingSignal();
374 * @copydoc Dali::Toolkit::Popup::HiddenSignal()
376 Toolkit::Popup::DisplayStateChangeSignalType& HiddenSignal();
379 * Connects a callback function with the object's signals.
380 * @param[in] object The object providing the signal.
381 * @param[in] tracker Used to disconnect the signal.
382 * @param[in] signalName The signal to connect to.
383 * @param[in] functor A newly allocated FunctorDelegate.
384 * @return True if the signal was connected.
385 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
387 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
392 * Signal occurs when the State animation (transition from hide <-> show) finishes.
393 * @param[in] source The animation that just finished.
395 void OnDisplayChangeAnimationFinished( Animation& source );
398 * Signal occurs when the dimmed backing for the Popup is touched.
399 * @param[in] actor The Actor Touched
400 * @param[in] event The Touch Event.
401 * @return Whether to consume event or not.
403 bool OnBackingTouched(Actor actor, const TouchEvent& event);
406 * Signal occurs when a mouse wheel event occurs on the dimmed backing.
407 * @param[in] actor The Actor that got the wheel event.
408 * @param[in] event The Wheel Event.
409 * @return Whether to consume event or not.
411 bool OnBackingWheelEvent(Actor actor, const WheelEvent& event);
414 * Signal occurs when the dialog has been touched.
415 * @param[in] actor The Actor Touched
416 * @param[in] event The Touch Event.
417 * @return Whether to consume event or not.
419 bool OnDialogTouched(Actor actor, const TouchEvent& event);
422 * @copydoc Toolkit::Control::OnInitialize()
424 virtual void OnInitialize();
427 * Called whenever the popup layout is re-set up.
428 * Normally due to a change in contents.
429 * Note: This is only done when the popup is shown.
431 virtual void OnLayoutSetup() {}
434 * Called when the popup is directly or indirectly parented to the stage.
436 virtual void OnControlStageConnection();
439 * From Control; called after a child has been added to the owning actor.
440 * @param[in] child The child which has been added.
442 virtual void OnControlChildAdd( Actor& child );
445 * @copydoc Control::OnRelayOut()
447 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
450 * @copydoc Control::OnSetResizePolicy()
452 virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
455 * @copydoc Control::GetNaturalSize()
457 virtual Vector3 GetNaturalSize();
460 * @copydoc Control::GetHeightForWidth()
462 virtual float GetHeightForWidth( float width );
465 * @copydoc Control::GetWidthForHeight()
467 virtual float GetWidthForHeight( float height );
470 * @copydoc Control::OnKeyEvent()
472 virtual bool OnKeyEvent( const KeyEvent& event );
475 * @copydoc Control::GetNextKeyboardFocusableActor()
477 Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled );
485 Popup& operator=(const Popup& rhs);
489 Toolkit::Popup::TouchedOutsideSignalType mTouchedOutsideSignal;
490 Toolkit::Popup::DisplayStateChangeSignalType mShowingSignal;
491 Toolkit::Popup::DisplayStateChangeSignalType mShownSignal;
492 Toolkit::Popup::DisplayStateChangeSignalType mHidingSignal;
493 Toolkit::Popup::DisplayStateChangeSignalType mHiddenSignal;
495 Layer mLayer; ///< Popup Layer (i.e. Dim backing and PopupBg reside in this).
496 Toolkit::TableView mPopupLayout; ///< Popup Background (i.e. dialog reside in this).
497 Toolkit::Control mBacking; ///< Backing actor (dim effect).
498 Actor mPreviousFocusedActor; ///< Store the previous focused actor to restore the focus when popup hide.
499 Actor mTailImage; ///< Stores the tail image.
500 Actor mPopupContainer; ///< This actor is used to house the background image and the main popup layout.
501 Animation mAnimation; ///< The current animation in use used to manage display state changing.
502 bool mAlterAddedChild; ///< Flag used to control whether children are reparented or not.
503 bool mLayoutDirty; ///< Set to true whenever any property that would require a layout update is modified.
504 Timer mAutoHideTimer; ///< Used to perform an auto-hide of the popup if desired.
505 bool mTouchTransparent; ///< Allows all events to pass through the popup.
507 // Main Content related properties:
508 Actor mTitle; ///< Stores the text title.
509 Actor mContent; ///< Stores the unselected content.
510 Actor mFooter; ///< Stores the footer content (typically controls).
512 // Display related properties.
513 Toolkit::Popup::DisplayState mDisplayState; ///< The current display state of the popup.
514 bool mTailVisible; ///< True if the popup tail should be visible.
515 Vector3 mTailPosition; ///< The position of the tail.
516 Toolkit::Popup::ContextualMode mContextualMode; ///< Allows the popup to be layed out adjacent to its parent in different directions.
517 float mAnimationDuration; ///< The duration of the transition in and out animations.
518 Toolkit::Popup::AnimationMode mAnimationMode; ///< The animation to use to transition in and out.
519 Dali::AnimationData mEntryAnimationData; ///< Stores description data that can be used for generating a custom entry animation.
520 Dali::AnimationData mExitAnimationData; ///< Stores description data that can be used for generating a custom exit animation.
521 unsigned int mAutoHideDelay; ///< If set, will auto-hide the popup after a specified amount of time.
523 // Style related properties:
524 bool mBackingEnabled; ///< True if a dimmed backing will be used.
525 Vector4 mBackingColor; ///< The color of the backing.
526 Actor mPopupBackgroundImage; ///< Stores the background image.
527 Vector4 mBackgroundOuterBorder; ///< Background external border margin size
528 float mMargin; ///< Internal margin for popup contents.
529 std::string mTailUpImage; ///< Image used for the tail for the up direction.
530 std::string mTailDownImage; ///< Image used for the tail for the down direction.
531 std::string mTailLeftImage; ///< Image used for the tail for the left direction.
532 std::string mTailRightImage; ///< Image used for the tail for the right direction.
535 } // namespace Internal
537 // Helpers for public-api forwarding methods
539 inline Toolkit::Internal::Popup& GetImpl( Toolkit::Popup& publicObject )
541 DALI_ASSERT_ALWAYS( publicObject );
543 Dali::RefObject& handle = publicObject.GetImplementation();
545 return static_cast<Toolkit::Internal::Popup&>( handle );
548 inline const Toolkit::Internal::Popup& GetImpl( const Toolkit::Popup& publicObject )
550 DALI_ASSERT_ALWAYS( publicObject );
552 const Dali::RefObject& handle = publicObject.GetImplementation();
554 return static_cast<const Toolkit::Internal::Popup&>( handle );
557 } // namespace Toolkit
561 #endif // __DALI_TOOLKIT_INTERNAL_POPUP_H__