* @endif
*/
-/**
- * @if OSPCOMPAT
- * @page CompGetCurrentLevelInPercentage Compatibility for current battery level
- * @section CompGetCurrentLevelInPercentageIssue Issues
- * Implementation of this method in %Tizen API versions prior to 2.1 has the following issue: @n
- *
- * -# GetCurrentLevelInPercentage() is moved to PowerManager class.
- *
- * @section CompGetCurrentLevelInPercentageResolution Resolutions
- * The issue mentioned above is resolved in %Tizen API version 2.1 as follows: @n
- *
- * -# GetCurrentLevelInPercentage() is provided by PowerManager class.
- * @endif
- */
-
-/**
- * @if OSPCOMPAT
- * @page CompGetCurrentLevel Compatibility for current battery level
- * @section CompGetCurrentLevelIssue Issues
- * Implementation of this method in %Tizen API versions prior to 2.1 has the following issue: @n
- *
- * -# CompGetCurrentLevel() is moved to PowerManager class.
- *
- * @section CompGetCurrentLevelResolution Resolutions
- * The issue mentioned above is resolved in %Tizen API version 2.1 as follows: @n
- *
- * -# GetCurrentLevel() is supported by PowerManager class.
- * @endif
- */
-
-/**
- * @if OSPCOMPAT
- * @page CompIsCharging Compatibility for current battery level
- * @section CompIsChargingIssue Issues
- * Implementation of this method in %Tizen API versions prior to 2.1 has the following issue: @n
- *
- * -# IsCharging() is moved to PowerManager class.
- *
- * @section CompIsChargingResolution Resolutions
- * The issue mentioned above is resolved in %Tizen API version 2.1 as follows: @n
- *
- * -# IsCharging() is supported by PowerManager class.
- * @endif
- */
-
class _OSP_EXPORT_ Battery
: public Tizen::Base::Object
{
public:
/**
- * @if OSPCOMPAT
* @if OSPDEPREC
* Gets the current charge remaining in the battery as a percentage.
*
* @deprecated This method is deprecated. Instead of using this method, use the PowerManager::GetCurrentBatteryLevelInPercentage() method.
* @since 2.0
- *
+ * @if OSPCOMPAT
+ * @brief <i>[Deprecated] [Compatibility] </i>
* @compatibility This method has compatibility issues with OSP compatible applications. @n
* For more information, see @ref CompGetCurrentLevelInPercentage "here".
+ * @endif
* @return An error code
* @param[out] level The percentage of the charge remaining in the battery
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The resolution of the level is @c 1% since 2.0. The range of the level is @c 0 (Minimum) to @c 100 (Maximum).
* @endif
- * @endif
*/
static result GetCurrentLevelInPercentage(int& level);
/**
* @if OSPCOMPAT
+ * @page CompGetCurrentLevelInPercentage Compatibility for current battery level
+ * @section CompGetCurrentLevelInPercentageIssue Issues
+ * Implementation of this method in %Tizen API versions prior to 2.1 has the following issue: @n
+ *
+ * - GetCurrentLevelInPercentage() is moved to PowerManager class.
+ *
+ * @section CompGetCurrentLevelInPercentageResolution Resolutions
+ * The issue mentioned above is resolved in %Tizen API version 2.1 as follows: @n
+ *
+ * - GetCurrentLevelInPercentage() is provided by PowerManager class.
+ * @endif
+ */
+
+ /**
* @if OSPDEPREC
* Gets the current charging level of the battery.
*
* @deprecated This method is deprecated. Instead of using this method, use the PowerManager::GetCurrentBatteryLevel() method.
* @since 2.0
- *
+ * @if OSPCOMPAT
+ * @brief <i>[Deprecated] [Compatibility] </i>
* @compatibility This method has compatibility issues with OSP compatible applications. @n
* For more information, see @ref CompGetCurrentLevel "here".
+ * @endif
* @return An error code
* @param[out] level A value from the enumerator BatteryLevel indicating the current charging level
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE The battery service is not available.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @endif
- * @endif
*/
static result GetCurrentLevel(BatteryLevel& level);
/**
* @if OSPCOMPAT
+ * @page CompGetCurrentLevel Compatibility for current battery level
+ * @section CompGetCurrentLevelIssue Issues
+ * Implementation of this method in %Tizen API versions prior to 2.1 has the following issue: @n
+ *
+ * - CompGetCurrentLevel() is moved to PowerManager class.
+ *
+ * @section CompGetCurrentLevelResolution Resolutions
+ * The issue mentioned above is resolved in %Tizen API version 2.1 as follows: @n
+ *
+ * - GetCurrentLevel() is supported by PowerManager class.
+ * @endif
+ */
+
+ /**
* @if OSPDEPREC
* Checks whether the battery is currently charging.
*
* @deprecated This method is deprecated. Instead of using this method, use the PowerManager::IsCharging() method.
* @since 2.0
- *
+ * @if OSPCOMPAT
+ * @brief <i>[Deprecated] [Compatibility] </i>
* @compatibility This method has compatibility issues with OSP compatible applications. @n
* For more information, see @ref CompIsCharging "here".
+ * @endif
* @return An error code
* @param[out] charging Set to @c true if the charging cable is connected to the phone, @n
* else @c false
* @exception E_INVALID_STATE The battery service is not available.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @endif
- * @endif
*/
static result IsCharging(bool& charging);
+ /**
+ * @if OSPCOMPAT
+ * @page CompIsCharging Compatibility for current battery level
+ * @section CompIsChargingIssue Issues
+ * Implementation of this method in %Tizen API versions prior to 2.1 has the following issue: @n
+ *
+ * - IsCharging() is moved to PowerManager class.
+ *
+ * @section CompIsChargingResolution Resolutions
+ * The issue mentioned above is resolved in %Tizen API version 2.1 as follows: @n
+ *
+ * - IsCharging() is supported by PowerManager class.
+ * @endif
+ */
+
private:
/**
* This is the default constructor for this class. This default constructor is intentionally declared as private so that only the platform can create an instance.
projects / platform / framework / native / appfw.git / blobdiff