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) 2015 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 // INTERNAL INCLUDES
  22 #include <dali-toolkit/public-api/controls/control-impl.h>
  23 #include <dali-toolkit/public-api/controls/text-controls/text-field.h>
  24 #include <dali-toolkit/internal/text/clipping/text-clipper.h>
  25 #include <dali-toolkit/internal/text/decorator/text-decorator.h>
  26 #include <dali-toolkit/internal/text/text-control-interface.h>
  27 #include <dali-toolkit/internal/text/text-controller.h>
  28 #include <dali-toolkit/internal/text/rendering/text-renderer.h>
  29
  30 // EXTERNAL INCLUDES
  31 #include <dali/devel-api/adaptor-framework/clipboard-event-notifier.h>
  32
  33 namespace Dali
  34 {
  35
  36 namespace Toolkit
  37 {
  38
  39 namespace Internal
  40 {
  41
  42 /**
  43  * @brief A control which renders a short text string.
  44  */
  45 class TextField : public Control, public Text::ControlInterface
  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    * Connects a callback function with the object's signals.
  76    * @param[in] object The object providing the signal.
  77    * @param[in] tracker Used to disconnect the signal.
  78    * @param[in] signalName The signal to connect to.
  79    * @param[in] functor A newly allocated FunctorDelegate.
  80    * @return True if the signal was connected.
  81    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
  82    */
  83   static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
  84
  85   /**
  86    * @copydoc TextField::TextChangedSignal()
  87    */
  88   Toolkit::TextField::TextChangedSignalType&  TextChangedSignal();
  89
  90   /**
  91    * @copydoc TextField::MaxLengthReachedSignal()
  92    */
  93   Toolkit::TextField::MaxLengthReachedSignalType&  MaxLengthReachedSignal();
  94
  95 private: // From Control
  96
  97   /**
  98    * @copydoc Control::OnInitialize()
  99    */
 100   virtual void OnInitialize();
 101
 102   /**
 103    * @copydoc Control::OnStyleChange()
 104    */
 105   virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
 106
 107   /**
 108    * @copydoc Control::GetNaturalSize()
 109    */
 110   virtual Vector3 GetNaturalSize();
 111
 112   /**
 113    * @copydoc Control::GetHeightForWidth()
 114    */
 115   virtual float GetHeightForWidth( float width );
 116
 117   /**
 118    * @copydoc Control::OnInitialize()
 119    */
 120   virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
 121
 122   /**
 123    * @copydoc Control::OnKeyInputFocusGained()
 124    */
 125   virtual void OnKeyInputFocusGained();
 126
 127   /**
 128    * @copydoc Control::OnKeyInputFocusLost()
 129    */
 130   virtual void OnKeyInputFocusLost();
 131
 132   /**
 133    * @copydoc Control::OnTap()
 134    */
 135   virtual void OnTap( const TapGesture& tap );
 136
 137   /**
 138    * @copydoc Control::OnPan()
 139    */
 140   virtual void OnPan( const PanGesture& gesture );
 141
 142   /**
 143    * @copydoc Control::OnStageConnection()
 144    */
 145   virtual void OnStageConnection( unsigned int depth );
 146
 147   /**
 148    * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
 149    */
 150   virtual bool OnKeyEvent(const KeyEvent& event);
 151
 152   /**
 153    * @copydoc Text::ControlInterface::AddDecoration()
 154    */
 155   virtual void AddDecoration( Actor& actor, bool needsClipping );
 156
 157   /**
 158    * @copydoc Text::ControlInterface::RequestTextRelayout()
 159    */
 160   virtual void RequestTextRelayout();
 161
 162   /**
 163    * @copydoc Text::ControlInterface::TextChanged()
 164    */
 165   virtual void TextChanged();
 166
 167   /**
 168    * @copydoc Text::ControlInterface::MaxLengthReached()
 169    */
 170   virtual void MaxLengthReached();
 171
 172   /**
 173    * @copydoc Dali::Toolkit::Text::Controller::(ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent)
 174    */
 175   ImfManager::ImfCallbackData OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent );
 176
 177   /**
 178    * @brief Callback when Clipboard signals an item should be pasted
 179    * @param[in] clipboard handle to Clipboard Event Notifier
 180    */
 181   void OnClipboardTextSelected( ClipboardEventNotifier& clipboard );
 182
 183 private: // Implementation
 184
 185   /**
 186    * @brief Enable or disable clipping.
 187    *
 188    * @param[in] clipping True if clipping should be enabled.
 189    * @param[in] size The area to clip within.
 190    */
 191   void EnableClipping( bool clipping, const Vector2& size );
 192
 193   /**
 194    * @brief Callback when keyboard is shown/hidden.
 195    *
 196    * @param[in] keyboardShown True if keyboard is shown.
 197    */
 198   void KeyboardStatusChanged( bool keyboardShown );
 199
 200   /**
 201    * @brief Callback when Textfield is touched
 202    *
 203    * @param[in] actor TextField touched
 204    * @param[in] event TouchEvent information
 205    */
 206   bool OnTouched( Actor actor, const TouchEvent& event );
 207
 208   /**
 209    * Construct a new TextField.
 210    */
 211   TextField();
 212
 213   /**
 214    * A reference counted object may only be deleted by calling Unreference()
 215    */
 216   virtual ~TextField();
 217
 218   // Undefined copy constructor and assignment operators
 219   TextField(const TextField&);
 220   TextField& operator=(const TextField& rhs);
 221
 222   /**
 223    * @brief Render view, create and attach actor(s) to this Text Field.
 224    */
 225   void RenderText();
 226
 227   // Connection needed to re-render text, when a Text Field returns to the stage.
 228   void OnStageConnect( Dali::Actor actor );
 229
 230 private: // Data
 231
 232   // Signals
 233   Toolkit::TextField::TextChangedSignalType mTextChangedSignal;
 234   Toolkit::TextField::MaxLengthReachedSignalType mMaxLengthReachedSignal;
 235
 236   Text::ControllerPtr mController;
 237   Text::RendererPtr mRenderer;
 238   Text::DecoratorPtr mDecorator;
 239   Text::ClipperPtr mClipper; ///< For EXCEED_POLICY_CLIP
 240   std::vector<Actor> mClippingDecorationActors;   ///< Decoration actors which need clipping.
 241
 242   Actor mRenderableActor;
 243
 244   int mRenderingBackend;
 245   int mExceedPolicy;
 246   unsigned int mDepth;
 247   bool mHasBeenStaged:1;
 248 };
 249
 250 } // namespace Internal
 251
 252 // Helpers for public-api forwarding methods
 253
 254 inline Toolkit::Internal::TextField& GetImpl( Toolkit::TextField& textField )
 255 {
 256   DALI_ASSERT_ALWAYS(textField);
 257
 258   Dali::RefObject& handle = textField.GetImplementation();
 259
 260   return static_cast<Toolkit::Internal::TextField&>(handle);
 261 }
 262
 263 inline const Toolkit::Internal::TextField& GetImpl( const Toolkit::TextField& textField )
 264 {
 265   DALI_ASSERT_ALWAYS(textField);
 266
 267   const Dali::RefObject& handle = textField.GetImplementation();
 268
 269   return static_cast<const Toolkit::Internal::TextField&>(handle);
 270 }
 271
 272 } // namespace Toolkit
 273
 274 } // namespace Dali
 275
 276 #endif // __DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H__