dali-toolkit/public-api/controls/text-controls/hidden-input-properties.h

   1 #ifndef DALI_HIDDEN_INPUT_PROPERTIES_H
   2 #define DALI_HIDDEN_INPUT_PROPERTIES_H
   3
   4 /*
   5  * Copyright (c) 2020 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 namespace Dali
  22 {
  23 namespace Toolkit
  24 {
  25 /**
  26  * @addtogroup dali_toolkit_controls_text_controls
  27  * @{
  28  */
  29
  30 namespace HiddenInput
  31 {
  32 /**
  33  * @brief HiddenInput Property.
  34  * @SINCE_1_2.60
  35  */
  36 namespace Property
  37 {
  38 /**
  39  * @brief HiddenInput Property.
  40  * @SINCE_1_2.60
  41  */
  42 enum
  43 {
  44   /**
  45    * @brief The mode for input text display.
  46    * @details Name "mode", type HiddenInput::Mode (Property::INTEGER).
  47    * @SINCE_1_2.60
  48    * @note Optional.
  49    * @see HiddenInput::Mode
  50    */
  51   MODE,
  52
  53   /**
  54    * @brief All input characters are substituted by this character.
  55    * @details Name "substituteCharacter", type Property::INTEGER.
  56    * @SINCE_1_2.60
  57    * @note Optional.
  58    */
  59   SUBSTITUTE_CHARACTER,
  60
  61   /**
  62    * @brief Length of text to show or hide, available when HIDE_COUNT/SHOW_COUNT mode is used.
  63    * @details Name "substituteCount", type Property::INTEGER.
  64    * @SINCE_1_2.60
  65    * @note Optional.
  66    */
  67   SUBSTITUTE_COUNT,
  68
  69   /**
  70    * @brief Hide last character after this duration, available when SHOW_LAST_CHARACTER mode.
  71    * @details Name "showDuration", type Property::INTEGER.
  72    * @SINCE_1_2.60
  73    * @note Optional.
  74    */
  75   SHOW_LAST_CHARACTER_DURATION
  76 };
  77
  78 } // namespace Property
  79
  80 /**
  81  * @brief The type for HiddenInput::Property::MODE.
  82  * @SINCE_1_2.60
  83  */
  84 namespace Mode
  85 {
  86 /**
  87  * @brief The type for HiddenInput::Property::MODE.
  88  * @SINCE_1_2.60
  89  */
  90 enum Type
  91 {
  92   HIDE_NONE,          ///< Do not hide text. @SINCE_1_2.60
  93   HIDE_ALL,           ///< Hide all the input text. @SINCE_1_2.60
  94   HIDE_COUNT,         ///< Hide n characters from start. @SINCE_1_2.60
  95   SHOW_COUNT,         ///< Show n characters from start. @SINCE_1_2.60
  96   SHOW_LAST_CHARACTER ///< Show last character for the duration (use Property::SHOW_LAST_CHARACTER_DURATION to modify duration). @SINCE_1_2.60
  97 };
  98
  99 } // namespace Mode
 100
 101 } // namespace HiddenInput
 102
 103 /**
 104  * @}
 105  */
 106
 107 } // namespace Toolkit
 108
 109 } // namespace Dali
 110
 111 #endif // DALI_HIDDEN_INPUT_PROPERTIES_H