2 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include <dali-toolkit/public-api/text/decorator/text-decorator.h>
22 #include <dali/public-api/actors/actor.h>
23 #include <dali/public-api/actors/image-actor.h>
24 #include <dali/public-api/actors/layer.h>
25 #include <dali/public-api/common/constants.h>
26 #include <dali/public-api/events/tap-gesture.h>
27 #include <dali/public-api/events/tap-gesture-detector.h>
28 #include <dali/public-api/events/pan-gesture.h>
29 #include <dali/public-api/events/pan-gesture-detector.h>
30 #include <dali/public-api/images/resource-image.h>
31 #include <dali/public-api/math/vector2.h>
32 #include <dali/public-api/math/vector4.h>
33 #include <dali/public-api/signals/connection-tracker.h>
36 #include <dali-toolkit/public-api/controls/control.h>
37 #include <dali-toolkit/public-api/controls/control-impl.h>
40 #define DECORATOR_DEBUG
47 const char* DEFAULT_GRAB_HANDLE_IMAGE( DALI_IMAGE_DIR "insertpoint-icon.png" );
48 const char* DEFAULT_SELECTION_HANDLE_ONE( DALI_IMAGE_DIR "text-input-selection-handle-left.png" );
49 const char* DEFAULT_SELECTION_HANDLE_TWO( DALI_IMAGE_DIR "text-input-selection-handle-right.png" );
50 //const char* DEFAULT_SELECTION_HANDLE_ONE_PRESSED( DALI_IMAGE_DIR "text-input-selection-handle-left-press.png" );
51 //const char* DEFAULT_SELECTION_HANDLE_TWO_PRESSED( DALI_IMAGE_DIR "text-input-selection-handle-right-press.png" );
53 const Dali::Vector3 DEFAULT_GRAB_HANDLE_RELATIVE_SIZE( 1.5f, 2.0f, 1.0f );
54 const Dali::Vector3 DEFAULT_SELECTION_HANDLE_RELATIVE_SIZE( 1.5f, 1.5f, 1.0f );
67 struct Decorator::Impl : public ConnectionTracker
75 color(Dali::Color::WHITE)
86 struct SelectionHandleImpl
98 float cursorHeight; ///< Not the handle height
108 Impl( Dali::Toolkit::Internal::Control& parent, Observer& observer )
111 mActiveCursor(ACTIVE_CURSOR_NONE),
112 mActiveGrabHandle(false),
113 mCursorBlinkInterval(0.5f),
114 mCursorBlinkDuration(0.0f)
118 void Relayout( const Vector2& size )
120 // Show or hide the grab handle
121 if( mActiveGrabHandle )
128 mGrabHandle.SetPosition( mCursor[PRIMARY_CURSOR].x, mCursor[PRIMARY_CURSOR].y + mCursor[PRIMARY_CURSOR].height );
130 else if( mGrabHandle )
132 UnparentAndReset( mGrabHandle );
135 // Show or hide the selection handles/highlight
136 if( mActiveSelection )
141 CreateSelectionHandles();
143 SelectionHandleImpl& primary = mSelectionHandle[ PRIMARY_SELECTION_HANDLE ];
144 primary.actor.SetPosition( primary.x, primary.y + primary.cursorHeight );
146 SelectionHandleImpl& secondary = mSelectionHandle[ SECONDARY_SELECTION_HANDLE ];
147 secondary.actor.SetPosition( secondary.x, secondary.y + secondary.cursorHeight );
149 //CreateHighlight(); TODO
153 UnparentAndReset( mSelectionHandle[ PRIMARY_SELECTION_HANDLE ].actor );
154 UnparentAndReset( mSelectionHandle[ SECONDARY_SELECTION_HANDLE ].actor );
160 void SetupTouchEvents()
164 mTapDetector = TapGestureDetector::New();
165 mTapDetector.DetectedSignal().Connect( this, &Decorator::Impl::OnTap );
168 if ( !mPanGestureDetector )
170 mPanGestureDetector = PanGestureDetector::New();
171 mPanGestureDetector.DetectedSignal().Connect( this, &Decorator::Impl::OnPan );
175 void CreateActiveLayer()
179 Actor parent = mParent.Self();
181 mActiveLayer = Layer::New();
182 #ifdef DECORATOR_DEBUG
183 mActiveLayer.SetName ( "ActiveLayerActor" );
186 mActiveLayer.SetAnchorPoint( AnchorPoint::CENTER);
187 mActiveLayer.SetParentOrigin( ParentOrigin::CENTER);
188 mActiveLayer.SetSizeMode( SIZE_EQUAL_TO_PARENT );
189 mActiveLayer.SetPositionInheritanceMode( USE_PARENT_POSITION );
191 parent.Add( mActiveLayer );
194 mActiveLayer.RaiseToTop();
197 void CreateGrabHandle()
201 if ( !mGrabHandleImage )
203 mGrabHandleImage = ResourceImage::New( DEFAULT_GRAB_HANDLE_IMAGE );
206 mGrabHandle = ImageActor::New( mGrabHandleImage );
207 #ifdef DECORATOR_DEBUG
208 mGrabHandle.SetName( "GrabHandleActor" );
210 mGrabHandle.SetParentOrigin( ParentOrigin::TOP_LEFT );
211 mGrabHandle.SetAnchorPoint( AnchorPoint::TOP_CENTER );
212 mGrabHandle.SetDrawMode( DrawMode::OVERLAY );
214 mGrabArea = Actor::New(); // Area that Grab handle responds to, larger than actual handle so easier to move
215 #ifdef DECORATOR_DEBUG
216 mGrabArea.SetName( "GrabArea" );
218 mGrabArea.SetPositionInheritanceMode( Dali::USE_PARENT_POSITION );
219 mGrabArea.SetSizeMode( SIZE_RELATIVE_TO_PARENT );
220 mGrabArea.SetSizeModeFactor( DEFAULT_GRAB_HANDLE_RELATIVE_SIZE );
221 mGrabHandle.Add(mGrabArea);
223 mTapDetector.Attach( mGrabArea );
224 mPanGestureDetector.Attach( mGrabArea );
226 mActiveLayer.Add(mGrabHandle);
230 void CreateSelectionHandles()
232 SelectionHandleImpl& primary = mSelectionHandle[ PRIMARY_SELECTION_HANDLE ];
233 if ( !primary.actor )
235 if ( !primary.releasedImage )
237 primary.releasedImage = ResourceImage::New( DEFAULT_SELECTION_HANDLE_ONE );
240 primary.actor = ImageActor::New( primary.releasedImage );
241 #ifdef DECORATOR_DEBUG
242 primary.actor.SetName("SelectionHandleOne");
244 primary.actor.SetParentOrigin( ParentOrigin::TOP_LEFT );
245 primary.actor.SetAnchorPoint( AnchorPoint::TOP_RIGHT ); // Change to BOTTOM_RIGHT if Look'n'Feel requires handle above text.
246 primary.actor.SetDrawMode( DrawMode::OVERLAY ); // ensure grab handle above text
247 primary.flipped = false;
249 primary.grabArea = Actor::New(); // Area that Grab handle responds to, larger than actual handle so easier to move
250 #ifdef DECORATOR_DEBUG
251 primary.grabArea.SetName("SelectionHandleOneGrabArea");
253 primary.grabArea.SetSizeMode( SIZE_RELATIVE_TO_PARENT );
254 primary.grabArea.SetSizeModeFactor( DEFAULT_SELECTION_HANDLE_RELATIVE_SIZE );
255 primary.grabArea.SetPositionInheritanceMode( Dali::USE_PARENT_POSITION );
257 mTapDetector.Attach( primary.grabArea );
258 mPanGestureDetector.Attach( primary.grabArea );
259 primary.grabArea.TouchedSignal().Connect( this, &Decorator::Impl::OnHandleOneTouched );
261 primary.actor.Add( primary.grabArea );
262 mActiveLayer.Add( primary.actor );
265 SelectionHandleImpl& secondary = mSelectionHandle[ SECONDARY_SELECTION_HANDLE ];
266 if ( !secondary.actor )
268 if ( !secondary.releasedImage )
270 secondary.releasedImage = ResourceImage::New( DEFAULT_SELECTION_HANDLE_TWO );
273 secondary.actor = ImageActor::New( secondary.releasedImage );
274 #ifdef DECORATOR_DEBUG
275 secondary.actor.SetName("SelectionHandleTwo");
277 secondary.actor.SetParentOrigin( ParentOrigin::TOP_LEFT );
278 secondary.actor.SetAnchorPoint( AnchorPoint::TOP_RIGHT ); // Change to BOTTOM_RIGHT if Look'n'Feel requires handle above text.
279 secondary.actor.SetDrawMode( DrawMode::OVERLAY ); // ensure grab handle above text
280 secondary.flipped = false;
282 secondary.grabArea = Actor::New(); // Area that Grab handle responds to, larger than actual handle so easier to move
283 #ifdef DECORATOR_DEBUG
284 secondary.grabArea.SetName("SelectionHandleTwoGrabArea");
286 secondary.grabArea.SetSizeMode( SIZE_RELATIVE_TO_PARENT );
287 secondary.grabArea.SetSizeModeFactor( DEFAULT_SELECTION_HANDLE_RELATIVE_SIZE );
288 secondary.grabArea.SetPositionInheritanceMode( Dali::USE_PARENT_POSITION );
290 mTapDetector.Attach( secondary.grabArea );
291 mPanGestureDetector.Attach( secondary.grabArea );
292 secondary.grabArea.TouchedSignal().Connect( this, &Decorator::Impl::OnHandleTwoTouched );
294 secondary.actor.Add( secondary.grabArea );
295 mActiveLayer.Add( secondary.actor );
298 //SetUpHandlePropertyNotifications(); TODO
301 void OnTap( Actor actor, const TapGesture& tap )
303 if( actor == mGrabHandle )
309 void OnPan( Actor actor, const PanGesture& gesture )
311 if( actor == mGrabHandle )
317 bool OnHandleOneTouched( Actor actor, const TouchEvent& touch )
323 bool OnHandleTwoTouched( Actor actor, const TouchEvent& touch )
329 Internal::Control& mParent;
332 Layer mActiveLayer; ///< Layer for active handles and alike that ensures they are above all else.
334 unsigned int mActiveCursor;
335 bool mActiveGrabHandle;
336 bool mActiveSelection;
338 CursorImpl mCursor[CURSOR_COUNT];
340 ImageActor mGrabHandle;
343 SelectionHandleImpl mSelectionHandle[SELECTION_HANDLE_COUNT];
346 Image mGrabHandleImage;
348 TapGestureDetector mTapDetector;
349 PanGestureDetector mPanGestureDetector;
351 float mCursorBlinkInterval;
352 float mCursorBlinkDuration;
355 DecoratorPtr Decorator::New( Internal::Control& parent, Observer& observer )
357 return DecoratorPtr( new Decorator(parent, observer) );
360 void Decorator::Relayout( const Vector2& size )
362 mImpl->Relayout( size );
365 void Decorator::SetActiveCursor( ActiveCursor activeCursor )
367 mImpl->mActiveCursor = activeCursor;
370 unsigned int Decorator::GetActiveCursor() const
372 return mImpl->mActiveCursor;
375 void Decorator::SetPosition( Cursor cursor, float x, float y, float height )
377 mImpl->mCursor[cursor].x = x;
378 mImpl->mCursor[cursor].y = y;
379 mImpl->mCursor[cursor].height = height;
382 void Decorator::GetPosition( Cursor cursor, float& x, float& y, float& height ) const
384 x = mImpl->mCursor[cursor].x;
385 y = mImpl->mCursor[cursor].y;
386 height = mImpl->mCursor[cursor].height;
389 void Decorator::SetCursorImage( Dali::Image image )
391 mImpl->mCursorImage = image;
394 Dali::Image Decorator::GetCursorImage() const
396 return mImpl->mCursorImage;
399 void Decorator::SetColor( Cursor cursor, const Dali::Vector4& color )
401 mImpl->mCursor[cursor].color = color;
404 const Dali::Vector4& Decorator::GetColor( Cursor cursor ) const
406 return mImpl->mCursor[cursor].color;
409 void Decorator::StartCursorBlink()
414 void Decorator::StopCursorBlink()
419 void Decorator::SetCursorBlinkInterval( float seconds )
421 mImpl->mCursorBlinkInterval = seconds;
424 float Decorator::GetCursorBlinkInterval() const
426 return mImpl->mCursorBlinkInterval;
429 void Decorator::SetCursorBlinkDuration( float seconds )
431 mImpl->mCursorBlinkDuration = seconds;
434 float Decorator::GetCursorBlinkDuration() const
436 return mImpl->mCursorBlinkDuration;
439 void Decorator::SetGrabHandleActive( bool active )
441 mImpl->mActiveGrabHandle = active;
444 bool Decorator::IsGrabHandleActive() const
446 return mImpl->mActiveGrabHandle;
449 void Decorator::SetGrabHandleImage( Dali::Image image )
451 mImpl->mGrabHandleImage = image;
454 Dali::Image Decorator::GetGrabHandleImage() const
456 return mImpl->mGrabHandleImage;
459 void Decorator::SetSelectionActive( bool active )
461 mImpl->mActiveSelection = active;
464 bool Decorator::IsSelectionActive() const
466 return mImpl->mActiveSelection;
469 void Decorator::SetPosition( SelectionHandle handle, float x, float y, float height )
471 mImpl->mSelectionHandle[handle].x = x;
472 mImpl->mSelectionHandle[handle].y = y;
473 mImpl->mSelectionHandle[handle].cursorHeight = height;
476 void Decorator::GetPosition( SelectionHandle handle, float& x, float& y, float& height ) const
478 x = mImpl->mSelectionHandle[handle].x;
479 y = mImpl->mSelectionHandle[handle].y;
480 height = mImpl->mSelectionHandle[handle].cursorHeight;
483 void Decorator::SetImage( SelectionHandle handle, SelectionHandleState state, Dali::Image image )
485 if( SELECTION_HANDLE_PRESSED == state )
487 mImpl->mSelectionHandle[handle].pressedImage = image;
491 mImpl->mSelectionHandle[handle].releasedImage = image;
495 Dali::Image Decorator::GetImage( SelectionHandle handle, SelectionHandleState state ) const
497 if( SELECTION_HANDLE_PRESSED == state )
499 return mImpl->mSelectionHandle[handle].pressedImage;
502 return mImpl->mSelectionHandle[handle].releasedImage;
505 Decorator::~Decorator()
510 Decorator::Decorator( Dali::Toolkit::Internal::Control& parent, Observer& observer )
513 mImpl = new Decorator::Impl( parent, observer );
518 } // namespace Toolkit