dali-toolkit/public-api/controls/text-controls/text-editor.h

   1 #ifndef __DALI_TOOLKIT_TEXT_EDITOR_H__
   2 #define __DALI_TOOLKIT_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.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 namespace Internal DALI_INTERNAL
  31 {
  32 class TextEditor;
  33 }
  34 /**
  35  * @addtogroup dali_toolkit_controls_text_controls
  36  * @{
  37  */
  38
  39 /**
  40  * @brief A control which provides a multi-line editable text editor.
  41  *
  42  *  * Signals
  43  * | %Signal Name         | Method                                              |
  44  * |----------------------|-----------------------------------------------------|
  45  * | textChanged          | @ref TextChangedSignal()                            |
  46  *
  47  */
  48 class DALI_IMPORT_API TextEditor : public Control
  49 {
  50 public:
  51
  52   /**
  53    * @brief The start and end property ranges for this control.
  54    */
  55   enum PropertyRange
  56   {
  57     PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
  58     PROPERTY_END_INDEX =   PROPERTY_START_INDEX + 1000              ///< Reserve property indices
  59   };
  60
  61   /**
  62    * @brief An enumeration of properties belonging to the TextEditor class.
  63    */
  64   struct Property
  65   {
  66     enum
  67     {
  68       RENDERING_BACKEND = PROPERTY_START_INDEX, ///< name "renderingBackend",                    The type or rendering e.g. bitmap-based,                                         type INT @SINCE_1_1.37
  69       TEXT,                                     ///< name "text",                                The text to display in UTF-8 format,                                             type STRING @SINCE_1_1.37
  70       TEXT_COLOR,                               ///< name "textColor",                           The text color,                                                                  type VECTOR4 @SINCE_1_1.37
  71       FONT_FAMILY,                              ///< name "fontFamily",                          The requested font family,                                                       type STRING @SINCE_1_1.37
  72       FONT_STYLE,                               ///< name "fontStyle",                           The requested font style,                                                        type STRING @SINCE_1_1.37
  73       POINT_SIZE,                               ///< name "pointSize",                           The size of font in points,                                                      type FLOAT @SINCE_1_1.37
  74       HORIZONTAL_ALIGNMENT,                     ///< name "horizontalAlignment",                 The text horizontal alignment,                                                   type STRING,  values "BEGIN", "CENTER", "END" @SINCE_1_1.37
  75       SCROLL_THRESHOLD,                         ///< name "scrollThreshold"                      Vertical scrolling will occur if the cursor is this close to the control border, type FLOAT @SINCE_1_1.37
  76       SCROLL_SPEED,                             ///< name "scrollSpeed"                          The scroll speed in pixels per second,                                           type FLOAT @SINCE_1_1.37
  77       PRIMARY_CURSOR_COLOR,                     ///< name "primaryCursorColor",                  The color to apply to the primary cursor,                                        type VECTOR4 @SINCE_1_1.37
  78       SECONDARY_CURSOR_COLOR,                   ///< name "secondaryCursorColor",                The color to apply to the secondary cursor,                                      type VECTOR4 @SINCE_1_1.37
  79       ENABLE_CURSOR_BLINK,                      ///< name "enableCursorBlink",                   Whether the cursor should blink or not,                                          type BOOLEAN @SINCE_1_1.37
  80       CURSOR_BLINK_INTERVAL,                    ///< name "cursorBlinkInterval",                 The time interval in seconds between cursor on/off states,                       type FLOAT @SINCE_1_1.37
  81       CURSOR_BLINK_DURATION,                    ///< name "cursorBlinkDuration",                 The cursor will stop blinking after this number of seconds (if non-zero),        type FLOAT @SINCE_1_1.37
  82       CURSOR_WIDTH,                             ///< name "cursorWidth",                         The cursor width,                                                                type INTEGER @SINCE_1_1.37
  83       GRAB_HANDLE_IMAGE,                        ///< name "grabHandleImage",                     The image to display for the grab handle,                                        type STRING @SINCE_1_1.37
  84       GRAB_HANDLE_PRESSED_IMAGE,                ///< name "grabHandlePressedImage",              The image to display when the grab handle is pressed,                            type STRING @SINCE_1_1.37
  85       SELECTION_HANDLE_IMAGE_LEFT,              ///< name "selectionHandleImageLeft",            The image to display for the left selection handle,                              type MAP @SINCE_1_1.37
  86       SELECTION_HANDLE_IMAGE_RIGHT,             ///< name "selectionHandleImageRight",           The image to display for the right selection handle,                             type MAP @SINCE_1_1.37
  87       SELECTION_HANDLE_PRESSED_IMAGE_LEFT,      ///< name "selectionHandlePressedImageLeft",     The image to display when the left selection handle is pressed,                  type MAP @SINCE_1_1.37
  88       SELECTION_HANDLE_PRESSED_IMAGE_RIGHT,     ///< name "selectionHandlePressedImageRight",    The image to display when the right selection handle is pressed,                 type MAP @SINCE_1_1.37
  89       SELECTION_HANDLE_MARKER_IMAGE_LEFT,       ///< name "selectionHandleMarkerImageLeft",      The image to display for the left selection handle marker,                       type MAP @SINCE_1_1.37
  90       SELECTION_HANDLE_MARKER_IMAGE_RIGHT,      ///< name "selectionHandleMarkerImageRight",     The image to display for the right selection handle marker,                      type MAP @SINCE_1_1.37
  91       SELECTION_HIGHLIGHT_COLOR,                ///< name "selectionHighlightColor",             The color of the selection highlight,                                            type VECTOR4 @SINCE_1_1.37
  92       DECORATION_BOUNDING_BOX,                  ///< name "decorationBoundingBox",               The decorations (handles etc) will positioned within this area on-screen,        type RECTANGLE @SINCE_1_1.37
  93       ENABLE_MARKUP,                            ///< name "enableMarkup",                        Whether the mark-up processing is enabled.                                       type BOOLEAN @SINCE_1_1.37
  94       INPUT_COLOR,                              ///< name "inputColor",                          The color of the new input text,                                                 type VECTOR4 @SINCE_1_1.37
  95       INPUT_FONT_FAMILY,                        ///< name "inputFontFamily",                     The font's family of the new input text,                                         type STRING @SINCE_1_1.37
  96       INPUT_FONT_STYLE,                         ///< name "inputFontStyle",                      The font's style of the new input text,                                          type STRING @SINCE_1_1.37
  97       INPUT_POINT_SIZE,                         ///< name "inputPointSize",                      The font's size of the new input text in points,                                 type FLOAT @SINCE_1_1.37
  98       LINE_SPACING,                             ///< name "lineSpacing",                         The default extra space between lines in points,                                 type FLOAT @SINCE_1_1.37
  99       INPUT_LINE_SPACING,                       ///< name "inputLineSpacing"                     The extra space between lines in points. It affects the whole paragraph where the new input text is inserted, type FLOAT @SINCE_1_1.37
 100       UNDERLINE,                                ///< name "underline"                            The default underline parameters,                                                type STRING @SINCE_1_1.37
 101       INPUT_UNDERLINE,                          ///< name "inputUnderline"                       The underline parameters of the new input text,                                  type STRING @SINCE_1_1.37
 102       SHADOW,                                   ///< name "shadow"                               The default shadow parameters,                                                   type STRING @SINCE_1_1.37
 103       INPUT_SHADOW,                             ///< name "inputShadow"                          The shadow parameters of the new input text,                                     type STRING @SINCE_1_1.37
 104       EMBOSS,                                   ///< name "emboss"                               The default emboss parameters,                                                   type STRING @SINCE_1_1.37
 105       INPUT_EMBOSS,                             ///< name "inputEmboss"                          The emboss parameters of the new input text,                                     type STRING @SINCE_1_1.37
 106       OUTLINE,                                  ///< name "outline"                              The default outline parameters,                                                  type STRING @SINCE_1_1.37
 107       INPUT_OUTLINE,                            ///< name "inputOutline"                         The outline parameters of the new input text,                                    type STRING @SINCE_1_1.37
 108     };
 109   };
 110
 111   // Type Defs
 112
 113   /// @brief Text changed signal type.
 114   typedef Signal<void ( TextEditor ) > TextChangedSignalType;
 115
 116   /**
 117    * @brief Create the TextEditor control.
 118    * @return A handle to the TextEditor control.
 119    */
 120   static TextEditor New();
 121
 122   /**
 123    * @brief Creates an empty handle.
 124    */
 125   TextEditor();
 126
 127   /**
 128    * @brief Copy constructor.
 129    *
 130    * @param[in] handle The handle to copy from.
 131    */
 132   TextEditor( const TextEditor& handle );
 133
 134   /**
 135    * @brief Assignment operator.
 136    *
 137    * @param[in] handle The handle to copy from.
 138    * @return A reference to this.
 139    */
 140   TextEditor& operator=( const TextEditor& handle );
 141
 142   /**
 143    * @brief Destructor.
 144    *
 145    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 146    */
 147   ~TextEditor();
 148
 149   /**
 150    * @brief Downcast a handle to TextEditor.
 151    *
 152    * If the BaseHandle points is a TextEditor the downcast returns a valid handle.
 153    * If not the returned handle is left empty.
 154    *
 155    * @param[in] handle Handle to an object.
 156    * @return handle to a TextEditor or an empty handle.
 157    */
 158   static TextEditor DownCast( BaseHandle handle );
 159
 160   // Signals
 161
 162   /**
 163    * @brief This signal is emitted when the text changes.
 164    *
 165    * A callback of the following type may be connected:
 166    * @code
 167    *   void YourCallbackName( TextEditor textEditor );
 168    * @endcode
 169    * @return The signal to connect to.
 170    */
 171   TextChangedSignalType& TextChangedSignal();
 172
 173 public: // Not intended for application developers
 174
 175   /// @cond internal
 176   /**
 177    * @brief Creates a handle using the Toolkit::Internal implementation.
 178    *
 179    * @param[in] implementation The Control implementation.
 180    */
 181   DALI_INTERNAL TextEditor( Internal::TextEditor& implementation );
 182
 183   /**
 184    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
 185    *
 186    * @param[in]  internal  A pointer to the internal CustomActor.
 187    */
 188   explicit DALI_INTERNAL TextEditor( Dali::Internal::CustomActor* internal );
 189   /// @endcond
 190 };
 191
 192 /**
 193  * @}
 194  */
 195 } // namespace Toolkit
 196
 197 } // namespace Dali
 198
 199 #endif // __DALI_TOOLKIT_TEXT_EDITOR_H__