#define DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H
/*
- * Copyright (c) 2021 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2022 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.
#include <dali/devel-api/adaptor-framework/accessibility.h>
#include <dali/devel-api/adaptor-framework/clipboard-event-notifier.h>
#include <dali/devel-api/adaptor-framework/input-method-context.h>
+#include <dali/devel-api/atspi-interfaces/editable-text.h>
+#include <dali/devel-api/atspi-interfaces/hypertext.h>
+#include <dali/devel-api/atspi-interfaces/text.h>
#include <dali/public-api/animation/animation.h>
// INTERNAL INCLUDES
DevelTextEditor::AnchorClickedSignalType& AnchorClickedSignal();
/**
+ * @copydoc Dali::Toollkit::TextEditor::CursorPositionChangedSignal()
+ */
+ DevelTextEditor::CursorPositionChangedSignalType& CursorPositionChangedSignal();
+
+ /**
* @copydoc Dali::Toollkit::TextEditor::InputFilteredSignal()
*/
DevelTextEditor::InputFilteredSignalType& InputFilteredSignal();
/**
+ * @copydoc Dali::Toollkit::TextEditor::SelectionChangedSignal()
+ */
+ DevelTextEditor::SelectionChangedSignalType& SelectionChangedSignal();
+
+ /**
+ * @copydoc Dali::Toollkit::TextEditor::SelectionClearedSignal()
+ */
+ DevelTextEditor::SelectionClearedSignalType& SelectionClearedSignal();
+
+ /**
+ * @copydoc Dali::Toollkit::TextEditor::SelectionStartedSignal()
+ */
+ DevelTextEditor::SelectionStartedSignalType& SelectionStartedSignal();
+
+ /**
* 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.
static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
/**
+ * @brief Gets text controller
+ *
+ * @return The text controller
+ */
+ Text::ControllerPtr GetTextController();
+
+ /**
* @copydoc TextEditor::TextChangedSignal()
*/
Toolkit::TextEditor::TextChangedSignalType& TextChangedSignal();
void TextDeleted(unsigned int position, unsigned int length, const std::string& content) override;
/**
- * @copydoc Text::EditableControlInterface::CaretMoved()
+ * @copydoc Text::EditableControlInterface::CursorPositionChanged()
*/
- void CaretMoved(unsigned int position) override;
+ void CursorPositionChanged(unsigned int oldPosition, unsigned int newPosition) override;
/**
* @copydoc Text::EditableControlInterface::TextChanged()
void InputStyleChanged(Text::InputStyle::Mask inputStyleMask) override;
/**
+ * @copydoc Text::SelectableControlInterface::SelectionChanged()
+ */
+ void SelectionChanged(uint32_t oldStart, uint32_t oldEnd, uint32_t newStart, uint32_t newEnd) override;
+
+ /**
* @copydoc Text::EditableControlInterface::AddDecoration()
*/
- void AddDecoration(Actor& actor, bool needsClipping) override;
+ void AddDecoration(Actor& actor, Toolkit::Text::DecorationType type, bool needsClipping) override;
/**
* @copydoc Text::EditableControlInterface::InputFiltered()
*/
void InputFiltered(Toolkit::InputFilter::Property::Type type) override;
+ /**
+ * @copydoc Text::EditableControlInterface::GetControlBackgroundColor()
+ */
+ void GetControlBackgroundColor(Vector4& color) const override;
+
// From SelectableControlInterface
public:
/**
void SelectNone() override;
/**
+ * @copydoc Text::SelectableControlInterface::SelectText()
+ */
+ void SelectText(const uint32_t start, const uint32_t end) override;
+
+ /**
* @copydoc Dali::Toolkit::DevelTextEditor::ScrollBy()
*/
void ScrollBy(Vector2 Scroll);
float GetVerticalScrollPosition();
/**
+ * @brief Get the rendered size of a specific text range.
+ * if the requested text is at multilines, multiple sizes will be returned for each text located in a separate line.
+ * if a line contains characters with different directions, multiple sizes will be returned for each block of contiguous characters with the same direction.
+ *
+ * @param[in] startIndex start index of the text requested to calculate size for.
+ * @param[in] endIndex end index(included) of the text requested to calculate size for.
+ * @return list of sizes of the reuested text.
+ */
+ Vector<Vector2> GetTextSize(const uint32_t startIndex, const uint32_t endIndex) const;
+
+ /**
+ * @brief Get the top/left rendered position of a specific text range.
+ * if the requested text is at multilines, multiple positions will be returned for each text located in a separate line.
+ * if a line contains characters with different directions, multiple positions will be returned for each block of contiguous characters with the same direction.
+ *
+ * @param[in] startIndex start index of the text requested to get position to.
+ * @param[in] endIndex end index(included) of the text requested to get position to.
+ * @return list of positions of the requested text.
+ */
+ Vector<Vector2> GetTextPosition(const uint32_t startIndex, const uint32_t endIndex) const;
+
+ /**
* @copydoc Text::SelectableControlInterface::GetSelectedText()
*/
string GetSelectedText() const override;
*/
void SetEditable(bool editable) override;
+ /**
+ * @copydoc Text::EditableControlInterface::CopyText()
+ */
+ string CopyText() override;
+
+ /**
+ * @copydoc Text::EditableControlInterface::CutText()
+ */
+ string CutText() override;
+
+ /**
+ * @copydoc Text::EditableControlInterface::PasteText()
+ */
+ void PasteText() override;
+
// From AnchorControlInterface
/**
*/
void AnchorClicked(const std::string& href) override;
- Text::ControllerPtr getController();
-
private: // Implementation
/**
* @copydoc Dali::Toolkit::Text::Controller::(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
void OnIdleSignal();
/**
+ * @brief Emits CursorPositionChanged signal.
+ */
+ void EmitCursorPositionChangedSignal();
+
+ /**
* @brief Emits TextChanged signal.
*/
void EmitTextChangedSignal();
/**
+ * @brief Emits SelectionChanged signal.
+ */
+ void EmitSelectionChangedSignal();
+
+ /**
+ * @brief Emits SelectionCleared signal.
+ */
+ void EmitSelectionClearedSignal();
+
+ /**
+ * @brief Emits SelectionStarted signal.
+ */
+ void EmitSelectionStartedSignal();
+
+ /**
* @brief set RenderActor's position with new scrollPosition
*
* Apply updated scroll position or start scroll animation if VerticalScrollAnimation is enabled
void OnScrollIndicatorAnimationFinished(Animation& animation);
/**
+ * @brief Callback function for when the layout is changed.
+ * @param[in] actor The actor whose layoutDirection is changed.
+ * @param[in] type The layoutDirection.
+ */
+ void OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type);
+
+ /**
+ * @brief Add a layer for active or cursor.
+ * @param[in] layer The actor in which to store the layer.
+ * @param[in] actor The new layer to add.
+ */
+ void AddLayer(Actor& layer, Actor& actor);
+
+ /**
* Construct a new TextEditor.
*/
TextEditor();
// Connection needed to re-render text, when a text editor returns to the scene.
void OnSceneConnect(Dali::Actor actor);
+ // Needed to synchronize TextAnchor actors with Anchor objects in text's logical model
+ void OnAccessibilityStatusChanged();
+
private: // Data
// Signals
- Toolkit::TextEditor::TextChangedSignalType mTextChangedSignal;
- Toolkit::TextEditor::InputStyleChangedSignalType mInputStyleChangedSignal;
- Toolkit::TextEditor::ScrollStateChangedSignalType mScrollStateChangedSignal;
- Toolkit::DevelTextEditor::MaxLengthReachedSignalType mMaxLengthReachedSignal;
- Toolkit::DevelTextEditor::AnchorClickedSignalType mAnchorClickedSignal;
- Toolkit::DevelTextEditor::InputFilteredSignalType mInputFilteredSignal;
-
- 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.
- Dali::InputMethodOptions mInputMethodOptions;
+ Toolkit::TextEditor::TextChangedSignalType mTextChangedSignal;
+ Toolkit::TextEditor::InputStyleChangedSignalType mInputStyleChangedSignal;
+ Toolkit::TextEditor::ScrollStateChangedSignalType mScrollStateChangedSignal;
+ Toolkit::DevelTextEditor::MaxLengthReachedSignalType mMaxLengthReachedSignal;
+ Toolkit::DevelTextEditor::AnchorClickedSignalType mAnchorClickedSignal;
+ Toolkit::DevelTextEditor::InputFilteredSignalType mInputFilteredSignal;
+ Toolkit::DevelTextEditor::CursorPositionChangedSignalType mCursorPositionChangedSignal;
+ Toolkit::DevelTextEditor::SelectionChangedSignalType mSelectionChangedSignal;
+ Toolkit::DevelTextEditor::SelectionClearedSignalType mSelectionClearedSignal;
+ Toolkit::DevelTextEditor::SelectionStartedSignalType mSelectionStartedSignal;
+
+ 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.
+ std::vector<Toolkit::TextAnchor> mAnchorActors;
+ Dali::InputMethodOptions mInputMethodOptions;
Actor mRenderableActor;
Actor mActiveLayer;
+ Actor mCursorLayer;
Actor mBackgroundActor;
CallbackBase* mIdleCallback;
bool mScrollAnimationEnabled : 1;
bool mScrollBarEnabled : 1;
bool mScrollStarted : 1;
- bool mTextChanged : 1; ///< If true, emits TextChangedSignal in next OnRelayout().
+ bool mTextChanged : 1; ///< If true, emits TextChangedSignal in next OnRelayout().
+ bool mCursorPositionChanged : 1; ///< If true, emits CursorPositionChangedSignal at the end of OnRelayout().
+ bool mSelectionChanged : 1; ///< If true, emits SelectionChangedSignal at the end of OnRelayout().
+ bool mSelectionCleared : 1; ///< If true, emits SelectionClearedSignal at the end of OnRelayout().
+
+ //args for cursor PositionChanged event
+ unsigned int mOldPosition;
+
+ //args for selection changed event
+ uint32_t mOldSelectionStart;
+ uint32_t mOldSelectionEnd;
+
+ bool mSelectionStarted : 1; ///< If true, emits SelectionStartedSignal at the end of OnRelayout().
- struct AccessibleImpl : public DevelControl::AccessibleImpl,
- public virtual Dali::Accessibility::Text,
- public virtual Dali::Accessibility::EditableText
+ struct PropertyHandler;
+
+ /**
+ * @brief This structure is to connect TextEditor with Accessible functions.
+ */
+ struct AccessibleImpl : public DevelControl::ControlAccessible,
+ public virtual Dali::Accessibility::EditableText,
+ public virtual Dali::Accessibility::Hypertext
{
- using DevelControl::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;
- Accessibility::Range GetTextAtOffset(size_t offset, Accessibility::TextBoundary boundary) override;
- 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;
+ using DevelControl::ControlAccessible::ControlAccessible;
+
+ /**
+ * @copydoc Dali::Accessibility::Accessible::GetName()
+ */
+ std::string GetName() const override;
+
+ /**
+ * @copydoc Dali::Accessibility::Text::GetText()
+ */
+ std::string GetText(size_t startOffset, size_t endOffset) const override;
+
+ /**
+ * @copydoc Dali::Accessibility::Text::GetCharacterCount()
+ */
+ size_t GetCharacterCount() const override;
+
+ /**
+ * @copydoc Dali::Accessibility::Text::GetCursorOffset()
+ */
+ size_t GetCursorOffset() const override;
+
+ /**
+ * @copydoc Dali::Accessibility::Text::SetCursorOffset()
+ */
+ bool SetCursorOffset(size_t offset) override;
+
+ /**
+ * @copydoc Dali::Accessibility::Text::GetTextAtOffset()
+ */
+ Accessibility::Range GetTextAtOffset(size_t offset, Accessibility::TextBoundary boundary) const override;
+
+ /**
+ * @copydoc Dali::Accessibility::Text::GetRangeOfSelection()
+ */
+ Accessibility::Range GetRangeOfSelection(size_t selectionIndex) const override;
+
+ /**
+ * @copydoc Dali::Accessibility::Text::RemoveSelection()
+ */
+ bool RemoveSelection(size_t selectionIndex) override;
+
+ /**
+ * @copydoc Dali::Accessibility::Text::SetRangeOfSelection()
+ */
+ bool SetRangeOfSelection(size_t selectionIndex, size_t startOffset, size_t endOffset) override;
+
+ /**
+ * @copydoc Dali::Accessibility::Text::GetRangeExtents()
+ */
+ Rect<> GetRangeExtents(size_t startOffset, size_t endOffset, Accessibility::CoordinateType type) override;
+
+ /**
+ * @copydoc Dali::Accessibility::EditableText::CopyText()
+ */
+ bool CopyText(size_t startPosition, size_t endPosition) override;
+
+ /**
+ * @copydoc Dali::Accessibility::EditableText::CutText()
+ */
+ bool CutText(size_t startPosition, size_t endPosition) override;
+
+ /**
+ * @copydoc Dali::Accessibility::Accessible::GetStates()
+ */
Accessibility::States CalculateStates() override;
- bool InsertText(size_t startPosition, std::string text) override;
- bool SetTextContents(std::string newContents) override;
- bool DeleteText(size_t startPosition, size_t endPosition) override;
+
+ /**
+ * @copydoc Dali::Accessibility::EditableText::InsertText()
+ */
+ bool InsertText(size_t startPosition, std::string text) override;
+
+ /**
+ * @copydoc Dali::Accessibility::EditableText::SetTextContents()
+ */
+ bool SetTextContents(std::string newContents) override;
+
+ /**
+ * @copydoc Dali::Accessibility::EditableText::DeleteText()
+ */
+ bool DeleteText(size_t startPosition, size_t endPosition) override;
+
+ /**
+ * @copydoc Dali::Accessibility::Hypertext::GetLink()
+ */
+ Accessibility::Hyperlink* GetLink(int32_t linkIndex) const override;
+
+ /**
+ * @copydoc Dali::Accessibility::Hypertext::GetLinkIndex()
+ */
+ int32_t GetLinkIndex(int32_t characterOffset) const override;
+
+ /**
+ * @copydoc Dali::Accessibility::Hypertext::GetLinkCount()
+ */
+ int32_t GetLinkCount() const override;
};
};
projects / platform / core / uifw / dali-toolkit.git / blobdiff