Added some keyboard & cursor plumbing
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / text-controls / text-field-impl.h
index 3dbec59..4bec09d 100644 (file)
@@ -1,5 +1,5 @@
-#ifndef __DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H__
-#define __DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H__
+#ifndef __DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H__
+#define __DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H__
 
 /*
  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
 // INTERNAL INCLUDES
 #include <dali-toolkit/public-api/controls/control-impl.h>
 #include <dali-toolkit/public-api/controls/text-controls/text-field.h>
-#include <dali-toolkit/public-api/text/decorator/text-decorator.h>
-#include <dali-toolkit/public-api/text/text-controller.h>
+#include <dali-toolkit/internal/text/clipping/text-clipper.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-controller.h>
+#include <dali-toolkit/internal/text/rendering/text-renderer.h>
 
 namespace Dali
 {
@@ -36,31 +39,20 @@ namespace Internal
 /**
  * @brief A control which renders a short text string.
  */
-class TextField : public Control
+class TextField : public Control, public Text::ControlInterface
 {
 public:
 
-  // Properties
-  enum
-  {
-    TEXTFIELD_PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
-    TEXTFIELD_PROPERTY_END_INDEX = TEXTFIELD_PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices
-  };
-
   /**
    * @copydoc Dali::Toollkit::TextField::New()
    */
   static Toolkit::TextField New();
 
-  /**
-   * @copydoc Dali::Toollkit::TextField::SetRenderer()
-   */
-  void SetRenderer( Text::RendererPtr renderer );
-
   // Properties
 
   /**
-   * Called when a property of an object of this type is set.
+   * @brief Called when a property of an object of this type is set.
+   *
    * @param[in] object The object whose property is set.
    * @param[in] index The property index.
    * @param[in] value The new property value.
@@ -68,7 +60,8 @@ public:
   static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
 
   /**
-   * Called to retrieve a property of an object of this type.
+   * @brief Called to retrieve a property of an object of this type.
+   *
    * @param[in] object The object whose property is to be retrieved.
    * @param[in] index The property index.
    * @return The current value of the property.
@@ -83,17 +76,66 @@ private: // From Control
   virtual void OnInitialize();
 
   /**
+   * @copydoc Control::OnStyleChange()
+   */
+  virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange change );
+
+  /**
+   * @copydoc Control::GetNaturalSize()
+   */
+  virtual Vector3 GetNaturalSize();
+
+  /**
+   * @copydoc Control::GetHeightForWidth()
+   */
+  virtual float GetHeightForWidth( float width );
+
+  /**
    * @copydoc Control::OnInitialize()
    */
   virtual void OnRelayout( const Vector2& size, ActorSizeContainer& container );
 
+  /**
+   * @copydoc Control::OnKeyInputFocusGained()
+   */
+  virtual void OnKeyInputFocusGained();
+
+  /**
+   * @copydoc Control::OnKeyInputFocusLost()
+   */
+  virtual void OnKeyInputFocusLost();
+
+  /**
+   * Received for single & double taps
+   */
+  virtual void OnTap( const TapGesture& tap );
+
+  /**
+   * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
+   */
+  virtual bool OnKeyEvent(const KeyEvent& event);
+
+  /**
+   * @copydoc Text::ControlInterface::RequestTextRelayout()
+   */
+  virtual void RequestTextRelayout();
+
 private: // Implementation
 
   /**
-   * Helper for SetProperty.
-   * @param[in] text The new "text" property value.
+   * @brief Enable or disable clipping.
+   *
+   * @param[in] clipping True if clipping should be enabled.
+   * @param[in] size The area to clip within.
+   */
+  void EnableClipping( bool clipping, const Vector2& size );
+
+  /**
+   * @brief Callback when keyboard is shown/hidden.
+   *
+   * @param[in] keyboardShown True if keyboard is shown.
    */
-  void SetText( const std::string& text );
+  void KeyboardStatusChanged( bool keyboardShown );
 
   /**
    * Construct a new TextField.
@@ -116,26 +158,32 @@ private: // Data
   Text::ControllerPtr mController;
   Text::RendererPtr mRenderer;
   Text::DecoratorPtr mDecorator;
+  Text::ClipperPtr mClipper; ///< For EXCEED_POLICY_CLIP
+
+  RenderableActor mRenderableActor;
+
+  int mRenderingBackend;
+  int mExceedPolicy;
 };
 
 } // namespace Internal
 
 // Helpers for public-api forwarding methods
 
-inline Toolkit::Internal::TextField& GetImpl( Toolkit::TextField& textLabel )
+inline Toolkit::Internal::TextField& GetImpl( Toolkit::TextField& textField )
 {
-  DALI_ASSERT_ALWAYS(textLabel);
+  DALI_ASSERT_ALWAYS(textField);
 
-  Dali::RefObject& handle = textLabel.GetImplementation();
+  Dali::RefObject& handle = textField.GetImplementation();
 
   return static_cast<Toolkit::Internal::TextField&>(handle);
 }
 
-inline const Toolkit::Internal::TextField& GetImpl( const Toolkit::TextField& textLabel )
+inline const Toolkit::Internal::TextField& GetImpl( const Toolkit::TextField& textField )
 {
-  DALI_ASSERT_ALWAYS(textLabel);
+  DALI_ASSERT_ALWAYS(textField);
 
-  const Dali::RefObject& handle = textLabel.GetImplementation();
+  const Dali::RefObject& handle = textField.GetImplementation();
 
   return static_cast<const Toolkit::Internal::TextField&>(handle);
 }
@@ -144,4 +192,4 @@ inline const Toolkit::Internal::TextField& GetImpl( const Toolkit::TextField& te
 
 } // namespace Dali
 
-#endif // __DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H__
+#endif // __DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H__