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

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