dali-toolkit/internal/controls/text-controls/text-field-impl.h

   1 #ifndef DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H
   2 #define DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H
   3
   4 /*
   5  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/devel-api/adaptor-framework/clipboard-event-notifier.h>
  23 #include <dali/devel-api/adaptor-framework/input-method-context.h>
  24 #include <dali/devel-api/adaptor-framework/autofill-item.h>
  25
  26 // INTERNAL INCLUDES
  27 #include <dali-toolkit/public-api/controls/control-impl.h>
  28 #include <dali-toolkit/public-api/controls/text-controls/text-field.h>
  29 #include <dali-toolkit/internal/text/decorator/text-decorator.h>
  30 #include <dali-toolkit/internal/text/text-control-interface.h>
  31 #include <dali-toolkit/internal/text/text-editable-control-interface.h>
  32 #include <dali-toolkit/internal/text/text-selectable-control-interface.h>
  33 #include <dali-toolkit/internal/text/text-controller.h>
  34 #include <dali-toolkit/internal/text/rendering/text-renderer.h>
  35
  36 namespace Dali
  37 {
  38
  39 namespace Toolkit
  40 {
  41
  42 namespace Internal
  43 {
  44 /**
  45  * @brief A control which renders a short text string.
  46  */
  47 class TextField : public Control, public Text::ControlInterface, public Text::EditableControlInterface, public Text::SelectableControlInterface
  48 {
  49 public:
  50
  51   /**
  52    * @copydoc Dali::Toollkit::TextField::New()
  53    */
  54   static Toolkit::TextField New();
  55
  56   // Properties
  57
  58   /**
  59    * @brief Called when a property of an object of this type is set.
  60    *
  61    * @param[in] object The object whose property is set.
  62    * @param[in] index The property index.
  63    * @param[in] value The new property value.
  64    */
  65   static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
  66
  67   /**
  68    * @brief Called to retrieve a property of an object of this type.
  69    *
  70    * @param[in] object The object whose property is to be retrieved.
  71    * @param[in] index The property index.
  72    * @return The current value of the property.
  73    */
  74   static Property::Value GetProperty( BaseObject* object, Property::Index index );
  75
  76   /**
  77    * @copydoc Dali::Toollkit::TextField::GetInputMethodContext()
  78    */
  79   InputMethodContext GetInputMethodContext();
  80
  81   /**
  82    * Connects a callback function with the object's signals.
  83    * @param[in] object The object providing the signal.
  84    * @param[in] tracker Used to disconnect the signal.
  85    * @param[in] signalName The signal to connect to.
  86    * @param[in] functor A newly allocated FunctorDelegate.
  87    * @return True if the signal was connected.
  88    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
  89    */
  90   static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
  91
  92   /**
  93    * @copydoc TextField::TextChangedSignal()
  94    */
  95   Toolkit::TextField::TextChangedSignalType&  TextChangedSignal();
  96
  97   /**
  98    * @copydoc TextField::MaxLengthReachedSignal()
  99    */
 100   Toolkit::TextField::MaxLengthReachedSignalType&  MaxLengthReachedSignal();
 101
 102   /**
 103    * @copydoc TextField::TextChangedSignal()
 104    */
 105   Toolkit::TextField::InputStyleChangedSignalType& InputStyleChangedSignal();
 106
 107   /**
 108    * @brief Called to select the whole texts.
 109    */
 110   void SelectWholeText();
 111
 112   /**
 113    * @brief Called to unselect the whole texts.
 114    */
 115   void SelectNone();
 116
 117 private: // From Control
 118
 119   /**
 120    * @copydoc Control::OnInitialize()
 121    */
 122   void OnInitialize() override;
 123
 124   /**
 125    * @copydoc Control::OnStyleChange()
 126    */
 127   void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change ) override;
 128
 129   /**
 130    * @copydoc Control::GetNaturalSize()
 131    */
 132   Vector3 GetNaturalSize() override;
 133
 134   /**
 135    * @copydoc Control::GetHeightForWidth()
 136    */
 137   float GetHeightForWidth( float width ) override;
 138
 139   /**
 140    * @copydoc Control::OnInitialize()
 141    */
 142   void OnRelayout( const Vector2& size, RelayoutContainer& container ) override;
 143
 144   /**
 145    * @copydoc Control::OnKeyInputFocusGained()
 146    */
 147   void OnKeyInputFocusGained() override;
 148
 149   /**
 150    * @copydoc Control::OnKeyInputFocusLost()
 151    */
 152   void OnKeyInputFocusLost() override;
 153
 154   /**
 155    * @copydoc Control::OnTap()
 156    */
 157   void OnTap( const TapGesture& tap ) override;
 158
 159   /**
 160    * @copydoc Control::OnPan()
 161    */
 162   void OnPan( const PanGesture& gesture ) override;
 163
 164   /**
 165    * @copydoc Control::OnLongPress()
 166    */
 167   void OnLongPress( const LongPressGesture& gesture ) override;
 168
 169   /**
 170    * @copydoc Control::OnSceneConnection()
 171    */
 172   void OnSceneConnection( int depth ) override;
 173
 174   /**
 175    * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
 176    */
 177   bool OnKeyEvent(const KeyEvent& event) override;
 178
 179 // From ControlInterface
 180
 181   /**
 182    * @copydoc Text::ControlInterface::RequestTextRelayout()
 183    */
 184   void RequestTextRelayout() override;
 185
 186 // From EditableControlInterface
 187
 188   /**
 189    * @copydoc Text::ControlInterface::TextChanged()
 190    */
 191   void TextChanged() override;
 192
 193   /**
 194    * @copydoc Text::ControlInterface::MaxLengthReached()
 195    */
 196   void MaxLengthReached() override;
 197
 198   /**
 199    * @copydoc Text::ControlInterface::InputStyleChanged()
 200    */
 201   void InputStyleChanged( Text::InputStyle::Mask inputStyleMask ) override;
 202
 203   /**
 204    * @copydoc Text::ControlInterface::AddDecoration()
 205    */
 206   void AddDecoration( Actor& actor, bool needsClipping ) override;
 207
 208 // From SelectableControlInterface
 209 public:
 210   /**
 211    * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
 212    */
 213   void SetTextSelectionRange(const uint32_t *start, const uint32_t *end) override;
 214
 215   /**
 216    * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
 217    */
 218   Uint32Pair GetTextSelectionRange() const override;
 219
 220   /**
 221    * @copydoc Text::EditableControlInterface::IsEditable()
 222    */
 223   bool IsEditable() const override;
 224
 225   /**
 226    * @copydoc Text::EditableControlInterface::SetEditable()
 227    */
 228   void SetEditable( bool editable ) override;
 229
 230 private: // Implementation
 231
 232   /**
 233    * @copydoc Dali::Toolkit::Text::Controller::(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
 234    */
 235   InputMethodContext::CallbackData OnInputMethodContextEvent( InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent );
 236
 237   /**
 238    * @brief Callback when Clipboard signals an item should be pasted
 239    * @param[in] clipboard handle to Clipboard Event Notifier
 240    */
 241   void OnClipboardTextSelected( ClipboardEventNotifier& clipboard );
 242
 243   /**
 244    * @brief Get a Property Map for the image used for the required Handle Image
 245    * @param[out] value the returned image property
 246    * @param[in] handleType the type of handle
 247    * @param[in] handleImageType the type of image for the given handleType
 248    */
 249   void GetHandleImagePropertyValue(  Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType );
 250
 251   /**
 252    * @brief Enable or disable clipping.
 253    */
 254   void EnableClipping();
 255
 256   /**
 257    * @brief Callback when keyboard is shown/hidden.
 258    *
 259    * @param[in] keyboardShown True if keyboard is shown.
 260    */
 261   void KeyboardStatusChanged( bool keyboardShown );
 262
 263   /**
 264    * @brief Callback when TextField is touched
 265    *
 266    * @param[in] actor TextField touched
 267    * @param[in] touch Touch information
 268    */
 269   bool OnTouched( Actor actor, const TouchEvent& touch );
 270
 271   /**
 272    * @brief Callbacks called on idle.
 273    *
 274    * If there are notifications of change of input style on the queue, Toolkit::TextField::InputStyleChangedSignal() are emitted.
 275    */
 276   void OnIdleSignal();
 277
 278   /**
 279    * Construct a new TextField.
 280    */
 281   TextField();
 282
 283   /**
 284    * A reference counted object may only be deleted by calling Unreference()
 285    */
 286   virtual ~TextField();
 287
 288   // Undefined copy constructor and assignment operators
 289   TextField(const TextField&);
 290   TextField& operator=(const TextField& rhs);
 291
 292   /**
 293    * @brief Render view, create and attach actor(s) to this Text Field.
 294    */
 295   void RenderText( Text::Controller::UpdateTextType updateTextType );
 296
 297   // Connection needed to re-render text, when a Text Field returns to the scene.
 298   void OnSceneConnect( Dali::Actor actor );
 299
 300 public: // For UTC only
 301
 302   Text::ControllerPtr GetTextController() { return mController; }
 303
 304 private: // Data
 305
 306   // Signals
 307   Toolkit::TextField::TextChangedSignalType mTextChangedSignal;
 308   Toolkit::TextField::MaxLengthReachedSignalType mMaxLengthReachedSignal;
 309   Toolkit::TextField::InputStyleChangedSignalType mInputStyleChangedSignal;
 310
 311   InputMethodContext mInputMethodContext;
 312   Text::ControllerPtr mController;
 313   Text::RendererPtr mRenderer;
 314   Text::DecoratorPtr mDecorator;
 315   Toolkit::Control mStencil; ///< For EXCEED_POLICY_CLIP
 316   std::vector<Actor> mClippingDecorationActors;   ///< Decoration actors which need clipping.
 317   Dali::InputMethodOptions mInputMethodOptions;
 318   Dali::AutofillItem mAutofillItem;
 319
 320   Actor mRenderableActor;
 321   Actor mActiveLayer;
 322   Actor mBackgroundActor;
 323   CallbackBase* mIdleCallback;
 324
 325   float mAlignmentOffset;
 326   int mRenderingBackend;
 327   int mExceedPolicy;
 328   bool mHasBeenStaged:1;
 329 };
 330
 331 } // namespace Internal
 332
 333 // Helpers for public-api forwarding methods
 334
 335 inline Toolkit::Internal::TextField& GetImpl( Toolkit::TextField& textField )
 336 {
 337   DALI_ASSERT_ALWAYS(textField);
 338
 339   Dali::RefObject& handle = textField.GetImplementation();
 340
 341   return static_cast<Toolkit::Internal::TextField&>(handle);
 342 }
 343
 344 inline const Toolkit::Internal::TextField& GetImpl( const Toolkit::TextField& textField )
 345 {
 346   DALI_ASSERT_ALWAYS(textField);
 347
 348   const Dali::RefObject& handle = textField.GetImplementation();
 349
 350   return static_cast<const Toolkit::Internal::TextField&>(handle);
 351 }
 352
 353 } // namespace Toolkit
 354
 355 } // namespace Dali
 356
 357 #endif // DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H