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

   1 #ifndef __DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H__
   2 #define __DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H__
   3
   4 /*
   5  * Copyright (c) 2016 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-editor.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 long text string with styles.
  44  */
  45 class TextEditor : public Control, public Text::ControlInterface
  46 {
  47 public:
  48
  49   /**
  50    * @copydoc Dali::Toollkit::TextEditor::New()
  51    */
  52   static Toolkit::TextEditor 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 TextEditor::TextChangedSignal()
  87    */
  88   Toolkit::TextEditor::TextChangedSignalType&  TextChangedSignal();
  89
  90 private: // From Control
  91
  92   /**
  93    * @copydoc Control::OnInitialize()
  94    */
  95   virtual void OnInitialize();
  96
  97   /**
  98    * @copydoc Control::OnStyleChange()
  99    */
 100   virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
 101
 102   /**
 103    * @copydoc Control::GetNaturalSize()
 104    */
 105   virtual Vector3 GetNaturalSize();
 106
 107   /**
 108    * @copydoc Control::GetHeightForWidth()
 109    */
 110   virtual float GetHeightForWidth( float width );
 111
 112   /**
 113    * @copydoc Control::OnInitialize()
 114    */
 115   virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
 116
 117   /**
 118    * @copydoc Control::OnKeyInputFocusGained()
 119    */
 120   virtual void OnKeyInputFocusGained();
 121
 122   /**
 123    * @copydoc Control::OnKeyInputFocusLost()
 124    */
 125   virtual void OnKeyInputFocusLost();
 126
 127   /**
 128    * @copydoc Control::OnTap()
 129    */
 130   virtual void OnTap( const TapGesture& tap );
 131
 132   /**
 133    * @copydoc Control::OnPan()
 134    */
 135   virtual void OnPan( const PanGesture& gesture );
 136
 137   /**
 138    * @copydoc Control::OnLongPress()
 139    */
 140   virtual void OnLongPress( const LongPressGesture& gesture );
 141
 142   /**
 143    * @copydoc Control::OnStageConnection()
 144    */
 145   virtual void OnStageConnection( int depth );
 146
 147   /**
 148    * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
 149    */
 150   virtual bool OnKeyEvent(const KeyEvent& event);
 151
 152 // From ControlInterface
 153
 154   /**
 155    * @copydoc Text::ControlInterface::AddDecoration()
 156    */
 157   virtual void AddDecoration( Actor& actor, bool needsClipping );
 158
 159   /**
 160    * @copydoc Text::ControlInterface::RequestTextRelayout()
 161    */
 162   virtual void RequestTextRelayout();
 163
 164   /**
 165    * @copydoc Text::ControlInterface::TextChanged()
 166    */
 167   virtual void TextChanged();
 168
 169   /**
 170    * @copydoc Text::ControlInterface::MaxLengthReached()
 171    */
 172   virtual void MaxLengthReached();
 173
 174 private: // Implementation
 175
 176   /**
 177    * @copydoc Dali::Toolkit::Text::Controller::(ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent)
 178    */
 179   ImfManager::ImfCallbackData OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent );
 180
 181   /**
 182    * @brief Callback when Clipboard signals an item should be pasted
 183    * @param[in] clipboard handle to Clipboard Event Notifier
 184    */
 185   void OnClipboardTextSelected( ClipboardEventNotifier& clipboard );
 186
 187   /**
 188    * @brief Get a Property Map for the image used for the required Handle Image
 189    * @param[out] value the returned image property
 190    * @param[in] handleType the type of handle
 191    * @param[in] handleImageType the type of image for the given handleType
 192    */
 193   void GetHandleImagePropertyValue(  Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType );
 194
 195   /**
 196    * @brief Enable or disable clipping.
 197    *
 198    * @param[in] clipping True if clipping should be enabled.
 199    * @param[in] size The area to clip within.
 200    */
 201   void EnableClipping( bool clipping, const Vector2& size );
 202
 203   /**
 204    * @brief Callback when keyboard is shown/hidden.
 205    *
 206    * @param[in] keyboardShown True if keyboard is shown.
 207    */
 208   void KeyboardStatusChanged( bool keyboardShown );
 209
 210   /**
 211    * @brief Callback when TextEditor is touched
 212    *
 213    * @param[in] actor TextEditor touched
 214    * @param[in] touch Touch information
 215    */
 216   bool OnTouched( Actor actor, const TouchData& touch );
 217
 218   /**
 219    * Construct a new TextEditor.
 220    */
 221   TextEditor();
 222
 223   /**
 224    * A reference counted object may only be deleted by calling Unreference()
 225    */
 226   virtual ~TextEditor();
 227
 228   // Undefined copy constructor and assignment operators
 229   TextEditor(const TextEditor&);
 230   TextEditor& operator=(const TextEditor& rhs);
 231
 232   /**
 233    * @brief Render view, create and attach actor(s) to this text editor.
 234    */
 235   void RenderText( Text::Controller::UpdateTextType updateTextType );
 236
 237   // Connection needed to re-render text, when a text editor returns to the stage.
 238   void OnStageConnect( Dali::Actor actor );
 239
 240 private: // Data
 241
 242   // Signals
 243   Toolkit::TextEditor::TextChangedSignalType mTextChangedSignal;
 244
 245   Text::ControllerPtr mController;
 246   Text::RendererPtr mRenderer;
 247   Text::DecoratorPtr mDecorator;
 248   Text::ClipperPtr mClipper;
 249   std::vector<Actor> mClippingDecorationActors;   ///< Decoration actors which need clipping.
 250
 251   Actor mRenderableActor;
 252
 253   int mRenderingBackend;
 254   bool mHasBeenStaged:1;
 255 };
 256
 257 } // namespace Internal
 258
 259 // Helpers for public-api forwarding methods
 260
 261 inline Toolkit::Internal::TextEditor& GetImpl( Toolkit::TextEditor& textEditor )
 262 {
 263   DALI_ASSERT_ALWAYS(textEditor);
 264
 265   Dali::RefObject& handle = textEditor.GetImplementation();
 266
 267   return static_cast<Toolkit::Internal::TextEditor&>(handle);
 268 }
 269
 270 inline const Toolkit::Internal::TextEditor& GetImpl( const Toolkit::TextEditor& textEditor )
 271 {
 272   DALI_ASSERT_ALWAYS(textEditor);
 273
 274   const Dali::RefObject& handle = textEditor.GetImplementation();
 275
 276   return static_cast<const Toolkit::Internal::TextEditor&>(handle);
 277 }
 278
 279 } // namespace Toolkit
 280
 281 } // namespace Dali
 282
 283 #endif // __DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H__