base/dali-toolkit/public-api/text/text-controller.h

   1 #ifndef __DALI_TOOLKIT_TEXT_CONTROLLER_H__
   2 #define __DALI_TOOLKIT_TEXT_CONTROLLER_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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/common/intrusive-ptr.h>
  23 #include <dali/public-api/object/ref-object.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/public-api/text/text-view.h>
  27
  28 namespace Dali
  29 {
  30
  31 namespace Toolkit
  32 {
  33
  34 namespace Text
  35 {
  36
  37 class Controller;
  38 typedef IntrusivePtr<Controller> ControllerPtr;
  39
  40 /**
  41  * @brief A Text Controller is used by UI Controls which display text.
  42  *
  43  * It manipulates the Logical & Visual text models on behalf of the UI Controls.
  44  * It provides a view of the text that can be used by rendering back-ends.
  45  */
  46 class Controller : public RefObject
  47 {
  48 public:
  49
  50   /**
  51    * @brief Create a new instance of a Controller.
  52    *
  53    * @return A pointer to a new Controller.
  54    */
  55   static ControllerPtr New();
  56
  57   // TODO - Layouting options e.g. single vs multi-line
  58
  59   /**
  60    * @brief Replaces any text previously set.
  61    *
  62    * @note This will be converted into UTF-32 when stored in the text model.
  63    * @param[in] text A string of UTF-8 characters.
  64    */
  65   void SetText( const std::string& text );
  66
  67   /**
  68    * @brief Return a view of the text.
  69    *
  70    * @return An interface to the view.
  71    */
  72   View& GetView();
  73
  74 protected:
  75
  76   /**
  77    * @brief A reference counted object may only be deleted by calling Unreference().
  78    */
  79   virtual ~Controller();
  80
  81 private:
  82
  83   /**
  84    * @brief Private constructor.
  85    */
  86   Controller();
  87
  88   /**
  89    * TODO - Move these with LayoutEngine
  90    */
  91   void UpdateVisualModel();
  92   void UpdateVisualPositions();
  93
  94   // Undefined
  95   Controller( const Controller& handle );
  96
  97   // Undefined
  98   Controller& operator=( const Controller& handle );
  99
 100 private:
 101
 102   struct Impl;
 103   Impl* mImpl;
 104 };
 105 } // namespace Text
 106
 107 } // namespace Toolkit
 108
 109 } // namespace Dali
 110
 111 #endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__