Update the text input popup GUI.
[platform/core/uifw/dali-toolkit.git] / base / dali-toolkit / internal / controls / text-input / text-input-popup-impl.h
index 81186df..41b9bb6 100644 (file)
@@ -22,6 +22,7 @@
 #include <dali/dali.h>
 
 #include <dali-toolkit/public-api/controls/text-view/text-view.h>
+#include <dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h>
 
 namespace Dali
 {
@@ -115,45 +116,45 @@ public:
   TextInputPopup();
 
   /**
-   * @return The root actor of for this popup is returned.
-   */
-  Actor Self();
-
-  /**
    * Clears popup options (popup no longer exists)
    */
   void Clear();
 
   /**
    * Create the label
+   * @return the newly created Image actor to be used as the icon
+   */
+  ImageActor CreateOptionIcon( Image iconImage, const Vector4& color );
+
+  /**
+   * Create the caption
    * @param[in] styledCaption The text to be displayed
    * @return the newly created label
    */
-  Toolkit::TextView CreateOptionText( const MarkupProcessor::StyledTextArray& styledCaption );
+  Toolkit::TextView CreateOptionCaption( const std::string& caption, const Vector4& color );
 
   /**
-   * Create the label
-   * @param[in] iconImage the image to be used
-   * @return the newly created Image actor to be used as the icon
+   * Creates and sets up the background
    */
-  ImageActor CreateOptionIcon( Image iconImage );
+  void CreateBackground();
 
   /**
-   * Creates and sets up the popup background
+   * Create and set up the tail
    */
-  void CreatePopUpBackground();
+  void CreateTail();
 
   /**
    * Create divider if multiple options
+   * @return Return a divider image actor
    */
-  void CreateDivider();
+  ImageActor CreateDivider();
 
   /**
-   * Create a background to be used when button pressed
+   * Create a background to be used when option pressed
    * @param[in] requiredSize size Image actor should be
    * @return Returns an Image Actor to be used a pressed background
    */
-  ImageActor CreatePressedBackground( const Vector3 requiredSize );
+  ImageActor CreatePressedBackground( const Vector2& requiredSize );
 
   /**
    * Creates a ordered vector of button options
@@ -207,32 +208,44 @@ public:
    * Set the Cut and Paste buttons color when in normal state
    * @param[in] color color to use
    */
-  void SetCutPastePopUpColor( const Vector4& color );
+  void SetCutPastePopupColor( const Vector4& color );
 
   /**
-   * Get the set color of the Copy and Paste PopUp buttons
+   * Get the set color of the Copy and Paste Popup buttons
    * @return color
    */
-  const Vector4& GetCutPastePopUpColor() const;
+  const Vector4& GetCutPastePopupColor() const;
 
   /**
    * Set the Cut and Paste button color when pressed.
    * @param[in] color color to use
    */
-  void SetCutPastePopUpPressedColor( const Vector4& color );
+  void SetCutPastePopupPressedColor( const Vector4& color );
 
   /**
    * Get the Cut and Paste pressed button color.
    * @return color
    */
-  const Vector4& GetCutPastePopUpPressedColor() const;
+  const Vector4& GetCutPastePopupPressedColor() const;
+
+  /**
+   * Set the border color of the popup
+   * @param[in] color required color
+   */
+  void SetCutPastePopupBorderColor( const Vector4& color );
+
+  /**
+   * Get the border color
+   * @return Vector4 the color of the border
+   */
+  const Vector4& GetCutPastePopupBorderColor() const;
 
   /**
    * Toggle if a popup button should be enabled (shown) or not
    * @param[in]  requiredButton Button Id to enable or disable
    * @param[in]  enable toggle to enable (true) or disable (false)
    */
-  void TogglePopUpButtonOnOff( TextInputPopup::Buttons requiredButton, bool enable );
+  void TogglePopupButtonOnOff( TextInputPopup::Buttons requiredButton, bool enable );
 
   /**
    * Set the Button Priority Position
@@ -242,6 +255,54 @@ public:
   void SetButtonPriorityPosition( TextInputPopup::Buttons button, unsigned int priority );
 
   /**
+   * Set the icon color of the popup
+   * @param[in] color required color
+   */
+  void SetCutPastePopupIconColor( const Vector4& color );
+
+  /**
+   * Get the popup icon color
+   * @return Vector4 the color of the popup icon
+   */
+  const Vector4& GetCutPastePopupIconColor() const;
+
+  /**
+   * Set the pressed icon color of the popup
+   * @param[in] color required color
+   */
+  void SetCutPastePopupIconPressedColor( const Vector4& color );
+
+  /**
+   * Get the popup pressed icon color
+   * @return Vector4 the color of the popup pressed icon
+   */
+  const Vector4& GetCutPastePopupIconPressedColor();
+
+  /**
+   * Set the text color of the popup
+   * @param[in] color required color
+   */
+  void SetCutPastePopupTextColor( const Vector4& color );
+
+  /**
+   * Get the popup text color
+   * @return Vector4 the color of the popup text
+   */
+  const Vector4& GetCutPastePopupTextColor();
+
+  /**
+   * Set the pressed text color of the popup
+   * @param[in] color required color
+   */
+  void SetCutPastePopupTextPressedColor( const Vector4& color );
+
+  /**
+   * Get the popup pressed text color
+   * @return Vector4 the color of the popup pressed text
+   */
+  const Vector4& GetCutPastePopupTextPressedColor();
+
+  /**
    * Get the Button Priority Position
    * @param[in] button Button id to get priority of
    * @return the button priority, 1 is highest, 0 is not shown.
@@ -253,6 +314,18 @@ public:
    */
   void AddPopupOptions();
 
+  /**
+   * Set Boundary that Popup should stay within
+   * @param[in] boundingRectangle coordinates of bounding box from Top Left
+   */
+  void SetPopupBoundary( const Rect<float>& boundingRectangle );
+
+  /**
+   * Sets the positon of the Popup tail relative to TextInput
+   * @param position Position to set
+   */
+  void SetTailPosition( const Vector3& position );
+
 private:
 
   /**
@@ -278,6 +351,40 @@ private:
   void ApplyConfinementConstraint();
 
   /**
+   * Applies constraint to keep the Tail attached to Popup
+   */
+  void ApplyTailConstraint();
+
+  /**
+   * Create a stencil to clip the scroll view content
+   * @param[in] size of the stencil.
+   */
+  void CreateStencil( const Vector2& size );
+
+  /**
+   * Popup has started to scroll
+   * @param[in] position current scroll view position
+   */
+  void OnScrollStarted( const Vector3& position );
+
+  /**
+   * Popup has stopped scrolling
+   * @param[in] position current scroll view position
+   */
+  void OnScrollCompleted( const Vector3& position );
+
+  /**
+   * Create a scroll view to hold the popup buttons and allow scrolling if too many buttons to fit within the visible boundary
+   */
+  void CreateScrollView();
+
+  /**
+   * Set the scroll view size and ruler.
+   * @param[in] visibleSize size of the visible scroll view
+   */
+  void UpdateScrollViewProperty( const Vector2& visibleSize );
+
+  /**
    * Removes Popup from the stage.
    */
   void RemoveFromStage();
@@ -305,20 +412,37 @@ private:
 private:
 
   State mState;                                       ///< Popup State.
-  Actor mRootActor;                                   ///< The actor which all popup content is added to (i.e. panel and buttons)
+  Layer mRoot;                                       ///< The actor which all popup content is added to (i.e. panel and buttons)
   Property::Index mAlternativeOffsetProperty;         ///< Property [Vector3] how much to offset the popup if it goes out of the screen
+  Property::Index mRequestionPositionProperty;        ///< Prperty [Vector3] Requested position to place popup
   ImageActor mBackground;                             ///< The background popup panel
+  ImageActor mBackgroundEffect;                       ///< The background effect
+  ImageActor mBackgroundLine;                         ///< The background line
   ImageActor mTail;                                   ///< The tail for the popup
-  Vector3 mContentSize;                               ///< Size of Content (i.e. Buttons)
+  ImageActor mTailEffect;                             ///< the tail effect
+  ImageActor mTailLine;                               ///< The border/outline around the tail
+
+  float mPopupTailXPosition;                          ///< X position of Popup tail.
+
+  Vector2 mContentSize;                               ///< Size of Content (i.e. Buttons)
   ActorContainer mButtonContainer;                    ///< List of buttons added to popup.
   ActorContainer mDividerContainer;                   ///< List of dividers added to popup.
   Animation mAnimation;                               ///< Popup Hide/Show animation.
 
+  Actor mStencil;                                     ///< Stencil to clip scrollview
+  Toolkit::ScrollView mScrollView;                    ///< Scrollview to house the popup
+
   std::vector<ButtonRequirement> mOrderListOfButtons;        // List of buttons in the order to be displayed and a flag to indicate if needed.
 
-  Vector4           mCutPasteButtonsColor;  // Color of the cut and paste popup
-  Vector4           mCutPasteButtonsPressedColor;  // Color of the cut and paste buttons when pressed.
-  Vector4           mBorderColor; // Color of the border around the Cut and Paste Popup
+  Vector4 mBackgroundColor;              // Color of the background of the text input popup
+  Vector4 mBackgroundPressedColor;       // Color of the option background.
+  Vector4 mLineColor;                    // Color of the line around the text input popup
+  Vector4 mIconColor;                    // Color of the popup icon.
+  Vector4 mIconPressedColor;             // Color of the popup icon when pressed.
+  Vector4 mTextColor;                    // Color of the popup text.
+  Vector4 mTextPressedColor;             // Color of the popup text when pressed.
+
+  Rect<float> mBoundingRect; // Boundary that Popup must stay within.
 
   // Priority of Options/Buttons in the Cut and Paste pop-up, higher priority buttons are displayed first, left to right.
   std::size_t mSelectOptionPriority;  // Position of Select Button