setting-display/setting-display.dox

   1 /**
   2 @page setting-display
   3 @section sec-setting-display setting-display
   4 @tableofcontents
   5
   6 UG creation code for setting-display
   7
   8 it consists of
   9  -# Brightness
  10  -# Backlight time
  11  -# Touch key light duration
  12  -# Auto adjust screen tone
  13  -# Auto rotate screen
  14  -# Display battery percentage
  15  -# Dynamic status bar
  16  -# Edit after screen capture
  17  -# Smart Screen
  18
  19
  20 @subsection sub-brightness Brightness
  21
  22 Brightness related vconf keys
  23 @verbatim
  24 Automatic ON/OFF control - VCONFKEY_SETAPPL_BRIGHTNESS_AUTOMATIC_INT
  25 Automatic Brightness value - VCONFKEY_SETAPPL_LCD_AUTOMATIC_BRIGHTNESS
  26 Manually Brightness value - VCONFKEY_SETAPPL_BRIGHTNESS_AUTOMATIC_INT
  27 @endverbatim
  28
  29 The basic principle for brightness change
  30 @verbatim
  31 When first booting or after factory reset,Automatic shall be OFF, Auto Brightness shall be MAX value(100), Manually brightness shall be 50% of max value.
  32 Manually Brightness shall be restricted when device is in high temperature state.
  33 @endverbatim
  34
  35 How to know the device is in high temperature state and change the brightness.
  36 @verbatim
  37 DBUS signal mechanism.
  38 - monitor the DBUS signal "ChangedSiop".
  39 - once get the signal "ChangedSiop",call device API int display_get_max_brightness(void) to update the brightness max value.
  40 The detailed implement,refer to following function
  41 - static int setting_brightness_dbus_handler_init(void* user_data).
  42 - static DBusHandlerResult setting_brightness_dbus_signal_filter(DBusConnection* conn, DBusMessage* message, void* user_data).
  43 @endverbatim
  44
  45 @subsection sub-backlighttime Backlight time
  46
  47 This menu is for changing different backlight time.
  48
  49 Vconf key for storing the current backlight time
  50 @verbatim
  51 #define VCONFKEY_SETAPPL_LCD_TIMEOUT_NORMAL                     VCONFKEY_SETAPPL_PREFIX"/lcd_backlight_normal"
  52 @endverbatim
  53
  54 @subsection sub-touchkeylightdurtion Touch key light duration
  55
  56 "Touch key light duration" means that when you touch the HW key, the HW key continuously lighting time, such as hard back key...
  57
  58 This menu is for changing different Touch key light duration.
  59
  60 Vconf key for storing the current Touch key light duration
  61 @verbatim
  62 #define VCONFKEY_SETAPPL_TOUCHKEY_LIGHT_DURATION VCONFKEY_SETAPPL_PREFIX"/display/touchkey_light_duration"
  63 enum {
  64         SETTING_TOUCHKEY_LIGIT_DURATION_90SEC = 90,
  65         SETTING_TOUCHKEY_LIGIT_DURATION_360SEC = 360,
  66         SETTING_TOUCHKEY_LIGIT_DURATION_ALWAYS_OFF = 0,
  67         SETTING_TOUCHKEY_LIGIT_DURATION_ALWAYS_ON = -1
  68 };
  69 @endverbatim
  70
  71 @subsection sub-autoadjust Auto adjust screen tone
  72
  73 enable/disable this function by setting following vconf key
  74 @verbatim
  75 #define VCONFKEY_SETAPPL_LCD_AUTO_DISPLAY_ADJUSTMENT             VCONFKEY_SETAPPL_PREFIX"/auto_display_adjustment"
  76 @endverbatim
  77
  78 @subsection sub-autorotate Auto rotate screen
  79
  80 enable/disable this function by setting following vconf key
  81 @verbatim
  82 #define VCONFKEY_SETAPPL_AUTO_ROTATE_SCREEN_BOOL                VCONFKEY_SETAPPL_PREFIX"/auto_rotate_screen"
  83 @endverbatim
  84
  85 @subsection sub-batterypercentage Display battery percentage
  86
  87 enable/disable this function by setting following vconf key
  88 @verbatim
  89 #define VCONFKEY_SETAPPL_BATTERY_PERCENTAGE_BOOL                VCONFKEY_SETAPPL_PREFIX"/battery_percentage"
  90 @endverbatim
  91
  92 @subsection sub-dynamicstatusbar Dynamic status bar
  93
  94 enable/disable this function by setting following vconf key
  95 @verbatim
  96 #define VCONFKEY_SETAPPL_DYNAMIC_STATUS_BAR                     VCONFKEY_SETAPPL_PREFIX"/display/dynamic_status_bar"
  97 @endverbatim
  98
  99 @subsection sub-editaftercapture Edit after screen capture
 100
 101 enable/disable this function by setting following vconf key
 102 @verbatim
 103 #define VCONFKEY_SETAPPL_SCREEN_CAPTURE_EDIT_AFTER_CAPTURE      VCONFKEY_SETAPPL_PREFIX"/display/edit_after_screen_capture"
 104 @endverbatim
 105
 106
 107 @subsection sub-smartscreen Smart screen
 108
 109 enable/disable "smart stay" by setting following vconf key
 110 @verbatim
 111 #define VCONFKEY_SETAPPL_SCREEN_CAPTURE_EDIT_AFTER_CAPTURE      VCONFKEY_SETAPPL_PREFIX"/display/edit_after_screen_capture"
 112 @endverbatim
 113
 114 enable/disable "smart rotation" by setting following vconf key
 115 @verbatim
 116 #define VCONFKEY_SETAPPL_SCREEN_CAPTURE_EDIT_AFTER_CAPTURE      VCONFKEY_SETAPPL_PREFIX"/display/edit_after_screen_capture"
 117 @endverbatim
 118
 119 To lunch smart screen help page
 120 @verbatim
 121 Click menu->help in smart screen view
 122 @endverbatim
 123
 124 Restrictions
 125 @verbatim
 126 smart screen cannot be turned on when TTS is enabled
 127 @endverbatim
 128
 129
 130
 131 @section sec-setting-display2 setting-display-another
 132 */