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