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