Merge "Add a callback for navigation policy in web view." into devel/master
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / popup / popup-impl.h
old mode 100755 (executable)
new mode 100644 (file)
index 099e5e6..50a2fd6
@@ -1,8 +1,8 @@
-#ifndef __DALI_TOOLKIT_INTERNAL_POPUP_H__
-#define __DALI_TOOLKIT_INTERNAL_POPUP_H__
+#ifndef DALI_TOOLKIT_INTERNAL_POPUP_H
+#define DALI_TOOLKIT_INTERNAL_POPUP_H
 
 /*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2021 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  */
 
 // EXTERNAL INCLUDES
-#include <dali/public-api/actors/image-actor.h>
+#include <dali/devel-api/animation/animation-data.h>
 #include <dali/public-api/actors/layer.h>
+#include <dali/public-api/adaptor-framework/timer.h>
 #include <dali/public-api/animation/animation.h>
 
 // INTERNAL INCLUDES
-#include <dali-toolkit/public-api/controls/control-impl.h>
-#include <dali-toolkit/public-api/controls/table-view/table-view.h>
-#include <dali-toolkit/public-api/controls/text-controls/text-label.h>
+#include <dali-toolkit/devel-api/controls/control-devel.h>
 #include <dali-toolkit/devel-api/controls/popup/popup.h>
-#include <dali-toolkit/internal/controls/popup/popup-style-impl.h>
+#include <dali-toolkit/devel-api/controls/table-view/table-view.h>
+#include <dali-toolkit/internal/controls/control/control-data-impl.h>
+#include <dali-toolkit/public-api/controls/control-impl.h>
 
 namespace Dali
 {
-
 namespace Toolkit
 {
-
-class Button;
-
 namespace Internal
 {
-
 class Popup;
-class PopupStyle;
 
-typedef IntrusivePtr<Popup>    PopupPtr;
-typedef IntrusivePtr<PopupStyle> PopupStylePtr;
+typedef IntrusivePtr<Popup> PopupPtr;
 
 /**
  * @copydoc Toolkit::Popup
@@ -53,7 +47,6 @@ typedef IntrusivePtr<PopupStyle> PopupStylePtr;
 class Popup : public Control
 {
 public:
-
   /**
    * Create a new Popup.
    * @return A public handle to the newly allocated Popup.
@@ -61,83 +54,205 @@ public:
   static Dali::Toolkit::Popup New();
 
 public:
+  /**
+   * @copydoc Toolkit::Popup::SetPopupBackgroundImage
+   */
+  void SetPopupBackgroundImage(Actor image);
 
   /**
-   * Returns number of buttons added to Popup
-   *
-   * @return Number of buttons
+   * @copydoc Toolkit::Popup::GetPopupBackgroundImage
    */
-  size_t GetButtonCount() const;
+  Actor GetPopupBackgroundImage() const;
 
   /**
-   * @copydoc Toolkit::Popup::SetBackgroundImage
+   * @copydoc Toolkit::Popup::SetTitle( Actor titleActor )
    */
-  void SetBackgroundImage( Actor image );
+  void SetTitle(Actor titleActor);
 
   /**
-   * @copydoc Toolkit::Popup::SetButtonAreaImage
+   * @copydoc Toolkit::Popup::GetTitle
    */
-  void SetButtonAreaImage( Actor image );
+  Actor GetTitle() const;
 
   /**
-   * @copydoc Toolkit::Popup::SetTitle( const std::string& text );
+   * @copydoc Toolkit::Popup::SetContent
    */
-  void SetTitle( const std::string& text );
+  void SetContent(Actor content);
 
   /**
-   * @copydoc Toolkit::Popup::GetTitle
+   * @copydoc Toolkit::Popup::GetContent
+   */
+  Actor GetContent() const;
+
+  /**
+   * @copydoc Toolkit::Popup::SetFooter
+   */
+  void SetFooter(Actor control);
+
+  /**
+   * @copydoc Toolkit::Popup::GetFooter
+   */
+  Actor GetFooter() const;
+
+  /**
+   * @copydoc Toolkit::Popup::SetDisplayState
+   */
+  void SetDisplayState(Toolkit::Popup::DisplayState displayState);
+
+  /**
+   * @copydoc Toolkit::Popup::GetDisplayState
+   */
+  Toolkit::Popup::DisplayState GetDisplayState() const;
+
+  /**
+   * @copydoc Toolkit::Popup::SetTailVisibility
+   */
+  void SetTailVisibility(bool visible);
+
+  /**
+   * @copydoc Toolkit::Popup::IsTailVisible
+   */
+  const bool IsTailVisible() const;
+
+  /**
+   * @copydoc Toolkit::Popup::SetTailPosition
+   */
+  void SetTailPosition(Vector3 position);
+
+  /**
+   * @copydoc Toolkit::Popup::GetTailPosition
+   */
+  const Vector3& GetTailPosition() const;
+
+  /**
+   * @copydoc Toolkit::Popup::SetContextualMode
+   */
+  void SetContextualMode(Toolkit::Popup::ContextualMode mode);
+
+  /**
+   * @copydoc Toolkit::Popup::GetContextualMode
+   */
+  Toolkit::Popup::ContextualMode GetContextualMode() const;
+
+  /**
+   * @copydoc Toolkit::Popup::SetAnimationDuration
+   */
+  void SetAnimationDuration(float duration);
+
+  /**
+   * @copydoc Toolkit::Popup::GetAnimationDuration
+   */
+  float GetAnimationDuration() const;
+
+  /**
+   * @copydoc Toolkit::Popup::SetAnimationMode
+   */
+  void SetAnimationMode(Toolkit::Popup::AnimationMode animationMode);
+
+  /**
+   * @copydoc Toolkit::Popup::GetAnimationMode
+   */
+  Toolkit::Popup::AnimationMode GetAnimationMode() const;
+
+  /**
+   * @copydoc Toolkit::Popup::SetAutoHideDelay
+   */
+  void SetAutoHideDelay(int delay);
+
+  /**
+   * @copydoc Toolkit::Popup::GetAutoHideDelay
    */
-  std::string GetTitle() const;
+  int GetAutoHideDelay() const;
 
   /**
-   * @copydoc Toolkit::Popup::AddButton
+   * @copydoc Toolkit::Popup::SetBackingEnabled
    */
-  void AddButton( Toolkit::Button button );
+  void SetBackingEnabled(bool enabled);
 
   /**
-   * @copydoc Toolkit::Popup::SetState( PopupState state )
+   * @copydoc Toolkit::Popup::IsBackingEnabled
    */
-  void SetState( Toolkit::Popup::PopupState state );
+  const bool IsBackingEnabled() const;
 
   /**
-   * @copydoc Toolkit::Popup::SetState( PopupState state, float duration )
+   * @copydoc Toolkit::Popup::SetBackingColor
    */
-  void SetState( Toolkit::Popup::PopupState state, float duration );
+  void SetBackingColor(Vector4 color);
 
   /**
-   * @copydoc Toolkit::Popup::GetState( )
+   * @copydoc Toolkit::Popup::GetBackingColor
    */
-  Toolkit::Popup::PopupState GetState() const;
+  const Vector4& GetBackingColor() const;
 
   /**
-   * @copydoc Toolkit::Popup::ShowTail
+   * @copydoc Toolkit::Popup::SetTailUpImage
    */
-  void ShowTail(const Vector3& position);
+  void SetTailUpImage(std::string image);
 
   /**
-   * @copydoc Toolkit::Popup::HideTail
+   * @copydoc Toolkit::Popup::GetTailUpImage
    */
-  void HideTail();
+  const std::string& GetTailUpImage() const;
 
   /**
-   * Sets the style of the popup
-   * @param[in] style The style of the popup
+   * @copydoc Toolkit::Popup::SetTailDownImage
    */
-  void SetStyle(PopupStyle& style);
+  void SetTailDownImage(std::string image);
 
   /**
-   * Gets the style of the popup
-   * @return style of the popup
+   * @copydoc Toolkit::Popup::GetTailDownImage
    */
-  PopupStylePtr GetStyle() const;
+  const std::string& GetTailDownImage() const;
+
+  /**
+   * @copydoc Toolkit::Popup::SetTailLeftImage
+   */
+  void SetTailLeftImage(std::string image);
+
+  /**
+   * @copydoc Toolkit::Popup::GetTailLeftImage
+   */
+  const std::string& GetTailLeftImage() const;
+
+  /**
+   * @copydoc Toolkit::Popup::SetTailRightImage
+   */
+  void SetTailRightImage(std::string image);
+
+  /**
+   * @copydoc Toolkit::Popup::GetTailRightImage
+   */
+  const std::string& GetTailRightImage() const;
+
+  /**
+   * Called when a property of an object of this type is set.
+   * @param[in] object The object whose property is set.
+   * @param[in] propertyIndex The property index.
+   * @param[in] value The new property value.
+   */
+  static void SetProperty(BaseObject* object, Property::Index propertyIndex, const Property::Value& value);
+
+  /**
+   * Called to retrieve a property of an object of this type.
+   * @param[in] object The object whose property is to be retrieved.
+   * @param[in] propertyIndex The property index.
+   * @return The current value of the property.
+   */
+  static Property::Value GetProperty(BaseObject* object, Property::Index propertyIndex);
 
 protected:
+  struct AccessibleImpl : public DevelControl::ControlAccessible
+  {
+    using DevelControl::ControlAccessible::ControlAccessible;
+
+    std::string                 GetNameRaw() const override;
+    Dali::Accessibility::States CalculateStates() override;
+  };
 
   /**
    * Construct a new Popup.
-   * @param[in] style of the popup
    */
-  Popup(PopupStyle& style);
+  Popup();
 
   /**
    * A reference counted object may only be deleted by calling Unreference()
@@ -145,47 +260,126 @@ protected:
   virtual ~Popup();
 
 private:
+  /**
+   * @brief Creates the layout of the popup, to be done just before showing for the first time.
+   * Also calls OnLayoutSetup() to allow derived classes to perform layout at this stage.
+   */
+  void LayoutPopup();
 
   /**
-   * Creates and applies the default background image.
+   * @brief Creates or destroys the popup tail based on the current TAIL_DISPLAYED property.
+   * Also uses the TAIL_POSITION property to position it.
    */
-  void SetDefaultBackgroundImage();
+  void LayoutTail();
 
   /**
-   * Create Dim Backing
-   * (covers all content behind the dialog)
+   * @brief Performs any relative positioning required based on the current contextual mode, if set.
+   * If contextual mode is not enabled, this method has no effect.
+   * @param[in] size The Popups current size (can be accessed from within the OnRelayout() method).
    */
-  void CreateBacking();
+  void LayoutContext(const Vector2& size);
 
   /**
-   * Create Dialog
-   * (dialog content resides inside this - buttons, title etc.)
+   * @brief All transition-in animation setup and layout is done here.
+   * Different types of animation mode require different layouts to work,
+   * this function encapsulates anything animation-mode specific.
+   * This is called once for multiple displays/hides of the pops.
+   * It is only re-called when the layout becomes dirty.
    */
-  void CreateDialog();
+  void LayoutAnimation();
 
   /**
-   * Animate Popup by scaling uniformally from 0 to 100% and vice versa (default behaviour)
-   * @param[in] state The desired state to change into.
-   * @param[in] duration The time for this animation to take.
+   * @brief Initiates a transition-in or transition-out animation based
+   * on the current animation settings.
+   * @param[in] transitionIn True to perform a transition-in, false for transition out.
+   * @param[in] instantaneous Optional - If set to true will override the duration to provide an instant animation.
    */
-  void HandleStateChange( Toolkit::Popup::PopupState state, float duration );
+  void StartTransitionAnimation(bool transitionIn, bool instantaneous = false);
 
   /**
-   * Invoked once StateChange has completed.
+   * @brief Invoked once a display state change has completed.
    */
-  void HandleStateChangeComplete();
+  void DisplayStateChangeComplete();
 
-public: // Signals
+  /**
+   * @brief This is called when the auto-hide timer finishes.
+   * It performs a display-state change to HIDDEN.
+   * @return True as signal is consumed.
+   */
+  bool OnAutoHideTimeReached();
+
+  /**
+   * @brief Create Dimmed Backing (covers all content behind the dialog).
+   *
+   * @return The backing control.
+   */
+  Toolkit::Control CreateBacking();
+
+  /**
+   * @brief Creates the lower area within the popup.
+   */
+  void CreateFooter();
+
+  /**
+   * @brief Sets if the popup allows touch events to pass through or not.
+   *
+   * @param[in] enabled Set to true to make the popup touch-transparent.
+   */
+  void SetTouchTransparent(bool enabled);
+
+  /**
+   * @brief Returns if the popup allows touch events to pass through or not.
+   *
+   * @return True if the popup is touch-transparent.
+   */
+  const bool IsTouchTransparent() const;
+
+  /**
+   * @brief Allows the popup entry animation to be setup from a Property::Map that could
+   * originate, for example, from a JSON file.
+   *
+   * @param[in] map A Property::Map containing a description of an animation
+   */
+  void SetEntryAnimationData(const Property::Map& map);
+
+  /**
+   * @brief Allows the popup exit animation to be setup from a Property::Map that could
+   * originate, for example, from a JSON file.
+   *
+   * @param[in] map A Property::Map containing a description of an animation
+   */
+  void SetExitAnimationData(const Property::Map& map);
 
   /**
+   * @briefs Updates the popup background's position and size.
+   */
+  void UpdateBackgroundPositionAndSize();
+
+public: // Signals
+  /**
    * @copydoc Dali::Toolkit::Popup::OutsideTouchedSignal()
    */
   Toolkit::Popup::TouchedOutsideSignalType& OutsideTouchedSignal();
 
   /**
+   * @copydoc Dali::Toolkit::Popup::ShowingSignal()
+   */
+  Toolkit::Popup::DisplayStateChangeSignalType& ShowingSignal();
+
+  /**
+   * @copydoc Dali::Toolkit::Popup::ShownSignal()
+   */
+  Toolkit::Popup::DisplayStateChangeSignalType& ShownSignal();
+
+  /**
+   * @copydoc Dali::Toolkit::Popup::HidingSignal()
+   */
+  Toolkit::Popup::DisplayStateChangeSignalType& HidingSignal();
+
+  /**
    * @copydoc Dali::Toolkit::Popup::HiddenSignal()
    */
-  Toolkit::Popup::HiddenSignalType& HiddenSignal();
+  Toolkit::Popup::DisplayStateChangeSignalType& HiddenSignal();
 
   /**
    * Connects a callback function with the object's signals.
@@ -196,27 +390,26 @@ public: // Signals
    * @return True if the signal was connected.
    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
    */
-  static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
+  static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
 
 private:
-
   /**
-   * Signal occurs when the State animation (transition from hide<->show) finishes
+   * Signal occurs when the State animation (transition from hide <-> show) finishes.
    * @param[in] source The animation that just finished.
    */
-  void OnStateAnimationFinished( Animation& source );
+  void OnDisplayChangeAnimationFinished(Animation& source);
 
   /**
    * Signal occurs when the dimmed backing for the Popup is touched.
    * @param[in] actor The Actor Touched
-   * @param[in] event The Touch Event.
+   * @param[in] touch The Touch Data.
    * @return Whether to consume event or not.
    */
-  bool OnBackingTouched(Actor actor, const TouchEvent& event);
+  bool OnBackingTouched(Actor actor, const TouchEvent& touch);
 
   /**
-   * Signal occurs when the wheel event is occured on dimmed backing for the Popup.
-   * @param[in] actor The Actor got wheel
+   * Signal occurs when a mouse wheel event occurs on the dimmed backing.
+   * @param[in] actor The Actor that got the wheel event.
    * @param[in] event The Wheel Event.
    * @return Whether to consume event or not.
    */
@@ -225,135 +418,167 @@ private:
   /**
    * Signal occurs when the dialog has been touched.
    * @param[in] actor The Actor Touched
-   * @param[in] event The Touch Event.
+   * @param[in] touch The Touch Data.
    * @return Whether to consume event or not.
    */
-  bool OnDialogTouched(Actor actor, const TouchEvent& event);
+  bool OnDialogTouched(Actor actor, const TouchEvent& touch);
 
   /**
    * @copydoc Toolkit::Control::OnInitialize()
    */
-  virtual void OnInitialize();
+  void OnInitialize() override;
+
+  /**
+   * Called whenever the popup layout is re-set up.
+   * Normally due to a change in contents.
+   * Note: This is only done when the popup is shown.
+   */
+  virtual void OnLayoutSetup()
+  {
+  }
 
   /**
-   * @copydoc Dali::CustomActorImpl::OnPropertySet()
+   * Called when the popup is directly or indirectly parented to the stage.
    */
-  virtual void OnPropertySet( Property::Index index, Property::Value propertyValue );
+  void OnSceneConnection(int depth) override;
 
   /**
    * From Control; called after a child has been added to the owning actor.
    * @param[in] child The child which has been added.
    */
-  virtual void OnControlChildAdd( Actor& child );
+  void OnChildAdd(Actor& child) override;
 
   /**
    * @copydoc Control::OnRelayOut()
    */
-  virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
+  void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
 
   /**
    * @copydoc Control::OnSetResizePolicy()
    */
-  virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
-
-  /**
-   * @copydoc Control::OnKeyEvent()
-   */
-  virtual bool OnKeyEvent(const KeyEvent& event);
+  void OnSetResizePolicy(ResizePolicy::Type policy, Dimension::Type dimension) override;
 
   /**
    * @copydoc Control::GetNaturalSize()
    */
-  virtual Vector3 GetNaturalSize();
+  Vector3 GetNaturalSize() override;
 
   /**
    * @copydoc Control::GetHeightForWidth()
    */
-  float GetHeightForWidth( float width );
+  float GetHeightForWidth(float width) override;
 
   /**
    * @copydoc Control::GetWidthForHeight()
    */
-  float GetWidthForHeight( float height );
+  float GetWidthForHeight(float height) override;
 
   /**
-   * @copydoc Control::GetNextKeyboardFocusableActor()
+   * @copydoc Control::OnKeyEvent()
    */
-  Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled);
+  bool OnKeyEvent(const KeyEvent& event) override;
 
   /**
-   * Create the root actor for the footer
+   * @copydoc Control::GetNextKeyboardFocusableActor()
    */
-  void CreateFooter();
+  Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled);
 
 private:
+  /**
+   * Recursively add any focusable actors or layout containers to the provided vector.
+   * Include the top level actor if it is a layout container.
+   *
+   * @param[in]     parent          The actor to start from
+   * @param[in/out] focusableActors The vector to add focusable actors to
+   */
+  void AddFocusableChildren(Actor parent, std::vector<Actor>& focusableActors);
 
-  // Undefined
-  Popup(const Popup&);
+  /**
+   * Recursively add any focusable actors or layout containers to the provided vector.
+   *
+   * @param[in]     parent          The actor to start from
+   * @param[in/out] focusableActors The vector to add focusable actors to
+   */
+  void AddFocusableChildrenRecursive(Actor parent, std::vector<Actor>& focusableActors);
 
-  // Undefined
-  Popup& operator=(const Popup& rhs);
+  /**
+   * Sets up the touch signals connections as required.
+   * @note This must be called after all the members have been created.
+   */
+  void SetupTouch();
 
 private:
+  // Undefined.
+  Popup(const Popup&);
 
-  struct LayoutInfo
-  {
-    Vector3 mTitleSize;
-    Vector3 mContentSize;
-    Vector3 mButtonBgSize;
-    std::vector<Vector3> mButtonSize;
-  };
+  // Undefined.
+  Popup& operator=(const Popup& rhs);
 
 private:
-
-  bool mShowing;                          ///< Popup is showing or not
-
-  Layer mLayer;                           ///< Popup Layer (i.e. Dim backing and PopupBg reside in this)
-  Toolkit::TableView mPopupLayout;        ///< Popup layout (i.e. dialog reside in this)
-  ImageActor mBacking;                    ///< Backing actor (dim effect)
-
-  Actor mPreviousFocusedActor;            ///< Store the previous focused actor to restore the focus when popup hide
-
-  Actor mBackgroundImage;                 ///< Stores the background image.
-  Actor mButtonAreaImage;                 ///< Stores the button background image.
-  Toolkit::TextLabel mTitle;               ///< Stores the text title.
-  Actor mContent;                         ///< Stores popup's content.
-  Actor mBottomBg;                        ///< bottom button bar background. ImageActor is replaced with Actor due to hidden image.
-  Actor mTailImage;                       ///< Stores the tail image
-
-  std::vector< Actor > mButtons;          ///< Keeps track of the buttons added to this popup.
-  Toolkit::Popup::PopupState mState;      ///< Popup current state.
-  Animation mAnimation;                   ///< The animation instance managing state changing.
-  bool mAlterAddedChild;                  ///< Flag used to control whether children are reparented or not.
-  PopupStylePtr mPopupStyle;              ///< The style to be used for this popup.
-
-  LayoutInfo mLayoutInfo;                 ///< Stores sizes of all popup components.
-
-  Toolkit::Popup::TouchedOutsideSignalType mTouchedOutsideSignal;
-  Toolkit::Popup::HiddenSignalType mHiddenSignal;
-
-  Property::Index mPropertyTitle;         ///< Property index for Title.
-  Property::Index mPropertyState;         ///< Property index for popup state.
+  Toolkit::Popup::TouchedOutsideSignalType     mTouchedOutsideSignal;
+  Toolkit::Popup::DisplayStateChangeSignalType mShowingSignal;
+  Toolkit::Popup::DisplayStateChangeSignalType mShownSignal;
+  Toolkit::Popup::DisplayStateChangeSignalType mHidingSignal;
+  Toolkit::Popup::DisplayStateChangeSignalType mHiddenSignal;
+
+  Layer              mLayer;                ///< Popup Layer (i.e. Dim backing and PopupBg reside in this).
+  Toolkit::TableView mPopupLayout;          ///< Popup Background (i.e. dialog reside in this).
+  Toolkit::Control   mBacking;              ///< Backing actor (dim effect).
+  Actor              mPreviousFocusedActor; ///< Store the previous focused actor to restore the focus when popup hide.
+  Actor              mTailImage;            ///< Stores the tail image.
+  Actor              mPopupContainer;       ///< This actor is used to house the background image and the main popup layout.
+  Animation          mAnimation;            ///< The current animation in use used to manage display state changing.
+  bool               mAlterAddedChild;      ///< Flag used to control whether children are reparented or not.
+  bool               mLayoutDirty;          ///< Set to true whenever any property that would require a layout update is modified.
+  Timer              mAutoHideTimer;        ///< Used to perform an auto-hide of the popup if desired.
+  bool               mTouchTransparent;     ///< Allows all events to pass through the popup.
+
+  // Main Content related properties:
+  Actor mTitle;   ///< Stores the text title.
+  Actor mContent; ///< Stores the unselected content.
+  Actor mFooter;  ///< Stores the footer content (typically controls).
+
+  // Display related properties.
+  Toolkit::Popup::DisplayState   mDisplayState;       ///< The current display state of the popup.
+  bool                           mTailVisible;        ///< True if the popup tail should be visible.
+  Vector3                        mTailPosition;       ///< The position of the tail.
+  Toolkit::Popup::ContextualMode mContextualMode;     ///< Allows the popup to be layed out adjacent to its parent in different directions.
+  float                          mAnimationDuration;  ///< The duration of the transition in and out animations.
+  Toolkit::Popup::AnimationMode  mAnimationMode;      ///< The animation to use to transition in and out.
+  Dali::AnimationData            mEntryAnimationData; ///< Stores description data that can be used for generating a custom entry animation.
+  Dali::AnimationData            mExitAnimationData;  ///< Stores description data that can be used for generating a custom exit animation.
+  unsigned int                   mAutoHideDelay;      ///< If set, will auto-hide the popup after a specified amount of time.
+
+  // Style related properties:
+  bool        mBackingEnabled;       ///< True if a dimmed backing will be used.
+  Vector4     mBackingColor;         ///< The color of the backing.
+  Actor       mPopupBackgroundImage; ///< Stores the background image.
+  Rect<int>   mBackgroundBorder;     ///< Background border.
+  float       mMargin;               ///< Internal margin for popup contents.
+  std::string mTailUpImage;          ///< Image used for the tail for the up direction.
+  std::string mTailDownImage;        ///< Image used for the tail for the down direction.
+  std::string mTailLeftImage;        ///< Image used for the tail for the left direction.
+  std::string mTailRightImage;       ///< Image used for the tail for the right direction.
 };
 
 } // namespace Internal
 
 // Helpers for public-api forwarding methods
 
-inline Toolkit::Internal::Popup& GetImpl(Toolkit::Popup& pub)
+inline Toolkit::Internal::Popup& GetImpl(Toolkit::Popup& publicObject)
 {
-  DALI_ASSERT_ALWAYS(pub);
+  DALI_ASSERT_ALWAYS(publicObject);
 
-  Dali::RefObject& handle = pub.GetImplementation();
+  Dali::RefObject& handle = publicObject.GetImplementation();
 
   return static_cast<Toolkit::Internal::Popup&>(handle);
 }
 
-inline const Toolkit::Internal::Popup& GetImpl(const Toolkit::Popup& pub)
+inline const Toolkit::Internal::Popup& GetImpl(const Toolkit::Popup& publicObject)
 {
-  DALI_ASSERT_ALWAYS(pub);
+  DALI_ASSERT_ALWAYS(publicObject);
 
-  const Dali::RefObject& handle = pub.GetImplementation();
+  const Dali::RefObject& handle = publicObject.GetImplementation();
 
   return static_cast<const Toolkit::Internal::Popup&>(handle);
 }
@@ -362,4 +587,4 @@ inline const Toolkit::Internal::Popup& GetImpl(const Toolkit::Popup& pub)
 
 } // namespace Dali
 
-#endif // __DALI_TOOLKIT_INTERNAL_POPUP_H__
+#endif // DALI_TOOLKIT_INTERNAL_POPUP_H