namespace
{
-const char* DEFAULT_GRAB_HANDLE_IMAGE( DALI_IMAGE_DIR "insertpoint-icon.png" );
+const char* DEFAULT_GRAB_HANDLE_IMAGE_RELEASED( DALI_IMAGE_DIR "insertpoint-icon.png" );
+const char* DEFAULT_GRAB_HANDLE_IMAGE_PRESSED( DALI_IMAGE_DIR "insertpoint-icon-pressed.png" );
const char* DEFAULT_SELECTION_HANDLE_ONE( DALI_IMAGE_DIR "text-input-selection-handle-left.png" );
const char* DEFAULT_SELECTION_HANDLE_TWO( DALI_IMAGE_DIR "text-input-selection-handle-right.png" );
//const char* DEFAULT_SELECTION_HANDLE_ONE_PRESSED( DALI_IMAGE_DIR "text-input-selection-handle-left-press.png" );
const unsigned int CURSOR_BLINK_INTERVAL = 500u; // Cursor blink interval
const float TO_MILLISECONDS = 1000.f;
-const float TO_SECONDS = 1.f / 1000.f;
+const float TO_SECONDS = 1.f / TO_MILLISECONDS;
const float DISPLAYED_HIGHLIGHT_Z_OFFSET( -0.05f );
+const unsigned int SCROLL_TICK_INTERVAL = 50u;
+
+const float SCROLL_THRESHOLD = 10.f;
+const float SCROLL_SPEED = 300.f;
+const float SCROLL_DISTANCE = SCROLL_SPEED * SCROLL_TICK_INTERVAL * TO_SECONDS;
+
/**
* structure to hold coordinates of each quad, which will make up the mesh.
*/
struct Decorator::Impl : public ConnectionTracker
{
+ enum ScrollDirection
+ {
+ SCROLL_NONE,
+ SCROLL_RIGHT,
+ SCROLL_LEFT,
+ SCROLL_TOP,
+ SCROLL_BOTTOM
+ };
+
struct CursorImpl
{
CursorImpl()
ImageActor actor;
Actor grabArea;
- Image pressedImage;
- Image releasedImage;
-
Vector2 position;
float lineHeight; ///< Not the handle height
bool flipped;
mCursorBlinkDuration( 0.0f ),
mGrabDisplacementX( 0.0f ),
mGrabDisplacementY( 0.0f ),
+ mScrollDirection( SCROLL_NONE ),
+ mScrollThreshold( SCROLL_THRESHOLD ),
+ mScrollSpeed( SCROLL_SPEED ),
+ mScrollDistance( SCROLL_DISTANCE ),
mActiveGrabHandle( false ),
mActiveSelection( false ),
mActiveCopyPastePopup( false ),
- mCursorBlinkStatus( true )
+ mCursorBlinkStatus( true ),
+ mPrimaryCursorVisible( false ),
+ mSecondaryCursorVisible( false )
{
}
CreateCursors();
if( mPrimaryCursor )
{
- mPrimaryCursor.SetPosition( mCursor[PRIMARY_CURSOR].position.x,
- mCursor[PRIMARY_CURSOR].position.y );
- mPrimaryCursor.SetSize( Size( 1.0f, mCursor[PRIMARY_CURSOR].cursorHeight ) );
+ mPrimaryCursorVisible = ( mCursor[PRIMARY_CURSOR].position.x <= size.width ) && ( mCursor[PRIMARY_CURSOR].position.x >= 0.f );
+ if( mPrimaryCursorVisible )
+ {
+ mPrimaryCursor.SetPosition( mCursor[PRIMARY_CURSOR].position.x,
+ mCursor[PRIMARY_CURSOR].position.y );
+ mPrimaryCursor.SetSize( Size( 1.0f, mCursor[PRIMARY_CURSOR].cursorHeight ) );
+ }
+ mPrimaryCursor.SetVisible( mPrimaryCursorVisible );
}
if( mSecondaryCursor )
{
- mSecondaryCursor.SetPosition( mCursor[SECONDARY_CURSOR].position.x,
- mCursor[SECONDARY_CURSOR].position.y );
- mSecondaryCursor.SetSize( Size( 1.0f, mCursor[SECONDARY_CURSOR].cursorHeight ) );
+ mSecondaryCursorVisible = ( mCursor[SECONDARY_CURSOR].position.x <= size.width ) && ( mCursor[SECONDARY_CURSOR].position.x >= 0.f );
+ if( mSecondaryCursorVisible )
+ {
+ mSecondaryCursor.SetPosition( mCursor[SECONDARY_CURSOR].position.x,
+ mCursor[SECONDARY_CURSOR].position.y );
+ mSecondaryCursor.SetSize( Size( 1.0f, mCursor[SECONDARY_CURSOR].cursorHeight ) );
+ }
+ mSecondaryCursor.SetVisible( mSecondaryCursorVisible );
}
// Show or hide the grab handle
if( mActiveGrabHandle )
{
- SetupTouchEvents();
+ const bool isVisible = ( mCursor[PRIMARY_CURSOR].position.x <= size.width ) && ( mCursor[PRIMARY_CURSOR].position.x >= 0.f );
- CreateGrabHandle();
+ if( isVisible )
+ {
+ SetupTouchEvents();
- mGrabHandle.SetPosition( mCursor[PRIMARY_CURSOR].position.x,
- mCursor[PRIMARY_CURSOR].position.y + mCursor[PRIMARY_CURSOR].lineHeight );
+ CreateGrabHandle();
+
+ mGrabHandle.SetPosition( mCursor[PRIMARY_CURSOR].position.x,
+ mCursor[PRIMARY_CURSOR].position.y + mCursor[PRIMARY_CURSOR].lineHeight );
+ }
+ mGrabHandle.SetVisible( isVisible );
}
else if( mGrabHandle )
{
mCopyPastePopup.SetPosition( popupPosition ); //todo grabhandle(cursor) or selection handle positions to be used
}
- void CreateCursor( ImageActor& cursor )
+ void CreateCursor( ImageActor& cursor, const Vector4& color )
{
- cursor = CreateSolidColorActor( Color::WHITE );
+ cursor = CreateSolidColorActor( color );
cursor.SetParentOrigin( ParentOrigin::TOP_LEFT ); // Need to set the default parent origin as CreateSolidColorActor() sets a different one.
cursor.SetAnchorPoint( AnchorPoint::TOP_CENTER );
}
{
if ( !mPrimaryCursor )
{
- CreateCursor( mPrimaryCursor );
+ CreateCursor( mPrimaryCursor, mCursor[PRIMARY_CURSOR].color );
#ifdef DECORATOR_DEBUG
mPrimaryCursor.SetName( "PrimaryCursorActor" );
#endif
{
if ( !mSecondaryCursor )
{
- CreateCursor( mSecondaryCursor );
+ CreateCursor( mSecondaryCursor, mCursor[SECONDARY_CURSOR].color );
#ifdef DECORATOR_DEBUG
mSecondaryCursor.SetName( "SecondaryCursorActor" );
#endif
// Cursor blinking
if ( mPrimaryCursor )
{
- mPrimaryCursor.SetVisible( mCursorBlinkStatus );
+ mPrimaryCursor.SetVisible( mPrimaryCursorVisible && mCursorBlinkStatus );
}
if ( mSecondaryCursor )
{
- mSecondaryCursor.SetVisible( mCursorBlinkStatus );
+ mSecondaryCursor.SetVisible( mSecondaryCursorVisible && mCursorBlinkStatus );
}
mCursorBlinkStatus = !mCursorBlinkStatus;
{
if( !mGrabHandle )
{
- if ( !mGrabHandleImage )
+ if ( !mGrabHandleImageReleased )
{
- mGrabHandleImage = ResourceImage::New( DEFAULT_GRAB_HANDLE_IMAGE );
+ mGrabHandleImageReleased = ResourceImage::New( DEFAULT_GRAB_HANDLE_IMAGE_RELEASED );
+ }
+ if ( !mGrabHandleImagePressed )
+ {
+ mGrabHandleImagePressed = ResourceImage::New( DEFAULT_GRAB_HANDLE_IMAGE_PRESSED );
}
- mGrabHandle = ImageActor::New( mGrabHandleImage );
+ mGrabHandle = ImageActor::New( mGrabHandleImageReleased );
mGrabHandle.SetAnchorPoint( AnchorPoint::TOP_CENTER );
mGrabHandle.SetDrawMode( DrawMode::OVERLAY );
// Area that Grab handle responds to, larger than actual handle so easier to move
SelectionHandleImpl& primary = mSelectionHandle[ PRIMARY_SELECTION_HANDLE ];
if ( !primary.actor )
{
- if ( !primary.releasedImage )
+ if ( !mSelectionReleasedLeft )
{
- primary.releasedImage = ResourceImage::New( DEFAULT_SELECTION_HANDLE_ONE );
+ mSelectionReleasedLeft = ResourceImage::New( DEFAULT_SELECTION_HANDLE_ONE );
}
- primary.actor = ImageActor::New( primary.releasedImage );
+ primary.actor = ImageActor::New( mSelectionReleasedLeft );
#ifdef DECORATOR_DEBUG
primary.actor.SetName("SelectionHandleOne");
#endif
SelectionHandleImpl& secondary = mSelectionHandle[ SECONDARY_SELECTION_HANDLE ];
if ( !secondary.actor )
{
- if ( !secondary.releasedImage )
+ if ( !mSelectionReleasedRight )
{
- secondary.releasedImage = ResourceImage::New( DEFAULT_SELECTION_HANDLE_TWO );
+ mSelectionReleasedRight = ResourceImage::New( DEFAULT_SELECTION_HANDLE_TWO );
}
- secondary.actor = ImageActor::New( secondary.releasedImage );
+ secondary.actor = ImageActor::New( mSelectionReleasedRight );
#ifdef DECORATOR_DEBUG
secondary.actor.SetName("SelectionHandleTwo");
#endif
if( Gesture::Started == gesture.state )
{
mGrabDisplacementX = mGrabDisplacementY = 0;
+ mGrabHandle.SetImage( mGrabHandleImagePressed );
}
mGrabDisplacementX += gesture.displacement.x;
if( Gesture::Started == gesture.state ||
Gesture::Continuing == gesture.state )
{
- mObserver.GrabHandleEvent( GRAB_HANDLE_PRESSED, x, y );
+ if( x < mScrollThreshold )
+ {
+ mScrollDirection = SCROLL_RIGHT;
+ mGrabDisplacementX -= x;
+ mCursor[PRIMARY_CURSOR].position.x = 0.f;
+ StartScrollTimer();
+ }
+ else if( x > mTextControlParent.GetControlSize().width - mScrollThreshold )
+ {
+ mScrollDirection = SCROLL_LEFT;
+ mGrabDisplacementX += ( mTextControlParent.GetControlSize().width - x );
+ mCursor[PRIMARY_CURSOR].position.x = mTextControlParent.GetControlSize().width;
+ StartScrollTimer();
+ }
+ else
+ {
+ StopScrollTimer();
+ mObserver.GrabHandleEvent( GRAB_HANDLE_PRESSED, x, y );
+ }
}
else if( Gesture::Finished == gesture.state ||
Gesture::Cancelled == gesture.state )
{
- mObserver.GrabHandleEvent( GRAB_HANDLE_RELEASED, x, y );
+ if( mScrollTimer && mScrollTimer.IsRunning() )
+ {
+ StopScrollTimer();
+ mObserver.GrabHandleEvent( GRAB_HANDLE_STOP_SCROLLING, x, y );
+ }
+ else
+ {
+ mObserver.GrabHandleEvent( GRAB_HANDLE_RELEASED, x, y );
+ }
+
+ mGrabHandle.SetImage( mGrabHandleImageReleased );
}
}
}
requiredPopupPosition.x = requiredPopupPosition.x + xOffSetToKeepWithinBounds;
}
+ void SetScrollThreshold( float threshold )
+ {
+ mScrollThreshold = threshold;
+ }
+
+ float GetScrollThreshold() const
+ {
+ return mScrollThreshold;
+ }
+
+ void SetScrollSpeed( float speed )
+ {
+ mScrollSpeed = speed;
+ mScrollDistance = speed * SCROLL_TICK_INTERVAL * TO_SECONDS;
+ }
+
+ float GetScrollSpeed() const
+ {
+ return mScrollSpeed;
+ }
+
+ /**
+ * Creates and starts a timer to scroll the text when handles are close to the edges of the text.
+ *
+ * It only starts the timer if it's already created.
+ */
+ void StartScrollTimer()
+ {
+ if( !mScrollTimer )
+ {
+ mScrollTimer = Timer::New( SCROLL_TICK_INTERVAL );
+ mScrollTimer.TickSignal().Connect( this, &Decorator::Impl::OnScrollTimerTick );
+ }
+
+ if( !mScrollTimer.IsRunning() )
+ {
+ mScrollTimer.Start();
+ }
+ }
+
+ /**
+ * Stops the timer used to scroll the text.
+ */
+ void StopScrollTimer()
+ {
+ if( mScrollTimer )
+ {
+ mScrollTimer.Stop();
+ }
+ }
+
+ /**
+ * Callback called by the timer used to scroll the text.
+ *
+ * It calculates and sets a new scroll position.
+ */
+ bool OnScrollTimerTick()
+ {
+ mObserver.GrabHandleEvent( GRAB_HANDLE_SCROLLING,
+ mScrollDirection == SCROLL_RIGHT ? mScrollDistance : -mScrollDistance,
+ 0.f );
+ return true;
+ }
+
Internal::Control& mTextControlParent;
Observer& mObserver;
TapGestureDetector mTapDetector;
PanGestureDetector mPanGestureDetector;
Timer mCursorBlinkTimer; ///< Timer to signal cursor to blink
+ Timer mScrollTimer; ///< Timer used to scroll the text when the grab handle is moved close to the edges.
Layer mActiveLayer; ///< Layer for active handles and alike that ensures they are above all else.
ImageActor mPrimaryCursor;
TextSelectionPopup mCopyPastePopup;
Image mCursorImage;
- Image mGrabHandleImage;
+ Image mGrabHandleImageReleased;
+ Image mGrabHandleImagePressed;
Mesh mHighlightMesh; ///< Mesh for highlight
MeshData mHighlightMeshData; ///< Mesh Data for highlight
Material mHighlightMaterial; ///< Material used for highlight
CursorImpl mCursor[CURSOR_COUNT];
SelectionHandleImpl mSelectionHandle[SELECTION_HANDLE_COUNT];
+
QuadContainer mHighlightQuadList; ///< Sub-selections that combine to create the complete selection highlight
+ Image mSelectionReleasedLeft; ///< Selection handle images
+ Image mSelectionReleasedRight;
+ Image mSelectionPressedLeft;
+ Image mSelectionPressedRight;
+
Rect<int> mBoundingBox;
Vector4 mHighlightColor; ///< Color of the highlight
float mCursorBlinkDuration;
float mGrabDisplacementX;
float mGrabDisplacementY;
-
- bool mActiveGrabHandle:1;
- bool mActiveSelection:1;
- bool mActiveCopyPastePopup:1;
- bool mCursorBlinkStatus:1; ///< Flag to switch between blink on and blink off
+ ScrollDirection mScrollDirection; ///< The direction of the scroll.
+ float mScrollThreshold; ///< Defines a square area inside the control, close to the edge. A cursor entering this area will trigger scroll events.
+ float mScrollSpeed; ///< The scroll speed in pixels per second.
+ float mScrollDistance; ///< Distance the text scrolls during a scroll interval.
+ unsigned int mScrollInterval; ///< Time in milliseconds of a scroll interval.
+
+ bool mActiveGrabHandle : 1;
+ bool mActiveSelection : 1;
+ bool mActiveCopyPastePopup : 1;
+ bool mCursorBlinkStatus : 1; ///< Flag to switch between blink on and blink off.
+ bool mPrimaryCursorVisible : 1; ///< Whether the primary cursor is visible.
+ bool mSecondaryCursorVisible : 1; ///< Whether the secondary cursor is visible.
};
DecoratorPtr Decorator::New( Internal::Control& parent, Observer& observer )
void Decorator::SetPosition( Cursor cursor, float x, float y, float cursorHeight, float lineHeight )
{
// Adjust grab handle displacement
- mImpl->mGrabDisplacementX -= x - mImpl->mCursor[cursor].position.x;
- mImpl->mGrabDisplacementY -= y - mImpl->mCursor[cursor].position.y;
+ if( PRIMARY_CURSOR == cursor )
+ {
+ mImpl->mGrabDisplacementX -= x - mImpl->mCursor[cursor].position.x;
+ mImpl->mGrabDisplacementY -= y - mImpl->mCursor[cursor].position.y;
+ }
mImpl->mCursor[cursor].position.x = x;
mImpl->mCursor[cursor].position.y = y;
lineHeight = mImpl->mCursor[cursor].lineHeight;
}
+const Vector2& Decorator::GetPosition( Cursor cursor ) const
+{
+ return mImpl->mCursor[cursor].position;
+}
+
void Decorator::SetColor( Cursor cursor, const Dali::Vector4& color )
{
mImpl->mCursor[cursor].color = color;
return mImpl->mActiveGrabHandle;
}
-void Decorator::SetGrabHandleImage( Dali::Image image )
+void Decorator::SetGrabHandleImage( GrabHandleImageType type, Dali::Image image )
{
- mImpl->mGrabHandleImage = image;
+ if( GRAB_HANDLE_IMAGE_PRESSED == type )
+ {
+ mImpl->mGrabHandleImagePressed = image;
+ }
+ else
+ {
+ mImpl->mGrabHandleImageReleased = image;
+ }
}
-Dali::Image Decorator::GetGrabHandleImage() const
+Dali::Image Decorator::GetGrabHandleImage( GrabHandleImageType type ) const
{
- return mImpl->mGrabHandleImage;
+ if( GRAB_HANDLE_IMAGE_PRESSED == type )
+ {
+ return mImpl->mGrabHandleImagePressed;
+ }
+
+ return mImpl->mGrabHandleImageReleased;
}
/** Selection **/
height = mImpl->mSelectionHandle[handle].lineHeight;
}
-void Decorator::SetImage( SelectionHandle handle, SelectionHandleState state, Dali::Image image )
+void Decorator::SetLeftSelectionImage( SelectionHandleState state, Dali::Image image )
+{
+ if( SELECTION_HANDLE_PRESSED == state )
+ {
+ mImpl->mSelectionPressedLeft = image;
+ }
+ else
+ {
+ mImpl->mSelectionReleasedLeft = image;
+ }
+}
+
+Dali::Image Decorator::GetLeftSelectionImage( SelectionHandleState state ) const
+{
+ if( SELECTION_HANDLE_PRESSED == state )
+ {
+ return mImpl->mSelectionPressedLeft;
+ }
+
+ return mImpl->mSelectionReleasedLeft;
+}
+
+void Decorator::SetRightSelectionImage( SelectionHandleState state, Dali::Image image )
{
if( SELECTION_HANDLE_PRESSED == state )
{
- mImpl->mSelectionHandle[handle].pressedImage = image;
+ mImpl->mSelectionPressedRight = image;
}
else
{
- mImpl->mSelectionHandle[handle].releasedImage = image;
+ mImpl->mSelectionReleasedRight = image;
}
}
-Dali::Image Decorator::GetImage( SelectionHandle handle, SelectionHandleState state ) const
+Dali::Image Decorator::GetRightSelectionImage( SelectionHandleState state ) const
{
if( SELECTION_HANDLE_PRESSED == state )
{
- return mImpl->mSelectionHandle[handle].pressedImage;
+ return mImpl->mSelectionPressedRight;
}
- return mImpl->mSelectionHandle[handle].releasedImage;
+ return mImpl->mSelectionReleasedRight;
}
void Decorator::AddHighlight( float x1, float y1, float x2, float y2 )
mImpl->mHighlightQuadList.clear();
}
+void Decorator::SetHighlightColor( const Vector4& color )
+{
+ mImpl->mHighlightColor = color;
+}
+
+const Vector4& Decorator::GetHighlightColor() const
+{
+ return mImpl->mHighlightColor;
+}
+
void Decorator::SetPopupActive( bool active )
{
mImpl->mActiveCopyPastePopup = active;
return mImpl->mActiveCopyPastePopup ;
}
+/** Scroll **/
+
+void Decorator::SetScrollThreshold( float threshold )
+{
+ mImpl->SetScrollThreshold( threshold );
+}
+
+float Decorator::GetScrollThreshold() const
+{
+ return mImpl->GetScrollThreshold();
+}
+
+void Decorator::SetScrollSpeed( float speed )
+{
+ mImpl->SetScrollSpeed( speed );
+}
+
+float Decorator::GetScrollSpeed() const
+{
+ return mImpl->GetScrollSpeed();
+}
+
Decorator::~Decorator()
{
delete mImpl;