//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The application should explicitly call this method again on foreground(activated) state, if the screen is to be kept 'ON' after coming back from the background(inactivated) state.
+ * @remarks This screen power control is available only when an application is active. To check the events that are active, use the Tizen::Ui::Controls::IFrameEventListener::OnFrameActivated() method.
*/
static result KeepScreenOnState(bool keepOn, bool dimming = true);
* @privilege %http://tizen.org/privilege/power
*
* @return An error code
- * @param[in] brightness The brightness level to set @n
- * The parameter value can range between @c 1 (minimum) and @c 10 (maximum).
+ * @param[in] brightness The brightness level to set between @c 1 (minimum) and @c 10 (maximum).
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_OUT_OF_RANGE The specified @c brightness is out of range.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks This brightness level is only available when an application is running on the foreground(activated). Even if the brightness is set to level 1, a black screen is not displayed. Level 1 is the minimum brightness level that can be set for an application. For screen off, Please refer TurnScreenOff method.
- * @see RestoreScreenBrightness(), TurnScreenOff()
+ * @remarks This brightness level change is available only when an application is active. To check the events that are active, use the Tizen::Ui::Controls::IFrameEventListener::OnFrameActivated() method. Even if the brightness is set to level 1, a black screen is not displayed. Level 1 is the minimum brightness level that can be set for an application. To know more about screen off, see the TurnScreenOff() method.
+ * @see RestoreScreenBrightness()
+ * @see TurnScreenOff()
*/
static result SetScreenBrightness(int brightness);
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SYSTEM A system error has occurred.
- * @remark This method keeps CPU power state only. Screen state or lock screen is not managed by this method.
+ * @remarks This method keeps CPU power state only. Screen state or lock screen is not managed by this method.
*/
static result KeepCpuAwake(bool enable);
/**
* Sets the screen event listener.
*
+ * @brief <i>[Deprecated]</i>
+ * @deprecated This method is deprecated. @n
+ * Instead of using this method, use AddScreenEventListener() and RemoveScreenEventListener().
* @since 2.0
*
- * @deprecated This method is deprecated. @n
- * Instead of using this method, please use AddScreenEventListener and RemoveScreenEventListener.
- *
* @param[in] listener The screen event listener
* @remarks This method always overwrites the first element of internal IScreenEventListener list.
- * The first element added by AddScreentEventListener may be overwritten by this method,
+ * The first element added by AddScreenEventListener() may be overwritten by this method,
* which may not be an expected behavior by API users. So, it is not recommended to use this method.
*/
static void SetScreenEventListener(IScreenEventListener& listener);
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_ALREADY_EXIST The listener has already been added.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @see IScreenEventListener, RemoveScreenEventListener
+ * @see IScreenEventListener
+ * @see RemoveScreenEventListener()
*/
static result AddScreenEventListener(IScreenEventListener& listener);
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified listener cannot be found.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @see IScreenEventListener, AddScreenEventListener
+ * @see IScreenEventListener
+ * @see AddScreenEventListener()
*/
static result RemoveScreenEventListener(IScreenEventListener& listener);
/**
* Sets the charging event listener.
*
+ * @brief <i>[Deprecated]</i>
+ * @deprecated This method is deprecated. @n
+ * Instead of using this method, use AddChargingEventListener() and RemoveChargingEventListener().
* @since 2.0
*
- * @deprecated This method is deprecated. @n
- * Instead of using this method, please use AddChargingEventListener and RemoveChargingEventListener.
- *
* @param[in] listener The charging event listener
* @remarks This method always overwrites the first element of internal IChargingEventListener list.
- * The first element added by AddChargingEventListener may be overwritten by this method,
+ * The first element added by AddChargingEventListener() may be overwritten by this method,
* which may not be an expected behavior by API users. So, it is not recommended to use this method.
*/
static void SetChargingEventListener(IChargingEventListener& listener);
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_ALREADY_EXIST The listener has already been added.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @see IChargingEventListener, RemoveChargingEventListener
+ * @see IChargingEventListener
+ * @see RemoveChargingEventListener()
*/
static result AddChargingEventListener(IChargingEventListener& listener);
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified listener cannot be found.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @see IChargingEventListener, AddChargingEventListener
+ * @see IChargingEventListener
+ * @see AddChargingEventListener()
*/
static result RemoveChargingEventListener(IChargingEventListener& listener);
projects / platform / framework / native / appfw.git / blobdiff