#define DALI_TOOLKIT_TEXT_CONTROLLER_H
/*
- * Copyright (c) 2022 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2024 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-toolkit/devel-api/text/spanned.h>
+#include <dali/devel-api/adaptor-framework/clipboard.h>
#include <dali/devel-api/adaptor-framework/input-method-context.h>
+#include <dali/integration-api/processor-interface.h>
#include <dali/public-api/events/gesture.h>
// INTERNAL INCLUDES
*
* The text selection popup button callbacks are as well handled via the TextSelectionPopupCallbackInterface interface.
*/
-class Controller : public RefObject, public Decorator::ControllerInterface, public TextSelectionPopupCallbackInterface, public HiddenText::Observer
+class Controller : public RefObject,
+ public Decorator::ControllerInterface,
+ public TextSelectionPopupCallbackInterface,
+ public HiddenText::Observer,
+ public ConnectionTracker,
+ public Integration::Processor
{
public: // Enumerated types.
/**
bool IsTextFitEnabled() const;
/**
+ * @brief Sets current line size.
+ *
+ * @param[in] lineSize line size value to store the MinLineSize set by user when TextFitArray is enabled.
+ */
+ void SetCurrentLineSize(float lineSize);
+
+ /**
+ * @brief Retrieves the current line size.
+ *
+ * @return The current line size
+ */
+ float GetCurrentLineSize() const;
+
+ /**
* @brief Sets minimum size valid for text fit.
*
* @param[in] minimum size value.
bool IsTextFitChanged() const;
/**
+ * @brief Sets line size valid for text fit.
+ *
+ * @param[in] lineSize line size value
+ */
+ void SetTextFitLineSize(float lineSize);
+
+ /**
+ * @brief Enable or disable the text fit array.
+ *
+ * @param[in] enabled Whether to enable the text fit array.
+ */
+ void SetTextFitArrayEnabled(bool enabled);
+
+ /**
+ * @brief Whether the text fit array is enabled or not.
+ *
+ * @return True if the text fit array is enabled.
+ */
+ bool IsTextFitArrayEnabled() const;
+
+ /**
+ * @brief Sets the text fit array.
+ *
+ * @param[in] fitOptions The list of text fit options.
+ */
+ void SetTextFitArray(std::vector<Toolkit::DevelTextLabel::FitOption>& fitOptions);
+
+ /**
+ * @brief Retrieve the text fit array.
+ *
+ * @return The list of text fit options.
+ */
+ std::vector<Toolkit::DevelTextLabel::FitOption>& GetTextFitArray();
+
+ /**
* @brief Sets disabled color opacity.
*
* @param[in] opacity The color opacity value in disabled state.
void GetText(std::string& text) const;
/**
+ * @brief Retrieves number of characters previously set.
+ *
+ * @return A length of string of UTF-32 characters.
+ */
+ Length GetNumberOfCharacters() const;
+
+ /**
* @brief Set the @p spannedText
* the spanned text contains content (text) and format (spans with ranges)
* the text is copied into text-controller and the spans are applied on ranges
*
* @return The default font family.
*/
- const std::string& GetDefaultFontFamily() const;
+ std::string GetDefaultFontFamily() const;
/**
* @brief Sets the placeholder text font family.
*
* @return The placeholder text font family
*/
- const std::string& GetPlaceholderFontFamily() const;
+ std::string GetPlaceholderFontFamily() const;
/**
* @brief Sets the default font weight.
const Vector4& GetDefaultColor() const;
/**
+ * @brief Sets the anchor's default color.
+ *
+ * @param color The anchor color.
+ */
+ void SetAnchorColor(const Vector4& color);
+
+ /**
+ * @brief Retrieves the anchor's default color.
+ *
+ * @return The anchor color.
+ */
+ const Vector4& GetAnchorColor() const;
+
+ /**
+ * @brief Sets the anchor's clicked color.
+ *
+ * @param color The anchor color.
+ */
+ void SetAnchorClickedColor(const Vector4& color);
+
+ /**
+ * @brief Retrieves the anchor's clicked color.
+ *
+ * @return The anchor color.
+ */
+ const Vector4& GetAnchorClickedColor() const;
+
+ /**
* @brief Sets the user interaction enabled.
*
* @param enabled whether to enable the user interaction.
float GetDashedUnderlineGap() const;
/**
+ * @brief Set the outline offset.
+ *
+ * @param[in] outlineOffset The outline offset.
+ */
+ void SetOutlineOffset(const Vector2& outlineOffset);
+
+ /**
+ * @brief Retrieve the outline offset.
+ *
+ * @return The outline offset.
+ */
+ const Vector2& GetOutlineOffset() const;
+
+ /**
* @brief Set the outline color.
*
* @param[in] color color of outline.
uint16_t GetOutlineWidth() const;
/**
+ * @brief Set the outline blur radius.
+ *
+ * @param[in] outlineBlurRadius The outline blur radius, 0,0 indicates no blur.
+ */
+ void SetOutlineBlurRadius(const float& outlineBlurRadius);
+
+ /**
+ * @brief Retrieve the outline blur radius.
+ *
+ * @return The outline blur radius.
+ */
+ const float& GetOutlineBlurRadius() const;
+
+ /**
* @brief Set the background color.
*
* @param[in] color color of background.
*
* @return The emboss's properties string.
*/
- const std::string& GetDefaultEmbossProperties() const;
+ std::string GetDefaultEmbossProperties() const;
/**
* @brief Sets the outline's properties string.
*
* @return The outline's properties string.
*/
- const std::string& GetDefaultOutlineProperties() const;
+ std::string GetDefaultOutlineProperties() const;
/**
* @brief Sets the default line spacing.
*
* @return The input text's font family name.
*/
- const std::string& GetInputFontFamily() const;
+ std::string GetInputFontFamily() const;
/**
* @brief Sets the input font's weight.
* @brief Sets the input font's point size.
*
* @param[in] size The input font's point size.
+ * @param[in] defaultFontSizeUpdated True If the default font size is updated and sets the input point size, false otherwise.
*/
- void SetInputFontPointSize(float size);
+ void SetInputFontPointSize(float size, bool defaultFontSizeUpdated = false);
/**
* @brief Retrieves the input font's point size.
*
* @return The shadow's properties string.
*/
- const std::string& GetInputShadowProperties() const;
+ std::string GetInputShadowProperties() const;
/**
* @brief Sets the input underline's properties string.
*
* @return The underline's properties string.
*/
- const std::string& GetInputUnderlineProperties() const;
+ std::string GetInputUnderlineProperties() const;
/**
* @brief Sets the input emboss's properties string.
*
* @return The emboss's properties string.
*/
- const std::string& GetInputEmbossProperties() const;
+ std::string GetInputEmbossProperties() const;
/**
* @brief Sets input the outline's properties string.
*
* @return The outline's properties string.
*/
- const std::string& GetInputOutlineProperties() const;
+ std::string GetInputOutlineProperties() const;
/**
* @brief Sets the input strikethrough's properties string.
*
* @return The strikethrough's properties string.
*/
- const std::string& GetInputStrikethroughProperties() const;
+ std::string GetInputStrikethroughProperties() const;
/**
* @brief Set the control's interface.
*/
const float GetCharacterSpacing() const;
+ /**
+ * @brief Sets the visual transform offset.
+ *
+ * @param[in] offset The offset.
+ */
+ void SetVisualTransformOffset(Vector2 offset);
+
+ /**
+ * @brief Sets whether background color with cutout is enabled.
+ *
+ * @param[in] enable True if enabled.
+ */
+ void SetBackgroundWithCutoutEnabled(bool enable);
+
+ /**
+ * @brief Whether background color with cutout is enabled.
+ *
+ * @return True if enabled.
+ */
+ bool IsBackgroundWithCutoutEnabled() const;
+
+ /**
+ * @brief Sets whether background color with cutout.
+ *
+ * @param[in] color The color to set.
+ */
+ void SetBackgroundColorWithCutout(const Vector4& color);
+
+ /**
+ * @brief Retrieves background color with cutout.
+ *
+ * @return The color.
+ */
+ const Vector4 GetBackgroundColorWithCutout() const;
+
public: // Queries & retrieves.
/**
* @brief Return the layout engine.
void FitPointSizeforLayout(Size layoutSize);
/**
+ * @brief Calculates the point size for text for given layout() using fit array.
+ */
+ void FitArrayPointSizeforLayout(Size layoutSize);
+
+ /**
* @brief Checks if the point size fits within the layout size.
*
* @return Whether the point size fits within the layout size.
void SetIgnoreSpacesAfterText(bool ignore);
/**
+ * @brief Retrieves removeFrontInset value from model
+ * @return The value of removeFrontInset
+ */
+ bool IsRemoveFrontInset() const;
+
+ /**
+ * @brief Sets removeFrontInset value to model
+ * @param[in] remove The value of removeFrontInset for the text
+ */
+ void SetRemoveFrontInset(bool remove);
+
+ /**
+ * @brief Retrieves removeBackInset value from model
+ * @return The value of removeBackInset
+ */
+ bool IsRemoveBackInset() const;
+
+ /**
+ * @brief Sets removeBackInset value to model
+ * @param[in] remove The value of removeBackInset for the text
+ */
+ void SetRemoveBackInset(bool remove);
+
+ /**
+ * @brief Retrieves cutout value to model
+ * @return The value of cutout for the text
+ */
+ bool IsTextCutout() const;
+
+ /**
+ * @brief Sets cutout value to model
+ * @param[in] cutout The value of cutout for the text
+ */
+ void SetTextCutout(bool cutout);
+
+ /**
* @brief Sets SetMatchLayoutDirection value to model
* @param[in] match The value of matchLayoutDirection for the text
*/
Rect<float> GetCharacterBoundingRectangle(const uint32_t charIndex);
/**
+ * @brief Get the character index.
+ * If the text is not yet rendered or the text is empty, -1 is returned.
+ *
+ * @param[in] visualX visual x position.
+ * @param[in] visualY visual y position.
+ * @return character index.
+ */
+ int GetCharacterIndexAtPosition(float visualX, float visualY);
+
+ /**
* @brief Gets the bounding box of a specific text range.
*
* @param[in] startIndex start index of the text requested to get bounding box to.
void ChangedLayoutDirection();
/**
+ * @brief Clear font and style data.
+ */
+ void ResetFontAndStyleData();
+
+ /**
* @brief Retrieves if showing real text or not.
* @return The value of showing real text.
*/
bool IsInputStyleChangedSignalsQueueEmpty();
/**
- * @brief Process all pending input style changed signals.
+ * @brief Request process all pending input style changed signals.
*
- * Calls the Text::ControlInterface::InputStyleChanged() method which is overriden by the
+ * Request to calls the Text::ControlInterface::InputStyleChanged() method which is overriden by the
* text controls. Text controls may send signals to state the input style has changed.
+ *
+ * The signal will be execute next idle time, or skip if we fail to add idler.
+ */
+ void RequestProcessInputStyleChangedSignals();
+
+private:
+ /**
+ * @brief Callbacks called on idle.
+ *
+ * If there are notifications of change of input style on the queue, Toolkit::TextField::InputStyleChangedSignal() are emitted.
*/
- void ProcessInputStyleChangedSignals();
+ void OnIdleSignal();
public: // Text-input Event Queuing.
/**
/**
* @brief Event from Clipboard notifying an Item has been selected for pasting
+ *
+ * @param[in] id The id of the data request.
+ * @param[in] mimeType The mime type of data received.
+ * @param[in] data The data received.
+ * @note
+ * This event is executed by receiving the Clipboard's DataReceivedSignal.
*/
- void PasteClipboardItemEvent();
+ void PasteClipboardItemEvent(uint32_t id, const char* mimeType, const char* data);
/**
* @brief Return true when text control should clear key input focus when escape key is pressed.
*/
void DisplayTimeExpired() override;
+protected: // Inherit from Integration::Processor
+ /**
+ * @copydoc Dali::Integration::Processor::Process()
+ */
+ void Process(bool postProcess) override;
+
+ /**
+ * @copydoc Dali::Integration::Processor::GetProcessorName()
+ */
+ std::string_view GetProcessorName() const override
+ {
+ return "Text::Controller";
+ }
+
private: // Private contructors & copy operator.
/**
* @brief Private constructor.
struct TextUpdater;
struct SpannableHandler;
- Impl* mImpl;
+ std::unique_ptr<Impl> mImpl{nullptr};
};
} // namespace Dali::Toolkit::Text
projects / platform / core / uifw / dali-toolkit.git / blobdiff