#define DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H
/*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 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/devel-api/adaptor-framework/clipboard-event-notifier.h>
+#include <dali/devel-api/adaptor-framework/input-method-context.h>
+#include <dali/devel-api/adaptor-framework/accessibility.h>
+#include <dali/public-api/animation/animation.h>
// INTERNAL INCLUDES
#include <dali-toolkit/public-api/controls/control-impl.h>
+#include <dali-toolkit/devel-api/controls/scroll-bar/scroll-bar.h>
#include <dali-toolkit/public-api/controls/text-controls/text-editor.h>
+#include <dali-toolkit/devel-api/controls/text-controls/text-editor-devel.h>
#include <dali-toolkit/internal/text/decorator/text-decorator.h>
#include <dali-toolkit/internal/text/text-control-interface.h>
#include <dali-toolkit/internal/text/text-editable-control-interface.h>
+#include <dali-toolkit/internal/text/text-selectable-control-interface.h>
#include <dali-toolkit/internal/text/text-controller.h>
#include <dali-toolkit/internal/text/text-vertical-scroller.h>
#include <dali-toolkit/internal/text/rendering/text-renderer.h>
+#include <dali-toolkit/internal/controls/control/control-data-impl.h>
namespace Dali
{
namespace Internal
{
-
/**
* @brief A control which renders a long text string with styles.
*/
-class TextEditor : public Control, public Text::ControlInterface, public Text::EditableControlInterface
+class TextEditor : public Control, public Text::ControlInterface, public Text::EditableControlInterface, public Text::SelectableControlInterface
{
public:
static Property::Value GetProperty( BaseObject* object, Property::Index index );
/**
+ * @copydoc Dali::Toollkit::TextEditor::GetInputMethodContext()
+ */
+ InputMethodContext GetInputMethodContext();
+
+ /**
+ * @copydoc Dali::Toollkit::TextEditor::MaxLengthReachedSignal()
+ */
+ DevelTextEditor::MaxLengthReachedSignalType& MaxLengthReachedSignal();
+
+ /**
* Connects a callback function with the object's signals.
* @param[in] object The object providing the signal.
* @param[in] tracker Used to disconnect the signal.
*/
Toolkit::TextEditor::InputStyleChangedSignalType& InputStyleChangedSignal();
+ /**
+ * @copydoc TextEditor::ScrollStateChangedSignal()
+ */
+ Toolkit::TextEditor::ScrollStateChangedSignalType& ScrollStateChangedSignal();
+
private: // From Control
/**
* @copydoc Control::OnInitialize()
*/
- virtual void OnInitialize();
+ void OnInitialize() override;
/**
* @copydoc Control::OnStyleChange()
*/
- virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
+ void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change ) override;
/**
* @copydoc Control::GetNaturalSize()
*/
- virtual Vector3 GetNaturalSize();
+ Vector3 GetNaturalSize() override;
/**
* @copydoc Control::GetHeightForWidth()
*/
- virtual float GetHeightForWidth( float width );
+ float GetHeightForWidth( float width ) override;
/**
* @copydoc Control::OnInitialize()
*/
- virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
+ void OnRelayout( const Vector2& size, RelayoutContainer& container ) override;
/**
* @copydoc Control::OnKeyInputFocusGained()
*/
- virtual void OnKeyInputFocusGained();
+ void OnKeyInputFocusGained() override;
/**
* @copydoc Control::OnKeyInputFocusLost()
*/
- virtual void OnKeyInputFocusLost();
+ void OnKeyInputFocusLost() override;
/**
* @copydoc Control::OnTap()
*/
- virtual void OnTap( const TapGesture& tap );
+ void OnTap( const TapGesture& tap ) override;
/**
* @copydoc Control::OnPan()
*/
- virtual void OnPan( const PanGesture& gesture );
+ void OnPan( const PanGesture& gesture ) override;
/**
* @copydoc Control::OnLongPress()
*/
- virtual void OnLongPress( const LongPressGesture& gesture );
+ void OnLongPress( const LongPressGesture& gesture ) override;
/**
- * @copydoc Control::OnStageConnection()
+ * @copydoc Control::OnSceneConnection()
*/
- virtual void OnStageConnection( int depth );
+ void OnSceneConnection( int depth ) override;
/**
* @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
*/
- virtual bool OnKeyEvent(const KeyEvent& event);
+ bool OnKeyEvent(const KeyEvent& event) override;
// From ControlInterface
/**
* @copydoc Text::ControlInterface::RequestTextRelayout()
*/
- virtual void RequestTextRelayout();
+ void RequestTextRelayout() override;
// From EditableControlInterface
/**
- * @copydoc Text::ControlInterface::TextChanged()
+ * @copydoc Text::EditableControlInterface::TextChanged()
+ */
+ void TextInserted( unsigned int position, unsigned int length, const std::string &content ) override;
+
+ /**
+ * @copydoc Text::EditableControlInterface::TextDeleted()
+ */
+ void TextDeleted( unsigned int position, unsigned int length, const std::string &content ) override;
+
+ /**
+ * @copydoc Text::EditableControlInterface::CaretMoved()
+ */
+ void CaretMoved( unsigned int position ) override;
+
+ /**
+ * @copydoc Text::EditableControlInterface::TextChanged()
+ */
+ void TextChanged() override;
+
+ /**
+ * @copydoc Text::EditableControlInterface::MaxLengthReached()
+ */
+ void MaxLengthReached() override;
+
+ /**
+ * @copydoc Text::EditableControlInterface::InputStyleChanged()
*/
- virtual void TextChanged();
+ void InputStyleChanged( Text::InputStyle::Mask inputStyleMask ) override;
/**
- * @copydoc Text::ControlInterface::MaxLengthReached()
+ * @copydoc Text::EditableControlInterface::AddDecoration()
*/
- virtual void MaxLengthReached();
+ void AddDecoration( Actor& actor, bool needsClipping ) override;
+
+// From SelectableControlInterface
+public:
+ /**
+ * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
+ */
+ void SetTextSelectionRange(const uint32_t *start, const uint32_t *end) override;
+
+ /**
+ * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
+ */
+ Uint32Pair GetTextSelectionRange() const override;
+
+ /**
+ * @copydoc Text::SelectableControlInterface::SelectWholeText()
+ */
+ void SelectWholeText() override;
+
+ /**
+ * @copydoc Text::SelectableControlInterface::SelectNone()
+ */
+ void SelectNone() override;
/**
- * @copydoc Text::ControlInterface::InputStyleChanged()
+ * @copydoc Text::SelectableControlInterface::GetSelectedText()
*/
- virtual void InputStyleChanged( Text::InputStyle::Mask inputStyleMask );
+ string GetSelectedText() const override;
/**
- * @copydoc Text::ControlInterface::AddDecoration()
+ * @copydoc Text::EditableControlInterface::IsEditable()
*/
- virtual void AddDecoration( Actor& actor, bool needsClipping );
+ bool IsEditable() const override;
+
+ /**
+ * @copydoc Text::EditableControlInterface::SetEditable()
+ */
+ void SetEditable( bool editable ) override;
+ Text::ControllerPtr getController();
private: // Implementation
/**
- * @copydoc Dali::Toolkit::Text::Controller::(ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent)
+ * @copydoc Dali::Toolkit::Text::Controller::(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
*/
- ImfManager::ImfCallbackData OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent );
+ InputMethodContext::CallbackData OnInputMethodContextEvent( InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent );
/**
* @brief Callback when Clipboard signals an item should be pasted
void KeyboardStatusChanged( bool keyboardShown );
/**
+ * @brief update scroll bar position
+ *
+ * If text scroll is occurred, create or update scroll bar position
+ */
+ void UpdateScrollBar();
+
+ /**
* @brief Callback when TextEditor is touched
*
* @param[in] actor TextEditor touched
* @param[in] touch Touch information
*/
- bool OnTouched( Actor actor, const TouchData& touch );
+ bool OnTouched( Actor actor, const TouchEvent& touch );
/**
* @brief Callbacks called on idle.
void ApplyScrollPosition();
/**
+ * @brief Callback function for ScrollBar indicator animation finished signal
+ *
+ * Emit ScrollBarStateChanged Signal and toggle mScrollStarted flag to false
+ */
+ void OnScrollIndicatorAnimationFinished( Animation& animation );
+
+ /**
* Construct a new TextEditor.
*/
TextEditor();
*/
void RenderText( Text::Controller::UpdateTextType updateTextType );
- // Connection needed to re-render text, when a text editor returns to the stage.
- void OnStageConnect( Dali::Actor actor );
+ // Connection needed to re-render text, when a text editor returns to the scene.
+ void OnSceneConnect( Dali::Actor actor );
private: // Data
-
// Signals
Toolkit::TextEditor::TextChangedSignalType mTextChangedSignal;
Toolkit::TextEditor::InputStyleChangedSignalType mInputStyleChangedSignal;
+ Toolkit::TextEditor::ScrollStateChangedSignalType mScrollStateChangedSignal;
+ Toolkit::DevelTextEditor::MaxLengthReachedSignalType mMaxLengthReachedSignal;
+ InputMethodContext mInputMethodContext;
Text::ControllerPtr mController;
Text::RendererPtr mRenderer;
Text::DecoratorPtr mDecorator;
Text::TextVerticalScrollerPtr mTextVerticalScroller;
Toolkit::Control mStencil;
+ Toolkit::ScrollBar mScrollBar;
+ Dali::Animation mAnimation; ///< Scroll indicator Show/Hide Animation.
+ Dali::TimePeriod mAnimationPeriod;
std::vector<Actor> mClippingDecorationActors; ///< Decoration actors which need clipping.
Actor mRenderableActor;
+ Actor mActiveLayer;
CallbackBase* mIdleCallback;
float mAlignmentOffset;
float mScrollAnimationDuration;
+ float mLineSpacing;
int mRenderingBackend;
bool mHasBeenStaged:1;
bool mScrollAnimationEnabled:1;
+ bool mScrollBarEnabled:1;
+ bool mScrollStarted:1;
+
+ struct AccessibleImpl : public Control::Impl::AccessibleImpl,
+ public virtual Dali::Accessibility::Text,
+ public virtual Dali::Accessibility::EditableText
+ {
+ using Control::Impl::AccessibleImpl::AccessibleImpl;
+
+ std::string GetName() override;
+ std::string GetText( size_t startOffset, size_t endOffset ) override;
+ size_t GetCharacterCount() override;
+ size_t GetCaretOffset() override;
+ bool SetCaretOffset(size_t offset) override;
+ Dali::Accessibility::Range
+ GetTextAtOffset( size_t offset,
+ Dali::Accessibility::TextBoundary boundary ) override;
+ Dali::Accessibility::Range GetSelection( size_t selectionNum ) override;
+ bool RemoveSelection( size_t selectionNum ) override;
+ bool SetSelection( size_t selectionNum, size_t startOffset,
+ size_t endOffset ) override;
+ bool CopyText( size_t startPosition, size_t endPosition ) override;
+ bool CutText( size_t startPosition, size_t endPosition ) override;
+ Dali::Accessibility::States CalculateStates() override;
+ };
};
} // namespace Internal
projects / platform / core / uifw / dali-toolkit.git / blobdiff