*
*/
-// INTERNAL INCLUDES
-#include <dali/dali.h>
+// EXTERNAL INCLUDES
+#include <dali/public-api/actors/image-actor.h>
+#include <dali/public-api/actors/layer.h>
+#include <dali/public-api/animation/animation.h>
+// INTERNAL INCLUDES
#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
{
StateShown
};
+ enum Buttons
+ {
+ ButtonsCut,
+ ButtonsCopy,
+ ButtonsPaste,
+ ButtonsSelect,
+ ButtonsSelectAll,
+ ButtonsClipboard,
+ ButtonsEnumEnd
+ };
+
+ struct ButtonRequirement
+ {
+ TextInputPopup::Buttons buttonId;
+ std::size_t orderOfPriority;
+ std::string name;
+ std::string caption;
+ Image iconImage;
+ bool enabled;
+ };
+
+ static const char* const OPTION_SELECT_WORD;
+ static const char* const OPTION_SELECT_ALL;
+ static const char* const OPTION_CUT;
+ static const char* const OPTION_COPY;
+ static const char* const OPTION_PASTE;
+ static const char* const OPTION_CLIPBOARD;
+
// Signal names
static const char* const SIGNAL_PRESSED;
static const char* const SIGNAL_HIDE_FINISHED;
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
- * @param[in] finalFlag flag to be set if option is the final one.
* @return Returns an Image Actor to be used a pressed background
*/
- ImageActor CreatePressedBackground( const Vector3 requiredSize, const bool finalFlag );
+ ImageActor CreatePressedBackground( const Vector2& requiredSize );
+
+ /**
+ * Creates a ordered vector of button options
+ */
+ void CreateOrderedListOfOptions();
+
+ /**
+ * Get the TextSize after constrained by the Popup margins.
+ * @param[in] textSize Natural size of text
+ * @return Vector2 constrained text size.
+ *
+ */
+ Vector2 GetConstrainedTextSize( const Vector2& textSize );
/**
* Adds a popup option.
/**
* Shows the popup
* @param[in] animate (optional) whether to animate popup to show state over time (i.e. tween).
+ * @param[in] target Actor to parent popup.
*/
- void Show(bool animate = true);
-
- /**
- * Sets Alternative offset property.
- * The alternative offset property is how much to move in the horizontal and vertical
- * axes when the popup goes out of the screen on the left/right sides or top/bottom sides.
- * @param[in] offset Vector holding the left/right offset (x) and top/bottom offset (y)
- */
- void SetAlternativeOffset(Vector2 offset);
+ void Show( Actor target, bool animate = true );
/**
* Returns the current state of the popup.
*/
Actor GetRootActor() const;
+ /**
+ * Set the Cut and Paste buttons color when in normal state
+ * @param[in] color color to use
+ */
+ void SetCutPastePopupColor( const Vector4& color );
+
+ /**
+ * Get the set color of the Copy and Paste Popup buttons
+ * @return color
+ */
+ const Vector4& GetCutPastePopupColor() const;
+
+ /**
+ * Set the Cut and Paste button color when pressed.
+ * @param[in] color color to use
+ */
+ void SetCutPastePopupPressedColor( const Vector4& color );
+
+ /**
+ * Get the Cut and Paste pressed button color.
+ * @return color
+ */
+ 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 );
+
+ /**
+ * Set the Button Priority Position
+ * @param[in] button Button id for priority to be set on
+ * @param[in] priority Priority level, 1 is highest so will appear first. 0 priority will not show the button.
+ */
+ 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.
+ */
+ unsigned int GetButtonPriorityPosition( TextInputPopup::Buttons button ) const;
+
+ /**
+ * Adds Popup options which have been enabled.
+ */
+ void AddPopupOptions();
+
+ /**
+ * Get Visible size of the Popup, excludes content that needs scrolling
+ * @return Vector3 size of Popup
+ */
+ const Vector3& GetVisibileSize() const;
+
+ /**
+ * Sets the positon of the PopUp tail relative to TextInput
+ * @param[in] position Position to set
+ * @param[in] yAxisFlip If tail should be flipped in y axis
+ */
+ void SetTailPosition( const Vector3& position, const bool yAxisFlip );
+
private:
/**
- * Adds popup to the stage (ideally on a separate top-most layer and as an overlay)
+ * Creates a Button with the required parameters.
+ * @param[in] buttonId enum representing the button
+ * @param[in] orderOfPriority Position in toolbar button should be position, 1 is first from left to right.
+ * @param[in] name Given name for Button actor
+ * @param[in] caption Text to display in button
+ * @param[in] iconImage Icon to display in button
+ * @param[in] enabled Toggle if button should be used or not, this is decided by the current state/conditions.
+ */
+ TextInputPopup::ButtonRequirement CreateRequiredButton( TextInputPopup::Buttons buttonId, std::size_t orderOfPriority,
+ const std::string& name, const std::string& caption, Image iconImage, bool enabled );
+
+ /**
+ * @brief Adds popup to the given parent
+ * @paran[in] parent target to add Popup to
+ */
+ void AddToParent( Actor parent );
+
+ /**
+ * @brief Removes Popup from Parent
*/
- void AddToStage();
+ void RemoveFromParent();
/**
* Applies constraint to keep Popup in view within the desired area.
void ApplyConfinementConstraint();
/**
- * Removes popup from the stage.
+ * Applies constraint to keep the Tail attached to Popup
+ */
+ void ApplyTailConstraint();
+
+ /**
+ * Create Layer to be used with stencil to allow scrolling of buttons which do not fit in visible popup
+ * @param[in] size of the layer.
+ */
+ void CreateLayer( const Vector2& size );
+
+ /**
+ * 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 RemoveFromStage();
+ void UpdateScrollViewRulerAndSize( const Vector2& visibleSize );
/**
- * Called when a button is pressed in the popup
+ * Called when a button is pressed in the Popup
* @param[in] button The button pressed.
*/
bool OnButtonPressed( Toolkit::Button button );
private:
State mState; ///< Popup State.
- Actor mRootActor; ///< 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
+ Layer mRoot; ///< The actor which all popup content is added to (i.e. panel and buttons)
+ Actor mButtons; ///< Actor which holds all the buttons, sensitivity can be set on all buttons via this actor
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)
- ActorContainer mButtonContainer; ///< List of buttons added to popup.
+ ImageActor mTailEffect; ///< the tail effect
+ ImageActor mTailLine; ///< The border/outline around the tail
+
+ Vector3 mVisiblePopUpSize; ///< Visible Size of Popup excluding content that needs scrolling.
+ float mPopupTailXPosition; ///< X position of PopUp tail.
+
+ Vector2 mContentSize; ///< Size of Content (i.e. Buttons)
ActorContainer mDividerContainer; ///< List of dividers added to popup.
Animation mAnimation; ///< Popup Hide/Show animation.
+ Layer mLayer; ///< Layer to be used with Stencil
+ 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 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.
+
+ // 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
+ std::size_t mSelectAllOptionPriority; // Position of Select All button
+ std::size_t mCutOptionPriority; // Position of Cut button
+ std::size_t mCopyOptionPriority; // Position of Copy button
+ std::size_t mPasteOptionPriority; // Position of Paste button
+ std::size_t mClipboardOptionPriority; // Position of Clipboard button
+
PressedSignalV2 mPressedSignal; ///< Signal emitted when a button within the popup is pressed.
HideFinishedSignalV2 mHideFinishedSignal; ///< Signal emitted when popup is completely hidden
ShowFinishedSignalV2 mShowFinishedSignal; ///< Signal emitted when popup is completely shown
projects / platform / core / uifw / dali-toolkit.git / blobdiff