dali-toolkit/internal/text/cursor-helper-functions.h

   1 #ifndef DALI_TOOLKIT_TEXT_CURSOR_HELPER_FUNCTIONS_H
   2 #define DALI_TOOLKIT_TEXT_CURSOR_HELPER_FUNCTIONS_H
   3
   4 /*
   5  * Copyright (c) 2017 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/internal/text/logical-model-impl.h>
  23 #include <dali-toolkit/internal/text/metrics.h>
  24 #include <dali-toolkit/internal/text/visual-model-impl.h>
  25
  26 namespace Dali
  27 {
  28
  29 namespace Toolkit
  30 {
  31
  32 namespace Text
  33 {
  34
  35 struct CharacterHitTest
  36 {
  37   /**
  38    * @brief Enumeration of the types of hit test.
  39    */
  40   enum Mode
  41   {
  42     TAP,   ///< Retrieves the first or last character of the line if the touch point is outside of the boundaries of the text.
  43     SCROLL ///< Retrieves the character above or below to the touch point if it's outside of the boundaries of the text.
  44   };
  45 };
  46
  47 struct CursorInfo
  48 {
  49   CursorInfo()
  50   : primaryPosition(),
  51     secondaryPosition(),
  52     lineOffset( 0.f ),
  53     lineHeight( 0.f ),
  54     primaryCursorHeight( 0.f ),
  55     secondaryCursorHeight( 0.f ),
  56     isSecondaryCursor( false )
  57   {}
  58
  59   ~CursorInfo()
  60   {}
  61
  62   Vector2 primaryPosition;       ///< The primary cursor's position (in text's coords).
  63   Vector2 secondaryPosition;     ///< The secondary cursor's position (in text's coords).
  64   float   lineOffset;            ///< The vertical offset where the line containing the cursor starts.
  65   float   lineHeight;            ///< The height of the line where the cursor is placed.
  66   float   primaryCursorHeight;   ///< The primary cursor's height.
  67   float   secondaryCursorHeight; ///< The secondary cursor's height.
  68   bool    isSecondaryCursor;     ///< Whether the secondary cursor is valid.
  69 };
  70
  71 /**
  72  * @brief Retrieves the closest line for a given touch point.
  73  *
  74  * It returns the first line if the touch point is above the text and the last line if the touch point is below.
  75  *
  76  * @param[in] visualModel The visual model.
  77  * @param[in] visualY The touch point 'y' in text's coords.
  78  * @param[out] matchedLine Whether the touch point actually hits a line.
  79  *
  80  * @return A line index.
  81  */
  82 LineIndex GetClosestLine( VisualModelPtr visualModel,
  83                           float visualY,
  84                           bool& matchedLine );
  85
  86 /**
  87  * @brief Calculates the vertical line's offset for a given line.
  88  *
  89  * @pre @p lineIndex must be between 0 and the number of lines (both inclusive).
  90  *
  91  * @param[in] lines The laid-out lines.
  92  * @param[in] lineIndex Index to the line.
  93  *
  94  * @return The vertical offset of the given line.
  95  */
  96 float CalculateLineOffset( const Vector<LineRun>& lines,
  97                            LineIndex lineIndex );
  98
  99 /**
 100  * @brief Retrieves the cursor's logical position for a given touch point x,y
 101  *
 102  * There are two types of hit test: CharacterHitTest::TAP retrieves the first or
 103  * last character of a line if the touch point is outside the boundaries of the
 104  * text, CharacterHitTest::SCROLL retrieves the character above or below to the
 105  * touch point if it's outside the boundaries of the text.
 106  *
 107  * @param[in] visualModel The visual model.
 108  * @param[in] logicalModel The logical model.
 109  * @param[in] metrics A wrapper around FontClient used to get metrics.
 110  * @param[in] visualX The touch point 'x' in text's coords.
 111  * @param[in] visualY The touch point 'y' in text's coords.
 112  * @param[in] mode The type of hit test.
 113  * @param[out] matchedCharacter Whether the touch point actually hits a character.
 114  *
 115  * @return The logical cursor position (in characters). 0 is just before the first character, a value equal to the number of characters is just after the last character.
 116  */
 117 CharacterIndex GetClosestCursorIndex( VisualModelPtr visualModel,
 118                                       LogicalModelPtr logicalModel,
 119                                       MetricsPtr metrics,
 120                                       float visualX,
 121                                       float visualY,
 122                                       CharacterHitTest::Mode mode,
 123                                       bool& matchedCharacter );
 124
 125 /**
 126  * @brief Calculates the cursor's position for a given character index in the logical order.
 127  *
 128  * It retrieves as well the line's height and the cursor's height and
 129  * if there is a valid alternative cursor, its position and height.
 130  *
 131  * @param[in] visualModel The visual model.
 132  * @param[in] logicalModel The logical model.
 133  * @param[in] metrics A wrapper around FontClient used to get metrics.
 134  * @param[in] logical The logical cursor position (in characters). 0 is just before the first character, a value equal to the number of characters is just after the last character.
 135  * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
 136  */
 137 void GetCursorPosition( VisualModelPtr visualModel,
 138                         LogicalModelPtr logicalModel,
 139                         MetricsPtr metrics,
 140                         CharacterIndex logical,
 141                         CursorInfo& cursorInfo );
 142
 143 /**
 144  * @brief Find the indices to the first and last characters of a word for the given touch point.
 145  *
 146  * @param[in] visualModel The visual model.
 147  * @param[in] logicalModel The logical model.
 148  * @param[in] metrics A wrapper around FontClient used to get metrics.
 149  * @param[in] visualX The touch point 'x' in text's coords.
 150  * @param[in] visualY The touch point 'y' in text's coords.
 151  * @param[out] startIndex Index to the first character of the selected word.
 152  * @param[out] endIndex Index to the last character of the selected word.
 153  * @param[out] noTextHitIndex Index to the nearest character when there is no hit.
 154  *
 155  * @return @e true if the touch point hits a character.
 156  */
 157 bool FindSelectionIndices( VisualModelPtr visualModel,
 158                            LogicalModelPtr logicalModel,
 159                            MetricsPtr metrics,
 160                            float visualX,
 161                            float visualY,
 162                            CharacterIndex& startIndex,
 163                            CharacterIndex& endIndex,
 164                            CharacterIndex& noTextHitIndex );
 165
 166 } // namespace Text
 167
 168 } // namespace Toolkit
 169
 170 } // namespace Dali
 171
 172 #endif // DALI_TOOLKIT_TEXT_CURSOR_HELPER_FUNCTIONS_H