WORLD_EXECUTE WORLD_READ)
INSTALL(DIRECTORY ${CMAKE_SOURCE_DIR}/res/common/opt/usr/etc DESTINATION ../opt/usr)
+INSTALL(DIRECTORY ${CMAKE_SOURCE_DIR}/res/common/usr/bin DESTINATION ../usr)
IF("${ARCH}" MATCHES "arm")
INSTALL(DIRECTORY ${CMAKE_SOURCE_DIR}/res/arm/usr/etc DESTINATION ../usr)
ELSEIF("${ARCH}" MATCHES "x86")
INSTALL(DIRECTORY ${CMAKE_SOURCE_DIR}/src/system/inc/ DESTINATION include/osp/system FILES_MATCHING PATTERN "*.h")
INSTALL(DIRECTORY ${CMAKE_SOURCE_DIR}/src/text/inc/ DESTINATION include/osp/text FILES_MATCHING PATTERN "*.h")
INSTALL(DIRECTORY ${CMAKE_SOURCE_DIR}/src/server/appfw/inc/ DESTINATION include/osp/server/appfw/ FILES_MATCHING PATTERN "*.h")
-INSTALL(DIRECTORY ${CMAKE_SOURCE_DIR}/src/system-server/inc/ DESTINATION include/osp/server/ FILES_MATCHING PATTERN "*.h")
+INSTALL(DIRECTORY ${CMAKE_SOURCE_DIR}/src/server/system/inc/ DESTINATION include/osp/server/system/ FILES_MATCHING PATTERN "*.h")
* @since 2.0
*
* @remarks @b Header @b %file: @b \#include @b <FApp.h> @n
- * @b Library : @b osp-appfw
+ * @b Library: @b osp-appfw
*
* The %App namespace contains classes for application development, including application life-cycle management, usage of
- * functionality exported by other applications through AppControl, and access to application registry and resources. %Tizen
+ * the functionality exported by other applications through AppControl, and access to the application registry and resources. %Tizen
* also provides various macros for debugging purposes.
- * @n
+ *
* For more information on the %App namespace features and the macros, see <a href="../org.tizen.native.appprogramming/html/guide/app/app_namespace.htm">App Guide</a> and <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/debugging_macros.htm">Debugging Macros</a>.
*
* The following diagram illustrates the relationships between the classes belonging to the %App namespace.
*
* The %App class is the base class of a %Tizen native application.
* A %Tizen native application must be inherited from the UiApp or ServiceApp class. These classes are inherited from the %App class. This class provides the basic features necessary to define an application.
- * @n
+ *
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/app/app_namespace.htm">App Guide</a>, <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/tizen_app_model/application_lifecycle.htm">Application Life-cycle</a>, and <a href="../org.tizen.native.appprogramming/html/guide/app/app_system_events.htm">System Events</a>.
*
*/
/**
* @if OSPDEPREC
- * Gets the list of the launch arguments. @n
+ * Gets the list of launch arguments. @n
* For more information on the launch arguments, see <a href="../org.tizen.native.appprogramming/html/guide/app/launching_other_apps_within_apps.htm">Launching Other Applications</a>.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated. Instead of using this method, it is recommended to use IAppControlProviderEventListener
- * to acquire delivered arguments list.
+ * to acquire the delivered arguments list.
* @since 2.0
*
* @return A pointer to the list that contains the Tizen::Base::String instances of the launch arguments
* Gets the locale-independent name of the application.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
* @section CompGetAppNamePageIssue Issues
* Implementation of this method in %Tizen API versions prior to 2.1 has the following issue: @n
*
- * -# GetAppName() returns the localized name of the application while the meaning of the application name is ambiguous.
- * There are different use cases for locale-dependent name and localized name and the platform does not provide
- * a method for obtaining language-neutral name.
+ * -# The GetAppName() method returns the localized name of the application while the meaning of the application name is ambiguous.
+ * There are different use cases for the locale-dependent name and the localized name. The platform does not provide
+ * any method for obtaining the language-neutral name.
*
* @section CompGetAppNamePageResolution Resolutions
* The issue mentioned above is resolved in %Tizen API version 2.1 as follows: @n
*
- * -# GetAppDisplayName() is introduced to acquire localized name and GetAppName() returns locale-independent application name.
+ * -# The GetAppDisplayName() method is introduced to acquire the localized application name and the GetAppName() method returns the locale-independent application name.
*/
/**
AppId GetAppId(void) const;
/**
- * Gets the path of the application's root directory where the application is installed.
+ * Gets the path to the application's root directory where the application is installed.
*
* @since 2.0
*
Tizen::Base::String GetAppRootPath(void) const;
/**
- * Gets the path of the application's data directory used to store its own private data.
+ * Gets the path to the application's data directory where its private data is stored.
*
* @since 2.0
*
Tizen::Base::String GetAppDataPath(void) const;
/**
- * Gets the path of the application's resource directory that ships resource files delivered with the application
- * package.
+ * Gets the path to the application's resource directory that ships the resource files that are delivered with the application package.
*
* @since 2.0
*
Tizen::Base::String GetAppResourcePath(void) const;
/**
- * Gets the path of the application's shared directory to export data to other applications.
+ * Gets the path to the application's shared directory to export data to other applications.
*
* @since 2.1
*
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state.
*/
* including restoring the application's states, must be done in the %OnAppInitializing() method.
* If this method fails, the application's state changes to App::TERMINATED.
*
- * @since 2.0
+ * @since 2.0
*
- * @return @c true if the method is successful, @n
- * else @c false
+ * @return @c true if the method is successful, @n
+ * else @c false
* @param[in] appRegistry The instance of AppRegistry that manages the application's states
* @remarks Introducing the modal dialogs (for example, MessageBox) in this method is not allowed,
- * because it blocks the initialization procedure.
+ * because it blocks the initialization procedure.
*/
virtual bool OnAppInitializing(AppRegistry& appRegistry) = 0;
/**
* Called when the application's initialization is finished. @n
* After the %OnAppInitialized() method succeeds, the application's state changes to App::RUNNING.
- * If this method fails, the application's state changes to App::TERMINATING and the App::OnAppTerminating() method is called.
+ * If this method fails, the application's state changes to App::TERMINATING and the OnAppTerminating() method is called.
*
* @since 2.0
*
/**
* Called when the application is requested to terminate. @n
* The %OnAppWillTerminate() method returns @c false to prevent the application from getting terminated.
- * If this method returns @c true, the application's state changes to App::TERMINATING and the App::OnAppTerminating() method is called.
+ * If this method returns @c true, the application's state changes to App::TERMINATING and the OnAppTerminating() method is called.
*
* @since 2.0
*
/**
* Called when the application's state changes to App::TERMINATING. @n
- * All the activities involved in terminating the application, including saving the application's states, must be done in the %OnAppTerminating() method.
+ * All the activities involved in terminating the application, including saving the application's states, must be done by the %OnAppTerminating() method.
* After this method, the application code cannot be executed. The application is destroyed subsequently. @n
*
- * An application's termination is triggered either by the system or other applications. @n
- * When the termination is triggered by the system because of conditions such as power-off and OOM, it is called "urgent termination" and during these terminations %OnAppTerminating(), cannot be executed properly.
+ * An application's termination is triggered either by the system or by other applications. @n
+ * When the termination is triggered by the system because of conditions, such as power-off, and OOM, it is called "urgent termination" and during these terminations the %OnAppTerminating() method cannot be executed properly.
* When an application is terminated because of a power-off, although this method is called, it should be executed in a short duration. And when an application is killed by OOM, this method is not called. @n
- * This implies that this method is not likely to be called during an urgent termination, and hence the application should save the critical data as often as possible.
- * For example, the application can set a check point or use the callback for low memory.
- * When an application is terminated by self or other applications, it is called "normal termination" and during these terminations this method is executed properly because more time is provided for executing it as compared to an urgent termination (however, it does have a limit of 3-5 seconds). @n
+ * This implies that this method is not likely to be called during an urgent termination, and hence the application should save its critical data as often as possible.
+ * For example, the application can set a check point or use a callback for low memory issues.
+ * When an application terminates itself or is terminated by other applications, it is called "normal termination" and during these terminations this method is executed properly because more time is provided for execution as compared to an urgent termination (however, it does have a limit of 3-5 seconds). @n
* When this method is called, the main loop has already been quit.
* Thus, the application should not use any kind of asynchronous API that has callbacks triggered by the main loop.
*
* @since 2.0
*
- * @return @c true if the method is successful, @n
- * else @c false
+ * @return @c true if the method is successful, @n
+ * else @c false
* @param[in] appRegistry The instance that manages the application's states
* @param[in] urgentTermination Set to @c true if the application is terminated by the system, @n
* else @c false
virtual bool OnAppTerminating(AppRegistry& appRegistry, bool urgentTermination = false) = 0;
/**
- * Called when the system detects that the system wide memory or application heap memory is insufficient to run the application any further. @n
+ * Called when the system detects that the system wide memory or the application heap memory is insufficient to run the application any further. @n
* Resources that are not in use currently can be released using the %OnLowMemory() method.
*
* @since 2.0
/**
* Called when the battery level changes. @n
- * It is recommended that the application decides whether to terminate by itself by considering its own battery power consumption, if the battery level is Tizen::System::BATTERY_LEVEL_CRITICAL.
+ * It is recommended that the application decides whether to terminate itself by considering its own battery power consumption, if the battery level is Tizen::System::BATTERY_LEVEL_CRITICAL.
*
* @since 2.0
*
*
* @return An error code
* @param[in] requestId The user defined event ID
- * @param[in] pArgs A pointer to an argument list of type Tizen::Base::String
+ * @param[in] pArgs A pointer to the argument list of type Tizen::Base::String
* @exception E_SUCCESS The method is successful.
* @see OnUserEventReceivedN()
*/
* @since 2.0
*
* @param[in] requestId The user defined event ID
- * @param[in] pArgs A pointer to an argument list of type Tizen::Base::String
+ * @param[in] pArgs A pointer to the argument list of type Tizen::Base::String
*/
virtual void OnUserEventReceivedN(RequestId requestId, Tizen::Base::Collection::IList* pArgs);
/**
- * Gets the %App instance's pointer.
+ * Gets a pointer to the %App instance.
*
* @since 2.0
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_contact.htm">Contact Application Control</a>.
*
* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.contacts".
* @since 2.0
* @endif
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_calendar.htm">Calendar Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
-* Instead of this variable, use the literal, L"tizen.calendar".
+* Instead of this variable, use the literal, L"tizen.calendar".
* @since 2.0
* @endif
*/
* @if OSPDEPREC
* The Todo %AppControl ID.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This application control provider name is deprecated.
-* @b OPERATION_PICK:
-* @since 2.0
+* @brief <i> [Deprecated] </i>
+* @deprecated This application control provider name is deprecated.
+* @b OPERATION_PICK:
+* @since 2.0
*
-* @remarks This constant is currently not available.
+* @remarks This constant is currently not available.
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_TODO;
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_call.htm">Call Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
-* Instead of this variable, use the literal, L"tizen.phone" with operation L"http://tizen.org/appcontrol/operation/dial".
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* Instead of this variable, use the literal, L"tizen.phone", with the operation L"http://tizen.org/appcontrol/operation/dial".
* @since 2.0
* @endif
*/
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_call.htm">Call Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
-* Instead of this variable, use the literal, L"tizen.phone" with operation L"http://tizen.org/appcontrol/operation/call".
-* @since 2.0
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* Instead of this variable, use the literal, L"tizen.phone", with the operation L"http://tizen.org/appcontrol/operation/call".
+* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/systeminfo
*
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_message.htm">Message Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.messages".
* @since 2.0
*
-* @remarks An MMS attachment may contain either an image, audio, video, vCard, vCalendar or a combination of an image, audio, vCard, and vCalendar files. @n
-* MMS attachments cannot contain a video in combination with an image or an audio file.
+* @remarks
+* - An MMS attachment may contain either an image, an audio, a video, a vCard, a vCalendar, or a combination of an image, an audio, a vCard, and a vCalendar file.
+* - MMS attachments cannot contain a video in combination with an image or an audio file.
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_MESSAGE;
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_email.htm">Email Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
-* Instead of this variable, use the literal, L"tizen.email".
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* Instead of this variable, use the literal, L"tizen.email".
* @since 2.0
* @endif
*/
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_media.htm">Media Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
-* Instead of this variable, use the literal, L"tizen.filemanager" or L"tizen.gallery".
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* Instead of this variable, use the literal, L"tizen.filemanager", or L"tizen.gallery".
* @since 2.0
* @endif
*/
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_image.htm">Image Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.imageviewer".
* @since 2.0
* @endif
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_video.htm">Video Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.videoplayer".
* @since 2.0
* @endif
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_audio.htm">Audio Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.musicplayer".
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_AUDIO;
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_browser.htm">Browser Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.internet".
-* @since 2.0
+* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
* @endif
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_camera.htm">Camera Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.camera".
* @since 2.0
* @endif
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_bluetooth.htm">Bluetooth Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.bluetooth".
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_BT;
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_settings.htm">Settings Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.settings".
* @since 2.0
* @endif
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_contact.htm">Contact Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.contacts".
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_CONTACT;
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_certmgr.htm">Certificate Manager Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.certificatemanager".
* @since 2.0
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_calendar.htm">Calendar Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.calendar".
* @since 2.0
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_call.htm">Call Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.phone".
-* @since 2.0
+* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/systeminfo
*
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_message.htm">Message Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.messages".
-* @since 2.0
+* @since 2.0
*
-* @remarks An MMS attachment may contain either an image, audio, video, vCard, vCalendar or a combination of an image, audio, vCard, and vCalendar files. @n
-* MMS attachments cannot contain a video in combination with an image or an audio file. @n
-* From Tizen 2.0, the CC and BCC recipients are merged with the TO recipients when launching the MMS app control.
+* @remarks An MMS attachment may contain either an image, an audio, a video, a vCard, a vCalendar, or a combination of an image, an audio, a vCard, and a vCalendar file. @n
+* MMS attachments cannot contain a video in combination with an image or an audio file. @n
+* From %Tizen 2.0, the CC and BCC recipients are merged with the TO recipients while launching the MMS application control.
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_MESSAGE;
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_email.htm">Email Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.email".
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_EMAIL;
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_media.htm">Media Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
-* Instead of this variable, use the literal, L"tizen.filemanager" or L"tizen.gallery".
+* Instead of this variable, use the literal, L"tizen.filemanager", or L"tizen.gallery".
* @since 2.0
* @endif
*/
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_image.htm">Image Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.imageviewer".
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_IMAGE;
-/*
+/**
* @if OSPDEPREC
-* The ImageCrop application control provider ID @n
+* The Image Editor %AppControl provider ID @n
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in a future release.
* use the literal, L"tizen.imageeditor", instead of this variable.
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_IMAGE_EDITOR;
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_video.htm">Video Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.videoplayer".
* @since 2.0
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_audio.htm">Audio Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.musicplayer".
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_AUDIO;
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_browser.htm">Browser Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.internet".
-* @since 2.0
+* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_camera.htm">Camera Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.camera".
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_CAMERA;
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_bluetooth.htm">Bluetooth Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.bluetooth".
-* @since 2.0
+* @since 2.0
*
-* @remarks Bluetooth functionality cannot be tested on the Emulator.
+* @remarks Bluetooth functionality cannot be tested on the Emulator.
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_BLUETOOTH;
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_settings.htm">Settings Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.settings".
* @since 2.0
* Operation Add. @n
* Adds an application item.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/add".
* @since 2.0
* @endif
/**
* @if OSPDEPREC
* Operation Pick. @n
-* Picks some application item(s).
+* Picks an application item(s).
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/pick".
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String OPERATION_PICK;
* Operation Edit. @n
* Edits an application item.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/edit".
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String OPERATION_EDIT;
* Operation View. @n
* Shows the application content.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/view".
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String OPERATION_VIEW;
* Operation Play. @n
* Plays the application content.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/view".
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String OPERATION_PLAY;
* Operation Default. @n
*
* Uses the default operation specific to the application control.
-* An application control can export its functionality using an operation. If the application control exports only one operation, OPERATION_DEFAULT can act as an alias for the operation.
+* An application control can export its functionality using an operation. If the application control exports only one operation, ::OPERATION_DEFAULT can act as the alias for that operation.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/main".
* @since 2.0
* @endif
* @if OSPDEPREC
* Operation Capture.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/createcontent".
* @since 2.0
* @endif
* Operation Add. @n
* Adds an application item.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/add".
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_OPERATION_ADD;
* Operation Default. @n
*
* Uses the default operation specific to the application control.
-* An application control can export its functionality using an operation. If the application control exports only one operation, OPERATION_DEFAULT can act as an alias for the operation.
+* An application control can export its functionality using an operation. If the application control exports only one operation, ::OPERATION_DEFAULT can act as an alias for that operation.
*
* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* @if OSPDEPREC
* Operation Main. @n
*
-* All the application exports the implicit %AppControl with %APPCONTROL_OPERATION_MAIN operation.
+* All the applications export the implicit %AppControl with the %APPCONTROL_OPERATION_MAIN operation.
*
* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/main".
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_OPERATION_MAIN;
/**
* @if OSPDEPREC
* Operation Pick. @n
-* Picks some application item(s).
+* Picks an application item(s).
*
* @brief <i> [Deprecated] </i>
-* @deprecated This variable is providyed only for backward compatibility and will be deleted in the near future.
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/pick".
* @since 2.0
* @endif
/**
* @if OSPDEPREC
* Operation Record. @n
-* Records the content.
+* Records the application content.
*
* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
/**
* @if OSPDEPREC
* Operation Share. @n
-* Shares the contents.
+* Shares the application content.
*
* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
/**
* @if OSPDEPREC
* Operation Crop. @n
-* Shows image with the crop rectangle.
+* Shows the image with the crop rectangle.
*
* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
/**
* @if OSPDEPREC
- * Not specified category.
+ * No specified category.
*
* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
/**
* @if OSPDEPREC
* The media category. @n
- * Specifying App::APPCONTROL_CATEGORY_MEDIA is equivalent to specifying all the App::APPCONTROL_CATEGORY_AUDIO,
+ * Specifying %APPCONTROL_CATEGORY_MEDIA is equivalent to specifying the App::APPCONTROL_CATEGORY_AUDIO,
* App::APPCONTROL_CATEGORY_IMAGE, and App::APPCONTROL_CATEGORY_VIDEO categories.
*
* @brief <i> [Deprecated] </i>
/**
* @if OSPDEPREC
- * The complete URI handling category corresponding to AppManager::StartAppControl().
+ * The complete URI handling category corresponding to the AppManager::StartAppControl() method.
*
* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
/**
* @if OSPDEPREC
- * The %AppControl operation is canceled.
+ * The %AppControl operation is cancelled.
*
* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* @brief This class represents the application control behavior.
* @since 2.0
*
-* @final This class is not intended for extension.
+* @final This class is not intended for extension.
*
-* The %AppControl class represents the application control behavior that provides a standard mechanism for using specific operations exported by other applications.
+* The %AppControl class represents the application control behavior that provides a standard mechanism for using specific operations exported by other applications.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/app/app_controls.htm">Application Controls</a>.
*
* @privilege %http://tizen.org/privilege/application.launch
*
* @return An error code
- * @param[in] pDataList The data list to deliver to the resolved application control @n
- * The maximum size of the list is 4096 bytes.
- * @param[in] pListener The application control callback listener @n
- * Some application controls need to get the callback result by implementing the IAppControlEventListener interface.
+ * @param[in] pDataList The data list to deliver to the resolved application control @n
+ * The maximum size of the list is 4096 bytes.
+ * @param[in] pListener The application control callback listener @n
+ * Some application controls get the callback result by implementing the IAppControlEventListener interface.
* @exception E_SUCCESS The method is successful.
* @exception E_MAX_EXCEEDED The size of @c pDataList has exceeded the maximum limit.
- * @exception E_OBJ_NOT_FOUND The target application control resource is not found.
- * @exception E_IN_PROGRESS The application control is in progress: @n
- * - The application has already started an %AppControl. @n
+ * @exception E_OBJ_NOT_FOUND The target application control resource has not been found.
+ * @exception E_IN_PROGRESS The application control is in progress:
+ * - The application has already started an %AppControl.
* - The target application has already started.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @exception E_ILLEGAL_ACCESS The application is not signed with the same certificate of target application. @b Since: @b 2.1
- * @remarks If the IAppControlEventListener instance (@c pListener) needs to get the
- * callback result for an application control, it must be valid till
- * IAppControlEventListener::OnAppControlCompleted() is invoked.
- * For example, a form object listener must not be deleted before the
- * system invokes %IAppControlEventListener::OnAppControlCompleted().
+ * @exception E_ILLEGAL_ACCESS The application is not signed with the same certificate as that of the target application. @b Since: @b 2.1
+ * @remarks If the specified @c pListener needs to get the callback result for an application control, it must be valid till IAppControlEventListener::OnAppControlCompleted() is invoked. @n
+ * For example, a form object listener must not be deleted before the system invokes %IAppControlEventListener::OnAppControlCompleted().
* @see AppManager::FindAppControlN()
* @see AppManager::FindAppControlsN()
* @endif
result Start(const Tizen::Base::Collection::IList* pDataList, IAppControlEventListener* pListener);
/**
- * Starts the found application control. @n
- * Once the found application starts, the calling application goes to the background and the found
+ * Starts the located application control. @n
+ * Once the located application starts, the calling application goes to the background and the located
* application is displayed.
*
* @since 2.0
* @privilege %http://tizen.org/privilege/application.launch
*
* @return An error code
- * @param[in] pUriData A pointer to the URI data
- * @param[in] pDataType A pointer to the MIME type (RFC 2046) data
- * @param[in] pExtraData A pointer to an argument map of key and value pair where the key is of type String and the value is of type String or of type ArrayList of String to deliver to the resolved application @n
- * The maximum size is 16 kilo bytes.
- * @param[in] pListener The application control callback listener @n
- * Some application need to get the result by implementing the IAppControlResponseListener interface.
+ * @param[in] pUriData A pointer to the URI data
+ * @param[in] pDataType A pointer to the MIME type (RFC 2046) data
+ * @param[in] pExtraData A pointer to the argument map of the key and value pair, where the key is of type Tizen::Base::String and the value is of type %Tizen::Base::String or of type Tizen::Base::Collection::ArrayList of %Tizen::Base::String, which is delivered to the resolved application @n
+ * The maximum size is 16 kilo bytes.
+ * @param[in] pListener The application control callback listener @n
+ * Some applications get the result by implementing the IAppControlResponseListener interface.
* @exception E_SUCCESS The method is successful.
* @exception E_MAX_EXCEEDED The size of @c pExtraData has exceeded the maximum limit.
- * @exception E_OBJ_NOT_FOUND The target application control is not found.
+ * @exception E_OBJ_NOT_FOUND The target application control has not been found.
* @exception E_IN_PROGRESS The application control is in progress: @n
* - The application has already started an %AppControl.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @exception E_ILLEGAL_ACCESS The application is not signed with the same certificate of target application. @b Since: @b 2.1
- * @remarks If the calling application needs to get some result for application control,
- * it must be valid till IAppControlResponseListener::OnAppControlCompleteResponseReceived() is invoked.
+ * @exception E_ILLEGAL_ACCESS The application is not signed with the same certificate as that of the target application. @b Since: @b 2.1
+ * @remarks If the calling application needs to get some result for the application control,
+ * it must be valid till IAppControlResponseListener::OnAppControlCompleteResponseReceived() is invoked. @n
* For example, a form object listener must not be deleted before the
* system invokes %IAppControlResponseListener::OnAppControlCompleteResponseReceived().
* @see AppManager::FindAppControlN()
result Start(const Tizen::Base::String* pUriData, const Tizen::Base::String* pDataType, const Tizen::Base::Collection::IMap* pExtraData, IAppControlResponseListener* pListener);
/**
- * Finds the matching application control with given operation ID, URI pattern, data type, and category and
- * starts the found one. @n
- * If there are more than one application controls found, then the selection is shown for user and the one that the user selects is started.
+ * Finds the matching application control with the given operation ID, URI pattern, data type, and category, after which it
+ * starts the found application control. @n
+ * If more than one application control is found, then user selection is enabled and the one selected by the user is started.
* When the found application control is started, the URI pattern, MIME type, and extra data is delivered using IAppControlProviderEventListener.
*
* @since 2.0
* @privilege %http://tizen.org/privilege/application.launch
*
* @return An error code
- * @param[in] operationId The operation ID
- * @param[in] pUriPattern A URI pattern which is used for application control resolution and is delivered as the argument
- * @param[in] pDataType The MIME type (RFC 2046) or file extension @n
- * The '.' prefix must be used when specifying the file extension.
- * @param[in] pCategory The application control category
- * @param[in] pExtraData A pointer to an argument map of key and value pair where the key is of type Tizen::Base::String and the value is of
- * type %Tizen::Base::String or of type Tizen::Base::Collection::ArrayList of %Tizen::Base::String to deliver to
- * the resolved application @n
- * The maximum size is 16 kilo bytes.
- * @param[in] pListener A listener that gets notified
- * @exception E_SUCCESS The method is successful.
- * @exception E_MAX_EXCEEDED The size of @c pDataList has exceeded the maximum limit.
- * @exception E_OBJ_NOT_FOUND The application control is not found.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @param[in] operationId The operation ID
+ * @param[in] pUriPattern The URI pattern that is used for the application control resolution which is delivered as an argument
+ * @param[in] pDataType The MIME type (RFC 2046) or file extension @n
+ * The '.' prefix must be used while specifying the file extension.
+ * @param[in] pCategory The application control category
+ * @param[in] pExtraData A pointer to the argument map of the key and value pair, where the key is of type Tizen::Base::String and the value is of
+ * type %Tizen::Base::String or of type Tizen::Base::Collection::ArrayList of %Tizen::Base::String which is delivered to
+ * the resolved application @n
+ * The maximum size is 16 kilo bytes.
+ * @param[in] pListener The listener that gets notified
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_MAX_EXCEEDED The size of @c pDataList has exceeded the maximum limit.
+ * @exception E_OBJ_NOT_FOUND The application control has not been found.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @exception E_ILLEGAL_ACCESS The application is not signed with the same certificate of target application. @b Since: @b 2.1
+ * @exception E_ILLEGAL_ACCESS The application is not signed with the same certificate as that of the target application. @b Since: @b 2.1
*/
static result FindAndStart(const Tizen::Base::String& operationId, const Tizen::Base::String* pUriPattern, const Tizen::Base::String* pDataType, const Tizen::Base::String* pCategory, const Tizen::Base::Collection::IMap* pExtraData, IAppControlResponseListener* pListener);
*
* @since 2.0
*
- * @param[in] pListener The listener to stop receiving the application control result
+ * @param[in] pListener The listener to stop from receiving the application control result
*/
static void StopAppControlResponseListener(IAppControlResponseListener* pListener);
*
* @since 2.0
*
- * @return The name of the application providing this %AppControl instance
+ * @return The name of the application that provides this %AppControl instance
*/
Tizen::Base::String GetAppName(void) const;
AppId GetAppId(void) const;
/**
- * @if OSPDEPREC
+ * @if OSPDEPREC
* Gets the associated application control provider ID.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because application ID replaced the role of provider ID. @n
+ * @deprecated This method is deprecated because the application ID has replaced the role of the provider ID. @n
* Instead of using this method, use GetAppId().
* @since 2.0
*
* @return The application control provider ID
- * @endif
+ * @endif
*/
Tizen::Base::String GetAppControlProviderId(void) const;
*
* @since 2.0
*
- * @return A pointer to the list of application control categories, @n
- * else @c null if an error occurs
- * @exception E_SUCCESS The method is successful.
+ * @return A pointer to the list of application control categories, @n
+ * else @c null if an error occurs
+ * @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
/**
* Stops the activated application control. @n
- * The %Stop() method works only with the following %AppControls provided by the platform:
+ * The %Stop() method works only with the following AppControls provided by the platform:
* tizen.bluetooth, tizen.calendar, tizen.camera, tizen.certificatemanager, tizen.contacts,
* tizen.email, tizen.filemanager, tizen.gallery, tizen.imageviewer, tizen.mmsmessages, and tizen.smsmessages.
*
* @since 2.0
*
- * @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_OPERATION The application control is not permitted to call this method.
+ * @return An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_INVALID_OPERATION The application control is not permitted to call this method.
* @remarks This method is asynchronous.
*/
result Stop(void);
* The %AppControl provider registers or unregisters the IAppControlProviderEventListener listener
* for providing the %AppControl functionality, looks up for the delivered %AppControl request information,
* and sends the %AppControl result back to the calling application. @n
- *
- * The request ID is used to identify each %AppControl request and can be acquired using
- * IAppControlProviderEventListener::OnAppControlRequestReceived().
+ * The request ID is used to identify each %AppControl request and can be acquired using the
+ * IAppControlProviderEventListener::OnAppControlRequestReceived() method.
*
*/
class _OSP_EXPORT_ AppControlProviderManager
{
public:
/**
- * Gets the application control provider manager instance.
+ * Gets a pointer to the %AppControlProviderManager instance.
*
* @since 2.0
*
- * @return A pointer to the %AppControlProviderManager instance if it succeeds, @n
- * else @c null
+ * @return A pointer to the %AppControlProviderManager instance, @n
+ * else @c null if it fails
*/
static AppControlProviderManager* GetInstance(void);
* Sets the application control provider listener to the application control provider manager. @n
* The listener gets notified when the application control request is received from other applications.
* To unset the listener, pass a @c null value to the listener parameter. @n
- *
- * If the application does not set the listener using %SetAppControlProviderEventListener(),
+ * If the application does not set the listener using the %SetAppControlProviderEventListener() method,
* then the application is launched or moves to the foreground without invoking any listener
* for the application request from another application.
*
* @since 2.0
*
- * @return An error code
- * @param[in] pListener The application control provider listener
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance has not been properly constructed.
- * @exception E_INVALID_OPERATION The listener must be set for the valid %App class.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks If the application is newly launched with the AppControl request, then %SetAppControlProviderEventListener() must
- * be set before invoking IAppControlProviderEventListener::OnAppControlRequestReceived().
- * For valid %AppControl request handling, %SetAppControlProviderEventListener() must be called within
- * App::OnAppInitializing().
+ * @return An error code
+ * @param[in] pListener The application control provider listener
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE This instance has not been properly constructed.
+ * @exception E_INVALID_OPERATION The listener must be set for the valid App class.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks
+ * - If the application is newly launched with the AppControl request, then the %SetAppControlProviderEventListener() method must
+ * be set before invoking the IAppControlProviderEventListener::OnAppControlRequestReceived() method.
+ * - For valid %AppControl request handling, the %SetAppControlProviderEventListener() method within App::OnAppInitializing()
+ * must be called.
*/
result SetAppControlProviderEventListener(IAppControlProviderEventListener* pListener);
*
* @since 2.0
*
- * @return The application ID @n
- * If an error occurs, an empty string is returned.
- * @param[in] reqId The requestID
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The application control request is not found.
+ * @return The application ID, @n
+ * else an empty string is returned if an error occurs
+ * @param[in] reqId The requestID
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The application control request has not been found.
* @exception E_INVALID_STATE This instance has not been properly constructed.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
AppId GetClientAppId(RequestId reqId) const;
/**
* Sends the result list for the application control request. @n
- * The client receives the result by implementing IAppControlResponseListener::OnAppControlCompleteResponseReceived().
+ * The client receives the result by implementing the IAppControlResponseListener::OnAppControlCompleteResponseReceived() method.
*
* @since 2.0
*
- * @return An error code
- * @param[in] reqId The application control request ID
+ * @return An error code
+ * @param[in] reqId The application control request ID
* @param[in] appControlResult The application control result
- * @param[in] pExtraData A pointer to an extra argument map of key and value pair where the key is of type Tizen::Base::String and the value is of type %Tizen::Base::String or type Tizen::Base::Collection::ArrayList of %Tizen::Base::String
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The application control request is not found.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @param[in] pExtraData A pointer to the extra argument map of the key and value pair, where the key is of type Tizen::Base::String and the value is of type %Tizen::Base::String or of type Tizen::Base::Collection::ArrayList of %Tizen::Base::String
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The application control request has not been found.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result SendAppControlResult(RequestId reqId, AppCtrlResult appControlResult, const Tizen::Base::Collection::IMap* pExtraData);
* @final This class is not intended for extension.
*
* The %AppManager class manages all the applications.
- * The application manager supports normal and conditional application launch, and application control search and launch.
+ * The application manager supports both normal and conditional application launch as well as application control search and launch.
* It looks up the specific application control from the application control registry and creates an application control instance.
- * @n
- * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/app/launching_other_apps_within_apps.htm">Launching Other Applications</a>
and <a href="../org.tizen.native.appprogramming/html/guide/app/registering_launch_condition.htm">Registering a Launch Condition</a>, and <a href="../org.tizen.native.appprogramming/html/guide/app/app_controls.htm">Application Controls</a>.
+ *
+ * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/app/launching_other_apps_within_apps.htm">Launching Other Applications</a>
, <a href="../org.tizen.native.appprogramming/html/guide/app/registering_launch_condition.htm">Registering a Launch Condition</a>, and <a href="../org.tizen.native.appprogramming/html/guide/app/app_controls.htm">Application Controls</a>.
*/
class _OSP_EXPORT_ AppManager
: public Tizen::Base::Object
*/
enum LaunchOption
{
- LAUNCH_OPTION_DEFAULT /**< The launch option: default */
+ LAUNCH_OPTION_DEFAULT /**< The default launch option */
};
/**
*
* @since 2.0
*
- * @return A pointer to the newly created AppControl instance if a matched %AppControl is found, @n
- * else @c null
+ * @return A pointer to the newly created AppControl instance, if a matched %AppControl is found, @n
+ * else @c null if it fails
* @param[in] appId The application ID
* @param[in] operationId The operation ID
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The application control is not found.
- * @exception E_SYSTEM A system error has occurred. @n
- * Either the file operation or the DB operation has failed.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks %Tizen platform defines platform-defined alias for application ID and this aliased application ID
+ * @exception E_OBJ_NOT_FOUND The application control has not been found.
+ * @exception E_SYSTEM Either of the following conditions has occurred:
+ * - A system error has occurred.
+ * - Either the file operation or the DB operation has failed.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The %Tizen platform defines a platform-defined alias for the application ID and this aliased application ID
* can be used to find the AppControl. For more information, see
* <a href="../org.tizen.native.appprogramming/html/guide/app/app_controls.htm">here</a>.
*
static AppControl* FindAppControlN(const AppId& appId, const Tizen::Base::String& operationId);
/**
- * Finds a list of AppControl instances that matches the specified operation ID, category,
+ * Finds a list of AppControl instances that match the specified operation ID, category,
* data type, and URI pattern.
*
* @since 2.0
*
- * @return A pointer to the list of the AppControl instances that matches the specified operation ID, category, URI, and data type, @n
- * else @c null if it fails
- * @param[in] pOperationId The operation ID
- * @param[in] pCategory The application category
- * @param[in] pDataType The MIME type (RFC 2046) or file extension @n
- * The '.' prefix must be used when specifying the file extension.
- * @param[in] pUriPattern The URI pattern
+ * @return A pointer to the list of the AppControl instances that match the specified operation ID, category, URI, and data type, @n
+ * else @c null if it fails
+ * @param[in] pOperationId The operation ID
+ * @param[in] pCategory The application category
+ * @param[in] pDataType The MIME type (RFC 2046) or file extension @n
+ * The '.' prefix must be used while specifying the file extension.
+ * @param[in] pUriPattern The URI pattern
*
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG At least one of the specified @c pOperationId, @c pCategory, @c pDataType, or @c pUriScheme must not be @c null.
- * @exception E_INVALID_FORMAT The specified URI scheme is invalid (RFC 2396).
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG At least one of the specified @c pOperationId, @c pCategory, @c pDataType, or @c pUriScheme must not be @c null.
+ * @exception E_INVALID_FORMAT The specified URI scheme is invalid (RFC 2396).
* @exception E_UNSUPPORTED_FORMAT The specified file extension for @c pDataType is not supported.
- * @exception E_OBJ_NOT_FOUND The application control is not found.
- * @exception E_SYSTEM A system error has occurred. @n
- * Either the file operation or the DB operation has failed.
+ * @exception E_OBJ_NOT_FOUND The application control has not been found.
+ * @exception E_SYSTEM Either of the following conditions has occurred:
+ * - A system error has occurred.
+ * - Either the file operation or the DB operation has failed.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static Tizen::Base::Collection::IList* FindAppControlsN(const Tizen::Base::String* pOperationId, const Tizen::Base::String* pCategory, const Tizen::Base::String* pDataType, const Tizen::Base::String* pUriPattern);
/**
* @if OSPDEPREC
* Starts the application control if there is only one application control that matches the specified URI, operation ID, and data type. @n
- * If there are more than one application controls, the one that the user selects is started.
+ * If there are more than one application controls, then the user selected one is started.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated because IAppControlListener is deprecated and replaced by IAppControlResponselistener.
* Instead of using this method, use AppControl::FindAndStart().
* @since 2.0
* @privilege %http://tizen.org/privilege/application.launch
*
* @return An error code
- * @param[in] uriData The URI that has a maximum size of @c 1024 bytes
- * @param[in] pOperationId The operation ID
- * @param[in] pDataType The MIME type (RFC 2046) or file extension @n
- * The '.' prefix must be used for the @c dataType when specifying the file extension.
- * @param[in] pListener A listener that gets notified when the resolved application control has started
- * @exception E_SUCCESS The method is successful.
- * @exception E_MAX_EXCEEDED The size of @c uri has exceeded the maximum limit.
+ * @param[in] uriData The URI that has a maximum size of @c 1024 bytes
+ * @param[in] pOperationId The operation ID
+ * @param[in] pDataType The MIME type (RFC 2046) or file extension @n
+ * The '.' prefix must be used for the @c dataType while specifying the file extension.
+ * @param[in] pListener The listener that gets notified when the resolved application control is started
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_MAX_EXCEEDED The size of @c uri has exceeded the maximum limit.
* @exception E_UNSUPPORTED_FORMAT The specified file extension for @c pDataType is not supported.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_OBJ_NOT_FOUND The application control is not found.
- * @exception E_IN_PROGRESS The target application control is in progress.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_OBJ_NOT_FOUND The application control has not been found.
+ * @exception E_IN_PROGRESS The target application control is in progress.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*
* @see App::GetAppArgumentListN()
* @see FindAppControlN()
/**
* @if OSPDEPREC
* Starts the application control if there is only one application control that matches the specified operation ID, category, URI, and data type. @n
- * If there are more than one application controls, the one that the user selects is started.
+ * If there are more than one application controls, then the user selected one is started.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated because IAppControlListener is deprecated and replaced by IAppControlResponselistener.
* Instead of using this method, use AppControl::FindAndStart().
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/application.launch
*
- * @return An error code
- * @param[in] pOperationId The operation ID
- * @param[in] pCategory The application control category
- * @param[in] pDataType The MIME type (RFC 2046) or file extension @n
- * The '.' prefix must be used when specifying the file extension.
- * @param[in] pUriPattern A URI pattern which is used for application control resolution and delivered as the argument
- * @param[in] pDataList The data list that is delivered to the resolved application control @n
- * It has a maximum size of @c 1024 bytes.
- * @param[in] pListener A listener that gets notified when the resolved application control has started
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG At least one of the specified @c pOperationId, @c pCategory, @c pDataType, or @c pUri must not be @c null.
- * @exception E_MAX_EXCEEDED The size of @c pDataList has exceeded the maximum limit.
+ * @return An error code
+ * @param[in] pOperationId The operation ID
+ * @param[in] pCategory The application control category
+ * @param[in] pDataType The MIME type (RFC 2046) or file extension @n
+ * The '.' prefix must be used while specifying the file extension.
+ * @param[in] pUriPattern The URI pattern which is used for the application control resolution and is delivered as an argument
+ * @param[in] pDataList The data list that is delivered to the resolved application control @n
+ * It has a maximum size of @c 1024 bytes.
+ * @param[in] pListener The listener that gets notified when the resolved application control is started
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG At least one of the specified @c pOperationId, @c pCategory, @c pDataType, or @c pUri must not be @c null.
+ * @exception E_MAX_EXCEEDED The size of @c pDataList has exceeded the maximum limit.
* @exception E_UNSUPPORTED_FORMAT The specified file extension for @c pDataType is not supported.
- * @exception E_OBJ_NOT_FOUND The application control is not found.
- * @exception E_IN_PROGRESS The target application control is in progress.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_OBJ_NOT_FOUND The application control has not been found.
+ * @exception E_IN_PROGRESS The target application control is in progress.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks For delivered launch arguments, see App::GetAppArgumentListN().
- * @see App::GetAppArgumentListN()
* @see FindAppControlsN()
* @see AppControl::Start()
* @endif
*
* @since 2.0
*
- * @return A pointer to the SqlDataControl instance if a matching data control is found, @n
- * else @c null
+ * @return A pointer to the SqlDataControl instance, if a matching data control is found, @n
+ * else @c null if it fails
* @param[in] providerId The provider ID
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The data control specified with the @c providerId is not found.
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
+ * @exception E_OBJ_NOT_FOUND The data control specified with the @c providerId has not been found.
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*
* @since 2.0
*
- * @return A pointer to the MapDataControl instance if a matching data control is found, @n
- * else @c null
+ * @return A pointer to the MapDataControl instance, if a matching data control is found, @n
+ * else @c null if it fails
* @param[in] providerId The provider ID
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The data control specified with the @c providerId is not found.
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
+ * @exception E_OBJ_NOT_FOUND The data control specified with the @c providerId has not been found.
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
static MapDataControl* GetMapDataControlN(const Tizen::Base::String& providerId);
/**
- * Gets the path of the read-only shared directory exported by an other application specified with an application ID.
+ * Gets the path of the read-only shared directory exported by another application specified with an application ID.
*
* @since 2.0
*
* else an empty string if an exception occurs
* @param[in] appId The application ID
* @exception E_SUCCESS The method is successful.
- * @exception E_APP_NOT_INSTALLED The expected shared directory cannot be found
- * because the application specified with @c appId cannot be installed.
+ * @exception E_APP_NOT_INSTALLED The expected shared directory has not been found
+ * because the application specified by @c appId cannot be installed.
* @remarks
- * - The returned path can be invalid when the application with specified with @c appId is uninstalled.
- * - The specific error code can be accessed using the GetLastResult() method.
+ * - The returned path can be invalid when the application specified by @c appId is uninstalled.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
static Tizen::Base::String GetAppSharedPath(const AppId& appId);
/**
- * Gets the application manager instance.
+ * Gets a pointer to the %AppManager instance.
*
* @since 2.0
*
/**
* @if OSPDEPREC
* Launches the default application with the given @c appId. @n
- * The launch arguments are given as App::OnUserEventReceivedN() or can be obtained by
- * invoking App::GetAppArgumentListN(), especially within App::OnAppInitializing().
+ * The launch arguments are given by the App::OnUserEventReceivedN() method or can be obtained by
+ * invoking the App::GetAppArgumentListN() method, especially within App::OnAppInitializing().
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because sending argument with %LaunchApplication() is not recommended. @n
- * Instead of using this method, use %LaunchApplication() without launch arguments or AppControl::Start().
- * @since 2.0
+ * @deprecated This method is deprecated because sending arguments through the %LaunchApplication() method is not recommended. @n
+ * Instead of using this method, use the %LaunchApplication() method without launch arguments or AppControl::Start().
+ * @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/application.launch
*
- * @return An error code
- * @param[in] appId The application's ID to execute
+ * @return An error code
+ * @param[in] appId The ID of the application to execute
* @param[in] pArguments A pointer to the list of string arguments that has a maximum size of @c 1024 bytes
* @param[in] option The launch option (currently only AppManager::LAUNCH_OPTION_DEFAULT is available)
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @exception E_INVALID_ARG The specified @c appId is empty.
- * @exception E_OBJ_NOT_FOUND The target application is not installed.
+ * @exception E_OBJ_NOT_FOUND The target application has not been installed.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_MAX_EXCEEDED The size of @c appId or @c pArguments has exceeded the maximum limit.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_ILLEGAL_ACCESS The application is not signed with the same certificate of target application. @b Since: @b 2.1
+ * @exception E_ILLEGAL_ACCESS The application is not signed with the same certificate as that of the target application. @b Since: @b 2.1
* @endif
*/
result LaunchApplication(const AppId& appId, const Tizen::Base::Collection::IList* pArguments, LaunchOption option = LAUNCH_OPTION_DEFAULT);
/**
* Launches the default application with the given @c appId.
*
- * @since 2.0
+ * @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/application.launch
*
- * @return An error code
- * @param[in] appId The application's ID to execute
+ * @return An error code
+ * @param[in] appId The ID of the application to execute
* @param[in] option The launch option (currently only AppManager::LAUNCH_OPTION_DEFAULT is available)
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @exception E_APP_NOT_INSTALLED The target application is not installed.
+ * @exception E_APP_NOT_INSTALLED The target application has not been installed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_ILLEGAL_ACCESS The application is not signed with the same certificate of target application. @b Since: @b 2.1
+ * @exception E_ILLEGAL_ACCESS The application is not signed with the same certificate as that of the target application. @b Since: @b 2.1
*/
result LaunchApplication(const AppId& appId, LaunchOption option = LAUNCH_OPTION_DEFAULT);
* @privilege %http://tizen.org/privilege/appmanager.kill @n
* (%http://tizen.org/privilege/application.kill is deprecated.)
*
- * @return An error code
- * @param[in] appId The application's ID to execute
+ * @return An error code
+ * @param[in] appId The ID of the application to execute
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_OBJ_NOT_FOUND The application is either not installed or is not running.
+ * @exception E_OBJ_NOT_FOUND Either of the following conditions has occurred:
+ * - The application is not installed.
+ * - The application is not running.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
result TerminateApplication(const AppId& appId);
/**
- * Checks whether an application is running.
+ * Checks whether the application is running.
*
* @since 2.0
*
- * @return @c true if the application is running, @n
- * else @c false
- * @param[in] appId The installed application ID
+ * @return @c true if the application is running, @n
+ * else @c false
+ * @param[in] appId The installed application's ID
*/
bool IsRunning(const AppId& appId) const;
/**
- * Gets a list of running applications at the time of invocation.
+ * Gets the list of running applications at the time of the invocation.
*
* @since 2.0
*
- * @return A pointer to the running state application list (AppId), @n
- * else @c null if an error occurs
+ * @return A pointer to the running state application list (AppId), @n
+ * else @c null if an error occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
/**
* Registers an application with a specific condition and launches it if the condition is met. @n
- * If the requested application is already running, the application is notified through IAppLaunchConditionEventListener::OnAppLaunchConditionMetN().
- * The launch arguments are given as input parameters to %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN().
+ * If the requested application is already running, the application is notified through the IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method.
+ * The launch arguments are given as input parameters to the %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method.
*
- * @since 2.0
+ * @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/application.launch
- * @feature %http://tizen.org/feature/network.nfc for L"NFC='command'" or %http://tizen.org/feature/usb.accessory for "Serial='command'" in the value of @c condition
+ * @feature %http://tizen.org/feature/network.nfc for L"NFC='command'" or %http://tizen.org/feature/usb.accessory for "Serial='command'" in the value of @c condition
*
* @return An error code
* @param[in] condition The launch condition for the application @n
- * The condition has L"Key='value'" format and is case sensitive. To use single or double quotes in the condition values, prefix them with a slash (\' or \"). @n
- * For more information on the condition formats, see <a href="../org.tizen.native.appprogramming/html/guide/app/registering_launch_condition.htm">Registering a Launch Condition</a>.
- * <table><tr><th>Condition Format</th><th>Meaning</th></tr>
- <tr><td>L"DateTime='mm/dd/yyyy hh:mm:ss'"</td>
- <td>The specified condition is the local due time.</td></tr>
- <tr><td>L"DueTime='mm/dd/yyyy hh:mm:ss' LaunchPeriod='mm'"</td>
- <td>The specific condition is the time period after due time.</td></tr>
- <tr><td>L"WeeklyTime='EEE HH:mm:ss'"</td>
- <td>The specified condition is a day of a week with a specific time at which the application is launched on a weekly basis. For multiple descriptions, "," delimiter can be used as shown in the following example: <br>i"'Mon 09:00:00', 'Tue 09:00:00', 'Wed 09:00:00', 'Thu 09:00:00', 'Fri 09:00:00'"<br> To specify the day of the week, it must be in one of the following supported string format: <br>Mon: Monday<br>Tue: Tuesday<br>Wed: Wednesday<br>Thu: Thursday<br>Fri: Friday<br>Sat: Saturday<br>Sun: Sunday</td></tr>
- <tr><td>L"Serial='command'"</td><td>The specified condition is a serial
- communication input command.</td></tr>
- <tr><td>L"NFC='command'"</td><td>The specified condition is a Near Field Communication (NFC) tag that has the NFC Data Exchange Format (NDEF) data.
- </td></tr></table> @n
-
- *
- * @param[in] pArguments A list of string arguments that has a maximum size of @c 1024 bytes @n
- * The parameter can also contain @c null. @n
- * For more information on the arguments, see <a href="../org.tizen.native.appprogramming/html/guide/app/launching_other_apps_within_apps.htm">Launching Other Applications</a>.
- * @param[in] option The launch option (currently only AppManager::LAUNCH_OPTION_DEFAULT is available)
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The launch condition is empty or too long (Maximum 400 bytes).
- * @exception E_INVALID_FORMAT The specified condition format is invalid.
- * @exception E_INVALID_CONDITION The specified condition format is valid but the condition has at least one or more invalid values.
- * @exception E_OBJ_ALREADY_EXIST The specified @c condition is already registered by a different application.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_MAX_EXCEEDED The size of @c pArguments has exceeded the maximum limit.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>. @b Since: @b 2.1
- *
- * @remarks When the registered application is about to be launched, the registered launch condition and arguments are given as parameters to IAppLaunchConditionEventListener::OnAppLaunchConditionMetN().
- * @remarks The newly introduced launch condition does not work on the previous SDK version and the E_INVALID_CONDITION exception is returned.
- * @remarks Registering the same launch condition overwrites the previous launch argument without throwing an exception.
- * @remarks The launch period requires more consideration because an inappropriate short period value may lead
- * to an adverse effect on the device battery.
- * @remarks For the NFC launch condition, the detected NDEF message can be acquired using the @c pExtraData parameter of the %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method.
- * @remarks Before calling this method, check whether the feature is supported by Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
+ * The condition has L"Key='value'" format and is case sensitive. To use single or double quotes in the condition values, prefix them with a slash (\' or \"). @n
+ * For more information on the condition formats, see <a href="../org.tizen.native.appprogramming/html/guide/app/registering_launch_condition.htm">Registering a Launch Condition</a>.
+ * <table><tr><th>Condition Format</th><th>Meaning</th></tr>
+ * <tr><td>L"DateTime='mm/dd/yyyy hh:mm:ss'"</td>
+ * <td>The specified condition is the local due time.</td></tr>
+ * <tr><td>L"DueTime='mm/dd/yyyy hh:mm:ss' LaunchPeriod='mm'"</td>
+ * <td>The specified condition is the time period after the due time.</td></tr>
+ * <tr><td>L"WeeklyTime='EEE HH:mm:ss'"</td>
+ * <td>The specified condition is a day of a week with a specific time at which the application is launched on a weekly basis. For multiple descriptions, "," delimiter can be used as shown in the following example: <br>i"'Mon 09:00:00', 'Tue 09:00:00', 'Wed 09:00:00', 'Thu 09:00:00', 'Fri 09:00:00'"<br> To specify the day of the week, it must be in one of the following supported string format: <br>Mon: Monday<br>Tue: Tuesday<br>Wed: Wednesday<br>Thu: Thursday<br>Fri: Friday<br>Sat: Saturday<br>Sun: Sunday</td></tr>
+ * <tr><td>L"Serial='command'"</td><td>The specified condition is a serial
+ * communication input command.</td></tr>
+ * <tr><td>L"NFC='command'"</td><td>The specified condition is a Near Field Communication (NFC) tag that has the NFC Data Exchange Format (NDEF) data.
+ * </td></tr></table> @n
+ *
+ *
+ * @param[in] pArguments The list of string arguments that has a maximum size of @c 1024 bytes @n
+ * This parameter can also contain @c null. @n
+ * For more information on the arguments, see <a href="../org.tizen.native.appprogramming/html/guide/app/launching_other_apps_within_apps.htm">Launching Other Applications</a>.
+ * @param[in] option The launch option (currently only AppManager::LAUNCH_OPTION_DEFAULT is available)
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The launch condition is empty or too long (Maximum 400 bytes).
+ * @exception E_INVALID_FORMAT The specified condition format is invalid.
+ * @exception E_INVALID_CONDITION The specified condition format is valid but the condition has at least one or more invalid values.
+ * @exception E_OBJ_ALREADY_EXIST The specified @c condition is already registered by a different application.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_MAX_EXCEEDED The size of @c pArguments has exceeded the maximum limit.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>. @b Since: @b 2.1
+ *
+ * @remarks
+ * - When the registered application is about to be launched, the registered launch condition and arguments are given as parameters to the
+ * IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method.
+ * - For the NFC launch condition, the detected NDEF message can be acquired using the @c pExtraData parameter of the
+ * %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method.
+ * - The newly introduced launch condition does not work on the previous SDK version and @c E_INVALID_CONDITION is returned.
+ * - Registering the same launch condition overwrites the previous launch argument without throwing an exception.
+ * - The launch period requires more consideration because an inappropriate short period value may lead to an adverse effect on the device battery.
+ * - Before calling this method, check whether the feature is supported by Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
* @see UnregisterAppLaunch()
* @see IsAppLaunchRegistered()
* @see LaunchApplication(const AppId&, LaunchOption);
/**
* Unregisters the previously registered launch condition.
*
- * @since 2.0
+ * @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/application.launch
*
* @return An error code
- * @exception E_SUCCESS Either of the following conditions has occurred:
+ * @exception E_SUCCESS Either of the following conditions has occurred:
* - The method is successful.
* - There is no registered launch condition.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @see RegisterAppLaunch()
* @see IsAppLaunchRegistered()
*/
* @return An error code
* @param[in] condition The launch condition for the application
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified launch condition is not found.
+ * @exception E_OBJ_NOT_FOUND The specified launch condition has not been found.
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
result UnregisterAppLaunch(const Tizen::Base::String& condition);
/**
- * Checks whether a launch condition is registered for the application.
+ * Checks whether the launch condition is registered for the application.
*
* @since 2.0
*
- * @return @c true if a condition is already registered to the application invoking this method, @n
+ * @return @c true if the condition is already registered for the application, @n
* else @c false
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
bool IsAppLaunchRegistered(void) const;
/**
- * Registers the specified application with a specific condition and launches it if the condition is met. @n
- * If the requested application is already running, the application is notified through IAppLaunchConditionEventListener::OnAppLaunchConditionMetN().
- * The launch arguments are given as input parameters to %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN().
+ * Registers the specified application with the specified condition and launches it if the condition is met. @n
+ * If the requested application is already running, the application is notified through the IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method.
+ * The launch arguments are given as input parameters to the %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method.
*
* @since 2.0
* @privlevel partner
* @privilege %http://tizen.org/privilege/appmanager.launch
- * @feature %http://tizen.org/feature/network.nfc for L"NFC='command'" or %http://tizen.org/feature/usb.accessory for L"Serial='command'" in the value of @c condition
+ * @feature %http://tizen.org/feature/network.nfc for L"NFC='command'", or %http://tizen.org/feature/usb.accessory for L"Serial='command'" in the value of @c condition
*
* @return An error code
* @param[in] appId The ID of the application registered for launch
* @param[in] condition The launch condition for the application @n
* The condition has L"Key='value'" format and is case sensitive. To use single or double quotes in the condition values, prefix them with a slash (\' or \"). @n
* For more information on the condition formats, see <a href="../org.tizen.native.appprogramming/html/guide/app/registering_launch_condition.htm">Registering a Launch Condition</a>.
- * <table><tr><th>Condition Format</th><th>Meaning</th></tr>
- <tr><td>L"DateTime='mm/dd/yyyy hh:mm:ss'"</td>
- <td>The specified condition is the local due time.</td></tr>
- <tr><td>L"DueTime='mm/dd/yyyy hh:mm:ss' LaunchPeriod='mm'"</td>
- <td>The specific condition is the time period after due time.</td></tr>
- <tr><td>L"WeeklyTime='EEE HH:mm:ss'"</td>
- <td>The specified condition is a day of a week with a specific time at which the application is launched on a weekly basis. For multiple descriptions, "," delimiter can be used as shown in the following example: <br>i"'Mon 09:00:00', 'Tue 09:00:00', 'Wed 09:00:00', 'Thu 09:00:00', 'Fri 09:00:00'"<br> To specify the day of the week, it must be in one of the following supported string format: <br>Mon: Monday<br>Tue: Tuesday<br>Wed: Wednesday<br>Thu: Thursday<br>Fri: Friday<br>Sat: Saturday<br>Sun: Sunday</td></tr>
- <tr><td>L"Serial='command'"</td><td>The specified condition is a serial
- communication input command.</td></tr>
- <tr><td>L"NFC='command'"</td><td>The specified condition is a Near Field Communication (NFC) tag that has the NFC Data Exchange Format (NDEF) data.
- </td></tr></table> @n
-
- *
- * @param[in] pArguments A list of string arguments that has a maximum size of @c 1024 bytes @n
- * The parameter can also contain @c null. @n
- * For more information on the arguments, see <a href="../org.tizen.native.appprogramming/html/guide/app/launching_other_apps_within_apps.htm">Launching Other Applications</a>.
- * @param[in] option The launch option (currently only AppManager::LAUNCH_OPTION_DEFAULT is available)
- * @exception E_SUCCESS The method is successful.
- * @exception E_APP_NOT_INSTALLED The application is not installed.
- * @exception E_INVALID_ARG The launch condition is empty or too long (Maximum 400 bytes).
- * @exception E_INVALID_FORMAT The specified condition format is invalid.
- * @exception E_INVALID_CONDITION The specified condition format is valid but the condition has at least one or more invalid values.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_MAX_EXCEEDED The size of @c pArguments has exceeded the maximum limit.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>. @b Since: @b 2.1
- *
- * @remarks When the registered application is about to be launched, the registered launch condition and arguments are given as parameters to IAppLaunchConditionEventListener::OnAppLaunchConditionMetN().
- * @remarks The newly introduced launch condition does not work on the previous SDK version and the @c E_INVALID_CONDITION exception is returned.
- * @remarks Registering the same launch condition overwrites the previous launch argument without throwing an exception.
- * @remarks The launch period requires more consideration because an inappropriate short period value may lead
- * to an adverse effect on the device battery.
- * @remarks For the NFC launch condition, the detected NDEF message can be acquired using the @c pExtraData parameter of the %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method.
- * @remarks Before calling this method, check whether the feature is supported by Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
+ * <table><tr><th>Condition Format</th><th>Meaning</th></tr>
+ * <tr><td>L"DateTime='mm/dd/yyyy hh:mm:ss'"</td>
+ * <td>The specified condition is the local due time.</td></tr>
+ * <tr><td>L"DueTime='mm/dd/yyyy hh:mm:ss' LaunchPeriod='mm'"</td>
+ * <td>The specified condition is the time period after the due time.</td></tr>
+ * <tr><td>L"WeeklyTime='EEE HH:mm:ss'"</td>
+ * <td>The specified condition is a day of a week with a specific time at which the application is launched on a weekly basis. For multiple descriptions, "," delimiter can be used as shown in the following example: <br>i"'Mon 09:00:00', 'Tue 09:00:00', 'Wed 09:00:00', 'Thu 09:00:00', 'Fri 09:00:00'"<br> To specify the day of the week, it must be in one of the following supported string format: <br>Mon: Monday<br>Tue: Tuesday<br>Wed: Wednesday<br>Thu: Thursday<br>Fri: Friday<br>Sat: Saturday<br>Sun: Sunday</td></tr>
+ * <tr><td>L"Serial='command'"</td><td>The specified condition is a serial
+ * communication input command.</td></tr>
+ * <tr><td>L"NFC='command'"</td><td>The specified condition is a Near Field Communication (NFC) tag that has the NFC Data Exchange Format (NDEF) data.
+ * </td></tr></table> @n
+ *
+ *
+ * @param[in] pArguments The list of string arguments that has a maximum size of @c 1024 bytes @n
+ * The parameter can also contain @c null. @n
+ * For more information on the arguments, see <a href="../org.tizen.native.appprogramming/html/guide/app/launching_other_apps_within_apps.htm">Launching Other Applications</a>.
+ * @param[in] option The launch option (currently only AppManager::LAUNCH_OPTION_DEFAULT is available)
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_APP_NOT_INSTALLED The application has not been installed.
+ * @exception E_INVALID_ARG The launch condition is empty or too long (Maximum 400 bytes).
+ * @exception E_INVALID_FORMAT The specified condition format is invalid.
+ * @exception E_INVALID_CONDITION The specified condition format is valid but the condition has at least one or more invalid values.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_MAX_EXCEEDED The size of @c pArguments has exceeded the maximum limit.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>. @b Since: @b 2.1
+ *
+ * @remarks
+ * - When the registered application is about to be launched, the registered launch condition and arguments are given as parameters to the
+ * IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method.
+ * - For the NFC launch condition, the detected NDEF message can be acquired using the @c pExtraData parameter of the
+ * %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method.
+ * - The newly introduced launch condition does not work on the previous SDK version and @c E_INVALID_CONDITION is returned.
+ * - Registering the same launch condition overwrites the previous launch argument without throwing an exception.
+ * - The launch period requires more consideration because an inappropriate short period value may lead
+ * to an adverse effect on the device battery.
+ * - Before calling this method, check whether the feature is supported by Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
* @see UnregisterAppLaunch()
* @see IsAppLaunchRegistered()
* @see LaunchApplication(const AppId&, LaunchOption);
- * @see IAppLaunchConditionEventListener::OnAppLaunchConditionMetN()
* @see Tizen::Base::DateTime::ToString()
* @see Tizen::Io::SerialPort
*/
* @privilege %http://tizen.org/privilege/appmanager.launch
*
* @return An error code
- * @param[in] appId The application ID
+ * @param[in] appId The application ID
* @param[in] pCondition The launch condition to unregister @n
* If the parameter contains @c null, all the conditions are unregistered.
* @exception E_SUCCESS The method is successful.
- * @exception E_APP_NOT_INSTALLED The application is not installed.
- * @exception E_OBJ_NOT_FOUND The specified launch condition is not found.
+ * @exception E_APP_NOT_INSTALLED The application has not been installed.
+ * @exception E_OBJ_NOT_FOUND The specified launch condition has not been found.
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @privlevel partner
* @privilege %http://tizen.org/privilege/appmanager.launch
*
- * @return @c true if a condition is already registered to the specified application with the specified condition, @n
+ * @return @c true if the condition is already registered for the specified application with the specified condition, @n
* else @c false
- * @param[in] appId The application ID
- * @param[in] pCondition The launch condition to register for the specified @c appId @n
- * If the parameter contains @c null, the method checks for any registered launch condition for the specified @c appId.
+ * @param[in] appId The application ID
+ * @param[in] pCondition The launch condition to register for the specified @c appId @n
+ * If the parameter contains @c null, the method checks for any registered launch condition for the specified @c appId.
* @exception E_SUCCESS The method is successful.
- * @exception E_APP_NOT_INSTALLED The application is not installed.
+ * @exception E_APP_NOT_INSTALLED The application has not been installed.
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*
* @since 2.0
*
- * @return An error code
- * @param[in] listener The listener to receive the checkpoint event
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_ALREADY_EXIST The listener is already set.
- * @exception E_SYSTEM A system error has occurred.
+ * @return An error code
+ * @param[in] listener The listener to receive the checkpoint event
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_ALREADY_EXIST The listener is already set.
+ * @exception E_SYSTEM A system error has occurred.
*
*/
result SetCheckpointEventListener(IAppCheckpointEventListener& listener);
/**
* @if OSPDEPREC
* Sends the result list for the application control request. @n
- * The client can get the result list by implementing IAppControlEventListener::OnAppControlCompleted().
+ * The client gets the result list by implementing the IAppControlEventListener::OnAppControlCompleted() method.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated because a new method has been added. @n
- * Instead of using this method, use AppControlProviderManager::SendAppControlResult().
+ * Instead of using this method, use AppControlProviderManager::SendAppControlResult().
* @since 2.0
*
* @return An error code
- * @param[in] appControlRequestId The application control request ID @n
- * The application control request ID is given as an argument for
- * App::GetAppArgumentListN() or App::OnUserEventReceivedN().
- * @param[in] pResultList The list of the result strings of the application control
+ * @param[in] appControlRequestId The application control request ID @n
+ * The application control request ID is given as an argument to the
+ * App::GetAppArgumentListN() method or the App::OnUserEventReceivedN() method.
+ * @param[in] pResultList The list of the result strings of the application control
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The application control request is not found.
+ * @exception E_OBJ_NOT_FOUND The application control request has not been found.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
* @see IAppControlEventListener
static result SendAppControlResult(const Tizen::Base::String& appControlRequestId, const Tizen::Base::Collection::IList* pResultList);
/**
- * Sets an IAppLaunchConditionEventListener to the %AppManager. @n
- * The listener gets notified when the application is launched by the registered condition.
- *
- * @since 2.0
- *
- * @param[in] pListener The event listener @n
- * To unset the listener, pass a @c null value to the listener parameter.
- * @remarks If the application is newly launched by the condition, then %SetAppLaunchConditionEventListener() must
- * be set within App::OnAppInitializing().
- * If the application does not set the listener using %SetAppLaunchConditionEventListener(),
- * then the application is launched without invoking any listener for the condition.
- * @see RegisterAppLaunch()
- */
+ * Sets an IAppLaunchConditionEventListener for the %AppManager. @n
+ * The listener gets notified when the application is launched by the registered condition.
+ *
+ * @since 2.0
+ *
+ * @param[in] pListener The event listener @n
+ * To unset the listener, pass a @c null value to the listener parameter.
+ * @remarks If the application is newly launched by the condition, then the %SetAppLaunchConditionEventListener() method
+ * within App::OnAppInitializing() must be set. @n
+ * If the application does not set the listener using the %SetAppLaunchConditionEventListener() method,
+ * then the application is launched without invoking any listener for the condition.
+ * @see RegisterAppLaunch()
+ */
void SetAppLaunchConditionEventListener(IAppLaunchConditionEventListener* pListener);
/**
- * Adds an IActiveAppEventListener to the %AppManager. @n
+ * Adds an IActiveAppEventListener for the %AppManager. @n
* The listener gets notified when the active application is changed.
*
* @since 2.0
* @exception E_OBJ_ALREADY_EXIST The listener is already added.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks Active application is the top most window with focus.
+ * @remarks The active application is the top most window with focus.
* @see GetActiveApp()
* @see RemoveActiveAppEventListener()
*/
* @return An error code
* @param[in] listener The event listener
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c listener is not found.
+ * @exception E_OBJ_NOT_FOUND The specified @c listener has not been found.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @see GetActiveApp()
result RemoveActiveAppEventListener(IActiveAppEventListener& listener);
/**
- * Gets the current active application AppId.
+ * Gets the current active application's ID.
*
* @since 2.0
*
* @privilege %http://tizen.org/privilege/appusage
*
* @return An error code
- * @param[out] appId The AppId of the active application
+ * @param[out] appId The ID of the active application
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks Active application is the top most window with focus.
+ * @remarks The active application is the top most window with focus.
* @see AddActiveAppEventListener()
* @see RemoveActiveAppEventListener()
*/
result GetActiveApp(AppId& appId);
/**
- * Checks whether the specified application is declared as preferred application for any AppControl resolution
+ * Checks whether the specified application is declared as the preferred application for any AppControl resolution
*
* @since 2.2
- * @privlevel platform
+ * @privlevel platform
* @privilege %http://tizen.org/privilege/appmanager.setting
*
* @return @c true if the application is running, @n
- * else @c false
- * @param[in] appId Application ID
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @exception E_APP_NOT_INSTALLED The specified application is not installed.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks For more information on AppControl resolution, see <a href="../org.tizen.native.appprogramming/html/guide/app/app_controls.htm">Application Controls</a>.
+ * else @c false
+ * @param[in] appId The application ID
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_APP_NOT_INSTALLED The specified application has not been installed.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - For more information on AppControl resolution, see <a href="../org.tizen.native.appprogramming/html/guide/app/app_controls.htm">Application Controls</a>.
*/
bool IsUserPreferredAppForAppControlResolution(const AppId& appId) const;
/**
- * Clear user preference for all AppControl resolutions on the specified application.
+ * Clears the user preference for all the AppControl resolutions of the specified application.
*
* @since 2.2
- * @privlevel platform
+ * @privlevel platform
* @privilege %http://tizen.org/privilege/appmanager.setting
*
- * @return An error code
+ * @return An error code
* @param[in] appId The preferred application's ID
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @exception E_APP_NOT_INSTALLED The specified application is not installed.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_APP_NOT_INSTALLED The specified application has not been installed.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks For more information on AppControl resolution, see <a href="../org.tizen.native.appprogramming/html/guide/app/app_controls.htm">Application Controls</a>.
*/
result ClearUserPreferenceForAppControlResolution(const AppId& appId);
*
* @final This class is not intended for extension.
*
- * The %AppRegistry class lets an application to save or restore its preferences.
+ * The %AppRegistry class lets an application save or restore its preferences.
* An instance of this class can be obtained through the Application class.
* Also, since an application's state is generally restored in the App::OnAppInitializing() method and saved in the App::OnAppTerminating() method, an instance of this class is passed as an argument when these methods are invoked.
* @n
*
* @since 2.0
*
- * @return An error code
- * @param[in] key A key corresponding to the value
- * @param[in] value A string value
+ * @return An error code
+ * @param[in] key The key corresponding to the string value
+ * @param[in] value The string value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly.
- * @exception E_KEY_ALREADY_EXIST The key has already been used in the application preferences.
+ * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly.
+ * @exception E_KEY_ALREADY_EXIST The specified @c key has already been used in the application preferences.
* @remarks In order to save the value in the persistent storage, the Save() method must be called.
*/
result Add(const Tizen::Base::String& key, const Tizen::Base::String& value);
*
* @since 2.0
*
- * @return An error code
- * @param[in] key A key corresponding to the value
- * @param[in] value An integer value
+ * @return An error code
+ * @param[in] key The key corresponding to the integer value
+ * @param[in] value The integer value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly.
- * @exception E_KEY_ALREADY_EXIST The key has already been used in the application preferences.
+ * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly.
+ * @exception E_KEY_ALREADY_EXIST The specified @c key has already been used in the application preferences.
* @remarks In order to save the value in the persistent storage, the Save() method must be called.
*/
result Add(const Tizen::Base::String& key, int value);
*
* @since 2.0
*
- * @return An error code
- * @param[in] key A key corresponding to the value
- * @param[in] value A floating point value
+ * @return An error code
+ * @param[in] key The key corresponding to the floating point value
+ * @param[in] value The floating point value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly.
- * @exception E_KEY_ALREADY_EXIST The key has already been used in the application preferences.
+ * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly.
+ * @exception E_KEY_ALREADY_EXIST The specified @c key has already been used in the application preferences.
* @remarks In order to save the value in the persistent storage, the Save() method must be called.
*/
result Add(const Tizen::Base::String& key, double value);
/**
- * Sets a string value associated with the specified @c key.
+ * Sets the string value associated with the specified @c key.
*
* @since 2.0
*
- * @return An error code
- * @param[in] key A key corresponding to the value
- * @param[in] value A string value
+ * @return An error code
+ * @param[in] key The key corresponding to the string value
+ * @param[in] value The string value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly.
+ * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly.
* @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences.
* @remarks In order to save the value in the persistent storage, the Save() method must be called.
*/
result Set(const Tizen::Base::String& key, const Tizen::Base::String& value);
/**
- * Sets an integer value associated with the specified @c key.
+ * Sets the integer value associated with the specified @c key.
*
* @since 2.0
*
- * @return An error code
- * @param[in] key A key corresponding to the value
- * @param[in] value An integer value
+ * @return An error code
+ * @param[in] key The key corresponding to the integer value
+ * @param[in] value The integer value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly.
+ * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly.
* @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences.
* @remarks In order to save the value in the persistent storage, the Save() method must be called.
*/
result Set(const Tizen::Base::String& key, int value);
/**
- * Sets a floating point value associated with the specified @c key.
+ * Sets the floating point value associated with the specified @c key.
*
* @since 2.0
*
- * @return An error code
- * @param[in] key A key corresponding to the value
- * @param[in] value A floating point value
+ * @return An error code
+ * @param[in] key The key corresponding to the floating point value
+ * @param[in] value The floating point value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly.
+ * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly.
* @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences.
* @remarks In order to save the value in the persistent storage, the Save() method must be called.
*/
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @exception E_SUCCESS The method is successful.
*/
result Save(void);
/**
- * Removes a preference associated with the specified @c key.
+ * Removes the preference associated with the specified @c key.
*
* @since 2.0
*
- * @return An error code
- * @param[in] key The key of the value to remove
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] key The key of the value to remove
+ * @exception E_SUCCESS The method is successful.
* @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences.
*/
result Remove(const Tizen::Base::String& key);
/**
- * Gets a string value associated with the specified @c key.
+ * Gets the string value associated with the specified @c key.
*
* @since 2.0
*
- * @return An error code
- * @param[in] key The key of the value to retrieve
- * @param[out] value A string value to retrieve
+ * @return An error code
+ * @param[in] key The key of the string value to retrieve
+ * @param[out] value The string value to retrieve
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly.
+ * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly.
* @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences.
*/
result Get(const Tizen::Base::String& key, Tizen::Base::String& value) const;
/**
- * Gets an integer value associated with the specified @c key.
+ * Gets the integer value associated with the specified @c key.
*
* @since 2.0
*
- * @return An error code
- * @param[in] key The key of the value to retrieve
- * @param[out] value An integer value to retrieve
+ * @return An error code
+ * @param[in] key The key of the integer value to retrieve
+ * @param[out] value The integer value to retrieve
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly.
+ * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly.
* @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences.
*/
result Get(const Tizen::Base::String& key, int& value) const;
/**
- * Gets a floating point value associated with the specified @c key.
+ * Gets the floating point value associated with the specified @c key.
*
* @since 2.0
*
- * @return An error code
- * @param[in] key The key of the value to retrieve
- * @param[out] value A floating point value to retrieve
+ * @return An error code
+ * @param[in] key The key of the floating point value to retrieve
+ * @param[out] value The floating point value to retrieve
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly.
+ * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly.
* @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences.
*/
result Get(const Tizen::Base::String& key, double& value) const;
/**
- * Gets the %AppRegistry instance pointer.
+ * Gets a pointer to the %AppRegistry instance.
*
* @since 2.0
*
- * @return A pointer to the %AppRegistry instance, @n
- * else @c null if it fails
+ * @return A pointer to the %AppRegistry instance, @n
+ * else @c null if it fails
*/
static AppRegistry* GetInstance(void);
//
/**
- * @file FAppAppResource.h
- * @brief This is the header file for the %AppResource class.
+ * @file FAppAppResource.h
+ * @brief This is the header file for the %AppResource class.
*
* This header file contains the declarations of the %AppResource class.
*/
{
/**
-* @class AppResource
-* @brief This class provides convenient methods to load application resources at run time.
+* @class AppResource
+* @brief This class provides convenient methods to load application resources at run time.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
* The %AppResource class provides convenient methods to load application resources at run time: @n
-* - Use AppResource::GetString() to get handle and display localized strings.
-* - Use AppResource::GetBitmapN() to obtain a bitmap image that matches the screen density.
-* - If the matching image does not exist, the image of the baseline density folder, ScreenDensity-High is used.
+* - Use the AppResource::GetString() method to get a handle and display localized strings.
+* - Use the AppResource::GetBitmapN() method to obtain a bitmap image that matches the screen density.
+* - If a matching image does not exist, the image of the baseline density folder, ScreenDensity-High is used.
*
-* The instance of this class can be obtained through App::GetAppResource().
+* The instance of this class can be obtained through the App::GetAppResource() method.
*
* The following example demonstrates how to use the %AppResource class to get strings.
*
* @return An error code
* @param[in] resourceId The resource ID of type Tizen::Base::String that describes the resource
* @param[out] loadedString The string obtained from the loaded application resource
- * @exception E_SUCCESS The method is successful.
- * @exception E_FAILURE The argument passed is not found.
- * @exception E_INVALID_ARG The argument passed to a method contains an invalid resource ID.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_FAILURE The argument passed has not been found.
+ * @exception E_INVALID_ARG The argument passed to the method contains an invalid resource ID.
*/
result GetString(const Tizen::Base::String& resourceId, Tizen::Base::String& loadedString) const;
/**
* Gets the bitmap at the specified path. @n
* The %GetBitmapN() method interprets the given resource path and reads the best matching image file for the current device resolution. @n
- * To load the bitmap image from a file, give the name of the file as the input parameter and not the file path (For example: "img.png").
- * Then, the system will first look for the image file in the folder specific to the current device resolution, such as
+ * To load the bitmap image from a file, give the name of the file as the input parameter and not the file path (For example, "img.png").
+ * The system will first look for the image file in the folder specific to the current device resolution, such as
* '720x1280' and if the file does not exist, it will then search the folder that corresponds to the current screen density,
* such as 'screen-density-xhigh'. After searching the density folder, all the other density folders are searched in the order high to low.
* If the requested image file is found in a density-specific folder that is different from the current screen density, the bitmap returned from this method is pre-scaled.
- * But in case of requested image file is saved as ".#.png" (For example : "img.#.png"), then a bitmap instance which is value of returned pointer is not pre-scaled.
- * So, it is recommended to use ".#.png" as extension (For example : "ninePatchImg.#.png") for nine-patch image file.
+ * But in case the requested image file is saved as ".#.png" (For example, "img.#.png"), then the bitmap instance of the returned pointer is not pre-scaled.
+ * So, it is recommended to use ".#.png" as the extension (For example, "ninePatchImg.#.png") for a nine-patch image file.
* Currently supported image formats are: JPEG, GIF, PNG, BMP, TIFF, and WBMP.
* For more information on the features, see <a href="../org.tizen.native.appprogramming/html/multiple_screen/autoscale_resource_fallback.htm">Resource Fallback and Prescaling.</a>
*
* @since 2.0
*
- * @return A pointer to the Bitmap instance generated from the specified file
+ * @return A pointer to the Tizen::Graphics::Bitmap instance generated from the specified file
* @param[in] imagePath The relative path starting from the directory @b "res/screen-density-XXX/" or @b "res/AxB", @n
- * where A and B represent the screen width and height of the supported device models, respectively.
+ * where A and B represent the screen width and screen height of the supported device models, respectively.
* @param[in] pixelFormat The pixel format of the resulting bitmap
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_UNSUPPORTED_FORMAT The image file format or specified pixel format is not supported.
+ * @exception E_UNSUPPORTED_FORMAT Either the image file format or the specified @c pixelFormat is not supported.
* @exception E_FILE_NOT_FOUND The specified file cannot be found.
* @exception E_SYSTEM A system error has occurred.
* @remarks
* - The specific error code can be accessed using the GetLastResult() method.
- * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
+ * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is @c E_OUT_OF_MEMORY or not.
+ * For more information on how to handle the out-of-memory exception, refer
+ * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
*/
Tizen::Graphics::Bitmap* GetBitmapN(const Tizen::Base::String& imagePath, Tizen::Graphics::BitmapPixelFormat pixelFormat) const;
/**
* Gets the bitmap at the specified path. @n
* The %GetBitmapN() method interprets the given resource path and reads the best matching image file for the current device resolution. @n
- * To load the bitmap image from a file, give the name of the file as the input parameter and not the file path (For example: "img.png").
- * Then, the system will first look for the image file in the folder specific to the current device resolution, such as
+ * To load the bitmap image from a file, give the name of the file as the input parameter and not the file path (For example, "img.png").
+ * The system will first look for the image file in the folder specific to the current device resolution, such as
* '720x1280' and if the file does not exist, it will then search the folder that corresponds to the current screen density,
* such as 'screen-density-xhigh'. After searching the density folder, all the other density folders are searched in the order high to low.
* If the requested image file is found in a density-specific folder that is different from the current screen density, the bitmap returned from this method is pre-scaled.
- * But in case of requested image file is saved as ".#.png" (For example : "img.#.png"), then a bitmap instance which is value of returned pointer is not pre-scaled.
- * So, it is recommended to use ".#.png" as extension (For example : "ninePatchImg.#.png") for nine-patch image file.
+ * But in case the requested image file is saved as ".#.png" (For example, "img.#.png"), then the bitmap instance of the returned pointer is not pre-scaled.
+ * So, it is recommended to use ".#.png" as the extension (For example, "ninePatchImg.#.png") for a nine-patch image file.
* Currently supported image formats are: JPEG, GIF, PNG, BMP, TIFF, and WBMP.
* For more information on the features, see <a href="../org.tizen.native.appprogramming/html/multiple_screen/autoscale_resource_fallback.htm">Resource Fallback and Prescaling.</a>
*
* @since 2.0
*
- * @return A pointer to the Tizen::Graphics::Bitmap instance generated from the specified file
+ * @return A pointer to the Tizen::Graphics::Bitmap instance generated from the specified file
* @param[in] imagePath The relative path starting from the density directory @b "res/screen-density-XXX/" or @b "res/AxB", @n
- * where A and B represent the width and height of the screen of the supported device models, respectively
+ * where A and B represent the screen width and screen height of the supported device models, respectively
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_UNSUPPORTED_FORMAT The image file format is not supported.
* @exception E_SYSTEM A system error has occurred.
* @remarks
* - The specific error code can be accessed using the GetLastResult() method.
- * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
+ * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is @c E_OUT_OF_MEMORY or not.
+ * For more information on how to handle the out-of-memory exception, refer
+ * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
*/
Tizen::Graphics::Bitmap* GetBitmapN(const Tizen::Base::String& imagePath) const;
/**
- * Gets the %AppResource instance pointer.
+ * Gets a pointer to the %AppResource instance.
*
- * @since 2.0
+ * @since 2.0
*
- * @return A pointer to the %AppResource instance, @n
- * else @c null if it fails
+ * @return A pointer to the %AppResource instance, @n
+ * else @c null if it fails
*/
static AppResource* GetInstance(void);
/**
- * Gets the resource instance of the specified resource path.
- * @since 2.0
+ * Gets an %AppResource instance of the specified @c resourcePath.
+ * @since 2.0
* @return A pointer to the %AppResource instance, @n
* else @c null if it fails
* @param[in] resourcePath The relative path starting from the resource directory path of the current application
* @exception E_SUCCESS The method is successful.
- * @exception E_FILE_NOT_FOUND The specified resource path does not exist.
- * @exception E_INVALID_ARG The length of the specified path is @c 0 or exceeds system limitations.
- * @exception E_SYSTEM Initializing string and bitmap resource is failed due to system error.
+ * @exception E_FILE_NOT_FOUND The specified @c resourcePath does not exist.
+ * @exception E_INVALID_ARG Either of the following conditions has occured:
+ * - The length of the specified path is @c 0.
+ * - The length of the specified path exceeds system limitations.
+ * @exception E_SYSTEM Initializing the string and the bitmap resource has failed due to a system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static AppResource* LoadAppResource(const Tizen::Base::String& resourcePath);
/**
- * Gets the application resource instance of the specified @c appId.
+ * Gets an %AppResource instance of the specified @c appId.
*
* @since 2.0
*
* @privlevel platform
- * @privilege %http://tizen.org/privilege/appsetting
+ * @privilege %http://tizen.org/privilege/appsetting
*
* @return A pointer to the %AppResource instance, @n
* else @c null if it fails
- * @param[in] appId The AppId of the installed application
+ * @param[in] appId The ID of the installed application
* @exception E_SUCCESS The method is successful.
- * @exception E_DATA_NOT_FOUND The instance of specified @c appId does not provide the string resource.
+ * @exception E_DATA_NOT_FOUND The specified @c appId does not provide the required string resource.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_APP_NOT_INSTALLED The specified @c appId is not found in the list of installed applications.
- * @exception E_SYSTEM Initializing string and bitmap resource has failed due to a system error.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_APP_NOT_INSTALLED The specified @c appId has not been found in the list of installed applications.
+ * @exception E_SYSTEM Initializing the string and the bitmap resource has failed due to a system error.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static AppResource* GetInstanceByAppId(const AppId& appId);
/**
- * Releases the application resource instance of the specified @c appId.
+ * Releases the %AppResource instance of the specified @c appId.
*
* @since 2.0
*
- * @privlevel platform
+ * @privlevel platform
* @privilege %http://tizen.org/privilege/appsetting
*
* @return An error code
- * @param[in] appId The AppId of the installed application
+ * @param[in] appId The ID of the installed application
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The application resource instance of the specified @c appId is not found.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks Individual instances are managed by the platform. @n
- * It is recommended to release instances to reduce memory usage.
+ * @exception E_OBJ_NOT_FOUND The application resource instance of the specified @c appId has not been found.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @remarks
+ * - Individual instances are managed by the platform.
+ * - It is recommended to release instances to reduce memory usage.
*/
static result ReleaseInstanceByAppId(const AppId& appId);
* @final This class is not intended for extension.
*
* The %AppSetting class is a helper class for an application to save or restore its settings.
- * A setting entity is composed of a string-typed key and a value. The value type must be only of these three types: @c int, @c bool, and @c String.
- * The settings are pre-defined in setting/setting.xml in the application's base directory
+ * A setting entity is composed of a string-typed key and a value. The value type must only be of three types: @c int, @c bool, and @c String.
+ * The settings are pre-defined at setting/setting.xml in the application's base directory
* and they can be easily set with %Tizen IDE (<a href="../org.tizen.native.appprogramming/html/ide_sdk_tools/creating_running_app_setting.htm">Creating and Using Application Settings</a>, <a href="../org.tizen.native.appprogramming/html/ide_sdk_tools/application_settings_editor.htm">Application Settings Editor</a>).
- * (The setting.xml is a symbolic link to the currently used setting file, which is related to the current version of the application.) @n
- * The %AppSetting class is basically used for specific applications such as IME, which have no UI.
+ * (setting.xml is a symbolic link to the currently used setting file, which is related to the current version of the application.) @n
+ * The %AppSetting class is basically used for specific applications which have no UI, such as IME.
* Because the applications have no external way to modify their settings, users can adjust the setting values through the setting application, which is delegated to manage the settings.
- * For supporting the consistency of setting values between two applications, the target application and the setting application, when setting a value in the setting application, the target application is notified from the setting application through
- * IAppSettingEventListener::OnAppSettingChanged()
- * For detailed example on this class, see <a href="../org.tizen.native.appprogramming/html/tutorials/app_tutorial/task_app_settings.htm?resultof=%22%41%70%70%53%65%74%74%69%6e%67%22%20%22%61%70%70%73%65%74%74%69%6e%67%22%20">Task: App Setting</a>.
+ * For supporting the consistency between the setting values of two applications, that is, the target application and the setting application, the setting application notifies the target application through
+ * the IAppSettingEventListener::OnAppSettingChanged() method when setting a value.
+ *
+ * For a detailed example on the %AppSetting class, see <a href="../org.tizen.native.appprogramming/html/tutorials/app_tutorial/task_app_settings.htm?resultof=%22%41%70%70%53%65%74%74%69%6e%67%22%20%22%61%70%70%73%65%74%74%69%6e%67%22%20">Task: App Setting</a>.
*
* @see IAppSettingEventListener
*/
{
public:
/**
- * Gets the application setting instance.
+ * Gets the pointer to the %AppSetting instance.
*
* @since 2.0
*
- * @return A pointer to the %AppSetting instance for the last setting, @n
+ * @return The pointer to the %AppSetting instance for the last setting, @n
* else @c null if it fails
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
static AppSetting* GetInstance(void);
/**
- * Gets the application setting instance of the specified version.
+ * Gets the pointer to the %AppSetting instance of the specified version.
*
* @since 2.0
*
- * @return A pointer to the %AppSetting instance, @n
+ * @return The pointer to the %AppSetting instance, @n
* else @c null if it fails
- * @param[in] settingVersion The version of setting is retrieved from GetAppSettingVersionListN()
+ * @param[in] settingVersion The version of the setting which is retrieved from GetAppSettingVersionListN()
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified version is not found.
+ * @exception E_OBJ_NOT_FOUND The specified version has not been found.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see GetAppSettingVersionListN()
*/
static AppSetting* GetInstance(const Tizen::Base::String& settingVersion);
/**
- * Gets the application setting instance of the specified AppId.
+ * Gets an %AppSetting instance of the specified ID.
*
* @since 2.0
*
*
* @return A pointer to the %AppSetting instance, @n
* else @c null if it fails
- * @param[in] appId The AppId of the application that has a valid application setting
+ * @param[in] appId The ID of the application that has a valid application setting
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The instance of specified AppId does not have setting information.
+ * @exception E_OBJ_NOT_FOUND The specified @c appId does not have the required setting information.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_APP_NOT_INSTALLED The AppId is not found.
+ * @exception E_APP_NOT_INSTALLED The @c appId has not been found.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks The specific error code can be accessed using the GetLastResult() method.
static AppSetting* GetInstanceByAppId(const AppId& appId);
/**
- * Releases the specified application setting instance.
+ * Releases the specified %AppSetting instance.
*
* @since 2.0
*
* @privilege %http://tizen.org/privilege/appsetting
*
* @return An error code
- * @param[in] appId The AppId of the application that has a valid application setting
+ * @param[in] appId The ID of the application that has a valid application setting
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified instance of AppId is not found or already released.
+ * @exception E_OBJ_NOT_FOUND Either of the following conditions has occurred:
+ * - The specified @c appId has not been found.
+ * - The specified @c appId is already released.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks Individual instances are managed by the platform. @n
- * It is recommended to release instances to reduce memory usage.
+ * @remarks
+ * - Individual instances are managed by the platform.
+ * - It is recommended to release instances to reduce memory usage.
* @see GetInstanceByAppId()
*/
static result ReleaseInstanceByAppId(const AppId& appId);
/**
- * Gets a list of all the versions that existed prior to the current version. @n
- * The versions listed are based on the setting.xml file, which is generated when an application is installed.
+ * Gets the list of all the versions that existed prior to the current version. @n
+ * The versions are listed based on the setting.xml file, which is generated when an application is installed.
*
* @since 2.0
*
- * @return A pointer to the list that contains the Tizen::Base::String instances of version list @n
- * The latest version string is located in the first position. If the old version does not exist then return empty collection.
+ * @return A pointer to the list that contains the Tizen::Base::String instances of the version list @n
+ * The latest version string is located at the first position @n
+ * If the old version does not exist then an empty collection is returned.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
static Tizen::Base::Collection::IList* GetAppSettingVersionListN(void);
/**
- * Gets a @c bool value associated with the specified @c id.
+ * Gets the @c bool value associated with the specified @c id.
*
* @since 2.0
*
* @return An error code
- * @param[in] id The ID of the value to retrieve
- * @param[out] value A boolean value to retrieve
+ * @param[in] id The ID of the boolean value to retrieve
+ * @param[out] value The boolean value to retrieve
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_OBJ_NOT_FOUND The specified @c id is not found in the application setting.
+ * @exception E_OBJ_NOT_FOUND The specified @c id has not been found in the application setting.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_TYPE_MISMATCH The operation has attempted to access different types.
+ * @exception E_TYPE_MISMATCH The types accessed by the method do not match.
*/
result GetValue(const Tizen::Base::String& id, bool& value) const;
/**
- * Gets an integer value associated with the specified @c id.
+ * Gets the integer value associated with the specified @c id.
*
* @since 2.0
*
* @return An error code
- * @param[in] id The ID of the value to retrieve
- * @param[out] value An integer value to retrieve
+ * @param[in] id The ID of the integer value to retrieve
+ * @param[out] value The integer value to retrieve
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_OBJ_NOT_FOUND The specified @c id is not found in the application setting.
+ * @exception E_OBJ_NOT_FOUND The specified @c id has not been found in the application setting.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_TYPE_MISMATCH The operation has attempted to access different types.
+ * @exception E_TYPE_MISMATCH The types accessed by the method do not match.
*/
result GetValue(const Tizen::Base::String& id, int& value) const;
/**
- * Gets a string value associated with the specified @c id.
+ * Gets the string value associated with the specified @c id.
*
* @since 2.0
*
* @return An error code
- * @param[in] id The id of the value to retrieve
- * @param[out] value A string value to retrieve
+ * @param[in] id The ID of the string value to retrieve
+ * @param[out] value The string value to retrieve
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_OBJ_NOT_FOUND The specified @c id is not found in the application setting.
+ * @exception E_OBJ_NOT_FOUND The specified @c id has not been found in the application setting.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_TYPE_MISMATCH The operation has attempted to access different types.
+ * @exception E_TYPE_MISMATCH The types accessed by the method do not match.
*/
result GetValue(const Tizen::Base::String& id, Tizen::Base::String& value) const;
/**
- * Sets a @c bool value associated with the specified @c id.
+ * Sets the @c bool value associated with the specified @c id.
*
* @since 2.0
*
* @return An error code
- * @param[in] id The ID of the value to modify
- * @param[in] value A boolean value
+ * @param[in] id The ID of the boolean value to modify
+ * @param[in] value The boolean value
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_OBJ_NOT_FOUND The specified @c id is not found in the application setting.
+ * @exception E_OBJ_NOT_FOUND The specified @c id has not been found in the application setting.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_TYPE_MISMATCH The operation has attempted to access different types.
+ * @exception E_TYPE_MISMATCH The types accessed by the method do not match.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result SetValue(const Tizen::Base::String& id, bool value);
/**
- * Sets an integer value associated with the specified @c id.
+ * Sets the integer value associated with the specified @c id.
*
* @since 2.0
*
* @return An error code
- * @param[in] id The ID of the value to modify
- * @param[in] value An integer value
+ * @param[in] id The ID of the integer value to modify
+ * @param[in] value The integer value
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_OBJ_NOT_FOUND The specified @c id is not found in the application setting.
- * @exception E_OUT_OF_RANGE The specified @c value is out of range.
+ * @exception E_OBJ_NOT_FOUND The specified @c id has not been found in the application setting.
+ * @exception E_OUT_OF_RANGE The specified @c value is out of the valid range.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_TYPE_MISMATCH The operation has attempted to access different types.
+ * @exception E_TYPE_MISMATCH The types accessed by the method do not match.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result SetValue(const Tizen::Base::String& id, int value);
/**
- * Sets a string value associated with the specified @c id.
+ * Sets the string value associated with the specified @c id.
*
* @since 2.0
*
* @return An error code
- * @param[in] id The ID of the value to modify
- * @param[in] value A string value
+ * @param[in] id The ID of the string value to modify
+ * @param[in] value The string value
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_OBJ_NOT_FOUND The specified @c id is not found in the application setting.
- * @exception E_OUT_OF_RANGE The specified string length is out of range.
+ * @exception E_OBJ_NOT_FOUND The specified @c id has not been found in the application setting.
+ * @exception E_OUT_OF_RANGE The specified string length is out of the valid range.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_TYPE_MISMATCH The operation has attempted to access different types.
+ * @exception E_TYPE_MISMATCH The types accessed by the method do not match.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result SetValue(const Tizen::Base::String& id, const Tizen::Base::String& value);
/**
- * Sets a setting event listener.
+ * Sets the setting event listener.
*
* @since 2.0
*
*
* @final This class is not intended for extension.
*
- * The %DataControlProviderManager class helps a data control provider application to handle data control requests from other applications and to send results or error message for each data control operation.
+ * The %DataControlProviderManager class helps a data control provider application to handle data control requests from other applications, and to send results or error messages for each data control operation.
*/
class _OSP_EXPORT_ DataControlProviderManager
: public Tizen::Base::Object
public:
/**
- * Sets an SQL-friendly interface based data control provider listener to the data control provider manager. @n
- * The listener gets notified when a data control request is received from the other applications.
+ * Sets an SQL-friendly interface based data control provider listener for the data control provider manager. @n
+ * The listener gets notified when a data control request is received from other applications.
* To unset the listener, pass a @c null value to the listener parameter.
*
* @since 2.0
* The listener must implement the ISqlDataControlProviderEventListener interface.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance has not been properly constructed.
- * @exception E_INVALID_OPERATION The listener must be set for a service application.
+ * @exception E_INVALID_OPERATION The listener has not been set for a service application.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks This method must be called in App::OnAppInitializing() for setting the data control provider listener
+ * @remarks This method must be called by the App::OnAppInitializing() method for setting the data control provider listener
* before receiving the data control request.
*/
result SetSqlDataControlProviderEventListener(ISqlDataControlProviderEventListener* pListener);
/**
- * Sets a key-value structured data control provider listener to the data control provider manager. @n
- * The listener gets notified when a data control request is received from the other applications.
+ * Sets a key-value structured data control provider listener for the data control provider manager. @n
+ * The listener gets notified when a data control request is received from other applications.
* To unset the listener, pass a @c null value to the listener parameter.
*
* @since 2.0
* The listener must implement the IMapDataControlProviderEventListener interface.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance has not been properly constructed.
- * @exception E_INVALID_OPERATION The listener must be set for a service application.
+ * @exception E_INVALID_OPERATION The listener has not been set for a service application.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks This method must be called in App::OnAppInitializing() for setting the data control provider listener
+ * @remarks This method must be called by the App::OnAppInitializing() method for setting the data control provider listener
* before receiving the data control request.
*/
result SetMapDataControlProviderEventListener(IMapDataControlProviderEventListener* pListener);
/**
- * Sends the success result and the result set of SELECT request to the application requesting the SQL-friendly interface based
+ * Sends the success result and the result set of the SELECT request to the application requesting for the SQL-friendly interface based
* data control. @n
* The data control provider must call the %SendSqlDataControlSelectResult() method to notify success to the requesting application.
* The application requesting the data control can get the success result and the result set
* @param[in] pDbEnum The Tizen::Io::DbEnumerator instance to obtain the result set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG Either of the following conditions has occurred:
- * - This method cannot send result for the specified @c reqId of INSERT, UPDATE, or DELETE requests.
- * - Tizen::Io::Database or Tizen::Io::DbStatement instance associated with the specified @c pDbEnum is deleted.
- * @exception E_OBJ_NOT_FOUND The data control request specified with the @c reqId does not exist.
- * @exception E_OBJECT_LOCKED The database instance associated to the specified @c pDbEnum is locked.
- * @exception E_INVALID_FORMAT The database file associated to the specified @c pDbEnum is malformed.
+ * - The result for the specified @c reqId of the INSERT, UPDATE, or DELETE request cannot be sent.
+ * - The Tizen::Io::Database or Tizen::Io::DbStatement instance associated with the specified @c pDbEnum is deleted.
+ * @exception E_OBJ_NOT_FOUND The data control request specified by the @c reqId does not exist.
+ * @exception E_OBJECT_LOCKED The database instance associated with the specified @c pDbEnum is locked.
+ * @exception E_INVALID_FORMAT The database file associated with the specified @c pDbEnum is in an invalid format.
* @exception E_IO Either of the following conditions has occurred:
- * - An unexpected device failure has occurred as the media ejected suddenly.
- * - %File corruption is detected.
- * @exception E_MAX_EXCEEDED The size of sending buffer has exceeded the maximum limit.
+ * - An unexpected device failure has occurred as the media ejected suddenly.
+ * - %File corruption has been detected.
+ * @exception E_MAX_EXCEEDED The size of the sending buffer has exceeded the maximum limit.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @see Tizen::App::DataControlProviderManager::SendSqlDataControlInsertResult()
* @see Tizen::App::DataControlProviderManager::SendSqlDataControlUpdateDeleteResult()
* @see Tizen::App::DataControlProviderManager::SendDataControlError()
- * @see Tizen::App::ISqlDataControlProviderEventListener
*/
result SendSqlDataControlSelectResult(RequestId reqId, Tizen::Io::IDbEnumerator* pDbEnum);
/**
- * Sends the success result of INSERT request and the last inserted row ID to the application requesting
+ * Sends the success result of the INSERT request and the last inserted row ID to the application requesting for
* the SQL-friendly interface based data control. @n
* The data control provider must call the %SendSqlDataControlInsertResult() method to notify success to the requesting application.
* The application requesting the data control can get the success result and the last inserted row ID
*
* @return An error code
* @param[in] reqId The request ID
- * @param[in] insertRowId The row ID of database changed by INSERT request
+ * @param[in] insertRowId The row ID of the database changed by the INSERT request
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG This method cannot send result for the specified @c reqId of SELECT, UPDATE, or DELETE request.
- * @exception E_OBJ_NOT_FOUND The data control request specified with the @c reqId does not exist.
+ * @exception E_INVALID_ARG The result for the specified @c reqId of the SELECT, UPDATE, or DELETE request cannot be sent.
+ * @exception E_OBJ_NOT_FOUND The data control request specified by the @c reqId does not exist.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @see Tizen::App::DataControlProviderManager::SendSqlDataControlSelectResult()
* @see Tizen::App::DataControlProviderManager::SendSqlDataControlUpdateDeleteResult()
* @see Tizen::App::DataControlProviderManager::SendDataControlError()
- * @see Tizen::App::ISqlDataControlProviderEventListener
* @see Tizen::Io::Database::GetLastInsertRowId()
*/
result SendSqlDataControlInsertResult(RequestId reqId, long long insertRowId);
/**
- * Sends the success result of UPDATE / DELETE request to the application requesting the SQL-friendly interface based data control. @n
+ * Sends the success result of the UPDATE or DELETE request to the application requesting for the SQL-friendly interface based data control. @n
* The data control provider must call the %SendSqlDataControlUpdateDeleteResult() method to notify success to the requesting application.
* The application requesting the data control can get the success result by implementing Tizen::App::ISqlDataControlResponseListener.
*
* @return An error code
* @param[in] reqId The request ID
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG This method cannot send result for the specified @c reqId of SELECT or INSERT request.
- * @exception E_OBJ_NOT_FOUND The data control request specified with the @c reqId does not exist.
+ * @exception E_INVALID_ARG The result for the specified @c reqId of the SELECT or INSERT request cannot be sent.
+ * @exception E_OBJ_NOT_FOUND The data control request specified by the @c reqId does not exist.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @see Tizen::App::DataControlProviderManager::SendSqlDataControlSelectResult()
* @see Tizen::App::DataControlProviderManager::SendSqlDataControlInsertResult()
result SendSqlDataControlUpdateDeleteResult(RequestId reqId);
/**
- * Sends the success result and the result list of the provider to the application requesting the key-value structured
+ * Sends the success result and the result list of the provider to the application requesting for the key-value structured
* data control. @n
* The data control provider must call the %SendMapDataControlResult() method to notify success to the requesting application.
* The application requesting the data control can get the success result and the result set
* @param[in] reqId The request ID
* @param[in] pResultValueList The result list to request @n
* The type of objects contained in the specified @c pResultValueList must be
- * Tizen::Base::String class.
+ * Tizen::Base::String.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG Either of the following conditions has occurred:
- * - The specified @c pResultValueList must be @c null if the request is one of
- * AddValue, SetValue, RemoveValue queries.
- * - The specified @c pResultValueList must not be @c null if the request is
- * GetValue() query.
- * @exception E_OBJ_NOT_FOUND The data control request specified with the @c reqId does not exist.
- * @exception E_MAX_EXCEEDED The size of sending buffer has exceeded the maximum limit.
+ * - The specified @c pResultValueList must be @c null if the request is an
+ * AddValue(), SetValue(), or RemoveValue() query.
+ * - The specified @c pResultValueList must not be @c null if the request is
+ * a GetValue() query.
+ * @exception E_OBJ_NOT_FOUND The data control request specified by the @c reqId does not exist.
+ * @exception E_MAX_EXCEEDED The size of the sending buffer has exceeded the maximum limit.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @see Tizen::App::DataControlProviderManager::SendDataControlError()
- * @see Tizen::App::IMapDataControlProviderEventListener
*/
result SendMapDataControlResult(RequestId reqId, Tizen::Base::Collection::IList* pResultValueList = null);
/**
- * Sends the provider error message to the application requesting the data control. @n
+ * Sends the provider error message to the application requesting for the data control. @n
* The data control provider must call the %SendDataControlError() method to notify failure to the requesting application.
* The application requesting the data control can get the failure result and the error message
* by implementing Tizen::App::ISqlDataControlResponseListener.
* @param[in] reqId The request ID
* @param[in] errorMsg The provider-defined error message
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The data control request specified with the @c reqId does not exist.
- * @exception E_MAX_EXCEEDED The size of sending buffer has exceeded the maximum limit.
+ * @exception E_OBJ_NOT_FOUND The data control request specified by the @c reqId does not exist.
+ * @exception E_MAX_EXCEEDED The size of the sending buffer has exceeded the maximum limit.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks The recommended data size is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.
+ * @remarks The recommended data size is under 16KB because a severe system performance degradation may occur for larger messages. @n
+ * @c E_MAX_EXCEEDED may be returned for messages over 16KB size.
* @see Tizen::App::DataControlProviderManager::SendSqlDataControlSelectResult()
* @see Tizen::App::DataControlProviderManager::SendSqlDataControlInsertResult()
* @see Tizen::App::DataControlProviderManager::SendSqlDataControlUpdateDeleteResult()
* @see Tizen::App::DataControlProviderManager::SendMapDataControlResult()
- * @see Tizen::App::ISqlDataControlProviderEventListener
* @see Tizen::App::IMapDataControlProviderEventListener
*/
result SendDataControlError(RequestId reqId, const Tizen::Base::String& errorMsg);
/**
- * Gets the data control provider manager instance.
+ * Gets a pointer to the %DataControlProviderManager instance.
*
* @since 2.0
*
- * @return A pointer to the %DataControlProviderManager instance if it succeeds, @n
- * else @c null
+ * @return A pointer to the %DataControlProviderManager instance, @n
+ * else @c null if it fails
*/
static DataControlProviderManager* GetInstance(void);
/**
* @interface IActiveAppEventListener
- * @brief This interface is the listener interface for receiving the AppId of active application.
+ * @brief This interface is the listener interface for receiving the ID of an active application.
*
* @since 2.0
*
- *
* The %IActiveAppEventListener interface is the listener interface for receiving the active application change events.
- * The class that processes an active application change event implements this interface and registers using
+ * The class that processes an active application change event implements this interface and registers it using
* the AppManager::AddActiveAppEventListener() method.
*
*/
{
public:
/**
- * This polymorphic destructor should be overridden if required. This way,
- * the destructors of the derived classes are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*
*
* @since 2.0
*
- * @param[in] appId The AppId of the active application
+ * @param[in] appId The ID of the active application
*/
virtual void OnActiveAppChanged(const AppId& appId) = 0;
//
/**
- * @file FAppIAppCheckPointEventListener.h
- * @brief This is the header file for the %IAppCheckpointEventListener interface.
+ * @file FAppIAppCheckPointEventListener.h
+ * @brief This is the header file for the %IAppCheckpointEventListener interface.
*
* This header file contains the declarations of the %IAppCheckpointEventListener interface. @n
* If a checkpoint event is generated, a method of this interface is called.
/**
* @interface IAppCheckpointEventListener
- * @brief This interface defines the listener for the checkpoint event.
+ * @brief This interface defines the listener for a checkpoint event.
*
* @since 2.0
*
- * The %IAppCheckpointEventListener interface is used for receiving the checkpoint event.
- * The event is fired when the system is about to terminate an application due to, for example, low memory or when another application
- * is being launched.
+ * The %IAppCheckpointEventListener interface is used for receiving a checkpoint event.
+ * The event is fired when the system is about to terminate an application due to reasons such as, low memory or when another application
+ * is being launched.
* @n
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/tizen_app_model/multitasking_in_tizen.htm">Multitasking in Tizen</a>.
*
{
public:
/**
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
* Called when a checkpoint event occurs.
*
* @since 2.0
- * @param[in] appRegistry The application registry
+ * @param[in] appRegistry The application's registry
*/
virtual void OnAppCheckpointing(AppRegistry& appRegistry) = 0;
//
/**
- * @file FAppIAppControlEventListener.h
- * @brief This is the header file for the %IAppControlEventListener interface.
+ * @if OSPDEPREC
+ * @file FAppIAppControlEventListener.h
+ * @brief This is the header file for the %IAppControlEventListener interface.
*
* This header file contains the declarations of the %IAppControlEventListener interface.
+ * @endif
*/
#ifndef _FAPP_IAPP_CONTROL_EVENT_LISTENER_H_
/**
* @if OSPDEPREC
* @interface IAppControlEventListener
-* @brief <i>[Deprecated]</i> This interface defines a listener for the AppControl result events.
+* @brief <i>[Deprecated]</i> This interface defines a listener for the %AppControl result events.
*
* @deprecated This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface.
* @since 2.0
public:
/**
* @if OSPDEPREC
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @brief <i> [Deprecated] </i>
/**
* @if OSPDEPREC
* Called when the application control is completed. @n
- * The client can get callback result for some application controls by implementing this listener. @n
- * %OnAppControlCompleted() is called after AppControl::Start() with listener for some application controls.
+ * The client can get the callback result for some application controls by implementing this listener. @n
+ * The %OnAppControlCompleted() method is called after AppControl::Start() is done listening to application controls.
*
* @brief <i> [Deprecated] </i>
*
* @deprecated This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface.
* @since 2.0
*
- * @param[in] providerId The provider ID
- * @param[in] operationId The operation ID used in application control invocation
- * @param[in] pResultList The list of callback strings of application control
+ * @param[in] providerId The provider ID
+ * @param[in] operationId The operation ID used for application control invocation
+ * @param[in] pResultList The list of callback strings for application control
*
- * @remarks The specified @c pResultList provides the result code for the first array element.
- * @remarks When the invoked application control is terminated without sending a result,
- * then this method is invoked with @c pResultList and it contains App::APPCONTROL_RESULT_TERMINATED.
- * @remarks Switching forms using Tizen::Ui::Controls::Frame::SetCurrentForm() in this listener disables the upcoming form
- * (UiApp::OnForeground()). If %UiApp::OnForeground() is being used in the application logic,
- * it is recommended to avoid switching forms in this listener.
+ * @remarks
+ * - The specified @c pResultList provides the result code for the first array element.
+ * - When the invoked application control is terminated without sending a result,
+ * then this method is invoked with @c pResultList and it contains App::APPCONTROL_RESULT_TERMINATED.
+ * - Switching forms using Tizen::Ui::Controls::Frame::SetCurrentForm() in this listener disables the upcoming form
+ * (UiApp::OnForeground()). @n If the %UiApp::OnForeground() method is being used in the application logic, it is recommended to avoid switching forms in this listener.
* @see Tizen::App::AppControl
* @endif
*/
//
/**
- * @file FAppIAppControlListener.h
- * @brief This is the header file for the %IAppControlListener interface.
+ * @if OSPDEPREC
+ * @file FAppIAppControlListener.h
+ * @brief This is the header file for the %IAppControlListener interface.
*
* This header file contains the declarations of the %IAppControlListener interface.
+ * @endif
*/
#ifndef _FAPP_IAPP_CONTROL_LISTENER_H_
/**
* @if OSPDEPREC
* @interface IAppControlListener
- * @brief <i>[Deprecated]</i> This interface defines a listener for the AppControl start and result events.
+ * @brief <i>[Deprecated]</i> This interface defines a listener for the %AppControl start and result events.
*
* @deprecated This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface.
* @since 2.0
public:
/**
* @if OSPDEPREC
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @brief <i>[Deprecated]</i>
{
public:
/**
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*
* @since 2.0
*
- * @param[in] reqId The application control request ID
+ * @param[in] reqId The application control request ID
* @param[in] operationId The application control operation ID
* @param[in] pUriData A pointer to the URI data
* @param[in] pMimeType A pointer to the MIME type (RFC 2046) data
- * @param[in] pExtraData A pointer to an argument map of key and value pair where the key is of type Tizen::Base::String and the value is of type %Tizen::Base::String or of type Tizen::Base::Collection::ArrayList of %Tizen::Base::String
- * @remarks To reply to the application control request, use AppControlProviderManager::SendAppControlResult() with the given request ID.
- * @remarks When the application receives the AppControl request on the background,
- * %OnAppControlRequestReceived() is invoked before UiApp::OnForeground().
- * @remarks When the application control is resolved with the file extension with AppControl::FindAndStart(),
- * the delivered file extension is converted to the corresponding MIME type in the @c pMimeType parameter.
+ * @param[in] pExtraData A pointer to the argument map of the key and value pair, where the key is of type Tizen::Base::String and the value is of type %Tizen::Base::String or of type Tizen::Base::Collection::ArrayList of %Tizen::Base::String
+ * @remarks
+ * - To reply to the application control request, use the AppControlProviderManager::SendAppControlResult() method with the given request ID. @n
+ * When the application receives the AppControl request in the background,
+ * the %OnAppControlRequestReceived() method is invoked before the UiApp::OnForeground() method.
+ * - When the application control is resolved with the file extension returned by the AppControl::FindAndStart() method,
+ * the delivered file extension is converted to the corresponding MIME type in the @c pMimeType parameter.
*/
virtual void OnAppControlRequestReceived(RequestId reqId, const Tizen::Base::String& operationId, const Tizen::Base::String* pUriData, const Tizen::Base::String* pMimeType, const Tizen::Base::Collection::IMap* pExtraData) = 0;
//
/**
- * @file FAppIAppControlResponseListener.h
- * @brief This is the header file for the %IAppControlResponseListener interface.
+ * @file FAppIAppControlResponseListener.h
+ * @brief This is the header file for the %IAppControlResponseListener interface.
*
* This header file contains the declarations of the %IAppControlResponseListener interface.
*/
{
public:
/**
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
virtual ~IAppControlResponseListener(void) {}
/**
- * Called when the response for application control completion is received.
+ * Called when the response for an application control completion is received.
*
* @since 2.0
*
- * @param[in] appId The ID of the requested application
- * @param[in] operationId The operation ID used in application control invocation
+ * @param[in] appId The ID of the requested application
+ * @param[in] operationId The operation ID used in the application control invocation
* @param[in] appControlResult The application control result
- * @param[in] pExtraData A pointer to an result map of key and value pair where the key of type Tizen::Base::String and the value of
- * type %Tizen::Base::String or of type Tizen::Base::ArrayList of %Tizen::Base::String
+ * @param[in] pExtraData A pointer to the result map of the key and value pair, where the key is of type Tizen::Base::String and the value is of
+ * type %Tizen::Base::String or of type Tizen::Base::Collection::ArrayList of %Tizen::Base::String
* @remarks The application control completion result is received when the requested application control
- * sends the result using AppControlProviderManager::SendAppControlResult().
+ * sends the result using the AppControlProviderManager::SendAppControlResult() method.
* @see AppControl
*/
virtual void OnAppControlCompleteResponseReceived(const AppId& appId, const Tizen::Base::String& operationId, AppCtrlResult appControlResult, const Tizen::Base::Collection::IMap* pExtraData) = 0;
/**
- * Called when the application control is about to start or to be canceled by the user resolution. @n
+ * Called when the application control is about to start or is to be cancelled by the user resolution. @n
* The calling application can get the result of the resolution by implementing this empty body method.
*
* @since 2.0
*
- * @param[in] appId The ID of the requested application
- * @param[in] operationId The operation ID used in application control invocation
- * @param[in] r The result of the application control start response @n
- * The exception code may be given through this parameter.
- * @exception E_SUCCESS The method is successful.
- * @exception E_OPERATION_CANCELED The application control resolve request is canceled by a user operation.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_SYSTEM A system error has occurred.
+ * @param[in] appId The ID of the requested application
+ * @param[in] operationId The operation ID used in the application control invocation
+ * @param[in] r The result of the application control start response @n
+ * The following exceptions may be given through this parameter.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OPERATION_CANCELED The application control resolve request has been cancelled by the user operation.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_SYSTEM A system error has occurred.
* @remarks This method is invoked only for the implicit AppControl resolution.
- * @see AppControl
* @see AppControl::FindAndStart()
*/
virtual void OnAppControlStartResponseReceived(const AppId& appId, const Tizen::Base::String& operationId, result r) {}
//
/**
- * @file FAppIAppFrame.h
- * @brief This is the header file for the %IAppFrame interface.
+ * @file FAppIAppFrame.h
+ * @brief This is the header file for the %IAppFrame interface.
*
* This header file contains the declarations of the %IAppFrame interface.
*/
*
* @since 2.0
*
- * The %IAppFrame interface provides methods for the application frame. A frame is the outermost boundary of the application UI.
+ * The %IAppFrame interface provides methods for the application frame.
+ * A frame is the outermost boundary of the application UI.
*/
class IAppFrame
{
public:
/**
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*
* @since 2.0
*
- * @return A pointer to the Tizen::Graphics::Canvas class
+ * @return A pointer to the Tizen::Graphics::Canvas instance
*/
virtual Tizen::Graphics::Canvas* GetCanvasN(void) const = 0;
*
* @since 2.0
*
- * @return An error code
- * @param[in] listener A Tizen::Ui::IKeyEventListener instance to add
+ * @return An error code
+ * @param[in] listener An instance of Tizen::Ui::IKeyEventListener to add
* @exception E_SUCCESS The method is successful.
*/
virtual result AddKeyEventListener(Tizen::Ui::IKeyEventListener& listener) = 0;
*
* @since 2.0
*
- * @return An error code
- * @param[in] listener A Tizen::Ui::IKeyEventListener instance to remove
+ * @return An error code
+ * @param[in] listener An instance of Tizen::Ui::IKeyEventListener to remove
* @exception E_SUCCESS The method is successful.
*/
virtual result RemoveKeyEventListener(Tizen::Ui::IKeyEventListener& listener) = 0;
*
* @since 2.0
*
- * @return An error code
- * @param[in] listener A Tizen::Ui::ITouchEventListener instance to add
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] listener An instance of Tizen::Ui::ITouchEventListener to add
+ * @exception E_SUCCESS The method is successful.
*/
virtual result AddTouchEventListener(Tizen::Ui::ITouchEventListener& listener) = 0;
*
* @since 2.0
*
- * @return An error code
- * @param[in] listener A Tizen::Ui::ITouchEventListener instance to add
+ * @return An error code
+ * @param[in] listener An instance of Tizen::Ui::ITouchEventListener to add
* @exception E_SUCCESS The method is successful.
*/
virtual result RemoveTouchEventListener(Tizen::Ui::ITouchEventListener& listener) = 0;
*
* @since 2.0
*
- * @return An error code
- * @param[in] listener A Tizen::Ui::IWindowEventListener instance to remove
+ * @return An error code
+ * @param[in] listener An instance of Tizen::Ui::IWindowEventListener to remove
* @exception E_SUCCESS The method is successful.
*/
virtual result AddWindowEventListener(Tizen::Ui::IWindowEventListener& listener) = 0;
*
* @since 2.0
*
- * @return An error code
- * @param[in] listener A Tizen::Ui::IWindowEventListener instance to remove
+ * @return An error code
+ * @param[in] listener An instance of Tizen::Ui::IWindowEventListener to remove
* @exception E_SUCCESS The method is successful.
*/
virtual result RemoveWindowEventListener(Tizen::Ui::IWindowEventListener& listener) = 0;
*
* @since 2.0
*
- * @return A pointer to Tizen::Ui::Controls::Frame if successful, @n
- * else @c null
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance is in an invalid state.
- * @exception E_UNSUPPORTED_OPERATION This method cannot be supported.
+ * @return A pointer to the Tizen::Ui::Controls::Frame instance, @n
+ * else @c null if it fails
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE This instance is in an invalid state.
+ * @exception E_UNSUPPORTED_OPERATION This method is not supported.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
virtual Tizen::Ui::Controls::Frame* GetFrame(void) = 0;
//
/**
- * @file FAppIAppLaunchConditionEventListener.h
- * @brief This is the header file for the %IAppLaunchConditionEventListener interface.
+ * @file FAppIAppLaunchConditionEventListener.h
+ * @brief This is the header file for the %IAppLaunchConditionEventListener interface.
*
* This header file contains the declarations of the %IAppLaunchConditionEventListener interface.
*/
{
public:
/**
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
* @since 2.0
*
* @param[in] condition The registered condition for the application launch
- * @param[in] pArguments A list of string arguments specified when the condition is registered
- * @param[in] pExtraData A pointer to the instance of object that system delivered, @n
+ * @param[in] pArguments The list of string arguments specified when the condition is registered
+ * @param[in] pExtraData A pointer to the Tizen::Base::Object instance that the system delivered, @n
* else @c null if there is no extra data
*
- * @remarks If extra data is required to be delivered, @c pExtraData contains the data,
+ * @remarks If the extra data has to be delivered, @c pExtraData contains the data,
* and this must be freed by the launched application after use.
- * ( Currently, only NFC condition uses this to deliver to Tizen::Net::Nfc::NdefMessage. )
+ * ( Currently, only the NFC condition uses this to deliver to Tizen::Net::Nfc::NdefMessage. )
* @see Tizen::App::AppManager::RegisterAppLaunch()
* @see Tizen::App::AppManager::SetAppLaunchConditionEventListener()
*
- * The following example demonstrates how to use the %OnAppLaunchConditionMetN() method to get Tizen::Net::Nfc::NdefMessage instance, when an application is launched by NFC condition.
+ * The following example demonstrates how to use the %OnAppLaunchConditionMetN() method to get the Tizen::Net::Nfc::NdefMessage instance, when an application is launched by the NFC condition.
* @code
* NdefMessage* pMessage = dynamic_cast<NdefMessage*>(pExtraData);
* @endcode
/**
* @interface IAppSettingEventListener
- * @brief This interface is the listener interface for receiving the setting change events.
+ * @brief This interface is the listener interface for receiving setting change events.
*
* @since 2.0
*
- * The %IAppSettingEventListener interface is the listener interface for receiving the setting change events.
- * The class that processes a setting change event implements this interface and registers using
+ * The %IAppSettingEventListener interface is the listener interface for receiving setting change events.
+ * The class that processes a setting change event implements this interface and registers it using
* the AppSetting::SetAppSettingEventListener() method.
*
*/
{
public:
/**
- * This polymorphic destructor should be overridden if required. This way,
- * the destructors of the derived classes are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*
- * @remarks This method is invoked only in the main thread
+ * @remarks This method is invoked only in the main thread.
*/
virtual ~IAppSettingEventListener(void) {}
*
* @param[in] id The ID of the application setting whose value is changed
*
- * @remarks This method is invoked only in the main thread
+ * @remarks This method is invoked only in the main thread.
*/
virtual void OnAppSettingChanged(const Tizen::Base::String& id) = 0;
/**
* @interface IMapDataControlProviderEventListener
- * @brief This interface defines a listener for dealing with key-value structured data control request.
+ * @brief This interface defines a listener for dealing with a key-value structured data control request.
*
* @since 2.0
*
- * The %IMapDataControlProviderEventListener interface defines a listener for dealing with key-value structured data control request.
+ * The %IMapDataControlProviderEventListener interface defines a listener for dealing with a key-value structured data control request.
*
* The following example demonstrates how to use the %IMapDataControlProviderEventListener interface.
* @code
public:
/**
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
virtual ~IMapDataControlProviderEventListener(void) {}
/**
- * Called when the request for getting the value list is received from key-value structured data control consumer. @n
+ * Called when the request for obtaining the value list is received from the key-value structured data control consumer. @n
* The provider must implement this listener for providing its own data.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific map to get from @n
+ * @param[in] dataId The string that identifies the specific map to obtain from @n
* The string consists of one or more components, separated by a slash('/').
- * @param[in] key A key of the value list to obtain
- * @remarks For replying to the data control request, use DataControlProviderManager::SendMapDataControlResult()
- * or DataControlProviderManager::SendDataControlError().
+ * @param[in] key The key of the value list to obtain
+ * @remarks For replying to the data control request, use the DataControlProviderManager::SendMapDataControlResult() method
+ * or the DataControlProviderManager::SendDataControlError() method.
*/
virtual void OnMapDataControlGetValueRequestReceived(RequestId reqId, const Tizen::Base::String& providerId,
const Tizen::Base::String& dataId, const Tizen::Base::String& key) = 0;
/**
- * Called when the request for adding the value is received from key-value structured data control consumer. @n
+ * Called when the request for adding the value is received from the key-value structured data control consumer. @n
* The provider must implement this listener for providing its own data.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific map to add to @n
+ * @param[in] dataId The string that identifies the specific map to add to @n
* The string consists of one or more components, separated by a slash('/').
- * @param[in] key A key of the value list to add
- * @param[in] value A value to add
- * @remarks For replying to the data control request, use DataControlProviderManager::SendMapDataControlResult()
- * or DataControlProviderManager::SendDataControlError().
+ * @param[in] key The key of the value list to add
+ * @param[in] value The value to add
+ * @remarks For replying to the data control request, use the DataControlProviderManager::SendMapDataControlResult() method
+ * or the DataControlProviderManager::SendDataControlError() method.
*/
virtual void OnMapDataControlAddValueRequestReceived(RequestId reqId, const Tizen::Base::String& providerId,
const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& value) = 0;
/**
- * Called when the request for replacing the value is received from key-value structured data control consumer. @n
+ * Called when the request for replacing the value is received from the key-value structured data control consumer. @n
* The provider must implement this listener for providing its own data.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific map to update @n
+ * @param[in] dataId The string that identifies the specific map to update @n
* The string consists of one or more components, separated by a slash('/').
- * @param[in] key A key of the value to replace
- * @param[in] oldValue A value to replace
- * @param[in] newValue A new value to replace the existing value
- * @remarks For replying to the data control request, use DataControlProviderManager::SendMapDataControlResult()
- * or DataControlProviderManager::SendDataControlError().
+ * @param[in] key The key of the value to replace
+ * @param[in] oldValue The value to replace
+ * @param[in] newValue The new value that replaces the existing value
+ * @remarks For replying to the data control request, use the DataControlProviderManager::SendMapDataControlResult() method
+ * or the DataControlProviderManager::SendDataControlError() method.
*/
virtual void OnMapDataControlSetValueRequestReceived(RequestId reqId, const Tizen::Base::String& providerId,
const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& oldValue,
const Tizen::Base::String& newValue) = 0;
/**
- * Called when the request for removing the value is received from key-value structured data control consumer. @n
+ * Called when the request for removing the value is received from the key-value structured data control consumer. @n
* The provider must implement this listener for providing its own data.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific map to remove from @n
+ * @param[in] dataId The string that identifies the specific map to remove from @n
* The string consists of one or more components, separated by a slash('/').
- * @param[in] key A key of the value to remove
- * @param[in] value A value to remove
- * @remarks For replying to the data control request, use DataControlProviderManager::SendMapDataControlResult()
- * or DataControlProviderManager::SendDataControlError().
+ * @param[in] key The key of the value to remove
+ * @param[in] value The value to remove
+ * @remarks For replying to the data control request, use the DataControlProviderManager::SendMapDataControlResult() method
+ * or the DataControlProviderManager::SendDataControlError() method.
*/
virtual void OnMapDataControlRemoveValueRequestReceived(RequestId reqId, const Tizen::Base::String& providerId,
const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& value) = 0;
public:
/**
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
virtual ~IMapDataControlResponseListener(void) {}
/**
- * Called when the result value list is received from key-value structured data control provider. @n
+ * Called when the result value list is received from the key-value structured data control provider. @n
* The application requesting the data control can get the result value list by implementing this listener. @n
- * This listener must be registered by MapDataControl::SetMapDataControlResponseListener() for receiving the result value set.
- * It is called after MapDataControl::GetValue().
+ * This listener must be registered by the MapDataControl::SetMapDataControlResponseListener() method for receiving the result value set.
+ * It is called after the MapDataControl::GetValue() method.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific map to get from @n
+ * @param[in] dataId The string that identifies the specific map to obtain from @n
* The string consists of one or more components, separated by a slash('/').
- * @param[in] resultValueList The result value list of data control request getting matching values @n
- * The type of objects contained in the specified @c resultValueList is
- * Tizen::Base::String class.
+ * @param[in] resultValueList The result value list of the data control request that gets the matching values @n
+ * The type of objects contained in the specified @c resultValueList are
+ * Tizen::Base::String.
* @param[in] providerResult Set to @c true if the data control provider successfully processed the request getting the values, @n
* else @c false
* @param[in] pErrorMsg The error message from the data control provider
bool providerResult, const Tizen::Base::String* pErrorMsg) = 0;
/**
- * Called when the response is received from key-value structured data control provider. @n
+ * Called when the response is received from the key-value structured data control provider. @n
* The application requesting the data control can get the result by implementing this listener. @n
- * This listener must be registered by MapDataControl::SetMapDataControlResponseListener() for receiving the result response.
- * It is called after MapDataControl::AddValue().
+ * This listener must be registered by the MapDataControl::SetMapDataControlResponseListener() method for receiving the result response.
+ * It is called after the MapDataControl::AddValue() method.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific map to add to @n
+ * @param[in] dataId The string that identifies the specific map to add to @n
* The string consists of one or more components, separated by a slash('/').
* @param[in] providerResult Set to @c true if the data control provider successfully processed the request adding a value, @n
* else @c false
const Tizen::Base::String& dataId, bool providerResult, const Tizen::Base::String* pErrorMsg) = 0;
/**
- * Called when the response is received from key-value structured data control provider. @n
- * The application requesting the data control can get the result for some data controls by implementing this listener. @n
- * This listener must be registered by MapDataControl::SetMapDataControlResponseListener() for receiving the result response.
- * It is called after MapDataControl::SetValue().
+ * Called when the response is received from the key-value structured data control provider. @n
+ * The application requesting the data control can get the result by implementing this listener. @n
+ * This listener must be registered by the MapDataControl::SetMapDataControlResponseListener() method for receiving the result response.
+ * It is called after the MapDataControl::SetValue() method.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific map to update @n
+ * @param[in] dataId The string that identifies the specific map to update @n
* The string consists of one or more components, separated by a slash('/').
* @param[in] providerResult Set to @c true if the data control provider successfully processed the request replacing a value, @n
* else @c false
const Tizen::Base::String& dataId, bool providerResult, const Tizen::Base::String* pErrorMsg) = 0;
/**
- * Called when the response is received from key-value structured data control provider. @n
- * The application requesting the data control can get the result for some data controls by implementing this listener. @n
- * This listener must be registered by MapDataControl::SetMapDataControlResponseListener() for receiving the result response.
- * It is called after MapDataControl::RemoveValue().
+ * Called when the response is received from the key-value structured data control provider. @n
+ * The application requesting the data control can get the result by implementing this listener. @n
+ * This listener must be registered by the MapDataControl::SetMapDataControlResponseListener() method for receiving the result response.
+ * It is called after the MapDataControl::RemoveValue() method.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific map to remove from @n
+ * @param[in] dataId The string that identifies the specific map to remove from @n
* The string consists of one or more components, separated by a slash('/').
* @param[in] providerResult Set to @c true if the data control provider successfully processed the request removing a value, @n
* else @c false
/**
* @interface ISqlDataControlProviderEventListener
- * @brief This interface defines a listener for dealing with SQL-friendly interface based data control request.
+ * @brief This interface defines a listener for dealing with an SQL-friendly interface based data control request.
*
* @since 2.0
*
- * The %ISqlDataControlProviderEventListener interface defines a listener for dealing with SQL-friendly interface based data control request.
+ * The %ISqlDataControlProviderEventListener interface defines a listener for dealing with an SQL-friendly interface based data control request.
*
* The following example demonstrates how to use the %ISqlDataControlProviderEventListener interface.
*
public:
/**
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
virtual ~ISqlDataControlProviderEventListener(void) {}
/**
- * Called when a select request is received from an application using SQL-friendly interface based data control. @n
+ * Called when the select request is received from an application using an SQL-friendly interface based data control. @n
* The provider must implement this listener for providing its own data.
*
* @since 2.0
*
* @param[in] reqId The request ID
- * @param[in] providerId The provider ID for identifying the data control
- * @param[in] dataId A string for identifying a specific table to query from @n
- * The string consists of one or more components, separated by a slash('/').
- * If the specified @c pColumnList is @c null, all columns are selected.
- * @param[in] pColumnList A list of column names to query @n
- * The type of objects contained in the specified @c pColumnList is
- * Tizen::Base::String class.
- * @param[in] pWhere A filter to select desired rows to query @n
+ * @param[in] providerId The provider ID that identifies the data control
+ * @param[in] dataId The string that identifies the specific table to query from @n
+ * The string consists of one or more components, separated by a slash('/') @n
+ * If the specified @c pColumnList is @c null, all the columns are selected.
+ * @param[in] pColumnList The list of column names to query @n
+ * The type of objects contained in the specified @c pColumnList are
+ * Tizen::Base::String.
+ * @param[in] pWhere The filter that selects the desired rows to query @n
* It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as
* column1 = 'stringValue' AND column2 = numericValue.
- * @param[in] pOrder The sorting order of rows to query @n
+ * @param[in] pOrder The sorting order of the rows to query @n
* It is an SQL 'ORDER BY' clause excluding the 'ORDER BY' itself.
- * @remarks For replying to the data control request, use DataControlProviderManager::SendSqlDataControlSelectResult()
- * or DataControlProviderManager::SendDataControlError().
+ * @remarks For replying to the data control request, use the DataControlProviderManager::SendSqlDataControlSelectResult() method
+ * or the DataControlProviderManager::SendDataControlError() method.
*/
virtual void OnSqlDataControlSelectRequestReceived(RequestId reqId, const Tizen::Base::String& providerId,
const Tizen::Base::String& dataId, const Tizen::Base::Collection::IList* pColumnList,
const Tizen::Base::String* pWhere, const Tizen::Base::String* pOrder) = 0;
/**
- * Called when an insert request is received from an application using SQL-friendly interface based data control. @n
+ * Called when the insert request is received from an application using an SQL-friendly interface based data control. @n
* The provider must implement this listener for providing its own data.
*
* @since 2.0
*
* @param[in] reqId The request ID
- * @param[in] providerId The provider ID for identifying the data control
- * @param[in] dataId A string for identifying a specific table to insert into @n
+ * @param[in] providerId The provider ID that identifies the data control
+ * @param[in] dataId The string that identifies the specific table to insert into @n
* The string consists of one or more components, separated by a slash('/').
- * @param[in] insertMap The field values in a record to insert @n
- * The type of objects contained in the specified @c insertMap is
- * Tizen::Base::String class.
- * @remarks For replying to the data control request, use DataControlProviderManager::SendSqlDataControlInsertResult()
- * or DataControlProviderManager::SendDataControlError().
+ * @param[in] insertMap The field values to insert in the record @n
+ * The type of objects contained in the specified @c insertMap are
+ * Tizen::Base::String.
+ * @remarks For replying to the data control request, use the DataControlProviderManager::SendSqlDataControlInsertResult() method
+ * or the DataControlProviderManager::SendDataControlError() method.
*/
virtual void OnSqlDataControlInsertRequestReceived(RequestId reqId, const Tizen::Base::String& providerId,
const Tizen::Base::String& dataId, const Tizen::Base::Collection::IMap& insertMap) = 0;
/**
- * Called when an update request is received from an application using SQL-friendly interface based data control. @n
+ * Called when the update request is received from an application using an SQL-friendly interface based data control. @n
* The provider must implement this listener for providing its own data.
*
* @since 2.0
*
* @param[in] reqId The request ID
- * @param[in] providerId The provider ID for identifying the data control
- * @param[in] dataId A string for identifying a specific table to update @n
+ * @param[in] providerId The provider ID that identifies the data control
+ * @param[in] dataId The string that identifies the specific table to update @n
* The string consists of one or more components, separated by a slash('/').
- * @param[in] updateMap The field values in a record to update @n
- * The type of objects contained in the specified @c updateMap is
- * Tizen::Base::String class.
- * @param[in] pWhere A filter to select desired rows to update @n
+ * @param[in] updateMap The field values to update in the record @n
+ * The type of objects contained in the specified @c updateMap are
+ * Tizen::Base::String.
+ * @param[in] pWhere The filter to select the desired rows to update @n
* It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as
* column1 = 'stringValue' AND column2 = numericValue.
- * @remarks For replying to the data control request, use DataControlProviderManager::SendSqlDataControlUpdateDeleteResult()
- * or DataControlProviderManager::SendDataControlError().
+ * @remarks For replying to the data control request, use the DataControlProviderManager::SendSqlDataControlUpdateDeleteResult() method
+ * or the DataControlProviderManager::SendDataControlError() method.
*/
virtual void OnSqlDataControlUpdateRequestReceived(RequestId reqId, const Tizen::Base::String& providerId,
const Tizen::Base::String& dataId, const Tizen::Base::Collection::IMap& updateMap,
const Tizen::Base::String* pWhere) = 0;
/**
- * Called when a delete request is received from an application using SQL-friendly interface based data control. @n
+ * Called when the delete request is received from an application using an SQL-friendly interface based data control. @n
* The provider must implement this listener for providing its own data.
*
* @since 2.0
*
* @param[in] reqId The request ID
- * @param[in] providerId The provider ID for identifying the data control
- * @param[in] dataId A string for identifying a specific table to delete from @n
+ * @param[in] providerId The provider ID that identifies the data control
+ * @param[in] dataId The string that identifies the specific table to delete from @n
* The string consists of one or more components, separated by a slash('/').
- * @param[in] pWhere A filter to select desired rows to delete @n
+ * @param[in] pWhere The filter to select the desired rows to delete @n
* It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as
* column1 = 'stringValue' AND column2 = numericValue.
- * @remarks For replying to the data control request, use DataControlProviderManager::SendSqlDataControlUpdateDeleteResult()
- * or DataControlProviderManager::SendDataControlError().
+ * @remarks For replying to the data control request, use the DataControlProviderManager::SendSqlDataControlUpdateDeleteResult() method
+ * or the DataControlProviderManager::SendDataControlError() method.
*/
virtual void OnSqlDataControlDeleteRequestReceived(RequestId reqId, const Tizen::Base::String& providerId,
const Tizen::Base::String& dataId, const Tizen::Base::String* pWhere) = 0;
/**
* @interface ISqlDataControlResponseListener
-* @brief This interface defines a listener for the SQL-friendly interface based data control response.
+* @brief This interface defines a listener for an SQL-friendly interface based data control response.
*
* @since 2.0
*
-* The %ISqlDataControlResponseListener interface defines a listener for the SQL-friendly interface based data control response.
+* The %ISqlDataControlResponseListener interface defines a listener for an SQL-friendly interface based data control response.
*/
class _OSP_EXPORT_ ISqlDataControlResponseListener
: virtual public Tizen::Base::Runtime::IEventListener
public:
/**
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
virtual ~ISqlDataControlResponseListener(void) {}
/**
- * Called when the result set is received from SQL-friendly interface based data control provider. @n
+ * Called when the result set is received from an SQL-friendly interface based data control provider. @n
* The application requesting the data control can get the query result by implementing this listener. @n
- * This listener must be registered by SqlDataControl::SetSqlDataControlResponseListener() for receiving the result set.
- * It is called after SqlDataControl::Select().
+ * This listener must be registered by the SqlDataControl::SetSqlDataControlResponseListener() method for receiving the result set.
+ * It is called after the SqlDataControl::Select() method.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific table to query from @n
+ * @param[in] dataId The string that identifies the specific table to query from @n
* The string consists of one or more components, separated by a slash('/').
- * @param[in] resultSetEnumerator Navigates the result of data control select request
+ * @param[in] resultSetEnumerator Navigates the result of the data control select request
* @param[in] providerResult Set to @c true if the data control provider successfully processed the query request, @n
* else @c false
* @param[in] pErrorMsg The error message from the data control provider
const Tizen::Base::String& dataId, Tizen::Io::IDbEnumerator& resultSetEnumerator, bool providerResult, const Tizen::Base::String* pErrorMsg) = 0;
/**
- * Called when the response is received from SQL-friendly interface based data control provider. @n
- * The application requesting the data control can get insert result by implementing this listener. @n
- * This listener must be registered by SqlDataControl::SetSqlDataControlResponseListener() for receiving the result response.
- * It is called after SqlDataControl::Insert().
+ * Called when the response is received from an SQL-friendly interface based data control provider. @n
+ * The application requesting the data control can get the insert result by implementing this listener. @n
+ * This listener must be registered by the SqlDataControl::SetSqlDataControlResponseListener() method for receiving the result response.
+ * It is called after the SqlDataControl::Insert() method.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific table to insert into @n
+ * @param[in] dataId The string that identifies the specific table to insert into @n
* The string consists of one or more components, separated by a slash('/').
* @param[in] insertRowId The inserted row ID set by the data control provider if the specified @c providerResult is @c true, @n
- * else @c -1
+ * else @c -1 if it fails
* @param[in] providerResult Set to @c true if the data control provider successfully processed the insert request, @n
* else @c false
* @param[in] pErrorMsg The error message from the data control provider
const Tizen::Base::String& dataId, long long insertRowId, bool providerResult, const Tizen::Base::String* pErrorMsg) = 0;
/**
- * Called when the response is received from SQL-friendly interface based data control provider. @n
- * The application requesting the data control can get update result implementing this listener. @n
- * This listener must be registered by SqlDataControl::SetSqlDataControlResponseListener() for receiving the result response.
- * It is called after SqlDataControl::Update().
+ * Called when the response is received from an SQL-friendly interface based data control provider. @n
+ * The application requesting the data control can get the update result implementing this listener. @n
+ * This listener must be registered by the SqlDataControl::SetSqlDataControlResponseListener() method for receiving the result response.
+ * It is called after the SqlDataControl::Update() method.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific table to update @n
+ * @param[in] dataId The string that identifies the specific table to update @n
* The string consists of one or more components, separated by a slash('/').
* @param[in] providerResult Set to @c true if the data control provider successfully processed the update request, @n
* else @c false
const Tizen::Base::String& dataId, bool providerResult, const Tizen::Base::String* pErrorMsg) = 0;
/**
- * Called when the response is received from SQL-friendly interface based data control provider. @n
- * The application requesting the data control can get delete result by implementing this listener. @n
- * This listener must be registered by SqlDataControl::SetSqlDataControlResponseListener() for receiving the result response.
- * It is called after SqlDataControl::Delete().
+ * Called when the response is received from an SQL-friendly interface based data control provider. @n
+ * The application requesting the data control can get the delete result by implementing this listener. @n
+ * This listener must be registered by the SqlDataControl::SetSqlDataControlResponseListener() method for receiving the result response.
+ * It is called after the SqlDataControl::Delete() method.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific table to delete from @n
+ * @param[in] dataId The string that identifies the specific table to delete from @n
* The string consists of one or more components, separated by a slash('/').
* @param[in] providerResult Set to @c true if the data control provider successfully processed the delete request, @n
* else @c false
*
* The %MapDataControl class represents the key-value structured data control behavior, that provides a standard mechanism
* for accessing specific data exported by other applications.
- * Data control provider can share its own data to data control consumers.
+ * A data control provider can share its data with data control consumers.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/app/data_controls.htm">Data Controls</a>.
*
virtual ~MapDataControl(void);
/**
- * Gets the value list associated with the specified @c key, from a key-values map owned by key-value structured data control provider. @n
+ * Gets the value list associated with the specified @c key, from the key-values map owned by the key-value structured data control provider. @n
* The %GetValue() method is asynchronous.
- * For receiving the response from data control provider, set the listener
- * with MapDataControl::SetMapDataControlResponseListener(). @n
- * When the requested value list has been received from data control provider,
+ * For receiving the response from the data control provider, set the listener
+ * using the MapDataControl::SetMapDataControlResponseListener() method. @n
+ * When the requested value list has been received from the data control provider,
* the IMapDataControlResponseListener::OnMapDataControlGetValueResponseReceived() method is called.
*
* @since 2.0
*
* @return An error code
- * @param[in] dataId A string for identifying specific data, usually a registry section to get from @n
- * The string consists of one or more components, separated by a slash('/').
- * @param[in] key A key of the value list to obtain
- * @param[out] reqId The ID of the request
- * @param[in] pageNo The page number of the value set @n
- * It starts from @c 1.
- * @param[in] countPerPage The desired maximum count of the data item on the page
+ * @param[in] dataId The string that identifies the specific data, usually a registry section to get from @n
+ * The string consists of one or more components, separated by a slash('/').
+ * @param[in] key The key of the value list to obtain
+ * @param[out] reqId The ID of the request
+ * @param[in] pageNo The page number of the value set @n
+ * It starts from @c 1.
+ * @param[in] countPerPage The desired maximum count of the data items per page
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance has not been properly constructed as yet.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The specified @c pageNo parameter is less than @c 1.
- * - The specified @c countPerPage parameter is less than @c 1.
- * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
- * - Access is denied due to insufficient permission.
- * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1
- * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: @n
- * - The total size of method arguments has exceeded the maximum limit.
- * - The number of requests sent has exceeded the maximum limit.
+ * @exception E_INVALID_STATE This instance has not been constructed properly as yet.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c pageNo is less than @c 1.
+ * - The specified @c countPerPage is less than @c 1.
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The access is denied due to insufficient permission.
+ * - The application using this method is not signed with the same certificate as that of the provider application. @b Since: @b 2.1
+ * @exception E_MAX_EXCEEDED Either of the following conditions has occurred:
+ * - The total size of the method arguments has exceeded the maximum limit.
+ * - The number of requests sent have exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The total size of method arguments is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.
+ * @remarks The total size of the method arguments is under 16KB because a severe system performance degradation may occur for larger messages. @n
+ * @c E_MAX_EXCEEDED may be returned for messages over 16KB.
*/
result GetValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, RequestId& reqId, int pageNo = 1, int countPerPage = 20);
/**
- * Adds the value associated with the specified @c key, to a key-values map owned by key-value structured data control provider. @n
+ * Adds the value associated with the specified @c key, to the key-values map owned by the key-value structured data control provider. @n
* The %AddValue() method is asynchronous.
- * For receiving the response from data control provider, set the listener
- * with MapDataControl::SetMapDataControlResponseListener(). @n
+ * For receiving the response from the data control provider, set the listener
+ * using the MapDataControl::SetMapDataControlResponseListener() method. @n
* When the response has been received from the data control provider,
* the IMapDataControlResponseListener::OnMapDataControlAddValueResponseReceived() method is called.
*
* @since 2.0
*
* @return An error code
- * @param[in] dataId A string for identifying specific data, usually a registry section to add to @n
- * The string consists of one or more components, separated by a slash('/').
- * @param[in] key A key of the value list to add
- * @param[in] value A value to add
- * @param[out] reqId The ID of the request
+ * @param[in] dataId The string that identifies the specific data, usually a registry section to add to @n
+ * The string consists of one or more components, separated by a slash('/').
+ * @param[in] key The key of the value list to add
+ * @param[in] value The value to add
+ * @param[out] reqId The ID of the request
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance has not been properly constructed as yet.
- * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
- * - Access is denied due to insufficient permission.
- * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1
- * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: @n
- * - The total size of method arguments has exceeded the maximum limit.
- * - The number of requests sent has exceeded the maximum limit.
+ * @exception E_INVALID_STATE This instance has not been constructed properly as yet.
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The access is denied due to insufficient permission.
+ * - The application using this method is not signed with the same certificate as that of the provider application. @b Since: @b 2.1
+ * @exception E_MAX_EXCEEDED Either of the following conditions has occurred:
+ * - The total size of the method arguments has exceeded the maximum limit.
+ * - The number of requests sent have exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The total size of method arguments is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.
+ * @remarks The total size of the method arguments is under 16KB because a severe system performance degradation may occur for larger messages. @n
+ * @c E_MAX_EXCEEDED may be returned for messages over 16KB.
*/
result AddValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& value, RequestId& reqId);
/**
- * Sets the value associated with the specified @c key with a new value. @n
- * The key-values map is owned by key-value structured data control provider. @n
+ * Sets the value associated with the specified @c key to a new value. @n
+ * The key-values map is owned by the key-value structured data control provider. @n
* The %SetValue() method is asynchronous.
- * For receiving the response from data control provider, set the listener
- * with MapDataControl::SetMapDataControlResponseListener(). @n
+ * For receiving the response from the data control provider, set the listener
+ * using the MapDataControl::SetMapDataControlResponseListener() method. @n
* When the response has been received from the data control provider,
* the IMapDataControlResponseListener::OnMapDataControlSetValueResponseReceived() method is called.
*
* @since 2.0
*
* @return An error code
- * @param[in] dataId A string for identifying specific data, usually a registry section to update @n
- * The string consists of one or more components, separated by a slash('/').
- * @param[in] key A key of the value to replace
- * @param[in] oldValue A value to replace
- * @param[in] newValue A new value to replace the existing value
- * @param[out] reqId The ID of the request
+ * @param[in] dataId The string that identifies the specific data, usually a registry section to update @n
+ * The string consists of one or more components, separated by a slash('/').
+ * @param[in] key The key of the value to replace
+ * @param[in] oldValue The value to replace
+ * @param[in] newValue The new value that replaces the existing value
+ * @param[out] reqId The ID of the request
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance has not been properly constructed as yet.
- * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
- * - Access is denied due to insufficient permission.
- * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1
- * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: @n
- * - The total size of method arguments has exceeded the maximum limit.
- * - The number of requests sent has exceeded the maximum limit.
+ * @exception E_INVALID_STATE This instance has not been constructed properly as yet.
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The access is denied due to insufficient permission.
+ * - The application using this method is not signed with the same certificate as that of the provider application. @b Since: @b 2.1
+ * @exception E_MAX_EXCEEDED Either of the following conditions has occurred:
+ * - The total size of the method arguments has exceeded the maximum limit.
+ * - The number of requests sent have exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The total size of method arguments is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.
+ * @remarks The total size of the method arguments is under 16KB because a severe system performance degradation may occur for larger messages. @n
+ * @c E_MAX_EXCEEDED may be returned for messages over 16KB.
*/
result SetValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& oldValue, const Tizen::Base::String& newValue, RequestId& reqId);
/**
- * Removes the value associated with the specified @c key, from a key-values map owned by key-value structured data control provider. @n
+ * Removes the value associated with the specified @c key, from the key-values map owned by the key-value structured data control provider. @n
* The %RemoveValue() method is asynchronous.
- * For receiving the response from data control provider, set the listener
- * with MapDataControl::SetMapDataControlResponseListener(). @n
+ * For receiving the response from the data control provider, set the listener
+ * using the MapDataControl::SetMapDataControlResponseListener() method. @n
* When the response has been received from the data control provider,
* the IMapDataControlResponseListener::OnMapDataControlRemoveValueResponseReceived() method is called.
*
* @since 2.0
*
* @return An error code
- * @param[in] dataId A string for identifying specific data, usually a registry section to remove from @n
- * The string consists of one or more components, separated by a slash('/').
- * @param[in] key A key of the value to remove
- * @param[in] value A value to remove
- * @param[out] reqId The ID of the request
+ * @param[in] dataId The string that identifies the specific data, usually a registry section to remove from @n
+ * The string consists of one or more components, separated by a slash('/').
+ * @param[in] key The key of the value to remove
+ * @param[in] value The value to remove
+ * @param[out] reqId The ID of the request
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance has not been properly constructed as yet.
- * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
- * - Access is denied due to insufficient permission.
- * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1
- * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: @n
- * - The total size of method arguments has exceeded the maximum limit.
- * - The number of requests sent has exceeded the maximum limit.
+ * @exception E_INVALID_STATE This instance has not been constructed properly as yet.
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The access is denied due to insufficient permission.
+ * - The application using this method is not signed with the same certificate as that of the provider application. @b Since: @b 2.1
+ * @exception E_MAX_EXCEEDED Either of the following conditions has occurred:
+ * - The total size of the method arguments has exceeded the maximum limit.
+ * - The number of requests sent have exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The total size of method arguments is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.
+ * @remarks The total size of the method arguments is under 16KB because a severe system performance degradation may occur for larger messages. @n
+ * @c E_MAX_EXCEEDED may be returned for messages over 16KB.
*/
result RemoveValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& value, RequestId& reqId);
/**
- * Sets the MAP-based data control listener to this instance.
+ * Sets the MAP-based data control listener for this instance.
*
* @since 2.0
*
* Some data controls need to get the callback result by implementing
* the IMapDataControlResponseListener interface.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance has not been properly constructed.
+ * @exception E_INVALID_STATE This instance has not been constructed properly as yet.
* @exception E_SYSTEM A system error has occurred.
*/
result SetMapDataControlResponseListener(IMapDataControlResponseListener* pListener);
* @final This class is not intended for extension.
*
* The %NotificationManager class provides methods to alert the user about a notification.
- * @n
- * For more information
about the class features, see <a href="../org.tizen.native.appprogramming/html/guide/shell/notifications.htm">Notifications</a>.
+ *
+ * For more information
on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/shell/notifications.htm">Notifications</a>.
*
* The following example demonstrates how to use the %NotificationManager class.
*
* @since 2.0
* @privilege %http://tizen.org/privilege/notification
*
- * @return The current badge number
+ * @return The current badge number, @n
+ * else @c -1 if it fails
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_OBJ_NOT_FOUND The application is not installed.
+ * @exception E_OBJ_NOT_FOUND The application has not been installed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks The specific error code can be accessed using the GetLastResult() method. @n
- * In case of failure, this method returns @c -1.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
* @endif
*/
int GetBadgeNumber(void);
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
* @privilege %http://tizen.org/privilege/notification
*
* @return An error code
* @param[in] badgeNumber The badge number
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the specified @c badgeNumber is less than @c 0.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The specified @c badgeNumber is less than @c 0.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the %Tizen platform policy.
+ * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @endif
*/
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
* @privilege %http://tizen.org/privilege/notification
*
* @return An error code
* @param[in] messageText The notification message
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the length of @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the %Tizen platform policy.
+ * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @endif
*/
/**
* @if OSPDEPREC
- * Notifies the user using a message and badge number.
+ * Notifies the user using a message and a badge number.
*
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
* @privilege %http://tizen.org/privilege/notification
*
* @return An error code
* @param[in] messageText The notification message
* @param[in] badgeNumber The badge number
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c badgeNumber is less than @c 0, or
- * the length of @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c badgeNumber is less than @c 0.
+ * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the %Tizen platform policy.
+ * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @endif
*/
/**
* @if OSPDEPREC
- * Notifies the user using a message and badge number. @n
+ * Notifies the user using a message and a badge number. @n
* If the user checks the message, @c launchArguments is delivered to the application. @n
* @c launchArguments is delivered as the value of the %http://tizen.org/appcontrol/data/notification key
- * for IAppControlProviderEventListener::OnAppControlRequestReceived().
+ * for the IAppControlProviderEventListener::OnAppControlRequestReceived() method.
*
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
* @privilege %http://tizen.org/privilege/notification
*
* @return An error code
* @param[in] messageText The notification message
* @param[in] badgeNumber The badge number
- * @param[in] launchArguments The message for application
+ * @param[in] launchArguments The message for the application
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - A specified input parameter is invalid. @n
- * - The specified @c badgeNumber is less than @c 0. @n
- * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c badgeNumber is less than @c 0.
+ * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
* - The length of the specified @c launchArguments is greater than App::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the %Tizen platform policy.
+ * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @see IAppControlProviderEventListener::OnAppControlRequestReceived()
* @endif
*/
result Notify(const Tizen::Base::String& messageText, int badgeNumber, const Tizen::Base::String& launchArguments);
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
* @privilege %http://tizen.org/privilege/notification
*
* @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks This method returns @c E_SUCCESS when there is no outstanding notification.
* @endif
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
* @privilege %http://tizen.org/privilege/notification
*
* @return An error code
* @param[in] messageText The notification message
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the length of @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the %Tizen platform policy.
+ * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @endif
*/
* @if OSPDEPREC
* Notifies the user about the ongoing activity using a message. @n
* @c launchArguments is delivered as the value of the %http://tizen.org/appcontrol/data/notification key
- * for IAppControlProviderEventListener::OnAppControlRequestReceived().
+ * for the IAppControlProviderEventListener::OnAppControlRequestReceived() method.
*
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
* @privilege %http://tizen.org/privilege/notification
*
* @return An error code
* @param[in] messageText The notification message
- * @param[in] launchArguments The launch arguments for the application
+ * @param[in] launchArguments The launch arguments for the application
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - A specified input parameter is invalid. @n
- * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
* - The length of the specified @c launchArguments is greater than App::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the %Tizen platform policy.
+ * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @endif
*/
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
* @privilege %http://tizen.org/privilege/notification
*
* @return An error code
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
* @privilege %http://tizen.org/privilege/notification
*
- * @return The current badge number
+ * @return The current badge number, @n
+ * else @c -1 if it fails
* @param[in] appId The application ID
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_OBJ_NOT_FOUND The application is not installed.
+ * @exception E_OBJ_NOT_FOUND The application has not been installed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks The specific error code can be accessed using the GetLastResult() method. @n
- * In case of failure, this method returns @c -1.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
* @endif
*/
int GetBadgeNumber(const AppId& appId);
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/notification @n
* @param[in] appId The application ID
* @param[in] badgeNumber The badge number
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c badgeNumber is less than @c 0.
- * @exception E_APP_NOT_INSTALLED The application is not installed.
- * @exception E_INVALID_OPERATION The target application with the specified application ID is not permitted to receive any notification as per the %Tizen platform policy.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c badgeNumber is less than @c 0.
+ * @exception E_APP_NOT_INSTALLED The application has not been installed.
+ * @exception E_INVALID_OPERATION The target application with the specified @c appId is not permitted to receive any notification as per the Tizen platform policy.
* @exception E_SYSTEM A system error has occurred.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @endif
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/notification @n
* @param[in] appId The application ID
* @param[in] messageText The notification message
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the length of @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
- * @exception E_APP_NOT_INSTALLED The application is not installed.
- * @exception E_INVALID_OPERATION The target application with the specified application ID is not permitted to receive any notification as per the %Tizen platform policy.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * @exception E_APP_NOT_INSTALLED The application has not been installed.
+ * @exception E_INVALID_OPERATION The target application with the specified @c appId is not permitted to receive any notification as per the Tizen platform policy.
* @exception E_SYSTEM A system error has occurred.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @endif
/**
* @if OSPDEPREC
- * Notifies the user using a message and badge number on behalf of the specified application.
+ * Notifies the user using a message and a badge number on behalf of the specified application.
*
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/notification @n
* @param[in] messageText The notification message
* @param[in] badgeNumber The badge number
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - A specified input parameter is invalid. @n
- * - The specified @c badgeNumber is less than @c 0. @n
- * - The length of @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
- * @exception E_APP_NOT_INSTALLED The application is not installed.
- * @exception E_INVALID_OPERATION The target application with the specified application ID is not permitted to receive any notification as per the %Tizen platform policy.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c badgeNumber is less than @c 0.
+ * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * @exception E_APP_NOT_INSTALLED The application has not been installed.
+ * @exception E_INVALID_OPERATION The target application with the specified @c appId is not permitted to receive any notification as per the Tizen platform policy.
* @exception E_SYSTEM A system error has occurred.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @endif
/**
* @if OSPDEPREC
- * Notifies the user using a message and badge number on behalf of the specified application. @n
- * If the user checks the message, the @c launchArguments is delivered to the application.
+ * Notifies the user using a message and a badge number on behalf of the specified application. @n
+ * If the user checks the message, @c launchArguments is delivered to the application.
*
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/notification @n
* (%http://tizen.org/privilege/notificationmanager is deprecated.)
*
- * @return An error code
+ * @return An error code
* @param[in] appId The application ID
- * @param[in] messageText The notification message
- * @param[in] launchArguments The launch arguments for the application
+ * @param[in] messageText The notification message
+ * @param[in] launchArguments The launch arguments for the application
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - A specified input parameter is invalid. @n
- * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. @n
- * - The length of the specified @c launchArguments is greater than App::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH.
- * @exception E_APP_NOT_INSTALLED The application is not installed.
- * @exception E_INVALID_OPERATION The target application with the specified application ID is not permitted to receive any notification as per the %Tizen platform policy.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * - The length of the specified @c launchArguments is greater than App::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH.
+ * @exception E_APP_NOT_INSTALLED The application has not been installed.
+ * @exception E_INVALID_OPERATION The target application with the specified @c appId is not permitted to receive any notification as per the Tizen platform policy.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @endif
*/
result NotifyOnBehalf(const AppId& appId, const Tizen::Base::String& messageText, const Tizen::Base::String& launchArguments);
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/notification @n
* @param[in] appId The application ID
* @param[in] messageText The notification message
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the length of @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
- * @exception E_APP_NOT_INSTALLED The application is not installed.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * @exception E_APP_NOT_INSTALLED The application has not been installed.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the %Tizen platform policy.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @endif
*/
result NotifyOngoingActivityOnBehalf(const AppId& appId, const Tizen::Base::String& messageText);
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/notification @n
* @return An error code
* @param[in] appId The application ID
* @param[in] messageText The notification message
- * @param[in] launchArguments The launch arguments for application
+ * @param[in] launchArguments The launch arguments for the application
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - A specified input parameter is invalid. @n
- * - The length of @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. @n
- * - The length of @c launchArguments is greater than App::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH.
- * @exception E_APP_NOT_INSTALLED The application is not installed.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * - The length of the specified @c launchArguments is greater than App::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH.
+ * @exception E_APP_NOT_INSTALLED The application has not been installed.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the %Tizen platform policy.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @endif
*/
result NotifyOngoingActivityOnBehalf(const AppId& appId, const Tizen::Base::String& messageText, const Tizen::Base::String& launchArguments);
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/notification @n
* @return An error code
* @param[in] appId The application ID
* @exception E_SUCCESS The method is successful.
- * @exception E_APP_NOT_INSTALLED The application is not installed.
+ * @exception E_APP_NOT_INSTALLED The application has not been installed.
* @exception E_SYSTEM A system error has occurred.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks Although there is no outstanding notification for the calling application, this method returns @c E_SUCCESS.
+ * @remarks Even if there is no outstanding notification for the calling application, this method returns @c E_SUCCESS.
* @endif
*/
result RemoveOngoingActivityNotificationOnBehalf(const AppId& appId);
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/notification @n
* @return An error code
* @param[in] appId The application ID
* @exception E_SUCCESS The method is successful.
- * @exception E_APP_NOT_INSTALLED The application is not installed.
+ * @exception E_APP_NOT_INSTALLED The application has not been installed.
* @exception E_SYSTEM A system error has occurred.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks Although there is no outstanding notification for the calling application, this method returns @c E_SUCCESS.
+ * @remarks Even if there is no outstanding notification for the calling application, this method returns @c E_SUCCESS.
* @endif
*/
result RemoveNotificationOnBehalf(const AppId& appId);
* @since 2.0
*
* @remarks @b Header @b %file: @b \#include @b <FApp.h> @n
- * @b Library : @b osp-appfw
+ * @b Library: @b osp-appfw
*
- * The %Package namespace contains classes and interfaces for information of packages and management of its installation or uninstallation.
+ * The %Package namespace contains classes and interfaces for obtaining the information and managing the installation or uninstallation of a package.
*
* The following diagram illustrates the relationships between the classes belonging to the %Package namespace.
* @image html app_package_namespace_classdiagram.png
/**
* @enum PackageInstallationResult
*
- * Defines the result of package installation.
+ * Defines the result of a package installation.
*
* @since 2.0
*/
{
PACKAGE_INSTALLATION_RESULT_SUCCESS = 0, /**< Success */
PACKAGE_INSTALLATION_RESULT_INVALID_PACKAGE, /**< An invalid package */
- PACKAGE_INSTALLATION_RESULT_STORAGE_FULL, /**< The installation target storage is full. */
+ PACKAGE_INSTALLATION_RESULT_STORAGE_FULL, /**< The installation's target storage is full */
};
/**
* @interface IPackageInstallationEventListener
-* @brief This interface defines a listener for a package installation and uninstallation.
+* @brief This interface defines a listener for a package's installation and uninstallation.
*
* @since 2.0
*
-* The %IPackageInstallationEventListener interface defines a listener that is notified for events related to installation or uninstallation of packages on a device.
+* The %IPackageInstallationEventListener interface defines a listener that is notified about events related to the installation or uninstallation of a package on a device.
* The events include installation completion, uninstallation completion, and installation progress.
-* This listener is registered with the PackageManager::AddPackageInstallationEventListener() method and unregistered with the PackageManager::RemovePackageInstallationEventListener() method.
-* Generally, this listener is used in system applications such as application service that utilizes packages' (un)installation information in a system.
+* This listener is registered using the PackageManager::AddPackageInstallationEventListener() method and unregistered using the PackageManager::RemovePackageInstallationEventListener() method.
+* Generally, this listener is used in system applications such as an application service that utilizes a package's (un)installation information that is present in the system.
*/
class _OSP_EXPORT_ IPackageInstallationEventListener
: virtual public Tizen::Base::Runtime::IEventListener
{
public:
/**
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
/**
* Called when a package uninstallation is completed. @n
- * The value of @c uninstallationResult is @c true if the uninstallation is successful, else @c false.
+ * The value of @c uninstallationResult is @c true if the uninstallation is successful, otherwise it is @c false.
*
* @since 2.0
*
- * @param[in] packageId The package ID
+ * @param[in] packageId The package ID
* @param[in] uninstallationResult Set to @c true if the uninstallation is successful, @n
- * else @c false
+ * else @c false
*/
virtual void OnPackageUninstallationCompleted(const PackageId& packageId, bool uninstallationResult) = 0;
* @since 2.0
*
* @param[in] packageId The package ID
- * @param[in] progress The progress of an installation in percentage
+ * @param[in] progress The progress of the installation in percentage
*/
virtual void OnPackageInstallationInProgress(const PackageId& packageId, int progress) = 0;
*
* @since 2.0
*
- * The %IPackageInstallationResponseListener interface defines a listener that is notified for events related to installation of a target package.
- * The events include installation result and installation progress information.
- * Generally, applications such as %Tizen Store use this listener in a package installation step.
+ * The %IPackageInstallationResponseListener interface defines a listener that is notified about events related to the installation of a target package.
+ * The events include the installation result and the installation progress information.
+ * Generally, applications such as the Tizen Store use this listener in a package installation step.
* @see PackageManager::InstallPackage()
*/
class _OSP_EXPORT_ IPackageInstallationResponseListener
{
public:
/**
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*
* @since 2.0
*
- * @param[in] packageId The package ID
+ * @param[in] packageId The package ID
* @param[in] installationResult The installation result
*
*/
* @since 2.0
*
* @param[in] packageId The package ID
- * @param[in] progress The progress of an installation in percentage
+ * @param[in] progress The progress of the installation in percentage
*
*/
virtual void OnPackageInstallationInProgressResponseReceived(const PackageId& packageId, int progress) = 0;
*
* @since 2.0
*
- * The %IPackageUninstallationResponseListener interface defines a listener that is notified for events related to uninstallation of a target package.
- * The events include uninstallation result.
- * Generally, applications such as %Tizen Store use this listener in a package uninstallation step.
+ * The %IPackageUninstallationResponseListener interface defines a listener that is notified about events related to the uninstallation of a target package.
+ * The events include the uninstallation result.
+ * Generally, applications such as the %Tizen Store use this listener in a package uninstallation step.
* @see PackageManager::UninstallPackage()
*
*/
{
public:
/**
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
/**
* Called when a package uninstallation is completed. @n
- * The value of @c uninstallationResult is @c true if the uninstallation is successful, else @c false.
+ * The value of @c uninstallationResult is @c true if the uninstallation is successful, otherwise it is @c false.
*
* @since 2.0
*
* @param[in] packageId The package ID
* @param[in] uninstallationResult Set to @c true if the uninstallation is successful, @n
- * else @c false
+ * else @c false
*
*/
virtual void OnPackageUninstallationResponseReceived(const PackageId& packageId, bool uninstallationResult) = 0;
/**
* @class PackageAppInfo
- * @brief This class represents the information of the application in package.
+ * @brief This class represents the information of an application in a package.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
- * The %PackageAppInfo class provides the information of the application in package.
+ * The %PackageAppInfo class provides the information of an application in a package.
*
*/
class _OSP_EXPORT_ PackageAppInfo
virtual ~PackageAppInfo(void);
/**
- * Gets an application ID.
+ * Gets the application ID.
*
* @since 2.0
*
- * @return An application ID
+ * @return The application ID
*/
AppId GetAppId(void) const;
*
* @since 2.0
*
- * @return The name of an application
+ * @return The name of the application
*/
Tizen::Base::String GetAppName(void) const;
*
* @since 2.0
*
- * @return The display name of an application
+ * @return The display name of the application
*/
Tizen::Base::String GetAppDisplayName(void) const;
*
* @since 2.1
*
- * @return The menu icon path of an application, @n
+ * @return The menu icon path of the application, @n
* else an empty string is returned if there is no value
*/
Tizen::Base::String GetAppMenuIconPath(void) const;
*
* @since 2.1
*
- * @return The setting icon path of an application, @n
- * else an empty string is returned if there is no value
+ * @return The setting icon path of the application, @n
+ * else an empty string is returned if there is no value
*/
Tizen::Base::String GetAppSettingIconPath(void) const;
*
* @since 2.1
*
- * @return The notification icon path of an application, @n
+ * @return The notification icon path of the application, @n
* else an empty string is returned if there is no value
*/
Tizen::Base::String GetAppNotificationIconPath(void) const;
/**
* Gets the menu icon of an application.
*
- * @since 2.1
+ * @since 2.1
*
- * @return A pointer to the menu icon of an application, @n
- * else @c null if it fails
+ * @return A pointer to the menu icon of the application, @n
+ * else @c null if it fails
* @exception E_SUCCESS The method is successful.
* @exception E_FILE_NOT_FOUND The menu icon does not exist.
* @exception E_UNSUPPORTED_FORMAT The image file format is not supported.
*
* @since 2.1
*
- * @return A pointer to a map of key(Tizen::Base::String) and value(Tizen::Base::String) pairs of the metadata, @n
+ * @return A pointer to the map of the key(Tizen::Base::String) and value(%Tizen::Base::String) pairs of the metadata, @n
* else @c null if it fails
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks
- * - The specific error code can be accessed using the GetLastResult() method.
- * - Application can use the metadata to set app-wide information.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - An application can use the metadata to set the app-wide information.
*/
Tizen::Base::Collection::IMap* GetAppMetadataListN(void) const;
Tizen::Base::Collection::IList* GetAppCategoryListN(void) const;
/**
- * Checks whether an application is visible on the menu.
+ * Checks if an application is visible on the menu.
*
* @since 2.0
*
- * @return @c true if an application is visible on the menu, @n
+ * @return @c true if the application is visible on the menu, @n
* else @c false
- * @remarks If the return value is @c false, it is recommended not to display the application on the menu.
+ * @remarks If the return value is @c false, it is not recommended to display the application on the menu.
*/
bool IsMenuIconVisible(void) const;
/**
- * Checks whether an application is the main application of the package.
+ * Checks if an application is the main application of the package.
*
* @since 2.0
*
- * @return @c true if an application is the main application of the package, @n
+ * @return @c true if the application is the main application of the package, @n
* else @c false
*/
bool IsMainApp(void) const;
virtual ~PackageInfo(void);
/**
- * Gets a package ID.
+ * Gets the package ID.
*
* @since 2.0
*
- * @return A package ID
+ * @return The package ID
*/
PackageId GetId(void) const;
*
* @since 2.0
*
- * @return The version of a package
+ * @return The version of the package
*/
Tizen::Base::String GetVersion(void) const;
*
* @since 2.0
*
- * @return The display name of a package
+ * @return The display name of the package
*/
Tizen::Base::String GetDisplayName(void) const;
*
* @since 2.0
*
- * @return The description of a package, @n
+ * @return The description of the package, @n
* else an empty string is returned if there is no value
*/
Tizen::Base::String GetDescription(void) const;
*
* @since 2.0
*
- * @return The author of a package, @n
+ * @return The author of the package, @n
* else an empty string is returned if there is no value
*/
Tizen::Base::String GetAuthor(void) const;
*
* @since 2.0
*
- * @return The URL of a package, @n
+ * @return The URL of the package, @n
* else an empty string is returned if there is no value
*/
Tizen::Base::String GetUrl(void) const;
/**
- * Gets the date and time when a package is installed.
+ * Gets the date and the time when a package is installed.
*
* @since 2.0
*
- * @return An instance of Tizen::Base::DateTime when a package is installed
+ * @return An instance of Tizen::Base::DateTime which contains the package installation details
*/
Tizen::Base::DateTime GetInstallationTime(void) const;
/**
- * Checks whether a package is installed in the external storage.
+ * Checks if a package is installed in the external storage.
*
* @since 2.0
*
- * @return @c true if a package is installed in the external storage, @n
+ * @return @c true if the package is installed in the external storage, @n
* else @c false
*/
bool IsInstalledInExternalStorage(void) const;
/**
- * Checks whether it is possible to uninstall a package.
+ * Checks if it is possible to uninstall a package.
*
* @since 2.0
*
- * @return @c true if it is possible to uninstall a package, @n
+ * @return @c true if it is possible to uninstall the package, @n
* else @c false
*/
bool IsUninstallable(void) const;
/**
- * Checks whether it is possible to move a package to either internal or external storage.
+ * Checks if it is possible to move a package to either the internal or the external storage.
*
* @since 2.0
*
- * @return @c true if it is possible to move a package to either internal or external storage, @n
+ * @return @c true if it is possible to move the package to either the internal or the external storage, @n
* else @c false
*/
bool IsMovable(void) const;
/**
- * Checks whether a package is downloaded.
+ * Checks if a package is downloaded.
*
* @since 2.0
*
- * @return @c true if a package is downloaded, @n
+ * @return @c true if the package is downloaded, @n
* else @c false
*/
bool IsDownloaded(void) const;
*
* @since 2.0
*
- * @return The size of a package
+ * @return The size of the package
*/
long long GetSize(void) const;
*
* @since 2.0
*
- * @return The data size of a package
+ * @return The data size of the package
*/
long long GetDataSize(void) const;
*
* @since 2.0
*
- * @return A pointer to PackageAppInfo
+ * @return A pointer to the PackageAppInfo instance
* @param[in] appId The application ID
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_OBJ_NOT_FOUND The application information is not found.
+ * @exception E_OBJ_NOT_FOUND The application information has not been found.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
/**
* Gets the type of a package.
*
- * @since 2.0
+ * @since 2.0
* @privlevel platform
* @privilege %http://tizen.org/privilege/packagemanager.setting @n
- * (%http://tizen.org/privilege/packagesetting is deprecated.)
+ * (%http://tizen.org/privilege/packagesetting is deprecated.)
*
- * @return The package type
+ * @return The package type
*/
PackageType GetType(void) const;
*
* @since 2.1
*
- * @return A pointer to the list of Tizen::Security::PrivilegeInfo instances, @n
+ * @return A pointer to the list of the Tizen::Security::PrivilegeInfo instances, @n
* else @c null if it fails
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetPrivilegeListN(void) const;
*/
enum PackageType
{
- PACKAGE_TYPE_TPK, /**< TIZEN Native package */
- PACKAGE_TYPE_WGT, /**< TIZEN %Web package */
- PACKAGE_TYPE_RPM, /**< TIZEN Core package */
+ PACKAGE_TYPE_TPK, /**< %Tizen native package */
+ PACKAGE_TYPE_WGT, /**< %Tizen Web package */
+ PACKAGE_TYPE_RPM, /**< %Tizen Core package */
};
/**
* @class PackageManager
- * @brief This class gets the information of packages and manages package installation or uninstallation.
+ * @brief This class gets the information of a package and manages the package's installation or uninstallation.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
- * The %PackageManager class provides methods to install or uninstall the packages, retrieves the information of the packages that are installed on the device.
+ * The %PackageManager class provides methods to install or uninstall a package and retrieve the information of a package that is installed on the device.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/app/package_namespace.htm">Package Management</a>.
*
* @since 2.0
*
* @return The package ID, @n
- * else @c packageId.IsEmtpy() == true is returned if an error occurs
+ * else an empty package ID if an error occurs @n
+ * Checks with packageId.IsEmpty() whether the package ID is empty.
* @param[in] appId The application ID
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
/**
* Adds a package installation event listener.
*
- * @since 2.0
+ * @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/package.info @n
- * (%http://tizen.org/privilege/packageinfo is deprecated.)
+ * (%http://tizen.org/privilege/packageinfo is deprecated.)
*
* @return An error code
* @param[in] listener The package installation event listener
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/package.info @n
- * (%http://tizen.org/privilege/packageinfo is deprecated.)
+ * (%http://tizen.org/privilege/packageinfo is deprecated.)
*
* @return An error code
* @param[in] listener The package installation event listener
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The listener is not added or is already removed.
+ * @exception E_OBJ_NOT_FOUND Either of the following conditions has occurred:
+ * - The listener is not added.
+ * - The listener is already removed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
result RemovePackageInstallationEventListener(IPackageInstallationEventListener& listener);
/**
- * Gets a package information with the specific package ID.
+ * Gets the package information with the specific package ID.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/package.info @n
- * (%http://tizen.org/privilege/packageinfo is deprecated.)
+ * (%http://tizen.org/privilege/packageinfo is deprecated.)
*
- * @return A pointer to PackageInfo
+ * @return A pointer to the PackageInfo instance
* @param[in] packageId The package ID
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @exception E_PKG_NOT_INSTALLED The package is not installed.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_PKG_NOT_INSTALLED The package has not been installed.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
PackageInfo* GetPackageInfoN(const PackageId& packageId) const;
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/package.info @n
- * (%http://tizen.org/privilege/packageinfo is deprecated.)
+ * (%http://tizen.org/privilege/packageinfo is deprecated.)
*
- * @return A pointer to PackageAppInfo
+ * @return A pointer to the PackageAppInfo instance
* @param[in] appId The application ID
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/package.info @n
- * (%http://tizen.org/privilege/packageinfo is deprecated.)
+ * (%http://tizen.org/privilege/packageinfo is deprecated.)
*
* @return A pointer to the list of the PackageInfo instances, @n
* else @c null if it fails
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/package.info @n
- * (%http://tizen.org/privilege/packageinfo is deprecated.)
+ * (%http://tizen.org/privilege/packageinfo is deprecated.)
*
- * @return @c true if a package is installed, @n
- * else @c false
- * @param[in] packageId The package ID
+ * @return @c true if the package is installed, @n
+ * else @c false
+ * @param[in] packageId The package ID
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
/**
* Installs a package. @n
- * The %InstallPackage() method operates asynchronously, that is, it ends immediately without an installation response. The application is notified when the installation is completed, so the response is available through the IPackageInstallationResponseListener::OnPackageInstallationCompleted() method, if this method returns @c E_SUCCESS.
+ * The %InstallPackage() method operates asynchronously, that is, it ends immediately without an installation response.
+ * The application is notified when the installation is completed, so the response is available through the IPackageInstallationResponseListener::OnPackageInstallationCompleted() method, if this method returns @c E_SUCCESS.
*
* @since 2.0
* @privlevel platform
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks A listener instance ownership is transferred to the platform. After notifying result, the listener instance is removed automatically. A reuse of the listener instance is not allowed.
+ * @remarks
+ * - A listener instance ownership is transferred to the platform.
+ * - After notifying the result, the listener instance is removed automatically.
+ * - A reuse of the listener instance is not allowed.
*/
result InstallPackage(const PackageId& packageId, const Tizen::Base::String& packagePath, IPackageInstallationResponseListener* pListener);
/**
* Uninstalls a package with the specified package ID. @n
- * The %UninstallPackage() method operates asynchronously, that is, it ends immediately without an uninstallation response. The application is notified when the uninstallation is completed, so the response is available through the IPackageUninstallationResponseListener::OnPackageUninstallationCompleted() method, if this method returns @c true.
+ * The %UninstallPackage() method operates asynchronously, that is, it ends immediately without an uninstallation response.
+ * The application is notified when the uninstallation is completed, so the response is available through the IPackageUninstallationResponseListener::OnPackageUninstallationCompleted() method, if this method returns @c true.
*
* @since 2.0
* @privlevel platform
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @exception E_PKG_NOT_INSTALLED The package is not installed.
+ * @exception E_PKG_NOT_INSTALLED The package has not been installed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks A listener instance ownership is transferred to the platform. After notifying result, the listener instance is removed automatically. A reuse of the listener instance is not allowed.
+ * @remarks
+ * - A listener instance ownership is transferred to the platform.
+ * - After notifying the result, the listener instance is removed automatically.
+ * - A reuse of the listener instance is not allowed.
*/
result UninstallPackage(const PackageId& packageId, IPackageUninstallationResponseListener* pListener);
/**
- * Moves a package with the specified package ID to an external storage.
+ * Moves a package with the specified package ID to the external storage.
*
- * @since 2.0
+ * @since 2.0
* @privlevel platform
* @privilege %http://tizen.org/privilege/packagemanager.setting @n
- * (%http://tizen.org/privilege/packagesetting is deprecated.)
+ * (%http://tizen.org/privilege/packagesetting is deprecated.)
*
* @return An error code
* @param[in] packageId The package ID
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_INVALID_OPERATION The package is already installed in an external storage.
+ * @exception E_INVALID_OPERATION The package is already installed in the external storage.
* @exception E_STORAGE_FULL The storage is full.
- * @exception E_PKG_NOT_INSTALLED The package is not installed.
+ * @exception E_PKG_NOT_INSTALLED The package has not been installed.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
result MoveToExternalStorage(const PackageId& packageId);
/**
- * Moves a package with the specified package ID to an internal storage.
+ * Moves a package with the specified package ID to the internal storage.
*
- * @since 2.0
+ * @since 2.0
* @privlevel platform
* @privilege %http://tizen.org/privilege/packagemanager.setting @n
- * (%http://tizen.org/privilege/packagesetting is deprecated.)
+ * (%http://tizen.org/privilege/packagesetting is deprecated.)
*
* @return An error code
* @param[in] packageId The package ID
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_INVALID_OPERATION The package is already installed in an internal storage.
+ * @exception E_INVALID_OPERATION The package is already installed in the internal storage.
* @exception E_STORAGE_FULL The storage is full.
- * @exception E_PKG_NOT_INSTALLED The package is not installed.
+ * @exception E_PKG_NOT_INSTALLED The package has not been installed.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
result MoveToInternalStorage(const PackageId& packageId);
/**
- * Gets a package information from a specific file. @n The supported file extensions are tpk and wgt.
+ * Gets the package information from a specific file. @n
+ * The supported file extensions are tpk and wgt.
*
* @since 2.1
* @privlevel platform
* @privilege %http://tizen.org/privilege/packagemanager.info
*
* @return A pointer to the PackageInfo instance, @n
- * else @c null if it fails
- * @param[in] filePath The package file path
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
- * @exception E_UNSUPPORTED_FORMAT The specified format is invalid or not supported.
- * @exception E_PARSING_FAILED The method has failed to parse the package file or xml file(s) inside the package.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * else @c null if it fails
+ * @param[in] filePath The package file path
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
+ * @exception E_UNSUPPORTED_FORMAT The specified format is invalid or not supported.
+ * @exception E_PARSING_FAILED The method has failed to parse the package file or xml file(s) inside the package.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
PackageInfo* GetPackageInfoFromFileN(const Tizen::Base::String& filePath) const;
/**
- * Gets the package information list with the package filter.
+ * Gets the package information list using the package filter.
*
* @since 2.1
* @privlevel public
* @return A pointer to the list of the PackageInfo instances, @n
* else @c null if it fails
* @param[in] packageFilterMap The predefined key(Tizen::Base::String)-value(Tizen::Base::Boolean) pairs for the package filter @n
- * For more information on the predefined key-value pairs for package filter,
- * see <a href="../org.tizen.native.appprogramming/html/guide/app/package_app_filter.htm">the predefined key-value pairs for package filter</a>.
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * For more information on the predefined key-value pairs for the package filter,
+ * see <a href="../org.tizen.native.appprogramming/html/guide/app/package_app_filter.htm">the predefined key-value pairs for the package filter</a>.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetPackageInfoListN(const Tizen::Base::Collection::IMap& packageFilterMap) const;
/**
- * Gets the application information list with the package app filter.
+ * Gets the application information list using the package application filter.
*
* @since 2.1
* @privlevel public
*
* @return A pointer to the list of the PackageAppInfo instances, @n
* else @c null if it fails
- * @param[in] packageAppFilterMap The predefined key(Tizen::Base::String)-value(Tizen::Base::String or Tizen::Base::Boolean) pairs for the package app filter @n
- * For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/package_app_filter.htm">
- * the predefined key-value pairs for package app filter</a>.
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @param[in] packageAppFilterMap The predefined key(Tizen::Base::String)-value(Tizen::Base::String or Tizen::Base::Boolean) pairs for the package application filter @n
+ *
For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/package_app_filter.htm">
+ * the predefined key-value pairs for the package application filter</a>.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetPackageAppInfoListN(const Tizen::Base::Collection::IMap& packageAppFilterMap) const;
/**
- * Gets the application information list with the package filter and package app filter.
+ * Gets the application information list using the package filter and the package application filter.
*
* @since 2.1
* @privlevel public
* @privilege %http://tizen.org/privilege/package.info
*
* @return A pointer to the list of the PackageAppInfo instances, @n
- * else @c null if it fails
+ * else @c null if it fails
* @param[in] packageFilterMap The predefined key(Tizen::Base::String)-value(Tizen::Base::Boolean) pairs for the package filter @n
- * @param[in] packageAppFilterMap The predefined and user defined key(Tizen::Base::String)-value(Tizen::Base::String or Tizen::Base::Boolean) pairs for the package app filter @n
- * The user defined key-value pairs can be added in <Metadata> of manifest.xml. @n For more information,
- * see <a href="../org.tizen.native.appprogramming/html/guide/app/package_filter.htm">the predefined key-value pairs
- *
for package filter</a> and <a href="../org.tizen.native.appprogramming/html/guide/app/package_app_filter.htm">the
- * predefined key-value pairs for package app filter</a>.
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @param[in] packageAppFilterMap The predefined and user defined key(Tizen::Base::String)-value(%Tizen::Base::String or Tizen::Base::Boolean) pairs for the package application filter @n
+ * The user defined key-value pairs can be added in the <Metadata> of the manifest.xml. @n For more information,
+ *
see <a href="../org.tizen.native.appprogramming/html/guide/app/package_filter.htm">the predefined key-value pairs
+ *
for the package filter</a>, and <a href="../org.tizen.native.appprogramming/html/guide/app/package_app_filter.htm">the
+ * predefined key-value pairs for the package application filter</a>.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetPackageAppInfoListN(const Tizen::Base::Collection::IMap& packageFilterMap, const Tizen::Base::Collection::IMap& packageAppFilterMap) const;
/**
- * Gets the package manager instance.
+ * Gets a pointer to the %PackageManager instance.
*
* @since 2.0
*
* @return A pointer to the %PackageManager instance, @n
- * else @c null
+ * else @c null if it fails
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static PackageManager* GetInstance(void);
/**
* @class ServiceApp
- * @brief This class is the base class of a %Tizen native service application.
+ * @brief This class is the base class of the %Tizen native service application.
*
* @since 2.0
*
- * The %ServiceApp class is the base class of a %Tizen native service application which has no UI.
+ * The %ServiceApp class is the base class of the %Tizen native service application which has no UI.
* A %Tizen native service application must inherit from the %ServiceApp class. This class provides the basic features necessary to define the
* %Tizen native service application.
- * @n
+ *
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/app/app_namespace.htm">App Guide</a> and <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/tizen_app_model/application_model.htm">Native Application Model</a>.
*
*/
virtual ~ServiceApp(void);
/**
- * Gets the %ServiceApp instance's pointer.
+ * Gets a pointer to the %ServiceApp instance.
*
* @since 2.0
*
/**
* Executes an application implemented by inheriting this class. @n
- * The %Execute() method must be called from the entry method - OspMain(), which is generated by IDE.
+ * The %Execute() method must be called from the entry method, that is, OspMain(), which is generated by IDE.
*
* @since 2.0
*
* @return An error code
- * @param[in] pServiceAppFactory The factory method that creates this %ServiceApp's instance
- * @param[in] pArguments The launch arguments for %App
+ * @param[in] pServiceAppFactory The factory method that creates this %ServiceApp instance
+ * @param[in] pArguments The launch arguments for the application
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INIT_FAILED The initialization failure during OnAppInitializing().
+ * @exception E_INIT_FAILED The initialization using the OnAppInitializing() method has failed.
* @exception E_SYSTEM A system error has occurred.
*/
static result Execute(ServiceAppInstanceFactory pServiceAppFactory, const Tizen::Base::Collection::IList* pArguments);
/**
* @class SqlDataControl
- * @brief This class represents the SQL-friendly interface based data control behavior.
+ * @brief This class represents the SQL-friendly interface based data control's behavior.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
- * The %SqlDataControl class represents the data control behavior, that provides a standard mechanism
- * for accessing specific data exported by other applications.
- * Data control provider can share its own data to data control consumers.
+ * The %SqlDataControl class represents the data control's behavior that provides a standard mechanism
+ * for accessing the specific data exported by other applications.
+ * A data control provider can share its data with data control consumers.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/app/data_controls.htm">Data Controls</a>.
*
/**
* Selects the specified columns to be queried. @n
- * The result set of the specified columns is retrieved from a table owned by an SQL-friendly interface based data control provider. @n
+ * The result set of the specified columns is retrieved from a table owned by the SQL-friendly interface based data control provider. @n
* The %Select() method is asynchronous.
- * For receiving the response from the data control provider, set the listener with
- * SqlDataControl::SetSqlDataControlResponseListener(). @n
+ * For receiving the response from the data control provider, set the listener using
+ * the SqlDataControl::SetSqlDataControlResponseListener() method. @n
* When the requested result set has been received from the data control provider,
* the ISqlDataControlResponseListener::OnSqlDataControlSelectResponseReceived() method is called.
*
* @since 2.0
*
* @return An error code
- * @param[in] dataId A string for identifying specific data, usually a database table to query from @n
+ * @param[in] dataId The string that identifies the specific data, usually a database table to query from @n
* The string consists of one or more components, separated by a slash('/').
- * @param[in] pColumnList A list of column names to query @n
+ * @param[in] pColumnList The list of column names to query @n
* The type of objects contained in the specified @c pColumnList must be
- * Tizen::Base::String class.
- * If the specified @c pColumnList is @c null, all columns are selected.
- * @param[in] pWhere A filter to select desired rows to query @n
+ * Tizen::Base::String @n
+ * If the specified @c pColumnList is @c null, all the columns are selected.
+ * @param[in] pWhere The filter to select the desired rows to query @n
* It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as
- * column1 = 'stringValue' AND column2 = numericValue. @n\r
- * If the value is string, the value must be wrapped in single quotes.\r
- * Otherwise it is not needed to wrap the numeric value in single quotes.\r
- * For more information on the SQL statement, see SQLite SQL documents.\r
- * @param[in] pOrder The sorting order of rows to query @n
+ * column1 = 'stringValue' AND column2 = numericValue @n
+ * If the value is a string, the value must be wrapped in single quotes,
+ * otherwise it need not be wrapped in single quotes @n
+ * For more information on the SQL statement, see SQLite SQL documents.
+ * @param[in] pOrder The sorting order of the rows to query @n
* It is an SQL 'ORDER BY' clause excluding the 'ORDER BY' itself.
* @param[out] reqId The request ID
- * @param[in] pageNo The page number of the result set @n It starts from @c 1.
- * @param[in] countPerPage The desired maximum count of rows on a page
+ * @param[in] pageNo The page number of the result set @n
+ * It starts from @c 1.
+ * @param[in] countPerPage The desired maximum count of the rows per page
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance has not been properly constructed.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
+ * @exception E_INVALID_STATE This instance has not been constructed properly.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
* - The specified @c pColumnList is empty.
- * - The specified @c pageNo parameter is less than @c 1.
- * - The specified @c countPerPage parameter is less than @c 1.
- * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
- * - Access is denied due to insufficient permission.
- * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1
+ * - The specified @c pageNo is less than @c 1.
+ * - The specified @c countPerPage is less than @c 1.
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The access is denied due to insufficient permission.
+ * - The application using this method is not signed with the same certificate as that of the provider application. @b Since: @b 2.1
* @exception E_MAX_EXCEEDED Either of the following conditions has occurred:
- * - The size of sending buffer has exceeded the maximum limit.
- * - The number of sending requests has exceeded the maximum limit.
+ * - The size of the sending buffer has exceeded the maximum limit.
+ * - The number of sending requests have exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The recommended data size is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.\r
+ * @remarks The recommended data size is under 16KB because a severe system performance degradation may occur for larger messages. @n
+ * @c E_MAX_EXCEEDED may be returned for messages over 16KB.
*/
result Select(const Tizen::Base::String& dataId, const Tizen::Base::Collection::IList* pColumnList,
const Tizen::Base::String* pWhere, const Tizen::Base::String *pOrder, RequestId& reqId,
int pageNo = 1, int countPerPage = 20);
/**
- * Inserts new rows into a table owned by an SQL-friendly interface based data control provider. @n
+ * Inserts new rows into a table owned by the SQL-friendly interface based data control provider. @n
* The %Insert() method is asynchronous.
- * For receiving the response from the data control provider, set the listener with
- * SqlDataControl::SetSqlDataControlResponseListener(). @n
+ * For receiving the response from the data control provider, set the listener using
+ * the SqlDataControl::SetSqlDataControlResponseListener() method. @n
* When the response has been received from the data control provider,
* the ISqlDataControlResponseListener::OnSqlDataControlInsertResponseReceived() method is called.
*
* @since 2.0
*
* @return An error code
- * @param[in] dataId A string for identifying specific data, usually a database table to insert into @n
+ * @param[in] dataId The string that identifies the specific data, usually a database table to insert into @n
* The string consists of one or more components, separated by a slash('/').
* @param[in] insertMap The column-value pairs to insert @n
- * The type of objects must be Tizen::Base::String class. @n\r
- * If the value is string, the value must be wrapped in\r
- * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.\r
- * For more information on the SQL statement, see SQLite SQL documents.\r
+ * The type of objects must be Tizen::Base::String @n
+ * If the value is a string, the value must be wrapped in single quotes,
+ * else it need not be wrapped in single quotes @n
+ * For more information on the SQL statement, see SQLite SQL documents.
* @param[out] reqId The request ID
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance has not been properly constructed.
+ * @exception E_INVALID_STATE This instance has not been constructed properly.
* @exception E_INVALID_ARG The specified @c insertMap is empty.
- * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
- * - Access is denied due to insufficient permission.
- * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The access is denied due to insufficient permission.
+ * - The application using this method is not signed with the same certificate as that of the provider application. @b Since: @b 2.1
* @exception E_MAX_EXCEEDED Either of the following conditions has occurred:
- * - The size of sending buffer has exceeded the maximum limit.
- * - The number of sending requests has exceeded the maximum limit.
+ * - The size of the sending buffer has exceeded the maximum limit.
+ * - The number of sending requests have exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The recommended data size is under 1MB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 1MB size.\r
+ * @remarks The recommended data size is under 1MB because a severe system performance degradation may occur for larger messages. @n
+ * @c E_MAX_EXCEEDED may be returned for messages over 1MB.
*/
result Insert(const Tizen::Base::String& dataId, const Tizen::Base::Collection::IMap& insertMap, RequestId& reqId);
/**
- * Updates values of a table owned by an SQL-friendly interface based data control provider. @n
+ * Updates values of a table owned by the SQL-friendly interface based data control provider. @n
* The %Update() method is asynchronous.
- * For receiving the response from the data control provider, set the listener with
- * SqlDataControl::SetSqlDataControlResponseListener(). @n
+ * For receiving the response from the data control provider, set the listener using
+ * the SqlDataControl::SetSqlDataControlResponseListener() method. @n
* When the response has been received from the data control provider,
* the ISqlDataControlResponseListener::OnSqlDataControlUpdateResponseReceived() method is called.
*
* @since 2.0
*
* @return An error code
- * @param[in] dataId A string for identifying specific data, usually a database table to update @n
+ * @param[in] dataId The string that identifies the specific data, usually a database table to update @n
* The string consists of one or more components, separated by a slash('/').
* @param[in] updateMap The column-value pairs to update @n
- * The type of objects must be Tizen::Base::String class. @n\r
- * If the value is string, the value must be wrapped in\r
- * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.\r
- * For more information on the SQL statement, see SQLITE SQL documents.\r
- * @param[in] pWhere A filter to select desired rows to update @n
+ * The type of objects must be Tizen::Base::String @n
+ * If the value is a string, the value must be wrapped in single quotes,
+ * else it need not be wrapped in single quotes @n
+ * For more information on the SQL statement, see SQLITE SQL documents.
+ * @param[in] pWhere The filter to select the desired rows to update @n
* It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as
- * column1 = 'stringValue' AND column2 = numericValue. @n\r
- * If the value is string, the value must be wrapped in\r
- * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.\r
- * For more information on the SQL statement, see SQLITE SQL documents.\r
+ * column1 = 'stringValue' AND column2 = numericValue @n
+ * If the value is a string, the value must be wrapped in single quotes,
+ * else it is not wrapped in single quotes @n
+ * For more information on the SQL statement, see SQLITE SQL documents.
* @param[out] reqId The request ID
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance has not been properly constructed.
+ * @exception E_INVALID_STATE This instance has not been constructed properly.
* @exception E_INVALID_ARG The specified @c updateMap is empty.
- * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
- * - Access is denied due to insufficient permission.
- * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The access is denied due to insufficient permission.
+ * - The application using this method is not signed with the same certificate as that of the provider application. @b Since: @b 2.1
* @exception E_MAX_EXCEEDED Either of the following conditions has occurred:
- * - The size of sending buffer has exceeded the maximum limit.
- * - The number of sending requests has exceeded the maximum limit.
+ * - The size of the sending buffer has exceeded the maximum limit.
+ * - The number of sending requests have exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The recommended data size is under 1MB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 1MB size.\r
+ * @remarks The recommended data size is under 1MB because a severe system performance degradation may occur for larger messages. @n
+ * @c E_MAX_EXCEEDED may be returned for messages over 1MB.
*/
result Update(const Tizen::Base::String& dataId, const Tizen::Base::Collection::IMap& updateMap,
const Tizen::Base::String* pWhere, RequestId& reqId);
/**
- * Deletes rows of a table owned by an SQL-friendly interface based data control provider. @n
+ * Deletes rows of a table owned by the SQL-friendly interface based data control provider. @n
* The %Delete() method is asynchronous.
- * For receiving the response from the data control provider, set the listener with
- * SqlDataControl::SetSqlDataControlResponseListener(). @n
+ * For receiving the response from the data control provider, set the listener using
+ * the SqlDataControl::SetSqlDataControlResponseListener() method. @n
* When the response has been received from the data control provider,
* the ISqlDataControlResponseListener::OnSqlDataControlDeleteResponseReceived() method is called.
*
* @since 2.0
*
* @return An error code
- * @param[in] dataId A string for identifying specific data, usually a database table to delete from @n
+ * @param[in] dataId The string that identifies the specific data, usually a database table to delete from @n
* The string consists of one or more components, separated by a slash('/').
- * @param[in] pWhere A filter to select desired rows to delete @n
+ * @param[in] pWhere The filter to select the desired rows to delete @n
* It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as
- * column1 = 'stringValue' AND column2 = numericValue.
- * If it is @c null, all rows are deleted. @n\r
- * If the value is string, the value must be wrapped in\r
- * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.\r
- * For more information on the SQL statement, see SQLITE SQL documents.\r
+ * column1 = 'stringValue' AND column2 = numericValue @n
+ * If it is @c null, all the rows are deleted @n
+ * If the value is a string, the value must be wrapped in single quotes,
+ * else it need not be wrapped in single quotes @n
+ * For more information on the SQL statement, see SQLITE SQL documents.
* @param[out] reqId The request ID
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance has not been properly constructed.
- * @exception E_INVALID_ARG A specified parameter is invalid.
- * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
- * - Access is denied due to insufficient permission.
- * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1
+ * @exception E_INVALID_STATE This instance has not been constructed properly.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The access is denied due to insufficient permission.
+ * - The application using this method is not signed with the same certificate as that of the provider application. @b Since: @b 2.1
* @exception E_MAX_EXCEEDED Either of the following conditions has occurred:
- * - The size of sending buffer has exceeded the maximum limit.
- * - The number of sending requests has exceeded the maximum limit.
+ * - The size of the sending buffer has exceeded the maximum limit.
+ * - The number of sending requests have exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The recommended data size is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.\r
+ * @remarks The recommended data size is under 16KB because a severe system performance degradation may occur for larger messages. @n
+ * @c E_MAX_EXCEEDED may be returned for messages over 16KB.
*/
result Delete(const Tizen::Base::String& dataId, const Tizen::Base::String* pWhere, RequestId& reqId);
*
* @return An error code
* @param[in] pListener The data control callback listener @n
- * Some data controls need to get the callback result by implementing
+ * Some data controls get the callback result by implementing
* the ISqlDataControlResponseListener interface.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance has not been properly constructed.
+ * @exception E_INVALID_STATE This instance has not been constructed properly.
* @exception E_SYSTEM A system error has occurred.
*/
result SetSqlDataControlResponseListener(ISqlDataControlResponseListener* pListener);
/**
* @file FAppTypes.h
- * @brief This is the header file for the enumerations of the App class.
+ * @brief This is the header file for the enumerations of the %App class.
*
- * This header file contains the declarations of the enumerations of the App class.
+ * This header file contains the declarations of the enumerations of the App class.
* @see Application
*/
/**
* @if OSPDEPREC
* The application secret
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This type is deprecated because the associated App::GetAppSecret() method is deprecated.
*
- * @since 2.0
+ * @since 2.0
* @endif
*/
typedef Tizen::Base::String AppSecret;
{
INITIALIZING, /**< The application has been launched */
RUNNING, /**< The application has been initialized and is currently being executed */
- TERMINATING, /**< The application is about to exit and releases its resources and saves its preferences */
- TERMINATED /**< The application has been destroyed */
+ TERMINATING, /**< The application is about to exit, release its resources, and save its preferences */
+ TERMINATED /**< The application has been destroyed */
};
/**
*/
enum AppUiState
{
- APP_UI_STATE_FOREGROUND = 0x01, /**< The application is completely visible on foreground */
+ APP_UI_STATE_FOREGROUND = 0x01, /**< The application is completely visible in the foreground */
APP_UI_STATE_PARTIAL_BACKGROUND = 0x02, /**< The application is partially hidden by another window, such as a system pop-up */
- APP_UI_STATE_BACKGROUND = 0x04 /**< The application is completely hidden by a full-screen window, usually by another application or an application control */
+ APP_UI_STATE_BACKGROUND = 0x04 /**< The application is completely hidden by a full-screen window, usually by another application, or an application control */
};
/**
{
APP_CTRL_RESULT_SUCCEEDED = 0x00, /**< The application operation is successful */
APP_CTRL_RESULT_FAILED = 0x01, /**< The application operation has failed */
- APP_CTRL_RESULT_CANCELED = 0x02, /**< The application operation is canceled by the callee application */
- APP_CTRL_RESULT_TERMINATED = 0x04, /**< The callee application is terminated without sending the result */
+ APP_CTRL_RESULT_CANCELED = 0x02, /**< The application operation is cancelled by the calling application */
+ APP_CTRL_RESULT_TERMINATED = 0x04, /**< The calling application is terminated without sending the result */
APP_CTRL_RESULT_ABORTED = 0x08, /**< The application operation is aborted by the platform */
};
/**
* @if OSPDEPREC
* The application launch request ID. @n
- * Represents the application launch arguments in App::App::OnUserEventReceivedN().
+ * Represents the application launch arguments in the App::App::OnUserEventReceivedN() method.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This variable is deprecated. From %Tizen API version 2.1, App::App::OnUserEventReceivedN()
- * is not invoked for the request from application and %AppLaunchRequestId is not used anymore.
+ * @deprecated This variable is deprecated. From Tizen API version 2.1, the App::App::OnUserEventReceivedN()
+ * method is not invoked for the request from the application and the %AppLaunchRequestId() method is not used anymore.
* Instead, use IAppControlProviderEventListener.
- * @since 2.0
+ * @since 2.0
*
- * @see App::App::OnUserEventReceivedN()
* @endif
*/
const long AppLaunchRequestId = (-0xFFFF);
/**
* @if OSPDEPREC
- * Defines the launch type - normal launch.
+ * Defines the launch type, for example, normal launch.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of using this variable, it is recommended to use IAppControlProviderEventListener to acquire the launch information.
- * @since 2.0
+ * @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APP_LAUNCH_NORMAL;
/**
* @if OSPDEPREC
- * Defines the launch type - conditional launch.
+ * Defines the launch type, for example, conditional launch.
*
* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
*
* @since 2.0
*
- * The %UiApp class is the base class of a %Tizen native UI application.
+ * The %UiApp class is the base class of a %Tizen native UI application.@n
* A %Tizen native UI application must inherit from the %UiApp class. This class provides the basic features necessary to define the
* %Tizen native UI application.
- * @n
+ *
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/app/app_namespace.htm">App Guide</a> and <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/tizen_app_model/application_model.htm">Native Application Model</a>.
*
*/
virtual ~UiApp(void);
/**
- * Gets the first frame in the frame list of the UI application.
+ * Gets the first frame to the frame list of the UI application.
*
- * @since 2.0
+ * @since 2.0
*
- * @return A pointer to the IAppFrame interface of the frame, @n
- * else @c null if it fails
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE The frame has not been properly initialized.
- * @exception E_OBJ_NOT_FOUND The frame is not found.
+ * @return A pointer to the IAppFrame instance of the frame, @n
+ * else @c null if it fails
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE The frame has not been initialized properly.
+ * @exception E_OBJ_NOT_FOUND The frame has not been found.
*/
IAppFrame* GetAppFrame(void) const;
/**
- * Adds the frame to the end of the list that is maintained by the UI application.
+ * Adds a frame to the end of the list that is maintained by the UI application.
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @param[in] frame The frame that is added to the UI application
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @param[in] frame The frame to remove
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified @c frame cannot be found.
/**
* Gets the list of the frames of the UI application.
*
- * @since 2.0
+ * @since 2.0
*
- * @return A pointer to Tizen::Base::Collection::IList that contains Tizen::Ui::Frame instances, @n
- * else @c null if it fails
+ * @return A pointer to the Tizen::Base::Collection::IList that contains the Tizen::Ui::Frame instances, @n
+ * else @c null if it fails
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE The application is in an invalid state.
* @remarks The specific error code can be accessed using the GetLastResult() method.
/**
* Gets the frame with the specified @c name.
*
- * @since 2.0
+ * @since 2.0
*
- * @return A pointer to the frame having the specified @c name, @n
- * else @c null if it fails
+ * @return A pointer to the frame that contains the specified @c name, @n
+ * else @c null if it fails
* @param[in] name The name of the frame
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified @c frame cannot be found.
Tizen::Ui::Controls::Frame* GetFrame(const Tizen::Base::String& name) const;
/**
- * Gets the frame at the specified @c index of the list.
+ * Gets the frame at the specified @c index in the list.
*
- * @since 2.0
+ * @since 2.0
*
- * @return A pointer to the frame at the specified @c index, @n
- * else @c null if it fails
+ * @return A pointer to the frame at the specified @c index, @n
+ * else @c null if it fails
* @param[in] index The index of the frame
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the frame list.
* @since 2.0
*
* @return The UI state of the UI application
- * @remarks Note that UiApp::OnBackground() is invoked when the UI state of a UI application changes
- * from App::APP_UI_STATE_FOREGROUND to App::APP_UI_STATE_PARTIAL_BACKGROUND or App::APP_UI_STATE_BACKGROUND.
+ * @remarks Note that the UiApp::OnBackground() method is invoked when the UI state of the UI application changes
+ * from App::APP_UI_STATE_FOREGROUND to App::APP_UI_STATE_PARTIAL_BACKGROUND, or App::APP_UI_STATE_BACKGROUND.
*/
AppUiState GetAppUiState(void) const;
/**
- * Called when a UI application moves to the foreground. @n
+ * Called when the UI application moves to the foreground. @n
* User interaction is enabled when the UI application moves to the foreground. @n
* A UI application moves to the foreground when:
*
- * - A UI application is selected from the Task Switcher.
- * - A UI application icon in the Launcher application is pressed when it is running in the background.
- * - A UI application is to be launched while it is running in the background.
- * - A system pop-up, such as an incoming call, notification (for example, SMS), or a low battery warning
- * pop-up disappears.
+ * - The UI application is selected from the Task Switcher.
+ * - The UI application icon in the Launcher application is pressed when it is running in the background.
+ * - The UI application is to be launched while it is running in the background.
+ * - A system pop-up, such as an incoming call, a notification (for example, an SMS), or a low battery warning
+ * pop-up disappears.
*
- * When this method is invoked, the following actions are recommended:
+ * When the %OnForeground() method is invoked, the following actions are recommended:
*
* - Resume the graphic processing, such as 3D or animation, as the UI application now has the focus.
* - Resume the operations that stopped when the UI application is last moved to the background.
* A UI application moves to the background when:
*
* - A system pop-up, such as an incoming call or a low battery warning pop-up is displayed.
- * - A device is locked.
+ * - The device is locked.
* - The Home key is pressed.
*
- * Whenever this method is invoked, the following actions are recommended:
+ * When the %OnBackground() method is invoked, the following actions are recommended:
*
* - Stop the graphic processing, such as 3D or animation, as they will not be displayed.
* - Release unnecessary resources.
*
* @since 2.0
*
- * @remarks When notification (for example, SMS) pops up, this method is not called.
- * When a system pop-up is displayed, a UI application becomes partially hidden
- * (App::APP_UI_STATE_PARTIAL_BACKGROUND).
- * If a UI application is partially hidden, it is recommended to hold the activated
- * tasks or resources instead of stopping or releasing them.
+ * @remarks
+ * - When a notification (for example, an SMS) pops up, this method is not called.
+ * - When a system pop-up is displayed, the UI application becomes partially hidden (App::APP_UI_STATE_PARTIAL_BACKGROUND).
+ * - If the UI application is partially hidden, it is recommended to hold the activated tasks or resources instead of stopping or releasing them.
* @see GetAppUiState()
*/
virtual void OnBackground(void);
/**
- * Gets the %UiApp instance's pointer.
+ * Gets a pointer to the %UiApp instance.
*
* @since 2.0
*
/**
* Executes an application implemented by inheriting this class.
- * The %Execute() method must be called from the entry method - OspMain(), which is generated by IDE.
+ * The %Execute() method must be called from the entry method, that is, OspMain(), which is generated by IDE.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] pUiAppFactory The factory method that creates this UiApp's instance
- * @param[in] pArguments The launch arguments for %App
+ * @return An error code
+ * @param[in] pUiAppFactory The factory method that creates this UiApp instance
+ * @param[in] pArguments The launch arguments for the application
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INIT_FAILED The initialization failure during OnAppInitializing().
+ * @exception E_INIT_FAILED A failure occurred while initializing using the OnAppInitializing() method.
* @exception E_SYSTEM A system error has occurred.
*/
static result Execute(UiAppInstanceFactory pUiAppFactory, const Tizen::Base::Collection::IList* pArguments);
* @since 2.0
*
* @remarks @b Header @b %file: @b \#include @b <FBase.h> @n
- * @b Library : @b osp-appfw
+ * @b Library: @b osp-appfw
*
*
* The %Runtime namespace contains classes for running applications.
* The runtime environment includes threading, synchronization objects,
* and timer.
*
- * For more information on the %
Base::Runtime namespace features, see <a href="../org.tizen.native.appprogramming/html/guide/base/runtime_namespace.htm">Runtime</a>.
+ * For more information on the %Runtime namespace features, see <a href="../org.tizen.native.appprogramming/html/guide/base/runtime_namespace.htm">Runtime</a>.
*
* The following diagram illustrates the relationships between the classes belonging to the %Runtime namespace.
* @image html base_runtime_namespace_classdiagram.png
* @file FBaseRtEvent.h
* @brief This is the header file for the %Event class.
*
- * This file contains the declarations of the %Event class.
+ * This header file contains the declarations of the %Event class.
*/
#ifndef _FBASE_RT_EVENT_H_
class IEventListener;
/**
* @class Event
-* @brief This class provides methods for notifying events with argument to its listeners.
+* @brief This class provides methods for notifying events with arguments to its listeners.
* @since 2.0
*
-* The %Event class provides methods for notifying events with argument to its listeners.
-* Because bounded to either default thread or event-driven thread, it cannot be created on worker thread.
-* It supports two types of listeners; one is called on the thread where the event is fired, and another is called on the thread where the listener was registered.
+* The %Event class provides methods for notifying events with arguments to its listeners.
+* Because it is bounded to either a default thread or an event-driven thread, it cannot be created on a worker thread.
+* It supports two types of listeners; one is called on the thread where the event is fired, and another is called on the thread where the listener is registered.
*
* @code
*
* @since 2.0
*
* @return An error code
- * @param[in] listener Listener to add
- * @param[in] calledByCallerThread true, to call the listener on the caller thread of this method
- * false, to call the listener on the thread in which the event is fired.
- * @exception E_SUCCESS This method is successful.
+ * @param[in] listener The listener to add
+ * @param[in] calledByCallerThread Set to @c true, to call the listener on the caller thread of this method, @n
+ * else @c false, to call the listener on the thread in which the event is fired.
+ * @exception E_SUCCESS The method is successful.
* @exception E_OBJ_ALREADY_EXIST The listener already exists.
- * @exception E_INVALID_OPERATION calledByCallerThread is set to true but the caller thread is a worker thread.
+ * @exception E_INVALID_OPERATION The specified @c calledByCallerThread is @c true but the caller thread is a worker thread.
*/
result AddListener(IEventListener& listener, bool calledByCallerThread = true);
* @since 2.0
*
* @return An error code
- * @param[in] listener Listener to remove
- * @exception E_SUCCESS This method is successful.
- * @exception E_OBJ_NOT_FOUND The listener is not found.
+ * @param[in] listener The listener to remove
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The listener has not been found.
*/
result RemoveListener(IEventListener& listener);
* @since 2.0
*
* @return An error code
- * @param[in] arg The event argument.
- * @exception E_SUCCESS This method is successful.
- * @exception E_INVALID_STATE This event has not been initialized.
+ * @param[in] arg The event argument
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE This event has not been initialized.
*
- * @remarks This takes the ownership of @c arg. So arg should be created on a heap and should not be deleted by caller.
+ * @remarks This takes the ownership of @c arg. @n
+ * So @c arg should be created on a heap and should not be deleted by caller.
*/
result Fire(IEventArg& arg);
/**
* @class EventDrivenThread
- * @brief This class is the fundamental class for the asynchronous execution of a thread.
+ * @brief This class is the fundamental class for the asynchronous execution of a thread.
*
* @since 2.0
*
* @param[in] stackSize The thread stack size
* @param[in] priority The thread priority
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG An invalid argument is passed.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
*/
result Construct(long stackSize = DEFAULT_STACK_SIZE, ThreadPriority priority = THREAD_PRIORITY_MID);
* @since 2.0
*
* @return An error code
- * @param[in] name The name of the thread
+ * @param[in] name The name of the thread
* @param[in] stackSize The thread stack size
* @param[in] priority The thread priority
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG An invalid argument is passed.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
*/
result Construct(const Tizen::Base::String& name, long stackSize = DEFAULT_STACK_SIZE, ThreadPriority priority = THREAD_PRIORITY_MID);
/**
* Called before the message loop is started. @n
- * If this method returns @c false, the thread is terminated immediately.
+ * If the %OnStart() method returns @c false, the thread is terminated immediately.
*
* @since 2.0
*
- * @return @c true if this thread can be run, @n
- * else @c false
- * @remarks You can initialize the event or event listener in this method for running this thread.
+ * @return @c true if this thread runs, @n
+ * else @c false
+ * @remarks The event or event listener in this method can be initialized for running this thread.
*
*/
virtual bool OnStart(void);
*
* @since 2.0
*
- * @remarks You can finalize the event or event listener in this method for running this thread.
+ * @remarks The event or event listener in this method can be finalized for running this thread.
*
*/
virtual void OnStop(void);
* If overridden, it may not work as expected.
*
* @return An error code
- * @param[in] requestId The user-defined event ID
- * @param[in] pArgs A pointer to a list of arguments
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE The thread is in an invalid state.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SYSTEM A system error has occurred.
+ * @param[in] requestId The user-defined event ID
+ * @param[in] pArgs A pointer to the list of arguments
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE The thread is in an invalid state.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_SYSTEM A system error has occurred.
*
* @see OnUserEventReceivedN()
*/
* @since 2.0
*
* @param[in] requestId The user-defined event ID
- * @param[in] pArgs A pointer to a list of arguments
+ * @param[in] pArgs A pointer to the list of arguments
*
* @see SendUserEvent()
*/
{
/**
* @interface IEventArg
-* @brief This interface is a tagging interface that all event argument must implement.
+* @brief This interface is a tagging interface that all event arguments must implement.
*
-* @since 2.0
+* @since 2.0
*
-* The %IEventArg interface is a tagging interface that all event argument must implement.
+* The %IEventArg interface is a tagging interface that all event arguments must implement.
*/
class IEventArg
{
//
/**
- * @file FBaseRtIEventListener.h
- * @brief This is the header file for the %IEventListener interface.
+ * @file FBaseRtIEventListener.h
+ * @brief This is the header file for the %IEventListener interface.
*
* This header contains the declarations of the %IEventListener interface.
*/
* @since 2.0
*
* The %IEventListener interface is a tagging interface that all event listeners must implement.
- * The event listener can listen when the specific event occurs. The event listener
+ * The event listener can listen when a specific event occurs. The event listener
* has several methods, and each method is called when a specific event occurs.
*
*/
{
/**
* @interface IRunnable
- * @brief This interface is the basic unit of the task. Also, it is the execution unit of
- * the thread. This interface must be inherited by the class whose instances will
+ * @brief This interface is the basic unit of a task. Also, it is the execution unit of
+ * the thread. This interface must be inherited by the class whose instances are
* run on the thread.
*
* @since 2.0
*
* @remarks Classes which inherit the %IRunnable interface must implement the Run() method.
*
- * The %IRunnable interface is the basic unit of the task. Also, it is the execution unit of
- * the thread. This interface must be inherited by the class whose instances will
+ * The %IRunnable interface is the basic unit of a task. Also, it is the execution unit of
+ * the thread. This interface must be inherited by the class whose instances are
* run on the thread.
* @n
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/thread_programming.htm">Thread Programming</a>.
/**
* Runs the task. @n
- * This method is an executable body of the task. In many cases, this method is called by the thread.
+ * The %Run() method is an executable body of the task. In many cases, this method is called by the thread.
* Although this method can return the result of the execution, the returned value might be discarded
* by the executor of this task.
*
* @since 2.0
*
* @return A pointer to the result of the task, @n
- * else @c null
+ * else @c null if it fails
*/
virtual Tizen::Base::Object* Run(void) = 0;
}; // IRunnable
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/timer.htm">Timer</a>.
*
- * @see Timer()
+ * @see Timer
*/
class _OSP_EXPORT_ ITimerEventListener
: virtual public IEventListener
*
* @since 2.0
*
- * @param[in] timer The timer that has expired
+ * @param[in] timer The expired timer
*/
virtual void OnTimerExpired(Timer& timer) = 0;
* @file FBaseRtIWaitingLoopCondition.h
* @brief This is the header file for the %IWaitingLoopCondition interface.
*
+ * This header file contains the declarations of the %IWaitingLoopCondition interface.
*/
#ifndef _FBASE_RT_WAITING_LOOP_CONDITION_H_
#define _FBASE_RT_WAITING_LOOP_CONDITION_H_
{
/*
* @interface IWaitingLoopCondition
- * @brief This interface provides the method to check whether the WaitingLoopCondition is met.
+ * @brief This interface provides a method to check whether the WaitingLoopCondition is met.
*
* @since 2.0
*/
{
public:
/*
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
virtual ~IWaitingLoopCondition(void) {}
/*
- * Check whether the waiting loop condition is met
+ * Checks whether the waiting loop condition is met.
*
* @since 2.0
*
{
/**
* @class Library
- * @brief This is the class for shared library.
+ * @brief This is the class for the shared library.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
* The %Library class loads the shared library with the given file path.
- * It loads the library in current process' memory space, and application can use this library explicitly.
+ * It loads the library in current process' memory space, and the application can use this library explicitly.
*/
class _OSP_EXPORT_ Library
: public Tizen::Base::Object
*
* @since 2.0
*
- * @return An error code
- * @param[in] libraryPath The path of the library file
+ * @return An error code
+ * @param[in] libraryPath The path of the library file
* @exception E_SUCCESS The method is successful.
* @exception E_LIBRARY_NOT_FOUND The library cannot be found.
* @exception E_INVALID_ARG The specified @c libraryPath is an empty string.
*
* @since 2.0
*
- * @return The address of the specified symbol
- * @param[in] symbol The symbol name
+ * @return The address of the specified symbol
+ * @param[in] symbol The symbol name
* @exception E_SUCCESS The method is successful.
* @exception E_SYMBOL_NOT_FOUND The symbol cannot be found.
* @exception E_INVALID_ARG The specified @c symbol is an empty string.
enum MemoryProtectionMode
{
MEMORY_PROTECTION_MODE_NONE = 0x0, /**< The memory cannot be accessed */
- MEMORY_PROTECTION_MODE_READ = 0x1, /**< The memory can be read */
- MEMORY_PROTECTION_MODE_WRITE = 0x2, /**< The memory can be modified */
- MEMORY_PROTECTION_MODE_EXEC = 0x4, /**< The memory can be executed */
+ MEMORY_PROTECTION_MODE_READ = 0x1, /**< The memory can be read */
+ MEMORY_PROTECTION_MODE_WRITE = 0x2, /**< The memory can be modified */
+ MEMORY_PROTECTION_MODE_EXEC = 0x4, /**< The memory can be executed */
};
/**
- * @class MemoryManager
+ * @class MemoryManager
* @brief This class represents a memory manager for runtime.
*
* @since 2.0
{
public:
/**
- * Changes protection on a memory region.
+ * Changes the protection on a memory region.
*
* @since 2.0
*
* @return An error code
- * @param[in] pAddress The start address of the memory region aligned on a page boundary.
+ * @param[in] pAddress The start address of the memory region aligned on a page boundary
* @param[in] length The length of the memory region in bytes
* @param[in] protection The memory protection @n
* It is either Tizen::Base::Runtime::MEMORY_PROTECTION_MODE_NONE or a bitwise OR of the
* other values in Tizen::Base::Runtime::MemoryProtectionMode.
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred due to an invalid address.
- * @exception E_INVALID_ARG The memory address is not valid, or the length is not a multiple of system page size.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The memory address is invalid.
+ * - The specified @c length is not a multiple of the system page size.
*/
static result ProtectMemory(const void* pAddress, long long length, unsigned long protection);
*
* @final This class is not intended for extension.
*
- * The %Monitor class represents a monitor. %Monitor is a synchronization mechanism that provides acquire/release semantics by Enter() / Exit() as well as wait/notify semantics by Wait() / Notify() / NotifyAll().
+ * The %Monitor class represents a monitor. A %Monitor is a synchronization mechanism that provides acquire and release semantics by Enter() and Exit() as well as wait and notify semantics by Wait(), Notify(), and NotifyAll().
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/monitor.htm">Monitor</a>.
*
- * The following examples demonstrates how to use the %Monitor class. In the examples, 2 classes, Consumer and Producer, share a space.
+ * The following examples demonstrates how to use the %Monitor class. In the examples, two classes, Consumer and Producer, share a space.
* Producer writes some data to this space, and Consumer reads it. Consumer and Producer run simultaneously.
* Consumer must not miss the data which Producer writes. In this case, Consumer and Producer share the monitor.
* Producer notifies Consumer that its writing action is done. Consumer waits for this notification, and reads the data after receiving it.
* @since 2.0
*
* @return An error code
- * @exception E_SUCCESS The method is successful.
+ * @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SYSTEM A system error has occurred.
*/
result Construct(void);
/**
- * Acquires a lock for a monitor. @n
- * Semantically, this method declares the beginning of the critical region for the monitor. This region
+ * Acquires a lock for the monitor. @n
+ * Semantically, the %Enter() method declares the beginning of the critical region for the monitor. This region
* ends with the Exit() method.
*
* @since 2.0
*
* @return An error code
- * @exception E_SUCCESS The method is successful in acquiring the lock.
+ * @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method will block if called on already locked monitor object until monitor becomes available.
+ * @remarks This method blocks if called on an already locked monitor object until the monitor becomes available.
* @see Exit()
*/
result Enter(void);
/**
- * Releases a lock for a monitor. @n
+ * Releases the lock for the monitor. @n
* Semantically, it declares the ending of the critical region for the monitor that begins with
* the Enter() method.
*
* @since 2.0
*
* @return An error code
- * @exception E_SUCCESS The method is successful in releasing the lock.
+ * @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method should be called only after acquiring lock by Enter() call
+ * @remarks This method should be called only after acquiring the lock by the Enter() call.
* @see Enter()
*/
result Exit(void);
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method should be called only after acquiring lock by Enter() call
+ * @remarks This method should be called only after acquiring the lock by the Enter() call.
* @see Notify()
* @see NotifyAll()
*/
/**
- * Notifies all waiting threads.
+ * Notifies all the waiting threads.
*
* @since 2.0
*
/**
* @class MonitorGuard
-* @brief This class is the RAII style class for %Monitor class.
+* @brief This class is the RAII style class for the Monitor class.
*
* @since 2.0
*/
*
* @since 2.0
*
- * @param[in] m The %Monitor instance to be manipulated
+ * @param[in] m A Monitor instance to manipulate
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see Monitor::Enter() for detailed exceptions
*/
}
/**
- * Returns whether this instance owns the lock on the given monitor at constructor.
+ * Checks whether this instance owns the lock on the given monitor at constructor.
*
* @since 2.0
*
* @return true if the lock is owned, @n
- * false otherwise.
+ * else @c false
*/
bool IsEntered(void) const
{
}
/**
- * Returns whether this instance owns the lock on the given monitor at constructor. @n
- * Have same effects to calling IsEntered().
+ * Checks whether this instance owns the lock on the given monitor at constructor. @n
+ * This method has the same effects when calling IsEntered().
*
* @since 2.0
*/
/**
* @struct NonRecursiveMutexTag
*
- * This struct is used only for providing the non-recursive type of mutex.
- * A non-recursive mutex is a mutex that can not be acquired multiple times by the locking thread. It returns an exception if the locking thread tries to lock the same mutex.
+ * This struct is used only for providing the non-recursive type of the mutex.
+ * A non-recursive mutex is a mutex that cannot be acquired multiple times by the locking thread. It returns an exception if the locking thread tries to lock the same mutex.
*
* @since 2.1
*
/**
* Creates an unnamed mutex which is a recursive mutex that can be acquired multiple times by the locking thread.
- * It keeps the number of getting locked and you must unlock it the same number of times.
+ * It keeps the number of locks and you must unlock it the same number of times.
*
* @since 2.0
*
- * @return An error code
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SYSTEM A system error has occurred.
*/
result Create(void);
*
* @since 2.1
*
- * @return An error code
+ * @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
*/
/**
* Creates a named mutex which is a recursive mutex that can be acquired multiple times by the locking thread.
- * It keeps the number of getting locked and you must unlock it the same number of times. @n
+ * It keeps the number of locks and you must unlock it the same number of times. @n
* If a mutex with the specified name already exists, this creates a mutex which references that particular mutex.
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @param[in] name The name of the mutex
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
*/
result Create(const Tizen::Base::String& name);
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks This method should be called only after acquiring lock by Acquire()/ TryToAcquire() call
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks This method should be called only after acquiring a lock by calling Acquire() or TryToAcquire().
*/
result Release(void);
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method will block if called on already locked monitor object until mutex becomes available.
+ * @remarks This method blocks if called on an already locked monitor object until the mutex becomes available.
*/
result Acquire(void);
/**
* Tries to acquire the mutex if it is not acquired. @n
- * If the mutex is already acquired by another thread, E_OBJECT_LOCKED is returned.
+ * If the mutex is already acquired by another thread, @c E_OBJECT_LOCKED is returned.
*
* @since 2.0
*
- * @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJECT_LOCKED The mutex is already locked.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks This method will block if called on already locked monitor object until mutex becomes available.
+ * @return An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJECT_LOCKED The mutex is already locked.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks This method blocks if called on an already locked monitor object until the mutex becomes available.
*/
result TryToAcquire(void);
/**
* @class MutexGuard
-* @brief This class is the RAII style class for %Mutex class.
+* @brief This class is the RAII style class for the %Mutex class.
*
* @since 2.0
*
-* The following example demonstrates how to use this %MutexGuard class
+* The following example demonstrates how to use the %MutexGuard class
*
* @code
*
*
* @since 2.0
*
- * @param[in] m The %Mutex instance to be manipulated
+ * @param[in] m A %Mutex instance to manipulate
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see Mutex::Acquire() for detailed exceptions
*/
*
* @since 2.0
*
- * @param[in] m The %Mutex instance to be manipulated
+ * @param[in] m A %Mutex instance to be manipulated
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see Mutex::TryToAcquire() for detailed exceptions
*/
}
/**
- * This destructor releases the lock if acquired when going out of a scope
+ * This destructor releases the lock if acquired when going out of the scope
*
* @since 2.0
*
}
/**
- * Returns whether this instance owns the lock on the given mutex at constructor.
+ * Checks whether this instance owns the lock on the given mutex at constructor.
*
* @since 2.0
*
- * @return true if the lock is owned, @n
- * false otherwise.
+ * @return @c true if the lock is owned, @n
+ * else @c false
*/
bool IsLocked(void) const
{
}
/**
- * Returns whether this instance owns the lock on the given mutex at constructor. @n
- * Have same effects to calling IsLocked().
+ * Checks whether this instance owns the lock on the given mutex at constructor. @n
+ * Has the same effects as calling IsLocked().
*
* @since 2.0
*/
}
/**
- * Acquires the lock manually on the given mutex at constructor in a blocking way
+ * Acquires the lock manually on the given mutex at constructor in a blocking way.
*
* @since 2.0
*
- * @return An error code.
+ * @return An error code
* @see Mutex::Acquire() for detailed exceptions
*/
result Lock(void)
*
* @since 2.0
*
- * @return An error code.
+ * @return An error code
* @see Mutex::TryToAcquire() for detailed exceptions
*/
result TryToLock(void)
*
* @since 2.0
*
- * @return An error code.
+ * @return An error code
* @see Mutex::Release() for detailed exceptions
*/
result Unlock(void)
{
/**
* @class Semaphore
- * @brief This class represents semaphore, a type of synchronization mechanisms. It can provide the acquiring semantics. @n
+ * @brief This class represents a semaphore, that is, a type of synchronization mechanism. It can provide the acquiring semantics. @n
*
* @since 2.0
*
* @final This class is not intended for extension.
*
* The %Semaphore class represents a semaphore; a type of synchronization mechanism.
- * It can provide the acquiring semantics. The semaphore allows the N threads to acquire the semaphore simultaneously.
+ * It can provide the acquiring semantics. The semaphore allows N threads to acquire the semaphore simultaneously.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/mutex_and_semaphore.htm">Mutex and Semaphore</a>.
*
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @param[in] count The number of threads that can acquire the semaphore simultaneously @n
* If the count is @c 1, then it is the same as a mutex.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c count is less than @c 0.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
*/
result Create(int count = 1);
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @param[in] name The name of the semaphore
* @param[in] count The number of threads that can acquire the semaphore simultaneously
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c count is less than @c 0.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
*/
result Create(const Tizen::Base::String& name, int count = 1);
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @param[in] timeout The period during which the thread tries to acquire the semaphore
* @exception E_SUCCESS The method is successful.
- * @exception E_TIMEOUT The operation cannot be completed within the specified time period. @n
- * The method has failed to acquire the semaphore because the given time has elapsed.
+ * @exception E_TIMEOUT Either of the following conditions has occurred:
+ * - The operation cannot be completed within the specified time period.
+ * - The method has failed to acquire the semaphore because the given time has elapsed.
* @exception E_SYSTEM A system error has occurred.
*/
result Acquire(long timeout = INFINITE);
/**
* Tries to acquire the semaphore. @n
- * If the semaphore is already acquired by another thread, E_OBJECT_LOCKED is returned.
+ * If the semaphore is already acquired by another thread, @c E_OBJECT_LOCKED is returned.
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJECT_LOCKED The semaphore is already locked.
+ * @exception E_OBJECT_LOCKED The semaphore is already locked.
* @exception E_SYSTEM A system error has occurred.
*/
result TryToAcquire(void);
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
*/
/**
* @class SemaphoreGuard
-* @brief This class is the RAII style class for %Semaphore class.
+* @brief This class is the RAII style class for the %Semaphore class.
*
* @since 2.0
*/
{
public:
/**
- * This constructor acquires a semaphore count in a blocking way.
- *
- * @since 2.0
- *
- * @param[in] s The %Semaphore instance to be manipulated
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see Semaphore::Acquire() for detailed exceptions
- */
+ * This constructor acquires a semaphore count in a blocking way.
+ *
+ * @since 2.0
+ *
+ * @param[in] s A Semaphore instance to manipulate
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @see Semaphore::Acquire() for detailed exceptions
+ */
SemaphoreGuard(Semaphore& s)
: __s(s)
, __acquired(false)
}
/**
- * This constructor acquires a semaphore count in a non-blocking way.
- *
- * @since 2.0
- *
- * @param[in] s The %Semaphore instance to be manipulated
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see Semaphore::TryToAcquire() for detailed exceptions
- */
+ * This constructor acquires a semaphore count in a non-blocking way.
+ *
+ * @since 2.0
+ *
+ * @param[in] s A Semaphore instance to manipulate
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @see Semaphore::TryToAcquire() for detailed exceptions
+ */
SemaphoreGuard(Semaphore& s, TryTag)
: __s(s)
, __acquired(false)
}
/**
- * This destructor releases the acquired semaphore count when going out of a scope
- *
- * @since 2.0
- *
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see Semaphore::Release() for detailed exceptions
- */
+ * This destructor releases the acquired semaphore count when going out of the scope
+ *
+ * @since 2.0
+ *
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @see Semaphore::Release() for detailed exceptions
+ */
~SemaphoreGuard(void)
{
SetLastResult(Release());
}
/**
- * Returns whether this instance owns a semaphore count on the given semaphore at constructor.
- *
- * @since 2.0
- *
- * @return true if a semaphore is owned, @n
- * false otherwise.
- */
+ * Checks whether this instance owns a semaphore count on the given semaphore at constructor.
+ *
+ * @since 2.0
+ *
+ * @return @c true if a semaphore is owned, @n
+ * else @c false
+ */
bool IsAcquired(void) const
{
return __acquired;
}
/**
- * Returns whether this instance owns a semaphore count on the given semaphore at constructor. @n
- * Have same effects to calling IsAcquired().
- *
- * @since 2.0
- */
+ * Checks whether this instance owns a semaphore count on the given semaphore at constructor. @n
+ * Has the same effects as calling IsAcquired().
+ *
+ * @since 2.0
+ */
operator bool() const
{
return IsAcquired();
}
/**
- * Acquires a semaphore count manually on the given semaphore at constructor in a blocking way
- *
- * @since 2.0
- *
- * @return An error code.
- * @see Semaphore::Acquire() for detailed exceptions
- */
+ * Acquires a semaphore count manually on the given semaphore at constructor in a blocking way.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @see Semaphore::Acquire() for detailed exceptions
+ */
result Acquire(void)
{
return SetAcquiredAndReturn(__s.Acquire());
}
/**
- * Acquires a semaphore count manually on the given semaphore at constructor in a non-blocking way
- *
- * @since 2.0
- *
- * @return An error code.
- * @see Semaphore::TryToAcquire() for detailed exceptions
- */
+ * Acquires a semaphore count manually on the given semaphore at constructor in a non-blocking way.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @see Semaphore::TryToAcquire() for detailed exceptions
+ */
result TryToAcquire(void)
{
return SetAcquiredAndReturn(__s.TryToAcquire());
}
/**
- * Releases the acquired semaphore count manually
- *
- * @since 2.0
- *
- * @return An error code.
- * @see Semaphore::Release() for detailed exceptions
- */
+ * Releases the acquired semaphore count manually
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @see Semaphore::Release() for detailed exceptions
+ */
result Release(void)
{
result r = E_SUCCESS;
*/
enum ThreadType
{
- THREAD_TYPE_WORKER = 0, /**< @if OSPDEPREC The worker thread mode @endif */
- THREAD_TYPE_EVENT_DRIVEN, /**< @if OSPDEPREC The event-driven thread mode @endif */
+ THREAD_TYPE_WORKER = 0, /**< @if OSPDEPREC The worker thread mode @endif */
+ THREAD_TYPE_EVENT_DRIVEN, /**< @if OSPDEPREC The event-driven thread mode @endif */
THREAD_TYPE_MAIN // This enum value is for internal use only. Using this enum value can cause behavioral,
// security-related, and consistency-related issues in the application.
// The main thread mode
* @remarks This class supports only worker threads. For event-driven threads, use the EventDrivenThread class.
*
* The %Thread class is the fundamental class for the asynchronous execution of a thread.
- * A Tizen native application can execute several threads during its operation from the multi-threading view.
+ * A %Tizen native application can execute several threads during its operation from the multi-threading view.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/thread.htm">Thread</a>.
*
*
* @return An error code
* @param[in] milliSeconds The time, in milliseconds, for which to suspend the execution @n
- * A value of zero causes the thread to relinquish the remainder of its time
- * slice to any other thread that is ready to run. The time cannot be negative.
+ * The value of zero causes the thread to relinquish the remainder of its time
+ * slice to any other thread that is ready to run @n
+ * The time cannot be negative.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A negative time value is passed.
+ * @exception E_INVALID_ARG A negative time value has been passed.
*/
static result Sleep(long milliSeconds);
static result Exit(int exitCode = 0x00);
/**
- * Gets the pointer of the currently running %Thread instance.
+ * Gets a pointer of the currently running %Thread instance.
*
* @since 2.0
*
* Initializes this instance of %Thread with the specified thread type, stack size, and priority.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because the %Thread class does not support event-driven thread any more. Instead, use the EventDrivenThread class instead.
+ * @deprecated This method is deprecated because the %Thread class does not support event-driven threads any more. Instead, use the EventDrivenThread class.
*
* @since 2.0
*
* @param[in] stackSize The thread stack size
* @param[in] priority The thread priority
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG An invalid argument is passed.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @endif
*/
* Initializes this instance of %Thread with the specified name, thread type, stack size, and priority.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because the %Thread class does not support event-driven thread any more. Instead, use the EventDrivenThread class instead.
+ * @deprecated This method is deprecated because the %Thread class does not support event-driven threads any more. Instead, use the EventDrivenThread class.
*
* @since 2.0
*
* @param[in] stackSize The thread stack size
* @param[in] priority The thread priority
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG An invalid argument is passed.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @endif
*/
* @param[in] stackSize The thread stack size
* @param[in] priority The thread priority
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG An invalid argument is passed.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
*/
result Construct(long stackSize = DEFAULT_STACK_SIZE, ThreadPriority priority = THREAD_PRIORITY_MID);
* @param[in] stackSize The thread stack size
* @param[in] priority The thread priority
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG An invalid argument is passed.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
*/
result Construct(const Tizen::Base::String& name,
* @param[in] stackSize The thread stack size
* @param[in] priority The thread priority
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG An invalid argument is passed.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
*/
result Construct(IRunnable& target, long stackSize = DEFAULT_STACK_SIZE, ThreadPriority priority = THREAD_PRIORITY_MID);
*
* @since 2.0
*
- * @return An error code
- * @param[in] name The name of the thread
+ * @return An error code
+ * @param[in] name The name of the thread
* @param[in] target An instance of IRunnable
* @param[in] stackSize The thread stack size
* @param[in] priority The thread priority
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG An invalid argument is passed.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
*/
result Construct(const Tizen::Base::String& name, IRunnable& target,
virtual ~Thread(void);
/**
- * Waits until the thread execution is terminated.
+ * Joins after the thread execution is terminated.
*
* @since 2.0
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION An other thread is calling this method.
+ * @exception E_INVALID_OPERATION Another thread is calling this method.
* @exception E_SYSTEM A system error has occurred.
*/
result Join(void);
* @since 2.0
*
* @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
* @remarks This is only available for event-driven threads.
* @endif
*/
/**
* Called when the thread is started without the IRunnable instance. @n
- * The body for thread execution is specified by inheriting the %Thread class and implementing this method.
+ * The body for the thread execution is specified by inheriting the %Thread class and implementing this method.
*
* @since 2.0
*
virtual Tizen::Base::Object* Run(void);
/**
- * Gets an exit code of the thread which is given by calling the Exit() method.
+ * Gets the exit code of the thread which is given by calling the Exit() method.
*
* @since 2.0
*
* @since 2.0
*
* @return The name of the thread
- * @exception E_SUCCESS The method is successful.
+ * @exception E_SUCCESS The method is successful.
*/
const Tizen::Base::String& GetName(void) const;
* @since 2.0
*
* @return @c true if this thread can be run, @n
- * else @c false
- * @remarks You can initialize the event or event listener in this method for running this
+ * else @c false
+ * @remarks The event or event listener in this method can be initialized for running this
* thread in an event-driven mode.
* @endif
*/
* @deprecated This method is deprecated because the %Thread class does not support event-driven threads.
* @since 2.0
*
- * @remarks You can finalize the event or event listener in this method for running this
+ * @remarks The event or event listener in this method can be finalized for running this
* thread in an event-driven mode.
*
* @endif
* @since 2.0
*
* @return An error code
- * @param[in] requestId The user-defined event Id
- * @param[in] pArgs A pointer to a list of arguments
+ * @param[in] requestId The user-defined event ID
+ * @param[in] pArgs A pointer to the list of arguments
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The thread is not an event-driven thread.
*
*
* @since 2.0
*
- * @param[in] requestId The user-defined event Id
- * @param[in] pArgs A pointer to a list of arguments
+ * @param[in] requestId The user-defined event ID
+ * @param[in] pArgs A pointer to the list of arguments
* @see SendUserEvent()
* @endif
*/
* @since 2.0
*
* The %Timer class can activate the timer and notify the listeners.
- * It supports relative time and provides both repeatable and non-repeatable timer.
- * Because Timer is handled by event-driven way, when the main loop gets blocked, even if the time is expired, the listener cannot get notified.
- * Once the target goes into sleep mode, Timer does not work properly because the main loop gets stopped.
- * You can use Alarm on behalf of Timer for sleep mode.
+ * It supports the relative time and provides both repeatable and non-repeatable timers.
+ * Because %Timer is handled in an event-driven way, when the main loop gets blocked, even if the time is expired, the listener cannot get notified.
+ * Once the target goes into the sleep mode, %Timer does not work properly because the main loop gets stopped.
+ * You can use Alarm on behalf of the %Timer for the sleep mode.
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/timer.htm">Timer</a>.
* The following example demonstrates how to use the %Timer class.
*
* @since 2.0
*
* @return An error code
- * @param[in] listener The event listener
- * @exception E_SUCCESS The method is successful.
+ * @param[in] listener The event listener
+ * @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SYSTEM A system error has occurred.
*/
result Construct(ITimerEventListener& listener);
* @since 2.0
*
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with %Tizen API versions @b prior @b to @b 2.1. @n
- * For more information, see @ref CompTimerStartPage "here".
+ * @compatibility This method has compatibility issues with Tizen API versions @b prior @b to @b 2.1. @n
+ * For more information, see @ref CompTimerStartPage "here".
* @endif
*
* @return An error code
- * @param[in] timeout A timeout interval in milliseconds
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_INVALID_STATE The timer is in an invalid state for start.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks Once the timer has been started, it cannot be started again until expired.
+ * @param[in] timeout The timeout interval in milliseconds
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_INVALID_STATE The timer cannot start as it is in an invalid state.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks Once the timer has been started, it cannot be started again until it has expired.
* @see Cancel()
*/
result Start(int timeout);
/**
- * @page CompTimerStartPage Compatibility for Start(int timeout)
- * @section CompTimerStartPageIssueSection Issues
- * Implementation of this method in %Tizen API versions prior to 2.1 has the following issue: @n
- * -# The method returns E_INVALID_ARG if timeout is equal to zero.
- *
- * @section CompTimerStartPageSolutionSection Resolutions
- * The issue mentioned above is resolved in %Tizen API version 2.1, and it is recommended to use %Tizen API version 2.1 or above.
- * -# In case of zero, Timer sets timeout to the best-effort minimum interval without returning E_INVALID_ARG.
- */
+ * @page CompTimerStartPage Compatibility for Start(int timeout)
+ * @section CompTimerStartPageIssueSection Issues
+ * Implementation of this method in Tizen API versions prior to 2.1 has the following issue: @n
+ * -# The method returns @c E_INVALID_ARG if timeout is equal to zero.
+ *
+ * @section CompTimerStartPageSolutionSection Resolutions
+ * The issue mentioned above is resolved in Tizen API version 2.1, and it is recommended to use Tizen API version 2.1 or above.
+ * -# In case of zero, %Timer sets the timeout to the best possible minimum interval without returning @c E_INVALID_ARG.
+ */
/**
* Starts the timer. @n
- * The timer is expired repeatedly until canceled.
+ * The timer expires repeatedly until it is cancelled.
*
* @since 2.0
*
* @return An error code
- * @param[in] interval A timeout interval in milliseconds
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_INVALID_STATE The timer is in an invalid state for start.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks To stop timer expiration or restart a timer, the timer must be canceled.
+ * @param[in] interval The timeout interval in milliseconds
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_INVALID_STATE The timer cannot start as it is in an invalid state.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks To stop the timer expiration or restart the timer, the timer must be cancelled.
* @see Cancel()
*/
result StartAsRepeatable(int interval);
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The started timer can be canceled when it does not get expired. If the timer was already expired, this method also returns E_SUCCESS which affects the same manner when canceled normally.
+ * @remarks The started timer can be cancelled when it does not get expired. @n
+ * If the timer has already expired, this method also returns @c E_SUCCESS which causes the same effect as when cancelled normally.
*/
result Cancel(void);
/**
* @file FBaseRtTypes.h
- * @brief This is the header file for the types in the Runtime package.
+ * @brief This is the header file for the types in the %Runtime package.
*
* This header file defines the types in the Runtime package.
*/
/**
* @struct TryTag
-* @brief This struct is used only for supporting non-blocking acquisition of a resource.
+* @brief This struct is used only for supporting the non-blocking acquisition of a resource.
*
-* The %TryTag struct is used for just discriminating between blocking and non-blocking acquisition
+* The %TryTag struct is used for just discriminating between the blocking and non-blocking acquisitions
* of a resource. So, the definition is empty.
*
* @since 2.0
};
/**
-* @brief Used only for just discriminating between blocking and non-blocking acquisition.
+* @brief Used only for discriminating between the blocking and non-blocking acquisitions.
*
* @code
* Mutex m;
class IWaitingLoopCondition;
/*
* @class WaitingLoop
- * @brief This class allows developers to make the current thread wait for callback events. This class should be used only for test codes and don't use this class for commercial applications
+ * @brief This class allows developers to make the current thread wait for callback events. This class should be used only for test codes and not for commercial applications.
* @since 2.0
*
* @final This class is not intended for extension.
{
public:
/*
- * Gets the WaitingLoop instance.
+ * Gets a pointer to the %WaitingLoop instance.
*
* @since 2.0
*
- * @return A pointer to the WaitingLoop instance, @n
+ * @return A pointer to a WaitingLoop instance, @n
* else @c null if it fails
- * @remarks Once the WaitingLoop instance has been created, you must not use the instance between threads. Especially, the methods for waiting should be called on the thread you get the instance at first time.
+ * @remarks Once the WaitingLoop instance has been created, the instance between the threads must not be used. @n
+ * Especially, the methods that are waiting should be called on the thread where the instance is obtained for the first time.
*/
static WaitingLoop* GetInstance(void);
*
* @since 2.0
*
- * @param[in] timeout The timeout period in milliseconds
- * @exception E_SUCCESS The method is successful.
- * @exception E_TIMEOUT The time is expired.
- * @exception E_INVALID_STATE The waiting loop has already been waiting on a callback event. In order to wait again, you must quit the waiting loop.
- * @remarks The timeout set to min(timeout, maximum), where the maximum is set using SetMaxTimeoutForWaiting().
+ * @param[in] timeout The timeout period in milliseconds
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_TIMEOUT The time has expired.
+ * @exception E_INVALID_STATE The waiting loop has already been waiting on a callback event. @n
+ * In order to wait again, quit the waiting loop.
+ * @remarks The timeout is set to min(timeout, maximum), where the maximum is set using SetMaxTimeoutForWaiting().
* @see Notify()
- * @see SetMaxTimoutForWaiting()
*/
result Wait(int timeout);
*
* @since 2.0
*
- * @param[in] condition The expiring condition
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE The waiting loop has already been waiting on a callback event. In order to wait again, you must quit the waiting loop.
- * @remarks In order to use this method correctly, you have to implement a class inheriting from %IWaitingLoopCondition.
+ * @param[in] condition The expiring condition
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE The waiting loop has already been waiting on a callback event. @n
+ * In order to wait again, quit the waiting loop.
+ * @remarks In order to use this method correctly, you have to implement a class inheriting from IWaitingLoopCondition.
*/
result Wait(IWaitingLoopCondition& condition);
/*
- * Starts the waiting loop and waits until either the expiring condition occurs or the time is expired.
+ * Starts the waiting loop and waits until either the expiring condition occurs or the time expires.
*
* @since 2.0
*
- * @param[in] timeout The timeout period in milliseconds
- * @param[in] condition The expiring condition
- * @exception E_TIMEOUT The time is expired.
- * @exception E_INVALID_STATE The waiting loop is waiting on a thread. In order to wait again, you must quit the waiting loop.
- * @remarks If the timeout is over the maximum, the expired time goes together with the maximum timeout. In order to use this method correctly, you have to implement a class inheriting from %IWaitingLoopCondition interface
+ * @param[in] timeout The timeout period in milliseconds
+ * @param[in] condition The expiring condition
+ * @exception E_TIMEOUT The time has expired.
+ * @exception E_INVALID_STATE The waiting loop is waiting on a thread. @n
+ * In order to wait again, quit the waiting loop.
+ * @remarks If the timeout has crossed the maximum value, the expired time goes along with the maximum timeout. @n
+ * In order to use this method correctly, implement a class inheriting from the IWaitingLoopCondition interface
*/
result Wait(int timeout, IWaitingLoopCondition& condition);
/*
- * Notify the waiting thread that the related callback has completed the job.
+ * Notifies the waiting thread that the related callback has completed the job.
*
* @since 2.0
*
- * @remarks This method is recommended to use when the waiting condition is not explicitly specified with Wait().
+ * @remarks This method is recommended when the waiting condition is not explicitly specified by Wait().
*/
void Notify(void);
* @since 2.0
*
* @param[in] timeout The timeout period in milliseconds
- * else @c false
- * @remarks If the timeout is considered as a small number, it will be replaced with the specified number provided by platform.
+ * else @c false
+ * @remarks If the timeout is considered as a small number, it is replaced with the specified number provided by the platform.
*/
static void SetMaxTimeoutForWaiting(int timeout);
TIME_FIELD_MILLISECOND, /**< Millisecond : 0-based (0~999) */
TIME_FIELD_ZONE_OFFSET, /**< Time Zone Offset : 0-based (-43200000~54000000 in milliseconds) */
TIME_FIELD_DST_OFFSET, /**< Daylight Saving Offset : 0-based (0~3600000 in milliseconds)*/
- TIME_FIELD_FIELD_COUNT /**< The number of time field */
+ TIME_FIELD_FIELD_COUNT /**< The number of time fields */
};
class _OSP_EXPORT_ Calendar
virtual ~Calendar(void);
/**
- * Adds the specified amount to the given time field, based on the calendar rules. @n
- * It is equivalent to calling SetTimeField(field, GetTimeField(field)+amount) with two adjustments. @n
+ * Adds the specified amount to the specified time field, based on the calendar rules. @n
+ * It is equivalent to calling SetTimeField(field, GetTimeField(field)+amount) with the following two adjustments: @n
*
* @b Add @b Rule1: The value of the time field @c field after the call minus the value of the field
* before the call is delta modulo any overflow that has occurred in the field.
* equal to its prior value because of changes in its minimum or maximum value after the time field @c field
* is changed, then its value is adjusted to be as close as possible to its expected value. @n
*
- * A smaller field represents a smaller unit of time. TIME_FIELD_HOUR is a smaller field than TIME_FIELD_DAY_OF_MONTH.
+ * A smaller field represents a smaller unit of time. @c TIME_FIELD_HOUR is a smaller field than @c TIME_FIELD_DAY_OF_MONTH.
* No adjustment is made to smaller fields that are not expected to be invariant.
- * The calendar system determines what fields are expected to be invariant.
+ * The calendar system determines the fields that are expected to be invariant.
*
* In addition, this method forces re-computation of the calendar's milliseconds and
* all time fields immediately. @n
*
* For example, consider a GregorianCalendar set to Oct 31, 2004.
- * Calling AddTimeField(TIME_FIELD_MONTH, 13) sets the calendar to Nov 30, 2005. @n
- * The TIME_FIELD_MONTH field is set to NOVEMBER by @b Rule1, since adding 13 months to October gives the
+ * Calling AddTimeField(@c TIME_FIELD_MONTH, 13) sets the calendar to Nov 30, 2005. @n
+ * The @c TIME_FIELD_MONTH field is set to NOVEMBER by @b Rule1, since adding 13 months to October sets the month as
* November of the next year.
- * Since, the TIME_FIELD_DAY_OF_MONTH cannot be 31 in November in a %GregorianCalendar, the TIME_FIELD_DAY_OF_MONTH is set to 30 by @b Rule2.
+ * Since, the @c TIME_FIELD_DAY_OF_MONTH cannot be 31 in November in a %GregorianCalendar, the @c TIME_FIELD_DAY_OF_MONTH is set to 30 by @b Rule2.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompCalendarAddTimeFieldPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompCalendarAddTimeFieldPage "here".
* @endif
*
* @return An error code
* @param[in] field The time field
* @param[in] amount The amount to add
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c field is invalid.
+ * @exception E_INVALID_ARG The specified @c field is invalid.
*/
virtual result AddTimeField(TimeField field, int amount) = 0;
/**
* @if OSPCOMPAT
- * @page CompCalendarAddTimeFieldPage Compatibility for AddTimeField()
- * @section CompCalendarAddTimeFieldIssueSection Issues
- * Implementation of this method in OSP compatible applications has the following issue: @n
- * -# The method returns E_INVALID_STATE if the time field is invalid.
- *
- * @section CompCalendarAddTimeFieldSolutionSection Resolutions
- * This issue has been resolved in Tizen.
+ * @page CompCalendarAddTimeFieldPage Compatibility for AddTimeField()
+ * @section CompCalendarAddTimeFieldIssueSection Issues
+ * Implementation of this method in OSP compatible applications has the following issue: @n
+ * -# The method returns @c E_INVALID_STATE if the time field is invalid.
+ *
+ * @section CompCalendarAddTimeFieldSolutionSection Resolutions
+ * This issue has been resolved in Tizen.
*
* @par When working in Tizen:
- * -# The method returns E_INVALID_ARG if the time field is invalid.
+ * -# The method returns @c E_INVALID_ARG if the time field is invalid.
* @endif
*/
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @endif
- * @since 2.0
+ * @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompCalendarAfterPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompCalendarAfterPage "here".
* @endif
*
- * @return An error code
- * @param[in] otherCalendar The instance of %Calendar to compare
- * @param[out] after Set to @c true if the current instance of %Calendar is after the specified instance of %Calendar, @n
+ * @return An error code
+ * @param[in] otherCalendar The instance of %Calendar to compare
+ * @param[out] after Set to @c true if the current instance of %Calendar is after the specified instance of %Calendar, @n
* else @c false
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c otherCalendar is invalid.
- * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified @c otherCalendar is invalid.
+ * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n
* If any time field value previously set is invalid, this exception is returned.
- * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n
- * If the value of the time fields goes out of range, this exception is returned.
+ * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n
+ * If the value of the time fields goes out of range, this exception is returned.
*/
result After(const Calendar& otherCalendar, bool& after);
/**
* @if OSPCOMPAT
- * @page CompCalendarAfterPage Compatibility for After()
- * @section CompCalendarAfterIssueSection Issues
- * Implementation of this method in OSP compatible applications has the following issue: @n
- * -# The method returns E_INVALID_STATE and E_OUT_OF_RANGE if the instance of %Calendar to be compared is invalid.
- *
- * @section CompCalendarAfterSolutionSection Resolutions
- * This issue has been resolved in Tizen.
+ * @page CompCalendarAfterPage Compatibility for After()
+ * @section CompCalendarAfterIssueSection Issues
+ * Implementation of this method in OSP compatible applications has the following issue: @n
+ * -# The method returns @c E_INVALID_STATE and @c E_OUT_OF_RANGE if the instance of %Calendar to be compared is invalid.
+ *
+ * @section CompCalendarAfterSolutionSection Resolutions
+ * This issue has been resolved in Tizen.
*
* @par When working in Tizen:
- * -# The method returns E_INVALID_ARG if the instance of %Calendar to be compared is invalid.
- * -# The method returns E_INVALID_STATE if any time field value previously set is invalid.
- * -# The method returns E_OUT_OF_RANGE if the value of the time fields goes out of range.
+ * -# The method returns @c E_INVALID_ARG if the instance of %Calendar to be compared is invalid.
+ * -# The method returns @c E_INVALID_STATE if any time field value previously set is invalid.
+ * -# The method returns @c E_OUT_OF_RANGE if the value of the time fields goes out of range.
* @endif
- */
+ */
/**
* Compares the current instance of %Calendar with the specified instance.
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @endif
- * @since 2.0
+ * @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompCalendarBeforePage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompCalendarBeforePage "here".
* @endif
*
- * @return An error code
- * @param[in] otherCalendar The instance of %Calendar to compare
- * @param[out] before Set to @c true if the current instance of %Calendar is before the specified instance of %Calendar, @n
- * else @c false
+ * @return An error code
+ * @param[in] otherCalendar The instance of %Calendar to compare
+ * @param[out] before Set to @c true if the current instance of %Calendar is before the specified instance of %Calendar, @n
+ * else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c otherCalendar is invalid.
- * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n
- * If any time field value previously set is invalid, this exception is returned.
- * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n
- * If the value of the time fields goes out of range, this exception is returned.
+ * @exception E_INVALID_ARG The specified @c otherCalendar is invalid.
+ * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n
+ * If any time field value previously set is invalid, this exception is returned.
+ * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n
+ * If the value of the time fields goes out of range, this exception is returned.
*/
result Before(const Calendar& otherCalendar, bool& before);
/**
* @if OSPCOMPAT
- * @page CompCalendarBeforePage Compatibility for Before()
- * @section CompCalendarBeforeIssueSection Issues
- * Implementation of this method in OSP compatible applications has the following issue: @n
- * -# The method returns E_INVALID_STATE and E_OUT_OF_RANGE if the instance of %Calendar to be compared is invalid.
- *
- * @section CompCalendarBeforeSolutionSection Resolutions
- * This issue has been resolved in Tizen.
+ * @page CompCalendarBeforePage Compatibility for Before()
+ * @section CompCalendarBeforeIssueSection Issues
+ * Implementation of this method in OSP compatible applications has the following issue: @n
+ * -# The method returns @c E_INVALID_STATE and @c E_OUT_OF_RANGE if the instance of %Calendar to be compared is invalid.
+ *
+ * @section CompCalendarBeforeSolutionSection Resolutions
+ * This issue has been resolved in Tizen.
*
* @par When working in Tizen:
- * -# The method returns E_INVALID_ARG if the instance of %Calendar to be compared is invalid.
- * -# The method returns E_INVALID_STATE if any time field value previously set is invalid.
- * -# The method returns E_OUT_OF_RANGE if the value of the time fields goes out of range.
- * @endif
- */
+ * -# The method returns @c E_INVALID_ARG if the instance of %Calendar to be compared is invalid.
+ * -# The method returns @c E_INVALID_STATE if any time field value previously set is invalid.
+ * -# The method returns @c E_OUT_OF_RANGE if the value of the time fields goes out of range.
+ * @endif
+ */
/**
* Clears all the time fields and sets it to @c 0. @n
- * Zero is not the default value for each field. It means the field is cleared.
+ * Zero is not the default value for each field. It means that the field is cleared.
*
* @since 2.0
*
/**
* Clears the specified time field and sets it to @c 0. @n
- * Zero is not the default value for each field. It means the field is cleared.
+ * Zero is not the default value for each field. It means that the field is cleared.
*
* @since 2.0
*
*
* @return @c true if the value of the specified instance of Tizen::Base::Object is equal to the value of the current instance of %Calendar, @n
* else @c false
- * @param[in] obj An instance of Tizen::Base::Object to compare
+ * @param[in] obj An instance of Tizen::Base::Object to compare
*/
virtual bool Equals(const Tizen::Base::Object& obj) const;
virtual int GetHashCode(void) const;
/**
- * Rolls up or down as per the specified @c amount in the specified time field without changing the larger fields (for example, TIME_FIELD_YEAR field cannot be changed when the input field is TIME_FIELD_MONTH). @n
+ * Rolls up or down as per the specified @c amount in the specified time field without changing the larger fields
+ * (for example, @c TIME_FIELD_YEAR field cannot be changed when the input field is @c TIME_FIELD_MONTH). @n
* If the specified @c amount is negative, the amount value is deducted from the specified time field value.
- * In this method, the time field of this instance is operated upon. If the value of the specified @c field goes out of range, E_OUT_OF_RANGE is returned.
+ * In this method, the time field of this instance is operated upon. If the value of the specified @c field goes out of range,
+ * @c E_OUT_OF_RANGE is returned.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompCalendarRollPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompCalendarRollPage "here".
* @endif
*
* @return An error code
- * @param[in] field The time field to roll
- * @param[in] amount The amount to add to the time field
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c field is invalid (for example, TIME_FIELD_DST_OFFSET, TIME_FIELD_ZONE_OFFSET).
- * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n
- * If the value of the time fields goes out of range, this exception is returned.
+ * @param[in] field The time field to roll
+ * @param[in] amount The amount to add to the time field
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified @c field is invalid (for example, @c TIME_FIELD_DST_OFFSET, @c TIME_FIELD_ZONE_OFFSET).
+ * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n
+ * If the value of the time fields goes out of range, this exception is returned.
*/
virtual result Roll(TimeField field, int amount);
/**
* @if OSPCOMPAT
- * @page CompCalendarRollPage Compatibility for Roll()
- * @section CompCalendarRollIssueSection Issues
- * Implementation of this method in OSP compatible applications has the following issue: @n
- * -# The method returns E_INVALID_STATE if the time field is invalid.
- *
- * @section CompCalendarRollSolutionSection Resolutions
- * This issue has been resolved in Tizen.
+ * @page CompCalendarRollPage Compatibility for Roll()
+ * @section CompCalendarRollIssueSection Issues
+ * Implementation of this method in OSP compatible applications has the following issue: @n
+ * -# The method returns @c E_INVALID_STATE if the time field is invalid.
+ *
+ * @section CompCalendarRollSolutionSection Resolutions
+ * This issue has been resolved in Tizen.
*
* @par When working in Tizen:
- * -# The method returns E_INVALID_ARG if the time field is invalid.
+ * -# The method returns @c E_INVALID_ARG if the time field is invalid.
* @endif
- */
+ */
/**
* Sets the specified time field with the specified @c value. @n
* until GetTimeField(), GetTime(), or GetTimeInMillisec() is called.
* Thus, even if you call this method several times, unnecessary multiple computations are not triggered. @n
*
- * As a result of changing a field using SetTimeField(), other fields may also change
+ * When a field is changed using SetTimeField(), other fields may also change
* depending on the field, the field value, and the calendar system. @n
*
* For example, consider a GregorianCalendar set to Oct. 31, 2004.
- * Calling SetTimeField(TIME_FIELD_MONTH, NOVEMBER) sets the calendar to Nov 31, 2004. @n
+ * Calling SetTimeField(@c TIME_FIELD_MONTH, NOVEMBER) sets the calendar to Nov 31, 2004. @n
* But, if you call GetTime(), then Dec 1, 2004 is returned because Nov 31, 2004 does not exist.
- * However, a call to SetTimeField(TIME_FIELD_MONTH, SEPTEMBER) before a call to GetTime() sets the calendar
+ * However, a call to SetTimeField(@c TIME_FIELD_MONTH, SEPTEMBER) before a call to GetTime() sets the calendar
* to Sep 30, 2004, since no re-computation has occurred after the first call to SetTimeField().
*
* The value of field is not affected by it being local time or UTC time.
/**
* Sets the value of year, month, day, hour, minute, and seconds. @n
- * The date and time are local time.
+ * The date and time are the local date and time.
*
* @since 2.0
*
* @return An error code
- * @param[in] year The value to set for year
- * @param[in] month The value to set for month @n
+ * @param[in] year The year to set
+ * @param[in] month The month to set @n
* The indexing is 1-based. Therefore, 1 means January.
- * @param[in] day The value to set for day
- * @param[in] hour The value to set for hour
- * @param[in] minute The value to set for minute
- * @param[in] second The value to set for second
+ * @param[in] day The day to set
+ * @param[in] hour The hour to set
+ * @param[in] minute The minute to set
+ * @param[in] second The second to set
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE A time field or its value is out of range in lenient mode.
+ * @exception E_OUT_OF_RANGE A time field or its value is out of range in lenient mode.
*/
result SetTime(int year, int month, int day, int hour = 0, int minute = 0, int second = 0);
/**
- * Sets the calendar's current time with the specified Tizen::Base::DateTime.
+ * Sets the current time of this %Calendar instance with the specified Tizen::Base::DateTime.
*
* @since 2.0
*
/**
* Gets the actual maximum value that the specified field can have, given the current date. @n
- * For example, if the current date is "Feb 10, 2004" and the time field specified is TIME_FIELD_DAY_OF_MONTH, then the actual
- * maximum value for this time field is 29.
+ * For example, if the current date is "Feb 10, 2004" and the time field specified is @c TIME_FIELD_DAY_OF_MONTH, then the actual
+ * maximum value for this time field is @c 29.
*
* @since 2.0
*
* @return An integer value indicating the actual maximum value
- * @param[in] field The time field
+ * @param[in] field The time field
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c field is invalid.
+ * @exception E_INVALID_ARG The specified @c field is invalid.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
virtual int GetActualMaxTimeField(TimeField field) const;
/**
* Gets the actual minimum value that the specified time field can have, given the current date. @n
- * For the Gregorian calendar, this is the same as GetMinTimeField() and
- * GetGreatestMinTimeField().
+ * For the Gregorian calendar, this is the same as GetMinTimeField() and GetGreatestMinTimeField().
*
* @since 2.0
*
* @return An integer value indicating the actual minimum value
- * @param[in] field The time field
+ * @param[in] field The time field
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c field is invalid.
+ * @exception E_INVALID_ARG The specified @c field is invalid.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
/**
* Gets the value of the first day of the week. @n
- * For example, in USA, the first day of the week is SUNDAY. But, it is MONDAY in France.
+ * For example, in USA, the first day of the week is SUNDAY. But, in France, it is MONDAY.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An integer value indicating the first day of the week, @n
- * else @c -1 if the method fails
+ * @return An integer value indicating the first day of the week, @n
+ * else @c -1 if it fails
*/
int GetFirstDayOfWeek(void) const;
* @since 2.0
*
* @return An integer value indicating the greatest minimum value for the specified time field
- * @param[in] field The time field
+ * @param[in] field The time field
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c field is invalid.
+ * @exception E_INVALID_ARG The specified @c field is invalid.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
* @since 2.0
*
* @return An integer value indicating the least maximum value for the specified time field
- * @param[in] field The time field
+ * @param[in] field The time field
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c field is invalid.
+ * @exception E_INVALID_ARG The specified @c field is invalid.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
* @since 2.0
*
* @return An integer value indicating the maximum value for the specified time field
- * @param[in] field The time field
+ * @param[in] field The time field
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c field is invalid.
+ * @exception E_INVALID_ARG The specified @c field is invalid.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
* @since 2.0
*
* @return An integer value indicating the minimum value for the specified time field
- * @param[in] field The time field
+ * @param[in] field The time field
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c field is invalid.
+ * @exception E_INVALID_ARG The specified @c field is invalid.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
* @since 2.0
*
* @return An instance of Tizen::Base::DateTime with the current time in local time
- * @remarks The time specified is local time.
+ * @remarks The time specified is the local time.
*/
Tizen::Base::DateTime GetTime(void) const;
*
* @return An integer value indicating the value of the specified time field
*
- * @param[in] field The given time field
+ * @param[in] field The given time field
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c field is invalid.
+ * @exception E_INVALID_ARG The specified @c field is invalid.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method is semantically const, but may alter the instance in memory.
- * All fields are re-computed if any field is invalid.
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - This method is semantically const, but may alter the instance in memory.
+ * - All fields are re-computed if any field is invalid.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
int GetTimeField(TimeField field) const;
* @since 2.0
*
* @return An error code
- * @param[out] millisec The current time in milliseconds from starting day (Jan 1, 1.)
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n
- * If any time field value previously set is invalid, this exception is returned.
- * @exception E_OUT_OF_RANGE The value of the argument is out of the valid range defined by the method.
+ * @param[out] millisec The current time in milliseconds from starting day (Jan 1, 1.)
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n
+ * If any time field value previously set is invalid, this exception is returned.
+ * @exception E_OUT_OF_RANGE The value of the argument is out of the valid range defined by the method.
*/
result GetTimeInMillisec(long long& millisec) const;
* @since 2.0
*
* @return The TimeZone instance associated with the current instance of %Calendar
- * @remarks The returned reference is valid only until the SetTimeZone() method is called or this instance of %Calendar is destroyed.
+ * @remarks The returned reference is valid only until the SetTimeZone() method is called or
+ * this instance of %Calendar is destroyed.
* @see SetTimeZone()
*/
TimeZone GetTimeZone(void) const;
* @since 2.0
*
* @return An instance of CalendarType representing the calendar type of the current instance of %Calendar @n
- * For example, CALENDAR_GREGORIAN.
+ * For example, @c CALENDAR_GREGORIAN.
*/
virtual CalendarType GetType(void) const = 0;
* @since 2.0
*
* @return An error code
- * @param[out] isInDst Set to @c true if the current date is in DST, @n
- * else @c false
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n
- * If any time field value previously set is invalid, this exception is returned.
- * @exception E_OUT_OF_RANGE A time field or its value is out of range. @n
- * In this method, the time fields of this instance are calculated. If the value of the time fields goes out of range, this exception is returned.
+ * @param[out] isInDst Set to @c true if the current date is in DST, @n
+ * else @c false
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n
+ * If any time field value previously set is invalid, this exception is returned.
+ * @exception E_OUT_OF_RANGE A time field or its value is out of range. @n
+ * In this method, the time fields of this instance are calculated.
+ * If the value of the time fields goes out of range, this exception is returned.
*/
virtual result IsInDst(bool& isInDst) const = 0;
/**
* Creates an instance of %Calendar of the specified type with the GMT time zone and the system locale. @n
- * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease.
- * The weekdata are set as default values by the locale.
+ * The instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease.
+ * The weekdata is set to default values by the locale.
*
* @since 2.0
*
* @return A pointer to the created %Calendar instance, @n
- * else @c null if the method fails
+ * else @c null if it fails
* @param[in] calendarType The type of calendar @n
- * Default calendar is the Gregorian calendar (CALENDAR_GREGORIAN).
+ * The default calendar is the Gregorian calendar (@c CALENDAR_GREGORIAN).
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
/**
* Creates an instance of %Calendar of the specified type with the specified time zone and the system locale. @n
* The @c timeZone is used for the zone offset and the DST offset.
- * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease.
- * The weekdata are set as default values by the locale.
+ * The instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease.
+ * The weekdata is set to default values by the locale.
*
* @since 2.0
*
* @return A pointer to the created %Calendar instance, @n
- * else @c null if the method fails
+ * else @c null if it fails
* @param[in] timeZone An instance of TimeZone
* @param[in] calendarType The type of calendar @n
- * Default calendar is the Gregorian calendar (CALENDAR_GREGORIAN).
+ * The default calendar is the Gregorian calendar (@c CALENDAR_GREGORIAN).
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
/**
* Creates an instance of %Calendar of the specified type with the specified @c locale and the GMT time zone. @n
- * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease.
- * The weekdata are set as default values by the specified @c locale.
+ * The instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease.
+ * The weekdata is set to default values by the specified @c locale.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompCalendarCreateInstanceNPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompCalendarCreateInstanceNPage "here".
* @endif
*
* @return A pointer to the created %Calendar instance, @n
- * else @c null if the method fails
+ * else @c null if it fails
* @param[in] locale The locale for whose country the %Calendar instance is needed
* @param[in] calendarType The type of calendar @n
- * Default calendar is the Gregorian calendar (CALENDAR_GREGORIAN).
+ * The default calendar is the Gregorian calendar (@c CALENDAR_GREGORIAN).
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG The specified @c locale is invalid.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_ARG The specified @c locale is invalid.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static Calendar* CreateInstanceN(const Locale& locale, CalendarType calendarType = CALENDAR_GREGORIAN);
/**
* Creates an instance of %Calendar of the specified type with the specified time zone and @c locale. @n
* The @c timeZone is used for the zone offset and the DST offset.
- * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease.
- * The weekdata are set as default values by the specified @c locale.
+ * The instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease.
+ * The weekdata is set to default values by the specified @c locale.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompCalendarCreateInstanceNPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompCalendarCreateInstanceNPage "here".
* @endif
*
* @return A pointer to the created %Calendar instance, @n
- * else @c null if the method fails
+ * else @c null if it fails
* @param[in] timeZone An instance of TimeZone
- * @param[in] locale The locale for whose country the %Calendar instance is needed
- * @param[in] calendarType The type of calendar @n
- * Default calendar is the Gregorian calendar (CALENDAR_GREGORIAN).
+ * @param[in] locale The locale for the country the %Calendar instance is created
+ * @param[in] calendarType The calendar type @n
+ * The default calendar is the Gregorian calendar (@c CALENDAR_GREGORIAN).
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG The specified @c locale is invalid.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_ARG The specified @c locale is invalid.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static Calendar* CreateInstanceN(const TimeZone& timeZone, const Locale& locale, CalendarType calendarType = CALENDAR_GREGORIAN);
/**
* @if OSPCOMPAT
- * @page CompCalendarCreateInstanceNPage Compatibility for CreateInstanceN()
- * @section CompCalendarCreateInstanceNIssueSection Issues
- * Implementation of this method in OSP compatible applications has the following issue: @n
- * -# The method returns E_UNSUPPORTED_OPERATION if the locale is invalid.
- *
- * @section CompCalendarCreateInstanceNSolutionSection Resolutions
- * This issue has been resolved in Tizen.
- * @par When working in Tizen:
- * -# The method returns E_INVALID_ARG if the locale is invalid.
+ * @page CompCalendarCreateInstanceNPage Compatibility for CreateInstanceN()
+ * @section CompCalendarCreateInstanceNIssueSection Issues
+ * Implementation of this method in OSP compatible applications has the following issue: @n
+ * -# The method returns @c E_UNSUPPORTED_OPERATION if the locale is invalid.
+ *
+ * @section CompCalendarCreateInstanceNSolutionSection Resolutions
+ * This issue has been resolved in Tizen.
+ * @par When working in Tizen:
+ * -# The method returns @c E_INVALID_ARG if the locale is invalid.
* @endif
- */
+ */
protected:
/**
* @enum AmPm
*
* Defines the AM/PM mode. @n
- * This is a.m./p.m. The indexing is 0-based.
+ * The indexing is 0-based.
*
* @since 2.0
*/
/**
* @enum CalendarLimitType
*
- * Defines the calendar limitations.
+ * Defines the calendar limits.
*
* @since 2.0
*/
*/
enum StampValue
{
- UNSET = 0, /**< Unset */
- COMPUTED, /**< Computed */
- MINIMUM_USER_STAMP /**< Minimum user stamp */
+ UNSET = 0, /**< The stamp is unset */
+ COMPUTED, /**< The stamp is computed */
+ MINIMUM_USER_STAMP /**< The minimum user stamp */
};
/**
- * This is the default constructor for this class. @n
- * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
- *
- * @since 2.0
- *
- * @see Construct()
- */
+ * This is the default constructor for this class. @n
+ * The object is not fully constructed after this constructor is called. For full construction,
+ * the Construct() method must be called right after calling this constructor.
+ *
+ * @since 2.0
+ */
Calendar(void);
/**
- * Initializes this instance of %Calendar.
- *
- * @since 2.0
- *
- * @return An error code
- * @exception E_SUCCESS The method is successful.
- */
+ * Initializes this instance of %Calendar.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @exception E_SUCCESS The method is successful.
+ */
result Construct(void);
/**
- * Initializes this instance of %Calendar with the specified parameter.
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] calendar The %Calendar instance to copy
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- *
- */
+ * Initializes this instance of %Calendar with the specified %Calendar instance.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] calendar The %Calendar instance to copy
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ *
+ */
result Construct(const Calendar& calendar);
/**
- * Initializes this instance of %Calendar with the specified time zone and @c locale. @n
- * The @c timeZone is used for the zone offset and the DST offset.
- * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease.
- * The weekdata are set as default values by the specified @c locale.
- *
- * @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
- * @endif
- * @since 2.0
- * @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompCalendarConstructPage "here".
- * @endif
- *
- * @return An error code
- * @param[in] timeZone An instance of TimeZone
- * @param[in] locale An instance of Locale
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c locale is invalid.
- */
+ * Initializes this instance of %Calendar with the specified time zone and @c locale. @n
+ * The @c timeZone is used for the zone offset and the DST offset.
+ * The instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease.
+ * The weekdata is set to default values by the specified @c locale.
+ *
+ * @if OSPCOMPAT
+ * @brief <i> [Compatibility] </i>
+ * @endif
+ * @since 2.0
+ * @if OSPCOMPAT
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompCalendarConstructPage "here".
+ * @endif
+ *
+ * @return An error code
+ * @param[in] timeZone An instance of TimeZone
+ * @param[in] locale An instance of Locale
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified @c locale is invalid.
+ */
result Construct(const Tizen::Locales::TimeZone& timeZone, const Locale& locale);
/**
- * @if OSPCOMPAT
- * @page CompCalendarConstructPage Compatibility for Construct()
- * @section CompCalendarConstructIssueSection Issues
- * Implementation of this method in OSP compatible applications has the following issue: @n
- * -# The method returns E_UNSUPPORTED_OPERATION if the locale is invalid.
- *
- * @section CompCalendarConstructSolutionSection Resolutions
- * This issue has been resolved in Tizen.
- * @par When working in Tizen:
- * -# The method returns E_INVALID_ARG if the locale is invalid.
- * @endif
- */
+ * @if OSPCOMPAT
+ * @page CompCalendarConstructPage Compatibility for Construct()
+ * @section CompCalendarConstructIssueSection Issues
+ * Implementation of this method in OSP compatible applications has the following issue: @n
+ * -# The method returns @c E_UNSUPPORTED_OPERATION if the locale is invalid.
+ *
+ * @section CompCalendarConstructSolutionSection Resolutions
+ * This issue has been resolved in Tizen.
+ * @par When working in Tizen:
+ * -# The method returns @c E_INVALID_ARG if the locale is invalid.
+ * @endif
+ */
/**
- * Rolls up or down with a single unit of time on a given time field without changing larger fields. @n
- * When rolling on the MONTH field, other fields such as DATE field might conflict
- * and needs to be changed.
+ * Rolls up or down with a single unit of time on the specified time field without changing the larger fields. @n
+ * When rolling on the MONTH field, other fields such as DATE field might conflict and need to be changed.
*
* @since 2.0
*
* @return An error code
- * @param[in] field The time field to change
- * @param[in] up Set to @c true if the time field must be rolled upwards, @n
- * else @c false
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n
- * If any time field value previously set is invalid, this exception is returned.
- * @exception E_INVALID_ARG The specified @c field is invalid (for example, TIME_FIELD_DST_OFFSET, TIME_FIELD_ZONE_OFFSET).
- * @exception E_OUT_OF_RANGE A time field or its value is out of range. @n
- * In this method, the time fields of this instance are calculated.
- * If the value of the time fields goes out of range, this exception is returned.
+ * @param[in] field The time field to change
+ * @param[in] up Set to @c true if the time field must be rolled upwards, @n
+ * else @c false
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n
+ * If any time field value previously set is invalid, this exception is returned.
+ * @exception E_INVALID_ARG The specified @c field is invalid (for example, @c TIME_FIELD_DST_OFFSET, @c TIME_FIELD_ZONE_OFFSET).
+ * @exception E_OUT_OF_RANGE A time field or its value is out of range. @n
+ * In this method, the time fields of this instance are calculated.
+ * If the value of the time fields goes out of range, this exception is returned.
*/
virtual result RollWithSingleUnit(TimeField field, bool up) = 0;
*
* @return @c true if the current instance of %Calendar is equivalent to the specified %Calendar instance, @n
* else @c false
- * @param[in] calendar The instance of %Calendar to compare with
+ * @param[in] calendar The instance of %Calendar to compare
* @remarks If the specified %Calendar instance is equivalent to the current instance, the two instances behave
* exactly the same, but they may be set to different times.
*/
/**
* Computes the time field value. @n
* Converts the current millisecond time value to TimeField. @n
- * This allows synching up the time field values with a new time that is set for the calendar.
+ * This allows syncing up the time field values with a new time that is set for the calendar.
*
* @since 2.0
*
* @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The time fields contain an invalid value. @n
- * In this method, the time fields of this instance are calculated. If the value of the time fields goes out of range, this exception is returned.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_RANGE The time fields contain an invalid value. @n
+ * In this method, the time fields of this instance are calculated.
+ * If the value of the time fields goes out of range, this exception is returned.
*/
virtual result ComputeTimeFields(void) = 0;
virtual int GetMonthLength(int extendedYear, int month) const = 0;
/**
- * Handles the limits of different types. @n
+ * Handle the limits of the specified time field that depend on the type of limit. @n
* Derived classes must implement this method for the following fields:
- * TIME_FIELD_ERA, TIME_FIELD_YEAR, TIME_FIELD_MONTH, TIME_FIELD_WEEK_OF_YEAR, TIME_FIELD_WEEK_OF_MONTH,
- * TIME_FIELD_DAY_OF_MONTH, TIME_FIELD_DAY_OF_YEAR, TIME_FIELD_DAY_OF_WEEK_IN_MONTH, TIME_FIELD_YEAR_WOY,
- * TIME_FIELD_EXTENDED_YEAR.
+ * @c TIME_FIELD_ERA, @c TIME_FIELD_YEAR, @c TIME_FIELD_MONTH, @c TIME_FIELD_WEEK_OF_YEAR, @c TIME_FIELD_WEEK_OF_MONTH,
+ * @c TIME_FIELD_DAY_OF_MONTH, @c TIME_FIELD_DAY_OF_YEAR, @c TIME_FIELD_DAY_OF_WEEK_IN_MONTH, @c TIME_FIELD_YEAR_WOY,
+ * @c TIME_FIELD_EXTENDED_YEAR.
*
* @since 2.0
*
*/
virtual int HandleGetLimit(TimeField field, CalendarLimitType limitType) const = 0;
- /*
+ /**
* Creates and returns a polymorphic copy of this calendar.
*
* @since 2.0
public:
/**
- * Millisecond constants for one day.
+ * One day in milliseconds.
*
* @since 2.0
*/
static const int ONE_DAY_IN_MILLISEC = 86400000;
/**
- * Millisecond constants for one hour.
+ * One hour in milliseconds.
*
* @since 2.0
*/
static const int ONE_HOUR_IN_MILLISEC = 60 * 60 * 1000;
/**
- * Millisecond constants for one minute.
+ * One minute in milliseconds.
*
* @since 2.0
*/
static const int ONE_MINUTE_IN_MILLISEC = 60000;
/**
- * Millisecond constants for one second.
+ * One second in milliseconds.
*
* @since 2.0
*/
static const int ONE_SECOND_IN_MILLISEC = 1000;
/**
- * Millisecond constants for one week.
+ * One week in milliseconds.
*
* @since 2.0
*/
/**
* @class Currency
- * @brief This class represents currencies.
+ * @brief This class provides methods for currencies.
*
* @since 2.0
*
/**
* This is the default constructor for this class. @n
- * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
+ * The object is not fully constructed after this constructor is called. For full construction, the Construct() method
+ * must be called right after calling this constructor.
*
* @since 2.0
- *
- * @see Construct()
*/
Currency(void);
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompCurrencyConstructPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompCurrencyConstructPage "here".
* @endif
*
* @return An error code
- * @param[in] locale The specified @c locale to get the currency symbol
- * @exception E_SUCCESS The method is successful.
+ * @param[in] locale The specified @c locale to get the currency symbol
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c locale is not supported.
*/
result Construct(const Locale& locale);
/**
* Initializes this instance of %Currency with the specified currency code. @n
- * Currencies are enumerated as defined by ISO 4217. For example, if the locale is Korean (language) and Korea (country), the currency code is "KRW".
+ * The currencies are enumerated as defined by ISO 4217. For example, if the locale is Korean (language) and Korea (country),
+ * the currency code is "KRW".
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompCurrencyConstructPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompCurrencyConstructPage "here".
* @endif
*
* @return An error code
- * @param[in] currencyCode The specified currency code to get the currency symbol
- * @exception E_SUCCESS The method is successful.
+ * @param[in] currencyCode The specified currency code to get the currency symbol
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c currencyCode is not supported.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
*/
result Construct(const Tizen::Base::String& currencyCode);
/**
* @if OSPCOMPAT
- * @page CompCurrencyConstructPage Compatibility for Construct()
- * @section CompCurrencyConstructIssueSection Issues
- * Implementation of this method in OSP compatible applications has the following issue: @n
- * -# The method returns E_UNSUPPORTED_OPERATION if the argument is invalid.
- *
- * @section CompCurrencyConstructSolutionSection Resolutions
- * This issue has been resolved in Tizen.
+ * @page CompCurrencyConstructPage Compatibility for Construct()
+ * @section CompCurrencyConstructIssueSection Issues
+ * Implementation of this method in OSP compatible applications has the following issue: @n
+ * -# The method returns E_UNSUPPORTED_OPERATION if the argument is invalid.
+ *
+ * @section CompCurrencyConstructSolutionSection Resolutions
+ * This issue has been resolved in Tizen.
* @par When working in Tizen:
- * -# The method returns E_INVALID_ARG if the argument is invalid.
+ * -# The method returns E_INVALID_ARG if the argument is invalid.
* @endif
- */
+ */
/**
*
* @return @c true if the value of the specified instance is equal to that of the current instance, @n
* else @c false
- * @param[in] obj The object to compare with the current instance
+ * @param[in] obj The object to compare with the current instance
*/
virtual bool Equals(const Tizen::Base::Object& obj) const;
* else a @c null pointer is returned if there is no currency available or there is some failure @n
* The array is a list of all the available currencies.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static Tizen::Base::Collection::IList* GetAvailableCurrenciesN(void);
*/
enum DateTimeStyle
{
- DATE_TIME_STYLE_NONE = -1, /**< The date time style: None */
- DATE_TIME_STYLE_FULL = 0, /**< The date time style: FULL is pretty completely specified, such as Tuesday, April 12, 1952 AD or 3:30:42PM PST */
- DATE_TIME_STYLE_LONG = 1, /**< The date time style: LONG is longer, such as July 18, 2012 or 3:30:32PM */
- DATE_TIME_STYLE_MEDIUM = 2, /**< The date time style: MEDIUM is a little longer, such as Jan 12, 1952 */
- DATE_TIME_STYLE_SHORT = 3, /**< The date time style: SHORT is completely numeric, such as 12/13/52 or 3:30PM */
- DATE_TIME_STYLE_DEFAULT = DATE_TIME_STYLE_MEDIUM /**< The default date time style: Medium */
+ DATE_TIME_STYLE_NONE = -1, /**< No date time style */
+ DATE_TIME_STYLE_FULL = 0, /**< The full date time style @n For example, Tuesday, April 12, 1952 AD or 3:30:42PM PST */
+ DATE_TIME_STYLE_LONG = 1, /**< The long date time style @n For example, July 18, 2012 or 3:30:32PM */
+ DATE_TIME_STYLE_MEDIUM = 2, /**< The medium date time style @n For example, Jan 12, 1952 */
+ DATE_TIME_STYLE_SHORT = 3, /**< The short date time style @n This style is completely numeric. For example, 12/13/52 or 3:30PM */
+ DATE_TIME_STYLE_DEFAULT = DATE_TIME_STYLE_MEDIUM /**< The default date time style @n This is set to Medium */
};
/**
* @return A pointer to the system locale date formatter, @n
* else @c null if an error occurs
* @param[in] style The formatting style @n
- * For example, "M/d/yy" is the short form for displaying only date in the US locale.
+ * For example, "M/d/yy" is the short form for displaying only the date in the US locale.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_UNSUPPORTED_OPERATION The current locale is not supported.
- * @exception E_INVALID_ARG The specified @c style is an invalid value.
+ * @exception E_INVALID_ARG The specified @c style is an invalid value.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static DateTimeFormatter* CreateDateFormatterN(DateTimeStyle style = DATE_TIME_STYLE_DEFAULT);
* Creates the date formatter with the specified formatting style for the specified locale.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompDateTimeFormatterCreateDateFormatterNPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompDateTimeFormatterCreateDateFormatterNPage "here".
* @endif
*
* @return A pointer to the specified locale date formatter, @n
* else @c null if an error occurs
* @param[in] locale The locale
* @param[in] style The formatting style @n
- * For example, "M/d/yy" is the short form for displaying only date in the US locale.
+ * For example, "M/d/yy" is the short form for displaying only the date in the US locale.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG The specified @c locale or @c style is invalid.
+ * @exception E_INVALID_ARG The specified @c locale or @c style is invalid.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static DateTimeFormatter* CreateDateFormatterN(const Locale& locale, DateTimeStyle style = DATE_TIME_STYLE_DEFAULT);
/**
* @if OSPCOMPAT
- * @page CompDateTimeFormatterCreateDateFormatterNPage Compatibility for CreateDateFormatterN()
- * @section CompDateTimeFormatterCreateDateFormatterNIssueSection Issues
- * Implementation of this method in OSP compatible applications has the following issue: @n
- * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid.
- *
- * @section CompDateTimeFormatterCreateDateFormatterNtSolutionSection Resolutions
- * This issue has been resolved in Tizen.
+ * @page CompDateTimeFormatterCreateDateFormatterNPage Compatibility for CreateDateFormatterN()
+ * @section CompDateTimeFormatterCreateDateFormatterNIssueSection Issues
+ * Implementation of this method in OSP compatible applications has the following issue: @n
+ * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid.
+ *
+ * @section CompDateTimeFormatterCreateDateFormatterNtSolutionSection Resolutions
+ * This issue has been resolved in Tizen.
* @par When working in Tizen:
- * -# The method returns E_INVALID_ARG if the @c locale or @c style is invalid.
+ * -# The method returns E_INVALID_ARG if the @c locale or @c style is invalid.
* @endif
- */
+ */
/**
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_UNSUPPORTED_OPERATION The current locale is not supported.
- * @exception E_INVALID_ARG The specified @c style is invalid.
+ * @exception E_INVALID_ARG The specified @c style is invalid.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static DateTimeFormatter* CreateTimeFormatterN(DateTimeStyle style = DATE_TIME_STYLE_DEFAULT);
* Creates the time formatter with the specified formatting style for the specified @c locale.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompDateTimeFormatterCreateTimeFormatterNPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompDateTimeFormatterCreateTimeFormatterNPage "here".
* @endif
*
* @return A pointer to the specified locale time formatter, @n
* For example, "h:mm a" is the short form for displaying the 12-hour time format in the US locale.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG The specified @c locale or @c style is invalid.
+ * @exception E_INVALID_ARG The specified @c locale or @c style is invalid.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static DateTimeFormatter* CreateTimeFormatterN(const Locale& locale, DateTimeStyle style = DATE_TIME_STYLE_DEFAULT);
/**
* @if OSPCOMPAT
- * @page CompDateTimeFormatterCreateTimeFormatterNPage Compatibility for CreateTimeFormatterN()
- * @section CompDateTimeFormatterCreateTimeFormatterNIssueSection Issues
- * Implementation of this method in OSP compatible applications has the following issue: @n
- * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid.
- *
- * @section CompGrDateTimeFormatterCreateTimeFormatterNSolutionSection Resolutions
- * This issue has been resolved in Tizen.
- * @par When working in Tizen:
- * -# The method returns E_INVALID_ARG if the @c locale or @c style is invalid.
+ * @page CompDateTimeFormatterCreateTimeFormatterNPage Compatibility for CreateTimeFormatterN()
+ * @section CompDateTimeFormatterCreateTimeFormatterNIssueSection Issues
+ * Implementation of this method in OSP compatible applications has the following issue: @n
+ * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid.
+ *
+ * @section CompGrDateTimeFormatterCreateTimeFormatterNSolutionSection Resolutions
+ * This issue has been resolved in Tizen.
+ * @par When working in Tizen:
+ * -# The method returns E_INVALID_ARG if the @c locale or @c style is invalid.
* @endif
- */
+ */
/**
* Creates the date/time formatter with the specified formatting style for the system locale.
* @return A pointer to the system locale date/time formatter, @n
* else @c null if an error occurs
* @param[in] dateStyle The date formatting style @n
- * For example, "M/d/yy" is the short form for displaying only date in the US locale.
+ * For example, "M/d/yy" is the short form for displaying only the date in the US locale.
* @param[in] timeStyle The time formatting style @n
* For example, "h:mm a" is the short form for displaying the 12-hour time format in the US locale.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_UNSUPPORTED_OPERATION The current locale is not supported.
- * @exception E_INVALID_ARG The specified @c dateStyle or @c timeStyle is invalid.
+ * @exception E_INVALID_ARG The specified @c dateStyle or @c timeStyle is invalid.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static DateTimeFormatter* CreateDateTimeFormatterN(DateTimeStyle dateStyle = DATE_TIME_STYLE_DEFAULT, DateTimeStyle timeStyle = DATE_TIME_STYLE_DEFAULT);
* For example, "h:mm a" is the short form for displaying the 12-hour time format in the US locale.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG The specified @c locale is not supported, or the @c dateStyle or the @c timeStyle is invalid.
+ * @exception E_INVALID_ARG The specified @c locale is not supported, or the @c dateStyle or the @c timeStyle is invalid.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static DateTimeFormatter* CreateDateTimeFormatterN(const Locale& locale, DateTimeStyle dateStyle = DATE_TIME_STYLE_DEFAULT, DateTimeStyle timeStyle = DATE_TIME_STYLE_DEFAULT);
/**
- * Formats a Tizen::Base::DateTime object into a date/time string and appends the resulting string to the specified string buffer.
+ * Formats a Tizen::Base::DateTime object into a date/time string and appends the resulting string to the specified string.
*
* @since 2.0
*
* @return An error code
* @param[in] date The Tizen::Base::DateTime object to format
- * @param[out] str The string to append to the resultant string
+ * @param[out] str The string to which formatted string is appended
* @exception E_SUCCESS The method is successful.
* @remarks This method does not handle the time zone information, so "z" pattern always returns "GMT+00:00".
- * @see Tizen::Base::DateTime
*/
virtual result Format(const Tizen::Base::DateTime& date, Tizen::Base::String& str) const;
*
* @return An error code
* @param[in] calendar The Calendar object to format
- * @param[out] str The string to append to the resultant string
+ * @param[out] str The string to which formatted string is appended
* @exception E_SUCCESS The method is successful.
- * @see Tizen::Base::DateTime
+ * @see Tizen::Base::DateTime
*/
virtual result Format(const Calendar& calendar, Tizen::Base::String& str) const;
*
* @since 2.0
*
- * @param[in] pattern The new date and time pattern for the date format
+ * @param[in] pattern The date and time pattern for the date format
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The length of the specified @c pattern is @c 0.
*/
/**
- * Gets a pattern string describing the date format.
+ * Gets the pattern string describing the date format.
*
* @since 2.0
*
- * @return A string describing the date format
+ * @return The date format pattern string
*/
Tizen::Base::String GetPattern(void) const;
*
* @since 2.0
*
- * @return A pointer to DateTimeSymbols for the formatter instance
+ * @return A pointer to DateTimeSymbols of the formatter
* @see SetDateTimeSymbols()
*/
const DateTimeSymbols* GetDateTimeSymbols(void) const;
/**
- * Sets the date and time format symbols of the date format.
+ * Sets the date and time format symbols of the formatter.
*
* @since 2.0
*
- * @param[in] newSymbols The new date and time format symbols
+ * @param[in] newSymbols The date and time format symbols
* @see GetDateTimeSymbols()
*/
void SetDateTimeSymbols(const DateTimeSymbols& newSymbols);
/**
* @class DateTimeSymbols
- * @brief This class provides methods that help in providing date and time symbols.
+ * @brief This class provides methods for date and time symbols.
*
* @since 2.0
*
- * The %DateTimeSymbols class is used for encapsulating localizable date-time formatting data, such as the names of the months, the days of the week, and the time zone data.
- * It is also used by DateTimeFormatter.
- * %DateTimeSymbols specifies the exact character strings to use for various parts of a date or time. For example, the names of the months and days of the week, the strings for AM and PM, and the day of the week considered to be the first day of the week.
+ * The %DateTimeSymbols class is used for encapsulating localizable date-time formatting data, such as the names of the months,
+ * the days of the week, and the time zone data. It is also used by DateTimeFormatter.
+ * %DateTimeSymbols specifies the exact character strings to use for various parts of a date or time. For example, the names of
+ * the months and days of the week, the strings for AM and PM, and the day of the week considered to be the first day of the week.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/locales/datetime_formatter.htm">Date and Time Formatter</a>.
*
public:
/**
* This is the default constructor for this class. @n
- * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
+ * The object is not fully constructed after this constructor is called. For full construction, the Construct() method
+ * must be called right after calling this constructor.
*
* @since 2.0
- *
- * @see Construct()
*/
DateTimeSymbols(void);
* Initializes this instance of %DateTimeSymbols with the specified @c locale and @c calendarType.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompDateTimeSymbolsConstructPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompDateTimeSymbolsConstructPage "here".
* @endif
*
* @return An error code
* @param[in] calendarType The calendar type
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG The specified @c locale or @c calendarType is invalid.
+ * @exception E_INVALID_ARG The specified @c locale or @c calendarType is invalid.
*/
result Construct(const Locale& locale, CalendarType calendarType = CALENDAR_GREGORIAN);
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompDateTimeSymbolsConstructPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompDateTimeSymbolsConstructPage "here".
* @endif
*
* @return An error code
* @param[in] calendarType The calendar type
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG The specified @c calendarType is invalid.
+ * @exception E_INVALID_ARG The specified @c calendarType is invalid.
*/
result Construct(CalendarType calendarType);
/**
* @if OSPCOMPAT
- * @page CompDateTimeSymbolsConstructPage Compatibility for Construct()
- * @section CompDateTimeSymbolsConstructIssueSection Issues
- * Implementation of this method in OSP compatible applications has the following issue: @n
- * -# The method returns E_UNSUPPORTED_OPERATION if the @c calendarType is invalid.
- *
- * @section CompDateTimeSymbolsConstructSolutionSection Resolutions
- * This issue has been resolved in Tizen.
- * @par When working in Tizen:
- * -# The method returns E_INVALID_ARG if the @c calendarType is invalid.
+ * @page CompDateTimeSymbolsConstructPage Compatibility for Construct()
+ * @section CompDateTimeSymbolsConstructIssueSection Issues
+ * Implementation of this method in OSP compatible applications has the following issue: @n
+ * -# The method returns E_UNSUPPORTED_OPERATION if the @c calendarType is invalid.
+ *
+ * @section CompDateTimeSymbolsConstructSolutionSection Resolutions
+ * This issue has been resolved in Tizen.
+ * @par When working in Tizen:
+ * -# The method returns E_INVALID_ARG if the @c calendarType is invalid.
* @endif
- */
+ */
/**
/**
* Sets the era strings. @n
- * Multiple strings can be concatenated by '|'. For example: "AD|BC".
+ * Multiple strings can be concatenated using '|'. For example: "AD|BC".
*
* @since 2.0
*
* @return An error code
- * @param[in] eras The era strings concatenated by '|'
+ * @param[in] eras The era strings concatenated using '|'
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c eras contains an invalid value.
* @see GetEras()
/**
* Gets the list of the month name strings. @n
- * For example: "January", "February", etc.
+ * For example: "January", "February".
*
* @since 2.0
*
/**
- * Sets the month name strings concatenated by '|'. @n
+ * Sets the month name strings concatenated using '|'. @n
* For example: "January|February|March|April|May|June|July|August|September|October|November|December".
*
* @since 2.0
*
* @return An error code
- * @param[in] months The new month strings concatenated by '|'
+ * @param[in] months The month strings concatenated using '|'
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c months contains an invalid value.
* @see GetMonths()
/**
* Gets the list of the short month name strings. @n
- * For example: "Jan", "Feb", etc.
+ * For example: "Jan", "Feb".
*
* @since 2.0
*
/**
- * Sets the short month name strings concatenated by '|'. @n
+ * Sets the short month name strings concatenated using '|'. @n
* For example: "Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec".
*
- * @since 2.0
+ * @since 2.0
* @return An error code
- * @param[in] shortMonths The new short month name strings concatenated by '|'
+ * @param[in] shortMonths The short month name strings concatenated using '|'
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c shortMonths contains an invalid value. @n See the valid string in the description of the method.
- * @see GetShortMonths()
+ * @exception E_INVALID_ARG The specified @c shortMonths contains an invalid value. @n
+ * See the valid string in the description of the method.
+ * @see GetShortMonths()
*/
result SetShortMonths(const Tizen::Base::String& shortMonths);
/**
* Gets the list of the weekday name strings. @n
- * For example: "Sunday", "Monday", etc.
+ * For example: "Sunday", "Monday".
*
* @since 2.0
*
* @since 2.0
*
* @return An error code
- * @param[in] weekdays The new weekday name strings concatenated by '|'
+ * @param[in] weekdays The weekday name strings concatenated using '|'
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c weekdays contains an invalid value.
* @see GetWeekdays()
/**
* Gets the list of the short weekday name strings. @n
- * For example: "Sun", "Mon", etc.
+ * For example: "Sun", "Mon".
*
* @since 2.0
*
/**
- * Sets the weekday name strings concatenated by '|'. @n
+ * Sets the weekday name strings concatenated using '|'. @n
* For example: "Sun|Mon|Tue|Wed|Thu|Fri|Sat".
*
* @since 2.0
*
* @return An error code
- * @param[in] shortWeekdays The new short weekday strings concatenated by '|'
+ * @param[in] shortWeekdays The short weekday strings concatenated using '|'
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c shortWeekdays contains an invalid value.
* @see GetShortWeekdays()
/**
- * Sets the AM/PM strings concatenated by '|'. @n
+ * Sets the AM/PM strings concatenated using '|'. @n
* For example: "AM|PM".
*
* @since 2.0
*
* @return An error code
- * @param[in] amPm The new AM/PM strings concatenated by '|'
+ * @param[in] amPm The AM/PM strings concatenated using '|'
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c amPm contains an invalid value.
* @see GetAmPm()
* Gets the name of the time zone. @n
* For example: "Eastern European Time (EET)", "Eastern European Summer Time (EEST)".
*
- * @since 2.0
+ * @since 2.0
*
- * @return The time zone name, @n
- * else an empty string if @c timeZoneId is not found @n
- * or the time zone name of @c timeZoneStyle is not found.
+ * @return The time zone name, @n
+ * else an empty string if @c timeZoneId is not found @n
+ * or the time zone name of @c timeZoneStyle is not found.
* @param[in] timeZoneId The time zone ID
* @param[in] timeZoneStyle The parameter may contain one of the following time zone styles:
* @li The normal time zone (0)
* @return An error code
* @param[in] timeZoneId The time zone ID @n
* For example: "Europe/Helsinki".
- * @param[in] concatenatedTimeZoneName The new concatenated time zone name @n
+ * @param[in] concatenatedTimeZoneName The concatenated time zone name @n
* For example, "Eastern European Time|EET|Eastern European Summer Time|EEST".
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c timeZoneId or @c concatenatedTimeZoneName contains an invalid value.
* @exception E_OBJ_NOT_FOUND The specified @c timeZoneId is not found.
- * @see GetTimeZoneName()
- * @see AddTimeZoneName()
+ * @see GetTimeZoneName()
+ * @see AddTimeZoneName()
*/
result SetTimeZoneName(const Tizen::Base::String& timeZoneId, const Tizen::Base::String& concatenatedTimeZoneName);
/**
- * Adds a new time zone name string that is related to time zone ID.
+ * Adds the time zone name that is related to time zone ID.
*
* @since 2.0
*
/**
* @class GregorianCalendar
- * @brief This class is a concrete subclass of calendar and provides the Gregorian calendar that is the most commonly used standard calendar.
+ * @brief This class is a concrete subclass of calendar and provides the Gregorian calendar that is the most commonly used
+ * standard calendar.
*
* @since 2.0
*
- * @final This class is not intended for extension.
+ * @final This class is not intended for extension.
*
* The %GregorianCalendar class is a concrete subclass of calendar and provides the Gregorian calendar that is the most commonly used standard calendar.
*
public:
/**
* This is the default constructor for this class. @n
- * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
+ * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must
+ * be called right after calling this constructor.
*
* @since 2.0
- *
- * @see Construct()
*/
GregorianCalendar(void);
/**
- * Initializes this instance of %GregorianCalendar with the current GMT time zone and the system locale.
- * The time zone is used for the zone offset and the DST offset.
- * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set and weekend cease.
- * The weekdata are set as default values by the locale.
- *
- * @since 2.0
- *
- * @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- */
+ * Initializes this instance of %GregorianCalendar with the current GMT time zone and the system locale. @n
+ * The time zone is used for the zone offset and the DST offset.
+ * An instance has weekdata which is the first of week, minimal days in the first week, weekend on set and weekend cease.
+ * The weekdata is set to default values by the locale.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ */
result Construct(void);
/**
* Initializes this instance of %GregorianCalendar based on the current time in the specified time zone with the system locale. @n
* The @c timeZone is used for the zone offset and the DST offset.
- * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease.
- * The weekdata are set as default values by the locale.
+ * An instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease.
+ * The weekdata is set to default values by the locale.
*
* @since 2.0
*
/**
* Initializes this instance of %GregorianCalendar based on the current time in the GMT time zone with the specified @c locale.
* The time zone is used for the zone offset and the DST offset.
- * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease.
- * The weekdata are set as default values by the specified @c locale.
+ * An instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease.
+ * The weekdata is set to default values by the specified @c locale.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompGregorianCalendarConstructPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompGregorianCalendarConstructPage "here".
* @endif
*
* @return An error code
- * @param[in] locale An instance of Locale
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG The specified @c locale is invalid.
+ * @param[in] locale An instance of Locale
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_ARG The specified @c locale is invalid.
*/
result Construct(const Locale& locale);
/**
* Initializes this instance of %GregorianCalendar based on the current time in the specified time zone with the specified system locale. @n
* The @c timeZone is used for the zone offset and the DST offset.
- * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease.
- * The weekdata are set as default values by the specified @c locale.
+ * An instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease.
+ * The weekdata is set to default values by the specified @c locale.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompGregorianCalendarConstructPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompGregorianCalendarConstructPage "here".
* @endif
*
* @return An error code
* @param[in] locale An instance of Locale
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG The specified @c locale is invalid.
+ * @exception E_INVALID_ARG The specified @c locale is invalid.
*/
result Construct(const TimeZone& timeZone, const Locale& locale);
/**
* @if OSPCOMPAT
- * @page CompGregorianCalendarConstructPage Compatibility for Construct()
- * @section CompGregorianCalendarConstructIssueSection Issues
+ * @page CompGregorianCalendarConstructPage Compatibility for Construct()
+ * @section CompGregorianCalendarConstructIssueSection Issues
* Implementation of this method in OSP compatible applications has the following issue: @n
- * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid.
+ * -# The method returns @c E_UNSUPPORTED_OPERATION if the @c locale is invalid.
*
- * @section CompGregorianCalendarConstructSolutionSection Resolutions
+ * @section CompGregorianCalendarConstructSolutionSection Resolutions
* This issue has been resolved in Tizen.
* @par When working in Tizen:
- * -# The method returns E_INVALID_ARG if the @c locale is invalid.
+ * -# The method returns @c E_INVALID_ARG if the @c locale is invalid.
* @endif
*/
* Initializes this instance of %GregorianCalendar based on the specified @c year, @c month, @c day, @c hour, @c minute, and @c second
* in the GMT time zone with the system locale. @n
* The time zone is used for the zone offset and the DST offset.
- * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease.
- * The weekdata are set as default values by the locale.
- * The Gregorian calendar is lenient: time fields are normalized when the user calls the Calendar::GetTimeField() method.
+ * An instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease.
+ * The weekdata is set to default values by the locale.
+ * The Gregorian calendar is lenient; time fields are normalized when the user calls the Calendar::GetTimeField() method.
*
* @since 2.0
*
* @return An error code
- * @param[in] year An integer value used to set the year time field
- * @param[in] month An integer value used to set the month time field @n
+ * @param[in] year The year value
+ * @param[in] month The month value @n
* The indexing is 1-based. Therefore, 1 means January.
- * @param[in] day An integer value used to set the date time field
- * @param[in] hour An integer value used to set the hour time field
- * @param[in] minute An integer value used to set the minute time field
- * @param[in] second An integer value used to set the second time field
+ * @param[in] day The date value
+ * @param[in] hour The hour value
+ * @param[in] minute The minute value
+ * @param[in] second The second value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG An argument is invalid.
+ * @exception E_INVALID_ARG A specified argument is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_OUT_OF_RANGE In this method, time fields of this instance are calculated. @n
- * If the value of the time fields goes out of range, this exception is returned.
+ * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n
+ * If the value of the time fields go out of range, this exception is returned.
*/
result Construct(int year, int month, int day, int hour = 0, int minute = 0, int second = 0);
/**
* Initializes this instance of %GregorianCalendar based on the specified date and time in the GMT time zone with the system locale. @n
* The time zone is used for the zone offset and the DST offset.
- * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease.
- * The weekdata are set as default values by the locale.
+ * An instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease.
+ * The weekdata is set to default values by the locale.
*
* @since 2.0
*
* @param[in] dateTime An instance of Tizen::Base::DateTime
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG The specified @c dateTime is invalid.
- * @exception E_OUT_OF_RANGE In this method, time fields of this instance are calculated. @n
- * If the value of the time fields goes out of range, this exception is returned.
+ * @exception E_INVALID_ARG The specified @c dateTime is invalid.
+ * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n
+ * If the value of the time fields go out of range, this exception is returned.
*/
result Construct(const Tizen::Base::DateTime& dateTime);
/**
* Adds the specified amount to the specified time field, based on the calendar rules. @n
- * It is equivalent to calling Set(field, GetTimeField(field)+amount) with two adjustments. @n
+ * It is equivalent to calling Set(field, GetTimeField(field)+amount) with the following two adjustments: @n
*
- * @b Add @b Rule1: The value of @c field after the call minus the value of @c field before the call is delta, modulo any overflow that has occurred in @c field.
- * Overflow occurs when the @c field value exceeds its range and, as a result, the next larger field is incremented or decremented and the @c field value is adjusted back into its range. @n
+ * @b Add @b Rule1: The value of @c field after the call minus the value of @c field before the call is delta, modulo any
+ * overflow that has occurred in @c field. Overflow occurs when the @c field value exceeds its range and, as a result,
+ * the next larger field is incremented or decremented and the @c field value is adjusted back into its range. @n
*
- * @b Add @b Rule2: If a smaller field is expected to be invariant, but it is impossible for it to be equal to its prior value because of
- * changes in its minimum or maximum value after the @c field value is changed, then its value is adjusted to the closest possible value. @n
+ * @b Add @b Rule2: If a smaller field is expected to be invariant, but it is impossible for it to be equal to its prior
+ * value because of changes in its minimum or maximum value after the @c field value is changed, then its value is adjusted
+ * to the closest possible value. @n
*
- * A smaller field represents a smaller unit of time. The TIME_FIELD_HOUR field is smaller than the TIME_FIELD_DAY_OF_MONTH field.
+ * A smaller field represents a smaller unit of time. The @c TIME_FIELD_HOUR field is smaller than the @c TIME_FIELD_DAY_OF_MONTH field.
* No adjustment is made to smaller fields that are not expected to be invariant.
* The calendar system determines what fields are expected to be invariant. @n
*
- * In addition, this method forces re-computation of the calendar's milliseconds and all time fields immediately.
+ * In addition, this method forces re-computation of the calendar's milliseconds and all the time fields immediately.
* @n
- * For example, consider a %GregorianCalendar set to Oct. 31. 2004. Calling AddTimeField(TIME_FIELD_MONTH, 13) sets the calendar to Nov. 30. 2005.
- * The TIME_FIELD_MONTH field is set to TIME_FIELD_NOVEMBER by @b Rule1, since adding 13 months to October gives November of the next year. Since
- * the TIME_FIELD_DAY_OF_MONTH cannot be 31 in November in a %GregorianCalendar, TIME_FIELD_DAY_OF_MONTH is set to 30 by @b Rule2.
+ * For example, consider a %GregorianCalendar set to Oct. 31. 2004. Calling AddTimeField(@c TIME_FIELD_MONTH, 13) sets the calendar to Nov. 30. 2005.
+ * The @c TIME_FIELD_MONTH field is set to @c TIME_FIELD_NOVEMBER by @b Rule1, since adding 13 months to October gives the month
+ * value as November of the next year. Since the @c TIME_FIELD_DAY_OF_MONTH cannot be 31 in November in a %GregorianCalendar,
+ * @c TIME_FIELD_DAY_OF_MONTH is set to 30 by @b Rule2.
*
* @since 2.0
*
* @return An error code
- * @param[in] field The time field
- * @param[in] amount The amount to add
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c field is invalid.
- * @exception E_OUT_OF_RANGE In this method, time fields of this instance are calculated. @n
- * If the value of the time fields goes out of range, this exception is returned.
- * @remarks The TIME_FIELD_EXTENDED_YEAR and TIME_FIELD_YEAR_WOY fields cannot be added.
+ * @param[in] field The time field
+ * @param[in] amount The amount to add
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified @c field is invalid.
+ * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n
+ * If the value of the time fields go out of range, this exception is returned.
+ * @remarks The @c TIME_FIELD_EXTENDED_YEAR and @c TIME_FIELD_YEAR_WOY fields cannot be added.
*/
virtual result AddTimeField(TimeField field, int amount);
* @since 2.0
*
* @return An integer value indicating the actual minimum value
- * @param[in] field The time field
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified time field is invalid.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @param[in] field The time field
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified time field is invalid.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
virtual int GetActualMinTimeField(TimeField field) const;
* @since 2.0
*
* @return An integer value indicating the actual maximum value
- * @param[in] field The time field
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified time field is invalid.
-
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @param[in] field The time field
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified time field is invalid.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
virtual int GetActualMaxTimeField(TimeField field) const;
- /*
+ /**
* Gets the Gregorian Calendar change date. @n
* This is the point when the switch from Julian dates to Gregorian dates occurred.
- * Default is 00:00:00 local time, October 15, 1582. Previous to this the time and date are Julian dates.
+ * Default is 00:00:00 local time, October 15, 1582. Previous to this, the time and date are Julian dates.
*
* @since 2.0
*
- * @return The milliseconds which is the Gregorian cutover time for this calendar
+ * @return The Gregorian cutover time for this calendar in milliseconds
*/
long long GetGregorianChange(void) const;
* @since 2.0
*
* @return An instance of CalendarType representing the calendar type of the current instance of Calendar @n
- * In this case, CALENDAR_GREGORIAN.
+ * In this case, @c CALENDAR_GREGORIAN.
*/
virtual CalendarType GetType(void) const;
* @param[out] isInDst Set to @c true if the current date is in DST, @n
* else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE In this method, time fields of this instance are calculated. @n
- * If the value of the time fields goes out of range, this exception is returned.
- * @exception E_INVALID_STATE In this method, time fields of this instance are calculated. @n
- * If any time field value previously set is invalid, this exception is returned.
+ * @exception E_OUT_OF_RANGE In this method, time fields of this instance are calculated. @n
+ * If the value of the time fields go out of range, this exception is returned.
+ * @exception E_INVALID_STATE In this method, time fields of this instance are calculated. @n
+ * If any time field value previously set is invalid, this exception is returned.
*/
virtual result IsInDst(bool& isInDst) const;
bool IsLeapYear(int year) const;
- /*
+ /**
* Sets the Gregorian Calendar change date. @n
* This is the point when the switch from Julian dates to Gregorian dates occurred.
* Default is 00:00:00 local time, Oct 15, 1582. Previous to this, dates are in the Julian calendar.
*
- * To obtain a pure Julian calendar, set the change @c change to MAX_MILLISECOND.
- * To obtain a pure Gregorian calendar, set the change @c change to MIN_MILLISECOND.
+ * To obtain a pure Julian calendar, set @c change to @c MAX_MILLISECOND.
+ * To obtain a pure Gregorian calendar, set @c change to @c MIN_MILLISECOND.
*
* @since 2.0
*
* @return An error code
- * @param[in] change The given Gregorian cutover date
+ * @param[in] change The Gregorian cutover date
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
*/
/**
* Rolls up or down as per the specified amount in the specified field. @n
- * This method overrides Calendar(). @n
+ * This method overrides Calendar().Roll(TimeField, int). @n
* For more details, refer to Tizen::Locales::Calendar::Roll(TimeField, int).
*
* @since 2.0
* @param[in] amount The amount to roll up/down
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE In this method, time fields of this instance are calculated. @n
- * If any time field value previously set is invalid, this exception is returned.
- * @exception E_INVALID_ARG The specified @c field is invalid (for example, TIME_FIELD_DST_OFFSET, TIME_FIELD_ZONE_OFFSET).
- * @exception E_OUT_OF_RANGE In this method, time fields of this instance are calculated. @n
- * If the value of the time fields goes out of range, this exception is returned.
+ * If any time field value previously set is invalid, this exception is returned.
+ * @exception E_INVALID_ARG The specified @c field is invalid (for example, @c TIME_FIELD_DST_OFFSET, @c TIME_FIELD_ZONE_OFFSET).
+ * @exception E_OUT_OF_RANGE In this method, time fields of this instance are calculated. @n
+ * If the value of the time fields go out of range, this exception is returned.
*/
virtual result Roll(TimeField field, int amount);
- /*
- * Gets the millisecond which is midnight, local time at or before the Gregorian cutover.
+ /**
+ * Gets the midnight, local time at or before the Gregorian cutover in milliseconds.
*
* @since 2.0
*
- * @return The millisecond which is midnight, local time at or before the Gregorian cutover
- * If this method fails, @c -1 is returned.
+ * @return The midnight, local time at or before the Gregorian cutover in milliseconds. @n
+ * If this method fails, @c -1 is returned. @n
* The specific error code can be accessed using the GetLastResult() method.
*/
long long GetNormalizedGregorianCutover(void) const;
- /*
+ /**
* Gets the year of the Gregorian cutover, with @c 0 representing 1 BC, @c -1 representing 2 BC, and so on.
*
* @since 2.0
*
- * @return The year of the Gregorian cutover
- * If this method fails, @c -1 is returned.
+ * @return The year of the Gregorian cutover @n
+ * If this method fails, @c -1 is returned. @n
* The specific error code can be accessed using the GetLastResult() method.
*/
int GetGregorianCutoverYear(void) const;
- /*
+ /**
* Gets the Julian day number of the Gregorian cutover.
*
* @since 2.0
int GetCutoverJulianDay(void) const;
- /*
+ /**
* Checks whether the current calendar is a Gregorian calendar or not.
*
* @since 2.0
public:
/*
- * Defines the length of months.
+ * The length of months.
*
* @since 2.0
*/
static const int MONTH_LENGTH[24];
/*
- * Defines the days of a year.
+ * The days of a year.
*
* @since 2.0
*/
* @enum LanguageCode
*
* Defines the ISO 639-2 language code. @n
- * The LanguageCode enumerator represents the ISO 639-2 language codes. @n
+ * This enum represents the ISO 639-2 language codes. @n
* The specific LanguageCode represents the language code with the locale's ISO-15924 abbreviation script code. @n
* The supported ISO-15924 script codes are Arabic, Cyrillic, Latin, Hans, Hant and Gurmukhi.
*
* @enum CountryCode
*
* Defines the ISO 3166-1 alpha-2 country code. @n
- * The CountryCode enumerator represents the ISO 3166-1 alpha-2 country codes.
- * The area code for Latin america and the Caribbean represents the ISO 3166-1 numeric-3.
+ * This enum represents the ISO 3166-1 alpha-2 country codes.
+ * The area code for Latin america and the Caribbean represents the ISO 3166-1 numeric-3 code.
*
* @since 2.0
*/
*
* @final This class is not intended for extension.
*
- * @remarks For more information on the example codes for %Locale class, see LocaleManager.
+ * @remarks For more information on the example codes for the %Locale class, see LocaleManager.
*
* The %Locale class represents a specific geographical, political, or cultural region. @n
* A %Locale object has three attributes:
*
* @since 2.0
*
- * @param[in] languageCode The language code
- * @param[in] countryCode The country code
- * @param[in] pVariantCodeString A pointer to the variant code string @n
- * It is converted to a uppercase letter if it is written in a lowercase letter.
+ * @param[in] languageCode The language code
+ * @param[in] countryCode The country code
+ * @param[in] pVariantCodeString A pointer to the variant code string @n
+ * It is converted to upper case letters if it is written in lower case letters.
*/
Locale(LanguageCode languageCode, CountryCode countryCode, const Tizen::Base::String* pVariantCodeString = null);
* Assigns the value of the specified instance to the current instance of %Locale. @n
* Copying of objects using this copy assignment operator is allowed.
*
- * @since 2.0
+ * @since 2.0
*
* @return A reference to the current instance of %Locale
- * @param[in] otherLocale An instance of %Locale
+ * @param[in] otherLocale An instance of %Locale
*/
Locale& operator =(const Locale& otherLocale);
/**
* Compares the current instance of %Locale with the specified instance of %Locale.
*
- * @since 2.0
+ * @since 2.0
*
* @return @c true if the value of the specified instance is equal to the value of the current instance, @n
* else @c false
- * @param[in] otherLocale An instance of %Locale
+ * @param[in] otherLocale An instance of %Locale
*/
bool operator ==(const Locale& otherLocale) const;
bool operator !=(const Locale& otherLocale) const;
/**
- * Converts the operand @c obj to an object of the %Locale type and then compares it with the current instance of %Locale.
+ * Converts the operand @c obj to an object of the %Locale type and compares it with the current instance of %Locale.
*
* @since 2.0
*
* @return @c true if the value of the current instance is equal to the value of the specified Tizen::Base::Object, @n
* else @c false
- * @param[in] obj The object to compare with the current instance
- * @see Tizen::Base::Object::Equals()
+ * @param[in] obj The object to compare with the current instance
+ * @see Tizen::Base::Object::Equals()
*/
virtual bool Equals(const Object& obj) const;
* @since 2.0
*
* @return The language code, @n
- * The specific language code string has the locale's ISO-15924 abbreviation script code.
+ * The specific language code string has the locale's ISO-15924 abbreviation script code.
*/
Tizen::Base::String GetLanguageCodeString(void) const;
*
* @since 2.0
*
- * @return The variant code string written in a uppercase letter even if it was set to a lowercase letter, @n
+ * @return The variant code string in upper case letters even if it was set to lower case letters, @n
* else an empty string if the variant is not specified
* @see SetVariantCodeString()
*/
* Gets the string representing the current instance of %Locale. @n
* The string consists of the values returned by GetLanguageCodeString(), GetCountryCodeString(), and GetVariantCodeString() assembled into a string.
*
- * @since 2.0
+ * @since 2.0
*
- * @return A concatenated string with the language code string, country code string, and variant string @n
- * For example, if the language code is LANGUAGE_ENG, country code is COUNTRY_US, and variant string is empty, @n
+ * @return The concatenated string with the language code string, country code string, and variant string @n
+ * For example, if the language code is ::LANGUAGE_ENG, country code is ::COUNTRY_US, and variant string is empty, @n
* the locale code string is "eng_US".
- * @see GetLanguageCodeString()
- * @see GetCountryCodeString()
- * @see GetVariantCodeString()
*/
Tizen::Base::String GetLocaleCodeString(void) const;
/**
- * Gets the country name of the current instance of %Locale that is appropriate for display to the user. @n
+ * Gets the country name of the current instance of %Locale that is appropriate for display. @n
* The name is localized for this locale. For example, if this locale is eng_US, the name is "United States".
*
* @since 2.0
*
* @return An error code
- * @param[out] countryName The country name of the locale
- * @exception E_SUCCESS The method is successful.
- * @exception E_UNSUPPORTED_OPERATION The current @c locale does not have country name entry in the database.
+ * @param[out] countryName The country name of the locale
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_UNSUPPORTED_OPERATION The current @c locale does not have a country name entry in the database.
*/
result GetCountryName(Tizen::Base::String& countryName) const;
/**
- * Gets the country name of the current instance of %Locale that is appropriate for display to the user in the specified %Locale. @n
+ * Gets the country name of the current instance of %Locale that is appropriate for display in the specified %Locale. @n
* The country name is localized for the specified locale(@c otherLocale). For example, if
* the current instance of %Locale is fra_FR and the @c otherLocale is eng_US, the name is "France";
* if the current instance is eng_US and the @c otherLocale is fra_FR, the name returned is "Etats-Unis".
* @since 2.0
*
* @return An error code
- * @param[in] otherLocale An instance of %Locale according to which the country name of the specified %Locale is displayed
- * @param[out] countryName The country name of the locale
- * @exception E_SUCCESS The method is successful.
- * @exception E_UNSUPPORTED_OPERATION The specified @c locale is not supported, or the current @c locale does not have country name entry in the database.
+ * @param[in] otherLocale An instance of %Locale to display the country name
+ * @param[out] countryName The country name of the locale
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_UNSUPPORTED_OPERATION The specified @c locale is not supported, or the current @c locale does not have a country name entry in the database.
*/
result GetCountryName(const Locale& otherLocale, Tizen::Base::String& countryName) const;
/**
- * Gets the language name of the current instance of %Locale that is appropriate for display to the user. @n
- * The name is localized for the locale. For example, if this locale is
- * eng_US, the name is "English".
+ * Gets the language name of the current instance of %Locale that is appropriate for display. @n
+ * The name is localized for the locale. For example, if this locale is eng_US, the name is "English".
*
* @since 2.0
*
* @return An error code
- * @param[out] languageName The language name of the locale
- * @exception E_SUCCESS The method is successful.
- * @exception E_UNSUPPORTED_OPERATION The current @c locale does not have country name entry in the database.
+ * @param[out] languageName The language name of the locale
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_UNSUPPORTED_OPERATION The current @c locale does not have a country name entry in the database.
*/
result GetLanguageName(Tizen::Base::String& languageName) const;
/**
- * Gets the language name of the current instance of %Locale that is appropriate for display to the user in the specified %Locale. @n
+ * Gets the language name of the current instance of %Locale that is appropriate for display in the specified %Locale. @n
* The name is localized for the specified locale (@c otherLocale). For example, if
* the current instance is fra_FR and the @c otherLocale is eng_US, the name is "French";
* if the current instance is engUS and the @c otherLocale is fra_FR, the name returned is "anglais".
* @since 2.0
*
* @return An error code
- * @param[in] otherLocale An instance of %Locale according to which the language name of the specified %Locale is displayed
- * @param[out] languageName The language name of the locale
- * @exception E_SUCCESS The method is successful.
+ * @param[in] otherLocale An instance of %Locale to display the language name
+ * @param[out] languageName The language name of the locale
+ * @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_OPERATION The specified @c locale is not supported, or the current @c locale does not have country name entry in the database.
*/
result GetLanguageName(const Locale& otherLocale, Tizen::Base::String& languageName) const;
/**
* Sets the variant code with the specified variant code string. @n
- * The variant code string is converted to a uppercase letter even if it is set to a lowercase letter.
+ * The variant code string is converted to upper case letters even if it is set to lower case letters.
*
* @since 2.0
*
- * @param[in] pVariantCode A pointer to the variant code
+ * @param[in] pVariantCode The pointer to the variant code
*/
void SetVariantCodeString(const Tizen::Base::String* pVariantCode = null);
* @since 2.0
*
* @param[in] languageCodeString The language code, @n
- * To get the specified LanguageCode with the locale's ISO-15924 abbreviation script code, @n
- * the form of languageCodeString should combine the ISO 639-2 language codes and the locale's ISO-15924 abbreviation script code by "-". @n
- * For example, if the language code is "aze" and the script code is "latn", @n
- * the languageCodeString is "aze-latn", and the LanguageCode is LANGUAGE_AZE_LATIN.
- * @return An instance of LanguageCode associated with the @c languageCodeString.
+ * To get the specified language code with the locale's ISO-15924 abbreviation script code,
+ * the form of @c languageCodeString should combine the ISO 639-2 language codes and the locale's
+ * ISO-15924 abbreviation script code by "-". @n
+ * For example, if the language code is "aze" and the script code is "latn",
+ * the @c languageCodeString is "aze-latn", and the language code is @c LANGUAGE_AZE_LATIN.
+ * @return An instance of LanguageCode associated with @c languageCodeString.
*/
static LanguageCode StringToLanguageCode(const Tizen::Base::String& languageCodeString);
/**
- * Gets the country code equivalent to the specified country code string.
+ * Gets the country code equivalent of the specified country code string.
*
* @since 2.0
*
* @param[in] countryCodeString The country code
- * @return An instance of CountryCode associated with the @c countryCodeString.
+ * @return An instance of CountryCode associated with the @c countryCodeString.
*/
static CountryCode StringToCountryCode(const Tizen::Base::String& countryCodeString);
/**
- * Gets the language code string equivalent to the specified @c languageCode.
+ * Gets the language code string equivalent of the specified @c languageCode.
*
* @since 2.0
*
* @param[in] languageCode The language code
- * @return The language code string associated with the @c languageCode, @n
- * else an empty string if languageCode is invalid.
- * @see StringToLanguageCode()
+ * @return The language code string associated with @c languageCode, @n
+ * else an empty string if @c languageCode is invalid.
+ * @see StringToLanguageCode()
*/
static Tizen::Base::String LanguageCodeToString(LanguageCode languageCode);
/**
- * Gets the country code string equivalent to the specified @c countryCode.
+ * Gets the country code string equivalent of the specified @c countryCode.
*
* @since 2.0
*
* @param[in] countryCode The country code
- * @return The ISO 3166-1 alpha-2 country code string associated with the @c countryCode, @n
- * else an empty string if countryCode is invalid.
+ * @return The ISO 3166-1 alpha-2 country code string associated with @c countryCode, @n
+ * else an empty string if @c countryCode is invalid.
*/
static Tizen::Base::String CountryCodeToString(CountryCode countryCode);
/**
- * Gets the 2-letter language code string equivalent to the specified @c languageCode.
+ * Gets the 2-letter language code string equivalent of the specified @c languageCode.
*
* @since 2.0
*
* @param[in] languageCode The language code
- * @return The ISO 639-2 language code string associated with the @c languageCode, @n
- * or The ISO 639-2 language code string with the ISO-15924 script code @n
- * if the @c languageCode represents The ISO 639-2 language code with the ISO-15924 script code, @n
- * else an empty string if languageCode is invalid.
+ * @return The ISO 639-2 language code string associated with @c languageCode, @n
+ * or the ISO 639-2 language code string with the ISO-15924 script code if the @c languageCode represents
+ * the ISO 639-2 language code with the ISO-15924 script code, @n
+ * else an empty string if @c languageCode is invalid.
*/
static Tizen::Base::String LanguageCodeToTwoLetterLanguageCodeString(LanguageCode languageCode);
/**
- * Gets the language code equivalent to the specified 2-letter language code string.
+ * Gets the language code equivalent of the specified 2-letter language code string.
*
* @since 2.0
*
* @param[in] languageCodeString The language code string
- * @return An instance of LanguageCode associated with the @c languageCodeString.
- * @see StringToLanguageCode()
+ * @return An instance of LanguageCode associated with @c languageCodeString.
+ * @see StringToLanguageCode()
*/
static LanguageCode TwoLetterLanguageCodeStringToLanguageCode(const Tizen::Base::String& languageCodeString);
/**
- * Gets the 3-letter country code string equivalent to the specified @c countryCode.
+ * Gets the 3-letter country code string equivalent of the specified @c countryCode.
*
* @since 2.0
*
* @param[in] countryCode The country code
- * @return The ISO 3166-1 alpha-3 country code string associated with the @c countryCode, @n
- * else an empty string if countryCode is invalid
- * @see CountryCodeToString()
- * @remarks COUNTRY_AREA_419 returns an empty string, since it is not defined in the ISO 3166-1 alpha-3.
+ * @return The ISO 3166-1 alpha-3 country code string associated with @c countryCode, @n
+ * else an empty string if @c countryCode is invalid
+ * @remarks @c COUNTRY_AREA_419 returns an empty string, since it is not defined in the ISO 3166-1 alpha-3.
+ * @see CountryCodeToString()
*/
static Tizen::Base::String CountryCodeToThreeLetterCountryCodeString(CountryCode countryCode);
/**
- * Gets the country code equivalent to the specified 3-letter country code string.
+ * Gets the country code equivalent of the specified 3-letter country code string.
*
* @since 2.0
*
* @param[in] countryCodeString The country code string
- * @return An instance of CountryCode associated with the @c countryCodeString.
- * @see StringToCountryCode()
+ * @return An instance of CountryCode associated with @c countryCodeString.
+ * @see StringToCountryCode()
*/
static CountryCode ThreeLetterCountryCodeStringToCountryCode(const Tizen::Base::String& countryCodeString);
/**
* @class LocaleManager
- * @brief This class is used for the %LocaleManager identification.
+ * @brief This class provides methods for %LocaleManager identification.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
- * The %LocaleManager class helps application programmers handle the system locale information of the device. Each device system has at least one installed locale and often has many locales from which the user can choose.
+ * The %LocaleManager class provides methods for the system locale information of the device. Each device system has at least
+ * one installed locale and often has many locales from which the user can choose.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/locales/lang_country_codes.htm">Retrieving Language and Country Codes</a>.
public:
/**
* This is the default constructor for this class. @n
- * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
+ * The object is not fully constructed after this constructor is called. For full construction, the Construct()
+ * method must be called right after calling this constructor.
*
* @since 2.0
*
- * @see Construct()
- *
*/
LocaleManager(void);
*
* @since 2.0
*
- * @return An instance of Locale
+ * @return The system locale
* @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * The resulting Locale instance is Locale (LANGUAGE_INVALID, COUNTRY_INVALID).
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The resulting Locale instance is Locale(@c LANGUAGE_INVALID, @c COUNTRY_INVALID).
*/
Locale GetSystemLocale(void) const;
/**
- * Gets a list of all the available locales.
+ * Gets the list of all the available locales.
*
* @since 2.0
*
- * @return A list of Locale instances, @n
- * else @c null if the method fails
+ * @return The list of available locales, @n
+ * else @c null if it fails
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The IList returned contains the list of all the locales installed on the system.
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - The Tizen::Base::Collection::IList returned contains the list of all the locales installed on the system.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetAvailableLocalesN(void) const;
*
* @since 2.0
*
- * @return An instance of Tizen::Base::String (ISO 639-2 code format), @n
+ * @return The user selected language as an instance of Tizen::Base::String (ISO 639-2 code format), @n
* else empty string if the method fails
* @exception E_SUCCESS The method is successful.
* @remarks The specific error code can be accessed using the GetLastResult() method.
/**
- * Gets a list of all the available languages supported by the device, which can be different according to the target country/region of the device.
+ * Gets the list of all the available languages supported by the device, which can be different according to the target
+ * country/region of the device.
*
* @since 2.0
*
- * @return A list of Tizen::Base::String instances (ISO 639-2 code format), @n
- * else @c null if the method fails
+ * @return The list of all available languages as Tizen::Base::String instances (ISO 639-2 code format), @n
+ * else @c null if it fails
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
/**
- * Gets a list of all the available time zone IDs.
+ * Gets the list of all the available time zone IDs.
*
* @since 2.0
*
- * @return A list of Tizen::Base::String instances, @n
- * else @c null if the method fails
+ * @return The list of all available time zone IDs as Tizen::Base::String instances, @n
+ * else @c null if it fails
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
/**
- * Gets a list of all the available time zone IDs with the specified Greenwich Mean Time (GMT) offset for this time zone.
+ * Gets the list of all the available time zone IDs with the specified Greenwich Mean Time (GMT) offset for this time zone.
*
* @since 2.0
*
- * @return A list of Tizen::Base::String instances, @n
- * else @c null if the method fails
+ * @return The list of all availabke time zone IDs with the GMT offset as Tizen::Base::String instances, @n
+ * else @c null if it fails
* @param[in] rawOffset The specified GMT offset for this time zone (Daylight Saving Time (DST) is not considered) @n
* The value of @c rawOffset is in minutes.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * If there are no time zones for the specified GMT offset, an empty list is returned.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - If there are no time zones for the specified GMT offset, an empty list is returned.
*/
Tizen::Base::Collection::IList* GetAvailableTimeZonesN(int rawOffset) const;
*
* @since 2.0
*
- * The %NumberFormatter class is used to format all number formats, including decimal and real numbers, currency, and percentage for any locale. It also provides methods to determine the locales that have number formats and their names. You can write codes completely independent of the locale conventions for decimal points, thousand separators as well as of the specific decimal digits used or whether the number format is a decimal. A normal decimal number can also be displayed as a currency or as a percentage.
+ * The %NumberFormatter class is used to format all number formats, including decimal and real numbers, currency, and percentage
+ * for any locale. It also provides methods to determine the locales that have number formats and their names. You can write
+ * codes completely independent of the locale conventions for decimal points, thousand separators, the specific
+ * decimal digits used, or the number format. A normal decimal number can also be displayed as a currency or as a percentage.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/locales/num_formatter.htm">Number Formatters</a>.
*
* Creates a number formatter for the specified locale.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompNumberFormatterCreateNumberFormatterNPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompNumberFormatterCreateNumberFormatterNPage "here".
* @endif
*
- * @return A pointer to a general number formatter for the specified @c locale, @n
+ * @return A pointer to the general number formatter for the specified @c locale, @n
* else @c null if an error occurs
* @param[in] locale An instance of Locale
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG The specified @c locale is invalid.
+ * @exception E_INVALID_ARG The specified @c locale is invalid.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static NumberFormatter* CreateNumberFormatterN(const Locale& locale);
/**
* @if OSPCOMPAT
- * @page CompNumberFormatterCreateNumberFormatterNPage Compatibility for CreateNumberFormatterN()
- * @section CompNumberFormatterCreateNumberFormatterNIssueSection Issues
- * Implementation of this method in OSP compatible applications has the following issue: @n
- * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid.
- *
- * @section CompNumberFormatterCreateNumberFormatterNSolutionSection Resolutions
- * This issue has been resolved in Tizen.
- * @par When working in Tizen:
- * -# The method returns E_INVALID_ARG if the @c locale is invalid.
+ * @page CompNumberFormatterCreateNumberFormatterNPage Compatibility for CreateNumberFormatterN()
+ * @section CompNumberFormatterCreateNumberFormatterNIssueSection Issues
+ * Implementation of this method in OSP compatible applications has the following issue: @n
+ * -# The method returns @c E_UNSUPPORTED_OPERATION if the @c locale is invalid.
+ *
+ * @section CompNumberFormatterCreateNumberFormatterNSolutionSection Resolutions
+ * This issue has been resolved in Tizen.
+ * @par When working in Tizen:
+ * -# The method returns @c E_INVALID_ARG if the @c locale is invalid.
* @endif
- */
+ */
/**
* Creates a currency formatter for the default locale.
*
* @since 2.0
*
- * @return A pointer to a currency formatter for the default locale, @n
+ * @return A pointer to the currency formatter for the default locale, @n
* else @c null if an error occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* Creates a currency formatter for the specified @c locale.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompNumberFormatterCreateCurrencyFormatterNPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompNumberFormatterCreateCurrencyFormatterNPage "here".
* @endif
*
- * @return A pointer to a currency formatter for the specified @c locale, @n
+ * @return A pointer to the currency formatter for the specified @c locale, @n
* else @c null if an error occurs
- * @param[in] locale An instance of Locale
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG The specified @c locale is invalid.
+ * @param[in] locale An instance of Locale
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_ARG The specified @c locale is invalid.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static NumberFormatter* CreateCurrencyFormatterN(const Locale& locale);
/**
* @if OSPCOMPAT
- * @page CompNumberFormatterCreateCurrencyFormatterNPage Compatibility for CreateCurrencyFormatterN()
- * @section CompNumberFormatterCreateCurrencyFormatterNIssueSection Issues
- * Implementation of this method in OSP compatible applications has the following issue: @n
- * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid.
- *
- * @section CompNumberFormatterCreateCurrencyFormatterNSolutionSection Resolutions
- * This issue has been resolved in Tizen.
+ * @page CompNumberFormatterCreateCurrencyFormatterNPage Compatibility for CreateCurrencyFormatterN()
+ * @section CompNumberFormatterCreateCurrencyFormatterNIssueSection Issues
+ * Implementation of this method in OSP compatible applications has the following issue: @n
+ * -# The method returns @c E_UNSUPPORTED_OPERATION if the @c locale is invalid.
+ *
+ * @section CompNumberFormatterCreateCurrencyFormatterNSolutionSection Resolutions
+ * This issue has been resolved in Tizen.
* @par When working in Tizen:
- * -# The method returns E_INVALID_ARG if the @c locale is invalid.
+ * -# The method returns @c E_INVALID_ARG if the @c locale is invalid.
* @endif
- */
+ */
/**
* Creates a percentage formatter for the system locale.
*
* @since 2.0
*
- * @return A pointer to a percentage formatter for the default locale, @n
+ * @return A pointer to the percentage formatter for the default locale, @n
* else @c null if an error occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* Creates a percentage formatter for the specified @c locale.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompNumberFormatterCreatePercentFormatterNPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompNumberFormatterCreatePercentFormatterNPage "here".
* @endif
*
- * @return A pointer to a percentage formatter for the specified @c locale, @n
+ * @return A pointer to the percentage formatter for the specified @c locale, @n
* else @c null if an error occurs
- * @param[in] locale An instance of Locale
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @param[in] locale An instance of Locale
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_INVALID_ARG The specified @c locale is invalid.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static NumberFormatter* CreatePercentFormatterN(const Locale& locale);
- /**
+ /**
* @if OSPCOMPAT
- * @page CompNumberFormatterCreatePercentFormatterNPage Compatibility for CreatePercentFormatterN()
- * @section CompNumberFormatterCreatePercentFormatterNIssueSection Issues
- * Implementation of this method in OSP compatible applications has the following issue: @n
- * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid.
- *
- * @section CompNumberFormatterCreatePercentFormatterNSolutionSection Resolutions
- * This issue has been resolved in Tizen.
+ * @page CompNumberFormatterCreatePercentFormatterNPage Compatibility for CreatePercentFormatterN()
+ * @section CompNumberFormatterCreatePercentFormatterNIssueSection Issues
+ * Implementation of this method in OSP compatible applications has the following issue: @n
+ * -# The method returns @c E_UNSUPPORTED_OPERATION if the @c locale is invalid.
+ *
+ * @section CompNumberFormatterCreatePercentFormatterNSolutionSection Resolutions
+ * This issue has been resolved in Tizen.
* @par When working in Tizen:
- * -# The method returns E_INVALID_ARG if the @c locale is invalid.
+ * -# The method returns @c E_INVALID_ARG if the @c locale is invalid.
* @endif
- */
+ */
*
* @return An error code
* @param[in] number The number of type Tizen::Base::Long to format
- * @param[out] str The string to append to the resultant string
+ * @param[out] str The string to append
* @exception E_SUCCESS The method is successful.
*/
virtual result Format(long number, Tizen::Base::String& str) const;
*
* @return An error code
* @param[in] number The number of type Tizen::Base::Double to format
- * @param[out] str The string to append to the resultant string
+ * @param[out] str The string to append
* @exception E_SUCCESS The method is successful.
*/
virtual result Format(double number, Tizen::Base::String& str) const;
* @remarks The initial value is derived in a locale dependent way. @n
* The returned value may be @c null if no valid currency is determined
* or no currency has been set using the SetCurrency() method.
- * @see SetCurrency()
*/
virtual const Currency* GetCurrency(void) const;
/**
- * Sets the currency used by the current number format when formatting currency values.
+ * Sets the currency to be used by the current number format when formatting currency values.
*
- * @since 2.0
+ * @since 2.0
*
- * @param[in] currency The new currency to use by the current number format
+ * @param[in] currency The currency to set
* @remarks This does not update the minimum or maximum number of fractional digits used by the number format.
- * @see GetCurrency()
+ * @see GetCurrency()
*/
virtual void SetCurrency(const Currency& currency);
*
* @param[in] newValue The maximum number of integer digits allowed in the integer portion of a number, @n
* If less than zero, @c 0 is used.
- * @remarks The maximum integer digits must be greater than or equal to the minimum integer digits.
+ * @remarks The maximum integer digits must be greater than or equal to the minimum integer digits.@n
* If the new value for the maximum integer digits is less than the current value of the minimum integer digits,
* the minimum integer digits are also set to the new value.
* @see GetMaxIntegerDigits()
*
* @since 2.0
*
- * @return An integer value representing the minimum number of digits allowed in the integer portion of a number
+ * @return An integer value representing the minimum number of digits
* @see SetMinIntegerDigits()
*/
virtual int GetMinIntegerDigits(void) const;
*
* @since 2.0
*
- * @param[in] newValue The minimum number of integer digits allowed in the integer portion of a number @n
- * If less than zero, @c 0 is used.
- * @remarks The minimum integer digits must be less than or equal to the maximum integer digits.
+ * @param[in] newValue The minimum number of integer digits allowed in the integer portion of a number @n
+ * If less than zero, @c 0 is used.
+ * @remarks The minimum integer digits must be less than or equal to the maximum integer digits. @n
* If the new value for the minimum integer digits exceeds the current value of the maximum integer digits,
* the maximum integer digits are also set to the new value.
* @see GetMinIntegerDigits()
*
* @since 2.0
*
- * @return An integer value representing the maximum number of digits allowed in the fractional portion of a number
+ * @return An integer value representing the maximum number of digits
* @see SetMaxFractionDigits()
*/
virtual int GetMaxFractionDigits(void) const;
*
* @param[in] newValue The maximum number of fractional digits allowed in the fractional portion of a number @n
* If less than zero, @c 0 is used.
- * @remarks The maximum fractional digits must be greater than or equal to the minimum fractional digits.
+ * @remarks The maximum fractional digits must be greater than or equal to the minimum fractional digits. @n
* If the new value for the maximum fractional digits is less than the current value of the minimum fractional digits,
* the minimum fractional digits are also set to the new value.
* @see GetMaxFractionDigits()
*
* @param[in] newValue The minimum number of fractional digits allowed in the fractional portion of a number @n
* If less than zero, @c 0 is used.
- * @remarks The minimum fractional digits must be less than or equal to the maximum fractional digits.
+ * @remarks The minimum fractional digits must be less than or equal to the maximum fractional digits. @n
* If the new value for the minimum fractional digits exceeds the current value of the maximum fraction digits,
* the maximum fraction digits are also set to the new value.
* @see GetMinFractionDigits()
*
* @return @c true if grouping is used in the current instance of %NumberFormatter, @n
* else @c false
- * @remarks For example, in the English locale, with grouping on, the number 1234567
+ * @remarks
+ * - For example, in the English locale, with grouping on, the number 1234567
* might be formatted as "1,234,567".
- * The grouping separator as well as the size of each group is locale dependent
+ * - The grouping separator as well as the size of each group is locale dependent
* and is determined by subclasses of %NumberFormatter.
* @see SetGroupingUsed()
*/
/**
- * Sets the current instance of %NumberFormatter to use or not to use grouping.
+ * Sets the use of grouping in the current instance of %NumberFormatter.
*
* @since 2.0
*
- * @param[in] newValue Set to @c true if grouping is used in the current formatter, @n
+ * @param[in] newValue Set to @c true to use grouping in the current formatter, @n
* else @c false
* @see IsGroupingUsed()
*/
/**
- * Applies the specified pattern to the current instance of %NumberFormatter.
+ * Applies the pattern to the current instance of %NumberFormatter.
*
* @since 2.0
*
* @return An error code
- * @param[in] pattern The new pattern
- * @param[in] localized The localization On/Off flag @n
+ * @param[in] pattern The pattern to apply
+ * @param[in] localized The flag to set the localization on or off @n
* Set to @c true if the pattern is applied with the localized symbols, @n
- * else @c false.
+ * else @c false
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c pattern is invalid or its length is @c 0.
*/
/**
- * Sets a new value for the positive prefix of the current instance of %NumberFormatter.
+ * Sets the positive prefix of the current instance of %NumberFormatter.
*
* @since 2.0
*
- * @param[in] newValue The new positive prefix
+ * @param[in] newValue The positive prefix to set
* @see GetPositivePrefix()
*/
void SetPositivePrefix(const Tizen::Base::String& newValue);
/**
- * Sets a new value for the negative prefix of the current instance of %NumberFormatter.
+ * Sets the negative prefix of the current instance of %NumberFormatter.
*
* @since 2.0
*
- * @param[in] newValue The new negative prefix
+ * @param[in] newValue The negative prefix to set
* @see GetNegativePrefix()
*/
void SetNegativePrefix(const Tizen::Base::String& newValue);
/**
- * Sets a new value for the positive suffix of the current instance of %NumberFormatter.
+ * Sets the positive suffix of the current instance of %NumberFormatter.
*
* @since 2.0
*
- * @param[in] newValue The new positive suffix
+ * @param[in] newValue The positive suffix to set
* @see GetPositiveSuffix()
*/
void SetPositiveSuffix(const Tizen::Base::String& newValue);
/**
- * Sets a new value for the negative suffix of the current instance of %NumberFormatter.
+ * Sets the negative suffix of the current instance of %NumberFormatter.
*
* @since 2.0
*
- * @param[in] newValue The new negative suffix
+ * @param[in] newValue The negative suffix to set
* @see GetNegativeSuffix()
*/
void SetNegativeSuffix(const Tizen::Base::String& newValue);
/**
- * Sets a new value for the multiplier for use in percent, per mill, and so on.
+ * Sets the multiplier for use in percent, per mill, and so on.
*
* @since 2.0
*
- * @param[in] newValue The new value for the multiplier
+ * @param[in] newValue The multiplier to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @remarks For example, in percentage, set the suffixes to have "%" and the multiplier to be 100.
* @since 2.0
*
* @return An integer value representing the grouping size
- * @remarks Grouping size is the number of digits between grouping separators in the integer portion of a number. @n
- * For example, in the number "123,456.78", the grouping size is 3.
+ * @remarks The grouping size is the number of digits between the grouping separators in the integer portion of a number. @n
+ * For example, in the number "123,456.78", the grouping size is 3.
* @see SetGroupingSize()
* @see IsGroupingUsed()
*/
/**
- * Sets a new value for the grouping size.
+ * Sets the grouping size.
*
* @since 2.0
*
- * @param[in] newValue The new value for the grouping size
+ * @param[in] newValue The grouping size to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @see GetGroupingSize()
/**
- * Sets the behavior of the decimal separator. @n
+ * Sets the visibility behavior of the decimal separator. @n
* The decimal separator can be set to always appear using this method.
*
* @since 2.0
*
- * @param[in] newValue Set to @c true if the decimal separator is always shown, @n
+ * @param[in] newValue Set to @c true to always show the decimal separator, @n
* else @c false
* @see IsDecimalSeparatorAlwaysShown()
*/
/**
- * Sets the behavior of the plus sign. @n
+ * Sets the visibility behavior of the plus sign. @n
* The plus sign can be set to always appear using this method.
*
* @since 2.0
*
- * @param[in] newValue Set to @c true if the plus sign is always shown, @n
+ * @param[in] newValue Set to @c true to always show the plus sign, @n
* else @c false
* @see IsPositiveSignAlwaysShown()
*/
/**
* @class NumberSymbols
- * @brief This class provides methods that help in providing number symbols.
+ * @brief This class provides methods for number symbols.
*
* @since 2.0
*
- * The %NumberSymbols class represents the set of symbols (such as the decimal separator and the grouping separator) needed by NumberFormatter to format numbers.
- * %NumberFormatter creates its own instance of %NumberSymbols from its locale data. %NumberSymbols can be adopted by a %NumberFormatter instance, or it can be specified when a %NumberFormatter is created. If you need to change any of these symbols, you can get the %NumberSymbols instance from your %NumberFormatter and then modify it.
+ * The %NumberSymbols class represents the set of symbols (such as the decimal separator and the grouping separator) needed by
+ * NumberFormatter to format numbers. %NumberFormatter creates its own instance of %NumberSymbols from its locale data.
+ * %NumberSymbols can be adapted by a %NumberFormatter instance, or it can be specified when a %NumberFormatter is created.
+ * If you need to change any of these symbols, you can get the %NumberSymbols instance from your %NumberFormatter and then modify it.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/locales/num_symbols_currencies.htm">Number Symbols and Currencies</a>.
*/
public:
/**
* This is the default constructor for this class. @n
- * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
+ * The object is not fully constructed after this constructor is called. For full construction, the Construct()
+ * method must be called right after calling this constructor.
*
- * @since 2.0
- *
- * @see Construct()
+ * @since 2.0
*/
NumberSymbols(void);
* Initializes this instance of %NumberSymbols with the specified @c locale.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
- * @since 2.0
+ * @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompNumberSymbolsConstructPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompNumberSymbolsConstructPage "here".
* @endif
*
* @return An error code
- * @param[in] locale An instance of Locale
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @param[in] locale An instance of Locale
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_INVALID_ARG The specified @c locale is invalid.
*/
result Construct(const Locale& locale);
/**
* @if OSPCOMPAT
- * @page CompNumberSymbolsConstructPage Compatibility for Construct()
- * @section CompNumberSymbolsConstructIssueSection Issues
- * Implementation of this method in OSP compatible applications has the following issue: @n
- * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid.
- *
- * @section CompNumberSymbolsConstructSolutionSection Resolutions
- * This issue has been resolved in Tizen.
+ * @page CompNumberSymbolsConstructPage Compatibility for Construct()
+ * @section CompNumberSymbolsConstructIssueSection Issues
+ * Implementation of this method in OSP compatible applications has the following issue: @n
+ * -# The method returns @c E_UNSUPPORTED_OPERATION if the @c locale is invalid.
+ *
+ * @section CompNumberSymbolsConstructSolutionSection Resolutions
+ * This issue has been resolved in Tizen.
* @par When working in Tizen:
- * -# The method returns E_INVALID_ARG if the @c locale is invalid.
+ * -# The method returns @c E_INVALID_ARG if the @c locale is invalid.
* @endif
- */
+ */
/**
* Gets the character used for number format.
* @return The character used for number format, @n
* else an empty string if the @c symbol is invalid
* @param[in] symbol The number format symbol instance
- * @see SetNumberSymbol()
+ * @see SetNumberSymbol()
*/
Tizen::Base::String GetNumberSymbol(NumberSymbol symbol) const;
* @param[in] symbol A symbol to set
* @param[in] str The new string for symbol
* @exception E_SUCCESS The method is successful.
- * @see GetNumberSymbol()
+ * @see GetNumberSymbol()
*/
result SetNumberSymbol(NumberSymbol symbol, const Tizen::Base::String& str);
* @since 2.0
*
* @return A pointer to the current instance of Locale, @n
- * else @c null if this method fails
+ * else @c null if it fails
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
const Locale* GetLocale(void) const;
/**
* @class TimeRule
- * @brief This class is for setting and getting the time rule.
+ * @brief This class provides methods for setting and getting the time rule.
*
* @since 2.0
*
* @param[in] day The day
* @param[in] hour The hour
* @param[in] minute The minute
- * @param[in] timeMode The time mode - TIME_MODE_UTC, TIME_MODE_STANDARD, or TIME_MODE_WALL
+ * @param[in] timeMode The time mode - @c TIME_MODE_UTC, @c TIME_MODE_STANDARD, or @c TIME_MODE_WALL
*/
TimeRule(Month month, int day, int hour = 0, int minute = 0, Tizen::System::TimeMode timeMode = Tizen::System::TIME_MODE_WALL);
* @param[in] dayOfWeek The day of the week
* @param[in] hour The hour
* @param[in] minute The minute
- * @param[in] timeMode The time mode - TIME_MODE_UTC, TIME_MODE_STANDARD, or TIME_MODE_WALL
+ * @param[in] timeMode The time mode - @c TIME_MODE_UTC, @c TIME_MODE_STANDARD, or @c TIME_MODE_WALL
*/
TimeRule(Month month, Week week, DayOfWeek dayOfWeek,
int hour = 0, int minute = 0, Tizen::System::TimeMode timeMode = Tizen::System::TIME_MODE_WALL);
* @b on @b or @b before @c day
* @param[in] hour The hour
* @param[in] minute The minute
- * @param[in] timeMode The time mode - TIME_MODE_UTC, TIME_MODE_STANDARD, or TIME_MODE_WALL
+ * @param[in] timeMode The time mode - @c TIME_MODE_UTC, @c TIME_MODE_STANDARD, or @c TIME_MODE_WALL
*/
TimeRule(Month month, int day, DayOfWeek dayOfWeek,
bool onOrAfterDay, int hour = 0, int minute = 0, Tizen::System::TimeMode timeMode = Tizen::System::TIME_MODE_WALL);
* @since 2.0
*
* @return @c true if the value of the specified instance is equal to that of the current instance, @n
- * else @c false
- * @param[in] obj The object to compare with the current instance
+ * else @c false
+ * @param[in] obj The object to compare with the current instance
*/
virtual bool Equals(const Tizen::Base::Object& obj) const;
* @param[in] day The day
* @param[in] week The week
* @param[in] dayOfWeek The day of week
- * @param[in] beforeAfter If @c after is ON_OR_AFTER_DAY, this rule selects the first @c dayOfWeek
+ * @param[in] beforeAfter If @c after is @c ON_OR_AFTER_DAY, this rule selects the first @c dayOfWeek
* @b on @b or @b after @c day.
- * If @c after is ON_OR_BEFORE_DAY, this rule selects the last @c dayOfWeek
+ * If @c after is @c ON_OR_BEFORE_DAY, this rule selects the last @c dayOfWeek
* @b on @b or @b before @c day.
* @param[in] hour The hour
* @param[in] minute The minute
- * @param[in] timeMode The time mode - TIME_MODE_UTC, TIME_MODE_STANDARD, TIME_MODE_WALL
+ * @param[in] timeMode The time mode - @c TIME_MODE_UTC, @c TIME_MODE_STANDARD, @c TIME_MODE_WALL
*/
void SetValue(Month month, int day, Week week,
DayOfWeek dayOfWeek, bool onOrAfterDay, int hour,
*
* @final This class is not intended for extension.
*
- * The %TimeZone class represents a time zone offset and figures out Daylight Saving Time (DST).
+ * The %TimeZone class represents the time zones and offers methods for time zone offset and Daylight Saving Time (DST).
+ * The time zone ID format is "Area/Location". @n
+ * However, the specialized time zone IDs have a different format, such as CST6CDT, EST5EDT and so on. @n
*
- * The form of time zone ID is "Area/Location". @n
+ * For more information on IDs, see <a href="http://www.iana.org/time-zones" target="_blank">Time Zone Database</a>. @n
*
- * However, the specialized time zone IDs have the different form, such as CST6CDT, EST5EDT and so on. @n
- *
- * For more information on IDs, refer <a href="http://www.iana.org/time-zones" target="_blank">Time Zone Database</a>. @n
- *
- * The supported time zone list depends on the device. Therefore, it must be checked by using LocaleManager::GetAvailableTimeZonesN().
+ * The supported time zone list depends on the device. Therefore, you must call LocaleManager::GetAvailableTimeZonesN() to get
+ * the supported time zones.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/locales/time_zone.htm">Time Zones</a>.
*
*
* @param[in] rawOffset The base time zone offset to GMT in minutes
* @param[in] id The time zone ID
- * @remarks The form of time zone @c id is "Area/Location". @n For more information on IDs, refer <a href="http://www.iana.org/time-zones" target="_blank">here</a>. @n
- * However, the supported time zone list depends on the device. Therefore, it must be checked before using this method.
- * @see LocaleManager::GetAvailableTimeZonesN()
+ * @remarks The format of time zone @c id is "Area/Location". @n
+ * For more information on IDs, refer <a href="http://www.iana.org/time-zones" target="_blank">here</a>. @n
+ * However, the supported time zone list depends on the device. Therefore, you must call
+ * LocaleManager::GetAvailableTimeZonesN() to get the supported time zones.
*/
TimeZone(int rawOffset, const Tizen::Base::String& id);
/**
* Initializes this instance of %TimeZone with the specified raw GMT offset,
- * the ID of the time zone, the rules for starting/ending DST, and the DST offset.
+ * the time zone ID, the rules for starting/ending DST, and the DST offset.
*
* @since 2.0
*
* @param[in] startRule The DST starting rule
* @param[in] endRule The DST end rule
* @param[in] dstOffset The amount of time in minutes saved during DST
- * @remarks The form of time zone @c id is "Area/Location". @n For more information on IDs, refer <a href="http://www.iana.org/time-zones" target="_blank">here</a>. @n
- * However, the supported time zone list depends on the device. Therefore, it must be checked before using this method.
- * @see LocaleManager::GetAvailableTimeZonesN()
+ * @remarks The form of time zone @c id is "Area/Location". @n
+ * For more information on IDs, refer <a href="http://www.iana.org/time-zones" target="_blank">here</a>. @n
+ * However, the supported time zone list depends on the device. Therefore, you must call
+ * LocaleManager::GetAvailableTimeZonesN() to get the supported time zones.
*/
TimeZone(int rawOffset, const Tizen::Base::String& id,
const TimeRule& startRule, const TimeRule& endRule, int dstOffset);
/**
- * Checks whether the specified instance of %TimeZone equals the value of the current instance.
+ * Checks whether the specified %TimeZone instance is equal to the current instance.
*
* @since 2.0
*
bool operator ==(const TimeZone& otherTimeZone) const;
/**
- * Checks whether the %TimeZone instance is equal to the current instance.
+ * Checks whether the specified %TimeZone instance is equal to the current instance.
*
* @since 2.0
*
* @since 2.0
*
* @return @c true if the value of the specified instance is equal to that of the current instance, @n
- * else @c false
- * @param[in] obj The object to compare with the current instance
+ * else @c false
+ * @param[in] obj The object to compare with the current instance
*/
virtual bool Equals(const Tizen::Base::Object& obj) const;
/**
* Converts the Coordinated Universal Time (UTC) time to the standard time.
*
- * @since 2.0
+ * @since 2.0
*
* @return The standard time
* @param[in] utcTime The UTC time
/**
* Converts the wall time to the UTC time.
*
- * @since 2.0
+ * @since 2.0
*
* @return The UTC time
* @param[in] wallTime The wall time
/**
* Gets the raw and GMT offset for the specified instance of Tizen::Base::DateTime in the current time zone.
*
- * @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @if OSPCOMPAT
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompTimeZoneGetOffsetPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompTimeZoneGetOffsetPage "here".
* @endif
*
* @return An error code
* @param[out] dstOffset The offset to add to @c rawOffset to obtain the total offset between the local and GMT time @n
* If DST is not in effect, it is zero.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c date is invalid.
- * @remarks Local millisecond = GMT milliseconds + rawOffset(in milliseconds) + dstOffset(in milliseconds).
- * All computations are performed in Gregorian calendar.
+ * @exception E_INVALID_ARG The specified @c date is invalid.
+ * @remarks Local millisecond = GMT milliseconds + rawOffset(in milliseconds) + dstOffset(in milliseconds). @n
+ * All computations are performed in Gregorian calendar.
*/
result GetOffset(const Tizen::Base::DateTime& date, bool local, int& rawOffset, int& dstOffset) const;
/**
- * Gets the difference in minutes between the local standard time and GMT, taking into consideration both the raw offset and the effect of DST.
+ * Gets the difference in minutes between the local standard time and GMT, taking into consideration both the raw offset
+ * and the effect of DST.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompTimeZoneGetOffsetPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompTimeZoneGetOffsetPage "here".
* @endif
*
* @return An error code
* The value is GMT time from starting day (Jan 1, 1.).
* @param[out] offset The offset between the local standard time and GMT, taking into consideration DST
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c ticks is invalid.
- * @see Base::DateTime::GetTicks()
+ * @exception E_INVALID_ARG The specified @c ticks is invalid.
+ * @see Base::DateTime::GetTicks()
*/
result GetOffset(long long ticks, int& offset) const;
- /**
+ /**
* @if OSPCOMPAT
- * @page CompTimeZoneGetOffsetPage Compatibility for GetOffset()
- * @section CompTimeZoneGetOffsetIssueSection Issues
- * Implementation of this method in OSP compatible applications has the following issue: @n
- * -# The method returns E_OUT_OF_RANGE if an argument is invalid.
- *
- * @section CompTimeZoneGetOffsetSolutionSection Resolutions
- * This issue has been resolved in Tizen.
- * @par When working in Tizen:
- * -# The method returns E_INVALID_ARG if an argument is invalid.
+ * @page CompTimeZoneGetOffsetPage Compatibility for GetOffset()
+ * @section CompTimeZoneGetOffsetIssueSection Issues
+ * Implementation of this method in OSP compatible applications has the following issue: @n
+ * -# The method returns @c E_OUT_OF_RANGE if an argument is invalid.
+ *
+ * @section CompTimeZoneGetOffsetSolutionSection Resolutions
+ * This issue has been resolved in Tizen.
+ * @par When working in Tizen:
+ * -# The method returns @c E_INVALID_ARG if an argument is invalid.
* @endif
- */
+ */
/**
* Gets the difference in minutes between the local standard time and GMT, without including DST (that is, raw offset).
int GetRawOffset(void) const;
/**
- * Gets the ID of the time zone.
+ * Gets the time zone ID.
*
* @since 2.0
*
- * @return The ID of the time zone
+ * @return The time zone ID
*/
Tizen::Base::String GetId(void) const;
static TimeZone GetGmtTimeZone(void);
/**
- * Gets the time zone instance from the given ID.
+ * Gets the time zone instance for the specified ID.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompTimeZoneGetTimeZonePage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompTimeZoneGetTimeZonePage "here".
* @endif
*
* @return An error code
* @param[in] id The time zone ID
- * @param[out] timeZone The time zone for the given ID
+ * @param[out] timeZone The time zone for the specified ID
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c id is invalid.
- * @remarks The %TimeZone instance for the specified @c id does not contain the DST information.
- * The supported time zone list depends on the device. Therefore, it should be checked before using this method.
- * @see LocaleManager::GetAvailableTimeZonesN()
+ * @exception E_INVALID_ARG The specified @c id is invalid.
+ * @remarks The %TimeZone instance for the specified @c id does not contain the DST information.@n
+ * The supported time zone list depends on the device. Therefore, you must call
+ * LocaleManager::GetAvailableTimeZonesN() to get the supported time zones.
*/
static result GetTimeZone(const Tizen::Base::String& id, Tizen::Locales::TimeZone& timeZone);
/**
- * Gets the %TimeZone instance from the specified ID and UTC time.
+ * Gets a %TimeZone instance from the specified ID and UTC time.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompTimeZoneGetTimeZonePage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompTimeZoneGetTimeZonePage "here".
* @endif
*
* @return An error code
* @param[in] utcTime The UTC time
* @param[out] timeZone The time zone for the specified ID and UTC time
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c id is invalid.
- * @remarks The %TimeZone instance for the specified ID and UTC time contains the DST information.
- * The supported time zone list depends on the device. Therefore, it should be checked before using this method.
- * @see LocaleManager::GetAvailableTimeZonesN()
+ * @exception E_INVALID_ARG The specified @c id is invalid.
+ * @remarks The %TimeZone instance for the specified ID and UTC time contains the DST information. @n
+ * The supported time zone list depends on the device. Therefore, you must call
+ * LocaleManager::GetAvailableTimeZonesN() to get the supported time zones.
*/
static result GetTimeZone(const Tizen::Base::String& id, const Tizen::Base::DateTime& utcTime, Tizen::Locales::TimeZone& timeZone);
- /**
+ /**
* @if OSPCOMPAT
- * @page CompTimeZoneGetTimeZonePage Compatibility for GetTimeZone()
- * @section CompTimeZoneGetTimeZoneIssueSection Issues
- * Implementation of this method in OSP compatible applications has the following issue: @n
- * -# The method returns E_UNSUPPORTED_OPERATION if the time zone ID is invalid.
- *
- * @section CompTimeZoneGetTimeZoneSolutionSection Resolutions
- * This issue has been resolved in Tizen.
+ * @page CompTimeZoneGetTimeZonePage Compatibility for GetTimeZone()
+ * @section CompTimeZoneGetTimeZoneIssueSection Issues
+ * Implementation of this method in OSP compatible applications has the following issue: @n
+ * -# The method returns @c E_UNSUPPORTED_OPERATION if the time zone ID is invalid.
+ *
+ * @section CompTimeZoneGetTimeZoneSolutionSection Resolutions
+ * This issue has been resolved in Tizen.
* @par When working in Tizen:
- * -# The method returns E_INVALID_ARG if the time zone ID is invalid.
+ * -# The method returns @c E_INVALID_ARG if the time zone ID is invalid.
* @endif
- */
+ */
/**
* Converts the UTC time to the standard time.
* @since 2.0
*
* @return The UTC time
- * @param[in] standardTime The standard time
+ * @param[in] standardTime The standard time
* @param[in] rawOffset The time zone's raw offset in minutes
*/
static Tizen::Base::DateTime StandardTimeToUtcTime(const Tizen::Base::DateTime& standardTime, int rawOffset);
* @since 2.0
*
* @return The wall time
- * @param[in] utcTime The UTC time
+ * @param[in] utcTime The UTC time
* @param[in] rawOffset The time zone's raw offset in minutes
* @param[in] dstOffset The amount of time in minutes saved during DST
*/
* @since 2.0
*
* @return The UTC time
- * @param[in] wallTime The wall time
+ * @param[in] wallTime The wall time
* @param[in] rawOffset The time zone's raw offset in minutes
* @param[in] dstOffset The amount of time in minutes saved during DST
*/
* @b Library: @b osp-appfw
*
*
- * The %Locales namespace contains classes representing a specific cultural region (locale) and the classes for manipulating and formatting locale-sensitive information, such as dates, times, numbers, and time zones.
+ * The %Locales namespace contains classes representing a specific cultural region (locale) and the classes for manipulating and
+ * formatting locale-sensitive information, such as dates, times, numbers, and time zones.
*
- * Even if the list of all the available languages supported by the device is different, the localized information by the %Locales namespace should be represented properly.
+ * Even if the list of all the available languages supported by the device is different, the localized information by
+ * the %Locales namespace should be represented properly.
*
* For more information on the %Locales namespace features, see <a href="../org.tizen.native.appprogramming/html/guide/locales/locales_namespace.htm">Locales Guide</a>.
*
{
public:
/**
- * This is the default constructor for this class.
+ * This is the default constructor for this class. @n
+ * The object is not fully constructed after this constructor is called. @n
+ * For full construction, the Construct() method must be called right after calling this constructor.
*
* @since 2.0
*
- * @remarks The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
*/
Alarm(void);
* @privlevel public
* @privilege %http://tizen.org/privilege/alarm
*
- * @return An error code
- * @param[in] duetime The time for the alarm to ring @n Any value with a unit that is less than a second is ignored.
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] duetime The time for the alarm to ring @n
+ * Any value with a unit that is less than a second is ignored.
+ * @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_INVALID_ARG The specified @c duetime is invalid.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks If this %Alarm instance is already registered by this method, existing alarm is cancelled automatically.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks If this %Alarm instance is already registered by this method, the existing alarm is cancelled automatically.
*/
result Set(const Tizen::Base::DateTime& duetime);
/**
* Sets a repeating alarm.
*
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/alarm
*
- * @return An error code
- * @param[in] start The time for the alarm to ring first @n Any value with a unit that is less than a second is ignored.
- * @param[in] period The interval in minutes between consecutive alarm rings
- * @param[in] pEnd The time for the alarm ring to end @n Any value with a unit that is less than a second is ignored.
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] start The time for the alarm to ring first @n
+ * Any value with a unit that is less than a second is ignored.
+ * @param[in] period The interval in minutes between consecutive alarm rings
+ * @param[in] pEnd The time for the alarm ring to end @n
+ * Any value with a unit that is less than a second is ignored.
+ * @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks If this %Alarm instance is already registered by this method, existing alarm is cancelled automatically. @n If @c pEnd is @c null, the alarm repeats forever.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks
+ * - If this %Alarm instance is already registered by this method, existing alarm is cancelled automatically.
+ * - If @c pEnd is @c null, the alarm repeats forever.
*/
result Set(const Tizen::Base::DateTime& start, int period, const Tizen::Base::DateTime* pEnd = null);
/**
* Cancels the alarm.
*
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/alarm
*
- * @return An error code
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @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.
+ * @exception E_SYSTEM A system error has occurred.
*/
result Cancel(void);
/**
* Gets the start time for the current instance of %Alarm.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An instance of Tizen::Base::DateTime indicating the start time for the alarm
- * @remarks If this %Alarm instance is not registered by the Set() method, return value is default value of the Tizen::Base::DateTime class.
+ * @return An instance of Tizen::Base::DateTime indicating the start time for the alarm
+ * @remarks If this %Alarm instance is not registered by the Set() method, the return value is the default value of
+ * the Tizen::Base::DateTime instance.
*/
const Tizen::Base::DateTime GetStartTime(void) const;
/**
* Gets the period of the current instance of %Alarm in minutes.
*
- * @since 2.0
+ * @since 2.0
*
- * @return The period of the current instance of %Alarm in minutes
+ * @return The period of the current instance of %Alarm in minutes
* @remarks If this %Alarm instance is not registered by the Set() method, return value is @c 0.
*/
int GetPeriod(void) const;
*
* @since 2.0
*
- * @return A pointer to Tizen::Base::DateTime indicating the end time for the alarm, @n
+ * @return A pointer to Tizen::Base::DateTime indicating the end time for the alarm, @n
* else @c null if the end time has not been set
*/
const Tizen::Base::DateTime* GetEndTime(void) const;
* @deprecated This class is deprecated. Instead of using this class, use the PowerManager class.
* @final This class is not intended for extension.
*
- * The %Battery class provides methods to get the status related to battery levels and
- * determine whether the battery is currently being charged.
- * You cannot create an instance of this class directly.
+ * The %Battery class provides methods to get the status related to battery levels and determine whether the battery is
+ * currently being charged. You cannot create an instance of this class directly.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/system/battery_status.htm">Battery Status</a>.
* @endif
* @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.
+ * @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_INVALID_STATE The battery service is not available.
- * @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).
+ * @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).
* @endcond
*/
static result GetCurrentLevelInPercentage(int& level);
* @compatibility This method has compatibility issues with OSP compatible applications. @n
* For more information, see @ref CompGetCurrentLevel "here".
* @endif
- * @return An error code
+ * @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_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.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @endcond
*/
static result GetCurrentLevel(BatteryLevel& level);
* @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_SUCCESS The method is successful.
+ * else @c false
+ * @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.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @endcond
*/
static result IsCharging(bool& charging);
*
* @final This class is not intended for extension.
*
- * The %DeviceManager class provides listener to handle events for various external device,
- * such as a Bluetooth headset, HDMI, and headphone.
- * This class also gets the current state of the device. You cannot create an instance of this class directly.
+ * The %DeviceManager class provides listeners to handle events for various external device, such as a Bluetooth headset, HDMI,
+ * and headphone. This class also gets the current state of the device. You cannot create an instance of this class directly.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/system/device_management.htm">External Device Management</a>.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @endif
- * @since 2.0
+ * @since 2.0
* @if OSPCOMPAT
* @compatibility This method has compatibility issues with %Tizen API versions @b prior @b to @b 2.0. @n
- * For more information, see @ref DeviceManagerGetStatePage "here".
+ * For more information, see @ref DeviceManagerGetStatePage "here".
* @endif
*
* @param[in] deviceType The value from the enumerator DeviceType indicating the device
* @param[out] state The device <a href="../org.tizen.native.appprogramming/html/guide/system/device_management.htm">state</a> of type Tizen::Base::String
*
- * @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_ARG The specified @c deviceType is not valid.
+ * @return An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_INVALID_ARG The specified @c deviceType is not valid.
* @exception E_UNSUPPORTED_OPERATION The specified @c deviceType is not supported on this model.
*/
static result GetState(DeviceType deviceType, Tizen::Base::String& state);
* @page DeviceManagerGetStatePage Compatibility for GetState()
* @section DeviceManagerGetStatePageIssueSection Issues
* Implementation of this method in OSP compatible applications has the following issue: @n
- * The GetState() method does not return E_DEVICE_UNAVAILABLE anymore. The E_DEVICE_UNAVAILABLE exception is removed.
+ * The GetState() method does not return @c E_DEVICE_UNAVAILABLE anymore. The @c E_DEVICE_UNAVAILABLE exception is removed.
* @section DeviceManagerGetStatePageIssueSection Resolutions
- * The E_UNSUPPORTED_OPERATION exception is added since Tizen. So, use E_UNSUPPORTED_OPERATION instead of E_DEVICE_UNAVAILABLE.
+ * The E_UNSUPPORTED_OPERATION exception is added since Tizen. So, use @c E_UNSUPPORTED_OPERATION instead of E_DEVICE_UNAVAILABLE.
* @endif
*/
/**
- * Adds a device event listener.
+ * Adds the device event listener.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @endif
- * @since 2.0
+ * @since 2.0
* @if OSPCOMPAT
* @compatibility This method has compatibility issues with %Tizen API versions @b prior @b to @b 2.0. @n
* For more information, see @ref DeviceManagerAddDeviceEventListenerPage "here".
* @endif
*
- * @return An error code
- * @param[in] deviceType The types of a device
- * @param[in] listener The device event listener
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_ARG The specified @c deviceType is not valid.
- * @exception E_OBJ_ALREADY_EXIST The specified @c deviceType and @c listener are already registered.
+ * @return An error code
+ * @param[in] deviceType The device type
+ * @param[in] listener The device event listener
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_INVALID_ARG The specified @c deviceType is not valid.
+ * @exception E_OBJ_ALREADY_EXIST The specified @c deviceType and @c listener are already registered.
* @exception E_UNSUPPORTED_OPERATION The specified @c deviceType is not supported on this model.
*/
static result AddDeviceEventListener(DeviceType deviceType, IDeviceEventListener& listener);
* @page DeviceManagerAddDeviceEventListenerPage Compatibility for AddDeviceEventListener()
* @section DeviceManagerAddDeviceEventListenerPageIssueSection Issues
* Implementation of this method in OSP compatible applications has the following issue: @n
- * This AddDeviceEventListener() method does not return E_DEVICE_UNAVAILABLE anymore. The E_DEVICE_UNAVAILABLE exception is removed.
+ * This AddDeviceEventListener() method does not return @c E_DEVICE_UNAVAILABLE anymore. The @c E_DEVICE_UNAVAILABLE exception is removed.
* @section DeviceManagerAddDeviceEventListenerPageIssueSection Resolutions
- * The E_UNSUPPORTED_OPERATION exception is added since Tizen. So, use E_UNSUPPORTED_OPERATION instead of E_DEVICE_UNAVAILABLE.
+ * The E_UNSUPPORTED_OPERATION exception is added since Tizen. So, use @c E_UNSUPPORTED_OPERATION instead of E_DEVICE_UNAVAILABLE.
* @endif
*/
/**
- * Removes a device event listener from all types of devices.
+ * Removes the device event listener from all types of devices.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] deviceType The types of a device
- * @param[in] listener The device event listener
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_ARG The specified @c deviceType is not valid.
- * @exception E_OBJ_NOT_FOUND The specified @c deviceType and @c listener are not registered.
+ * @return An error code
+ * @param[in] deviceType The types of a device
+ * @param[in] listener The device event listener
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_INVALID_ARG The specified @c deviceType is not valid.
+ * @exception E_OBJ_NOT_FOUND The specified @c deviceType and @c listener are not registered.
* @exception E_UNSUPPORTED_OPERATION The specified @c deviceType is not supported on this model.
*/
static result RemoveDeviceEventListener(DeviceType deviceType, IDeviceEventListener& listener);
* @page DeviceManagerRemoveDeviceEventListenerPage Compatibility for RemoveDeviceEventListener()
* @section DeviceManagerRemoveDeviceEventListenerPageIssueSection Issues
* Implementation of this method in OSP compatible applications has the following issue: @n
- * This RemoveDeviceEventListener() method does not return E_DEVICE_UNAVAILABLE anymore. The E_DEVICE_UNAVAILABLE exception is removed.
+ * This RemoveDeviceEventListener() method does not return @c E_DEVICE_UNAVAILABLE anymore. The @c E_DEVICE_UNAVAILABLE exception is removed.
* @section DeviceManagerRemoveDeviceEventListenerPageIssueSection Resolutions
- * The E_UNSUPPORTED_OPERATION exception is added since Tizen. So, use E_UNSUPPORTED_OPERATION instead of E_DEVICE_UNAVAILABLE.
+ * The E_UNSUPPORTED_OPERATION exception is added since Tizen. So, use @c E_UNSUPPORTED_OPERATION instead of E_DEVICE_UNAVAILABLE.
* @endif
*/
/**
- * Removes all device event listeners.
+ * Removes all the device event listeners.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
+ * @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
*/
public:
/**
- * Gets the path for the media directory that is usually used to store media contents.
+ * Gets the path for the media directory that stores the media contents.
*
* @since 2.0
*
static Tizen::Base::String GetMediaPath(void);
/**
- * Gets the path for the default download directory that is usually used to store downloaded contents by the Tizen::Content::DownloadManager class.
+ * Gets the path for the default download directory that stores the downloaded contents by the Tizen::Content::DownloadManager class.
*
* @since 2.0
*
/**
* Gets the directory path according to the pre-defined directory type.
*
- * @since 2.0
+ * @since 2.0
*
- * @return The pre-defined directory path according to the specified @c dirType, @n
- * else an empty string if the specified @c dirType is invalid
- * @param[in] dirType The pre-defined directory type
- * @remarks The directory path for some directory types such as IMAGES, SOUNDS, VIDEOS, CAMERA, DOWNLOADS, and OTHERS may not yet exist,
- * so you must make sure that it exists before using it.
- * @see Tizen::Io::Directory::Create()
+ * @return The pre-defined directory path according to the specified @c dirType, @n
+ * else an empty string if the specified @c dirType is invalid
+ * @param[in] dirType The pre-defined directory type
+ * @remarks The directory path for some directory types such as IMAGES, SOUNDS, VIDEOS, CAMERA, DOWNLOADS, and OTHERS may not yet exist,
+ * so you must make sure that it exists before using it.
+ * @see Tizen::Io::Directory::Create()
*/
static Tizen::Base::String GetPredefinedPath(PredefinedDirectoryType dirType);
/**
* @interface IAlarmEventListener
- * @brief This interface is the listener of the alarm event.
+ * @brief This interface is the listener of the alarm event.
*
* @since 2.0
*
{
public:
/**
- * This is the destructor for this class. This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ * This is the destructor for this class. @n
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
/**
* @interface IBatteryEventListener
- * @brief This interface is the listener of the battery event.
+ * @brief This interface is the listener of the battery event.
*
* @since 2.0
*
{
public:
/**
- * This is the destructor for this class. This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ * This is the destructor for this class. @n
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
- * @since 2.0
+ * @since 2.0
*/
virtual ~IBatteryEventListener(void) {}
*
* @since 2.0
*
- * @param[in] percentage The changed battery level
+ * @param[in] percentage The changed battery level
* @remarks The resolution of the level is @c 5%. The range of the level is @c 0 (Minimum) to @c 100 (Maximum).
*/
virtual void OnBatteryLevelChangedInPercentage(int percentage) = 0;
/**
* @interface IBootEventListener
- * @brief This interface is the listener of the boot event.
+ * @brief This interface is the listener of the boot event.
*
* @since 2.1
*
{
public:
/**
- * This is the destructor for this class. This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ * This is the destructor for this class. @n
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.1
*/
/**
* @interface IChargingEventListener
- * @brief This interface is the listener of the charging event.
+ * @brief This interface is the listener for charging events.
* @since 2.0
*
* The %IChargingEventListener interface must be registered and implemented by an application to
{
public:
/**
- * This is the destructor for this class. This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ * This is the destructor for this class. @n
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
- * @since 2.0
+ * @since 2.0
*/
virtual ~IChargingEventListener(void) {}
/**
* @interface IDeviceEventListener
- * @brief This interface is the listener of the device state changes.
+ * @brief This interface is the listener of the device state changes.
*
* @since 2.0
*
{
public:
/**
- * This is the destructor for this class. This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ * This is the destructor for this class. @n
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
*
* @since 2.0
*
- * @param[in] deviceType The types of a device
+ * @param[in] deviceType The device type
* @param[in] state The device state of type Tizen::Base::String
*/
virtual void OnDeviceStateChanged(DeviceType deviceType, const Tizen::Base::String& state) = 0;
{
/**
-* @interface IRuntimeInfoGetIntAsyncResultListener
-* @brief This interface defines the result listener for an asynchronous method call to the %RuntimeInfo class.
+* @interface IRuntimeInfoGetIntAsyncResultListener
+* @brief This interface defines the result listener for an asynchronous method call to the %RuntimeInfo class.
*
* @since 2.0
*
-* The %IRuntimeInfoGetIntAsyncResultListener interface defines the result listener for an asynchronous method call to the RuntimeInfo class. An instance of this interface is removed automatically by platform, after result is notified.
+* The %IRuntimeInfoGetIntAsyncResultListener interface defines the result listener for an asynchronous method call to the
+* RuntimeInfo class. An instance of this interface is removed automatically by the platform, after result is notified.
*
*/
class _OSP_EXPORT_ IRuntimeInfoGetIntAsyncResultListener
{
public:
/**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are when the destructor of this interface is called.
*
* @since 2.0
*/
*
* @since 2.0
*
- * @param[in] value The @c int type runtime information
- * @param[in] r An error code
- * @exception E_SUCCESS The result is successful.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @param[in] value The @c int type runtime information
+ * @param[in] r An error code
+ * @exception E_SUCCESS The result is successful.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
virtual void OnResultReceivedForGetValueAsync(int value, result r) = 0;
{
/**
-* @interface IRuntimeInfoGetLonglongAsyncResultListener
-* @brief This interface defines the result listener for an asynchronous method call to the %RuntimeInfo class.
+* @interface IRuntimeInfoGetLonglongAsyncResultListener
+* @brief This interface defines the result listener for an asynchronous method call to the %RuntimeInfo class.
*
-* @since 2.0
+* @since 2.0
*
-* The %IRuntimeInfoGetLonglongAsyncResultListener interface defines the result listener for an asynchronous method call to the RuntimeInfo class. An instance of this interface is removed automatically by platform, after result is notified.
+* The %IRuntimeInfoGetLonglongAsyncResultListener interface defines the result listener for an asynchronous method call
+* to the RuntimeInfo class. An instance of this interface is removed automatically by the platform, after result is notified.
*
*/
class _OSP_EXPORT_ IRuntimeInfoGetLonglongAsyncResultListener
{
public:
/**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
*
* @since 2.0
*
- * @param[in] value The @c long @c long type runtime information
- * @param[in] r An error code
- * @exception E_SUCCESS The result is successful.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @param[in] value The @c long @c long type runtime information
+ * @param[in] r An error code
+ * @exception E_SUCCESS The result is successful.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
virtual void OnResultReceivedForGetValueAsync(long long value, result r) = 0;
/**
* @interface IScreenEventListener
- * @brief This interface is the listener of the screen event.
+ * @brief This interface is the listener of the screen event.
*
* @since 2.0
*
/**
* Called when the screen turns off. @n
- * Unless there is a strong reason to do otherwise, release resources (such as 3D, media, and sensors) to allow the device to enter the sleep mode to save the battery.
- * Invoking a lengthy asynchronous method within this listener method can be risky, because it is not guaranteed to invoke a callback before the device enters the sleep mode.
- * Similarly, do not perform lengthy operations in this listener method. All operations must be quick ones.
+ * Unless there is a strong reason to do otherwise, release the resources (such as 3D, media, and sensors) to allow the device
+ * to enter the sleep mode to save the battery. @n
+ * Invoking a lengthy asynchronous method within this listener method can be risky, because it is not guaranteed to invoke a
+ * callback before the device enters the sleep mode. Similarly, do not perform lengthy operations in this listener method. @n
+ * All operations must be quick ones.
*
*@since 2.0
*/
/**
* @interface ISettingEventListener
- * @brief This interface is the listener of the setting event.
+ * @brief This interface is the listener of the setting event.
*
* @since 2.0
*
{
public:
/**
- * This is the destructor for this class. This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ * This is the destructor for this class. @n
+ * This polymorphic destructor should be overridden if required. @n This way,
+ * the destructors of the derived classes are called when the destructor of this interface is called.
*
- * @since 2.0
+ * @since 2.0
*/
virtual ~ISettingEventListener(void) {}
/**
- * Called when a certain setting value has been changed.
+ * Called when a setting value has been changed.
*
* @since 2.0
*
- * @param[in] key The key name of the changed setting information
- * @remarks Invokes one of the overloaded getter methods of Tizen::System::SettingInfo to get the changed value corresponding to the given key.
+ * @param[in] key The key name of the changed setting information
+ * @remarks Invokes one of the overloaded getter methods of Tizen::System::SettingInfo to get the changed value
+ * corresponding to the given key.
*/
virtual void OnSettingChanged(Tizen::Base::String& key) = 0;
*
* @since 2.0
*
- * The %ISettingInfoSetValueAsyncResultListener interface must be registered and implemented by an application to receive result for an asynchronous setting change method call.
+ * The %ISettingInfoSetValueAsyncResultListener interface must be registered and implemented by an application
+ * to receive result for an asynchronous setting change method call.
*
*/
class _OSP_EXPORT_ ISettingInfoSetValueAsyncResultListener
{
public:
/**
- * This is the destructor for this class. This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ * This is the destructor for this class. @n
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
*
* @since 2.0
*
- * @param[in] key The key name of the changed setting information
- * @param[in] r An error code
- * @exception E_SUCCESS The result is successful.
- * @exception E_SYSTEM The method cannot proceed due to severe system error.
+ * @param[in] key The key name of the changed setting information
+ * @param[in] r An error code
+ * @exception E_SUCCESS The result is successful.
+ * @exception E_SYSTEM The method cannot proceed due to severe system error.
*/
virtual void OnResultReceivedForSetValueAsync(const Tizen::Base::String& key, result r) = 0;
BATTERY_LOW, // This enum value is deprecated. Instead of using this enum value, use BATTERY_LEVEL_LOW.
BATTERY_CRITICAL, // This enum value is deprecated. Instead of using this enum value, use BATTERY_LEVEL_CRITICAL.
BATTERY_EMPTY, // This enum value is deprecated. Instead of using this enum value, use BATTERY_LEVEL_EMPTY.
- BATTERY_LEVEL_FULL = BATTERY_FULL,/**< The battery is fully charged */
- BATTERY_LEVEL_HIGH = BATTERY_HIGH,/**< The battery has plenty of charge */
- BATTERY_LEVEL_LOW = BATTERY_LOW,/**< The battery has little charge */
- BATTERY_LEVEL_CRITICAL = BATTERY_CRITICAL,/**< The battery charge is at a critical state @n It is strongly recommended to stop using all multimedia features because they are not guaranteed to work correctly at this level. */
- BATTERY_LEVEL_EMPTY = BATTERY_EMPTY, /**< The battery is empty @n It is strongly recommended to prepare for the safe termination of the application because the device will start a shutdown process soon after entering this level. */
+ BATTERY_LEVEL_FULL = BATTERY_FULL, /**< The battery is fully charged */
+ BATTERY_LEVEL_HIGH = BATTERY_HIGH, /**< The battery has plenty of charge */
+ BATTERY_LEVEL_LOW = BATTERY_LOW, /**< The battery has little charge */
+ BATTERY_LEVEL_CRITICAL = BATTERY_CRITICAL, /**< The battery charge is at a critical state @n
+ It is strongly recommended to stop using all multimedia features because they are not guaranteed to work correctly at this level. */
+ BATTERY_LEVEL_EMPTY = BATTERY_EMPTY, /**< The battery is empty @n
+ It is strongly recommended to prepare for the safe termination of the application because the device will start a shutdown process soon after entering this level. */
};
/**
* @enum PowerMode
*
- * Defines the representation of the charge remaining in the battery.
+ * Defines the representation of the power mode.
*
* @since 2.0
*/
{
POWER_STANDBY, // This enum value is deprecated. Instead of using this enum value, use POWER_MODE_STANDBY.
POWER_SLEEP, // This enum value is deprecated. Instead of using this enum value, use POWER_MODE_SLEEP.
- POWER_MODE_STANDBY = POWER_STANDBY, /**< The battery is fully charged */
- POWER_MODE_SLEEP = POWER_SLEEP, /**< The battery has plenty of charge */
+ POWER_MODE_STANDBY = POWER_STANDBY, /**< The standby power mode */
+ POWER_MODE_SLEEP = POWER_SLEEP, /**< The sleep power mode */
};
/**
/**
* Changes the policy of the screen power management.
*
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/power
*
- * @return An error code
- * @param[in] keepOn Set to @c true if the screen remains in the 'ON' state until the application goes to the background(inactivated), @n
- * else @c false if the state of the screen is controlled by the default power control policy of the system
- * @param[in] dimming Set to @c true if the screen is dimmed when there is no user input for a certain amount of time, @n
- * else @c false if the screen is not dimmed
- * @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 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.
+ * @return An error code
+ * @param[in] keepOn Set to @c true for the screen to remain in the 'ON' state until the application goes to the background(inactivated), @n
+ * else @c false for the state of the screen to be controlled by the default power control policy of the system
+ * @param[in] dimming Set to @c true to dim the screen when there is no user input for a certain amount of time, @n
+ * else @c false to not dim the screen
+ * @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 screen power control is available only when an application is active. @n
+ * To check the events that are active, use the Tizen::Ui::Controls::IFrameEventListener::OnFrameActivated() method.
*/
static result KeepScreenOnState(bool keepOn, bool dimming = true);
/**
* Restores the screen brightness control.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE The brightness is never changed.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @see SetScreenBrightness()
+ * @return An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE The brightness is never changed.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @see SetScreenBrightness()
*/
static result RestoreScreenBrightness(void);
/**
* Sets the screen brightness level for an application.
*
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/power
*
- * @return An error code
- * @param[in] brightness The brightness level to set between @c 1 (minimum) and @c 10 (maximum).
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @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 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()
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @remarks The brightness level change is available only when an application is active. @n
+ * To check the events that are active, use the Tizen::Ui::Controls::IFrameEventListener::OnFrameActivated() method. @n
+ * 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. @n
+ * To know more about turning the screen off, see the TurnScreenOff() method.
+ * @see RestoreScreenBrightness()
*/
static result SetScreenBrightness(int brightness);
/**
* Gets the screen brightness level of an application.
*
- * @since 2.0
+ * @since 2.0
*
- * @return The brightness level of the current application
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks This method returns the screen brightness level set for an application. If the brightness level is not set, it will return the default system brightness level. @n
- * In case of error, this method returns @c -1.
+ * @return The brightness level of the current application, @n
+ * else @c -1 in case of error
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks
+ * - This method returns the screen brightness level set for an application. If the brightness level is not set,
+ * it will return the default system brightness level.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
static int GetScreenBrightness(void);
/**
* Checks whether the screen is on.
*
- * @since 2.0
+ * @since 2.0
*
- * @return @c true if the screen is on, @n
- * else @c false
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks This method returns @c true when the screen is in the dimming state, and @c false in case of an error.
+ * @return @c true if the screen is on, @n
+ * else @c false
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks
+ * - This method returns @c true when the screen is in the dimming state, and @c false in case of an error.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
static bool IsScreenOn(void);
/**
- * Turns on the screen.
+ * Turns the screen on.
*
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/power
*
- * @return An error code
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @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.
+ * @exception E_SYSTEM A system error has occurred.
*/
static result TurnScreenOn(void);
/**
- * Turns off the screen.
+ * Turns the screen off.
*
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/power
*
- * @return An error code
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @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.
+ * @exception E_SYSTEM A system error has occurred.
*/
static result TurnScreenOff(void);
/**
- * Changes the policy of the CPU (Central Processing Unit) power management.
+ * Sets the policy of the CPU (Central Processing Unit) power management.
*
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/power
*
- * @return An error code
+ * @return An error code
* @param[in] enable Set to @c true to prevent the CPU from going into sleep mode, @n
- * else @c false to let the state of the CPU follow the system default power management policy
- * @exception E_SUCCESS The method is successful.
+ * else @c false to let the state of the CPU follow the system default power management policy
+ * @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 This method keeps CPU power state only. Screen state or lock screen is not managed by this method.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks This method only manages the CPU power state. The 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>
+ * @brief <i>[Deprecated]</i>
* @deprecated This method is deprecated. @n
- * Instead of using this method, use AddScreenEventListener() and RemoveScreenEventListener().
- * @since 2.0
+ * Instead of using this method, use AddScreenEventListener() and RemoveScreenEventListener().
+ * @since 2.0
*
* @param[in] listener The screen event listener
- * @remarks This method always overwrites the first element of internal IScreenEventListener list.
- * 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.
+ * @remarks This method always overwrites the first element of internal IScreenEventListener list. @n
+ * 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);
*
* @since 2.1
*
- * @param[in] listener The screen event 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
+ * @param[in] listener The screen event 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 RemoveScreenEventListener()
*/
static result AddScreenEventListener(IScreenEventListener& listener);
/**
- * Removes the screen event listener.
+ * Removes the specified screen event listener.
*
* @since 2.1
*
- * @param[in] listener The screen event 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
+ * @param[in] listener The screen event 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 AddScreenEventListener()
*/
static result RemoveScreenEventListener(IScreenEventListener& listener);
/**
* Sets the charging event listener.
*
- * @brief <i>[Deprecated]</i>
+ * @brief <i>[Deprecated]</i>
* @deprecated This method is deprecated. @n
- * Instead of using this method, use AddChargingEventListener() and RemoveChargingEventListener().
- * @since 2.0
+ * Instead of using this method, use AddChargingEventListener() and RemoveChargingEventListener().
+ * @since 2.0
*
* @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,
- * which may not be an expected behavior by API users. So, it is not recommended to use this method.
+ * @remarks
+ * - This method always overwrites the first element of internal IChargingEventListener list.
+ * - The first element added by AddChargingEventListener() may be overwritten by this method,
+ * which may not be the expected behavior. So, it is not recommended to use this method.
*/
static void SetChargingEventListener(IChargingEventListener& listener);
/**
* Adds the charging event listener.
*
- * @since 2.1
+ * @since 2.1
*
- * @param[in] listener The charging event 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
- * @see RemoveChargingEventListener()
+ * @param[in] listener The charging event 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 RemoveChargingEventListener()
*/
static result AddChargingEventListener(IChargingEventListener& listener);
/**
* Removes the charging event listener.
*
- * @since 2.1
+ * @since 2.1
*
- * @param[in] listener The charging event 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
- * @see AddChargingEventListener()
+ * @param[in] listener The charging event 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 AddChargingEventListener()
*/
static result RemoveChargingEventListener(IChargingEventListener& listener);
* @param[in] pListener The battery event listener
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks If @c pListener is set to @c null, the pre-registered listener is unregistered.
+ * @remarks If @c pListener is set to @c null, the current listener is unregistered.
*/
static result SetBatteryEventListener(IBatteryEventListener* pListener);
*
* @since 2.0
*
- * @return The percentage of the charge remaining in the battery.
- * @exception E_SUCCESS The method is successful.
- * @exception E_UNSUPPORTED_OPERATION The method is not supported by this device.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks The resolution of the level is @c 1 percentage. The range of the level is minimum @c 0 to maximum @c 100.
+ * @return The percentage of the charge remaining in the battery.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_UNSUPPORTED_OPERATION The method is not supported by this device.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @remarks
+ * - The resolution of the level is @c 1 percentage. The range of the level is minimum @c 0 to maximum @c 100.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
static int GetCurrentBatteryLevelInPercentage(void);
*
* @since 2.0
*
- * @return A value from the enumerator BatteryLevel indicating the current charging level
- * @exception E_SUCCESS The method is successful.
- * @exception E_UNSUPPORTED_OPERATION The method is not supported by this device.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @return A value from the enumerator BatteryLevel indicating the current charging level
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_UNSUPPORTED_OPERATION The method is not supported by this device.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static BatteryLevel GetCurrentBatteryLevel(void);
/**
* Checks whether the battery is currently charging.
*
- * @since 2.0
+ * @since 2.0
*
- * @return @c true if the charging cable is connected to the phone, @n
- * else @c false
- * @exception E_SUCCESS The method is successful.
- * @exception E_UNSUPPORTED_OPERATION The method is not supported by this device.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @return @c true if the charging cable is connected to the phone, @n
+ * else @c false
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_UNSUPPORTED_OPERATION The method is not supported by this device.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static bool IsCharging(void);
* @since 2.1
*
* @return An error code
- * @param[in] listener The boot event listener
- * @exception E_SUCCESS The method is successful.
+ * @param[in] listener The boot event listener
+ * @exception E_SUCCESS The method is successful.
* @exception E_OBJ_ALREADY_EXIST The listener is already added.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result AddBootEventListener(IBootEventListener& listener);
/**
* Removes the boot event listener.
*
- * @since 2.1
+ * @since 2.1
*
* @return An error code
- * @param[in] listener The boot event listener
- * @exception E_SUCCESS The method is successful.
+ * @param[in] listener The boot event listener
+ * @exception E_SUCCESS The method is successful.
* @exception E_OBJ_ALREADY_EXIST The listener is not added.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result RemoveBootEventListener(IBootEventListener& listener);
*
* @final This class is not intended for extension.
*
- * The %RuntimeInfo class provides runtime information, such as the allocated memory used by the application storage, memory, and CPU utilization. To get the information, you must provide the <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">RuntimeInfo key</a>.
+ * The %RuntimeInfo class provides runtime information, such as the allocated memory used by the application storage, memory, and CPU utilization.
+ * To get the information, you must provide the <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">RuntimeInfo key</a>.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">Runtime Information</a>.
*
public:
/**
- * Gets the specific Tizen::Base::String type runtime information based on the specified
- * designators (key).
+ * Gets the Tizen::Base::String type runtime information based on the specified designators (key).
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information
- * @param[out] value The runtime information of type Tizen::Base::String
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] key
The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information
+ * @param[out] value The runtime information of type Tizen::Base::String
+ * @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result GetValue(const Tizen::Base::String& key, Tizen::Base::String& value);
/**
- * Gets the specific integer type runtime information based on the specified
- * designators (key).
+ * Gets the integer type runtime information based on the specified designators (key).
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information @n
+ * @return An error code
+ * @param[in] key
The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information @n
* @if OSPCOMPAT
* The following key values are updated: @n
* - Since Tizen, refer <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">here</a>.
* - @b Deprecated All the key values provided prior to %Tizen are deprecated. For more detailed information, refer
* <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info_deprecated.htm">here</a>.
* @endif
- * @param[out] value The integer type runtime information
- * @exception E_SUCCESS The method is successful.
+ * @param[out] value The integer type runtime information
+ * @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result GetValue(const Tizen::Base::String& key, int& value);
/**
- * Gets the specific @c long @c long type runtime information based on the specified
- * designators (key).
+ * Gets the @c long @c long type runtime information based on the specified designators (key).
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information @n
+ * @return An error code
+ * @param[in] key
The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information @n
* @if OSPCOMPAT
* The following key values are updated: @n
* - Since Tizen, refer <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">here</a>.
* <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info_deprecated.htm">here</a>.
* @xmlonly <pcheck kind="value" since="1.0" deprecated="yes"> @endxmlonly MaxAllocatableMemory, AvailableVideoMemory @xmlonly </pcheck> @endxmlonly
* @endif
- * @param[out] value The @c long @c long type runtime information
- * @exception E_SUCCESS The method is successful.
+ * @param[out] value The @c long @c long type runtime information
+ * @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result GetValue(const Tizen::Base::String& key, long long& value);
/**
- * Gets the specific double type runtime information based on the specified
- * designators (key).
+ * Gets the double type runtime information based on the specified designators (key).
*
* @since 2.0
*
- * @return An error code
- * @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information
- * @param[out] value The @c double type runtime information
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] key
The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information
+ * @param[out] value The @c double type runtime information
+ * @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result GetValue(const Tizen::Base::String& key, double& value);
/**
- * Gets the specific @c bool type runtime information based on the specified
- * designators (key).
+ * Gets the @c bool type runtime information based on the specified designators (key).
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information
- * @param[out] value The @c bool type runtime information
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] key
The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information
+ * @param[out] value The @c bool type runtime information
+ * @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result GetValue(const Tizen::Base::String& key, bool& value);
/**
- * Gets the specific UuId type runtime information based on the specified
- * designators (key).
+ * Gets the UuId type runtime information based on the specified designators (key).
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information
- * @param[out] value The UuId type runtime information
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] key
The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information
+ * @param[out] value The UuId type runtime information
+ * @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result GetValue(const Tizen::Base::String& key, Tizen::Base::UuId& value);
/**
- * Gets the specific @c long @c long type runtime information based on specified designators (key) asynchronously.
+ * Gets the @c long @c long type runtime information based on specified designators (key) asynchronously.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information
- * @param[in] listener The result listener
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] key
The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information
+ * @param[in] listener The result listener
+ * @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result GetValueAsync(const Tizen::Base::String& key, IRuntimeInfoGetLonglongAsyncResultListener* listener);
/**
- * Gets the specific @c int type runtime information based on specified designators (key) asynchronously.
+ * Gets the @c int type runtime information based on specified designators (key) asynchronously.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information
- * @param[in] listener The result listener
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] key
The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information
+ * @param[in] listener The result listener
+ * @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result GetValueAsync(const Tizen::Base::String& key, IRuntimeInfoGetIntAsyncResultListener* listener);
/**
* @class SettingInfo
- * @brief This class provides methods for managing setting information.
+ * @brief This class provides methods to manage the setting information.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
- * The %SettingInfo class provides methods to managing the variety user setting elements. Please refer <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">SettingInfo key</a>.
+ * The %SettingInfo class provides methods to manage the user setting elements. @n
+ * To get the system information, you must provide the <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">SettingInfo key</a>.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">Settings Information</a>.
*
public:
/**
- * Gets the specific Tizen::Base::String type setting information based on the specified
- * designators (key).
+ * Gets the Tizen::Base::String type setting information for the specified designators (key).
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in]
key The <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">key name</a> of the setting information @n
+ * @return An error code
+ * @param[in]
key The <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">key name</a> of the setting information @n
* @if OSPCOMPAT
* The following key values are updated: @n
* - Since Tizen, refer <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">here</a>.
* - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer
* <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info_deprecated.htm">here</a>.
* @endif
- * @param[out] value The setting information of type Tizen::Base::String
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @param[out] value The setting information of type Tizen::Base::String
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
+ * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result GetValue(const Tizen::Base::String& key, Tizen::Base::String& value);
/**
- * Gets the specific integer type setting information based on the specified
- * designators (keys).
+ * Gets the specific integer type setting information for the specified designators (keys).
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in]
key The <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">key name</a> of the setting information @n
+ * @return An error code
+ * @param[in]
key The <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">key name</a> of the setting information @n
* @if OSPCOMPAT
* The following key values are updated: @n
* - Since Tizen, refer <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">here</a>.
* - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer
* <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info_deprecated.htm">here</a>.
* @endif
- * @param[out] value The setting information of type integer
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @param[out] value The setting information of type @c int
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
+ * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result GetValue(const Tizen::Base::String& key, int& value);
/**
- * Gets the specific @c long @c long type setting information based on the specified
- * designators (key).
+ * Gets the @c long @c long type setting information for the specified designators (key).
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">key name</a> of the setting information
+ * @return An error code
+ * @param[in] key
The <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">key name</a> of the setting information
* @param[out] value The setting information of type @c long @c long
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
+ * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result GetValue(const Tizen::Base::String& key, long long& value);
/**
- * Gets the specific double type setting information based on the specified
- * designators (key).
+ * Gets the double type setting information for the specified designators (key).
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">key name</a> of the setting information
- * @param[out] value The setting information of type double
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @return An error code
+ * @param[in] key
The <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">key name</a> of the setting information
+ * @param[out] value The setting information of type @c double
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
+ * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result GetValue(const Tizen::Base::String& key, double& value);
/**
- * Gets the specific @c bool type setting information based on the specified
- * designators (key).
+ * Gets the @c bool type setting information for the specified designators (key).
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">key name</a> of the setting information @n
+ * @return An error code
+ * @param[in] key
The <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">key name</a> of the setting information @n
* @if OSPCOMPAT
* The following key values are updated: @n
* - Since Tizen, refer <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">here</a>.
* - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer
* <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info_deprecated.htm">here</a>.
* @endif
- * @param[out] value The setting information of type bool
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @param[out] value The setting information of type @c bool
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
+ * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result GetValue(const Tizen::Base::String& key, bool& value);
/**
- * Gets the specific UuId type setting information based on the specified
- * designators (key).
+ * Gets the UuId type setting information for the specified designators (key).
*
* @since 2.0
*
- * @return An error code
- * @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">key name</a> of the setting information
- * @param[out] value The setting information of type UuId
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @return An error code
+ * @param[in] key
The <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">key name</a> of the setting information
+ * @param[out] value The setting information of type UuId
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
+ * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result GetValue(const Tizen::Base::String& key, Tizen::Base::UuId& value);
/**
- * Checks whether specific designator(key) is supported or not.
+ * Checks whether specific designator(key) is supported.
*
- * @since 2.0
+ * @since 2.0
*
- * @return @c true if the key is supported, @n
- * else @c false
- * @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">key name</a> of the setting information
+ * @return @c true if the key is supported, @n
+ * else @c false
+ * @param[in] key
The <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">key name</a> of the setting information
*
*/
static bool HasKey(const Tizen::Base::String& key);
/**
- * Sets the specific @c bool type setting information based on the specified designators (key).
+ * Sets the specified @c bool type setting information for the specified designators (key).
*
* @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/setting
*
- * @return An error code
+ * @return An error code
* @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">key name</a> of the setting information
- * @param[in] value The setting information of type bool
- * @exception E_SUCCESS The method is successful.
- * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method.
- * @exception E_INVALID_ARG The specified @c value is invalid value.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @param[in] value The setting information of type @c bool
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method.
+ * @exception E_INVALID_ARG The specified @c value is invalid.
+ * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
+ * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result SetValue(const Tizen::Base::String& key, bool value);
/**
- * Sets the specific @c int type setting information based on the specified designators (key).
+ * Sets the specified @c int type setting information for the specified designators (key).
*
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/setting
*
- * @return An error code
+ * @return An error code
* @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">key name</a> of the setting information
- * @param[in] value The setting information of type int
- * @exception E_SUCCESS The method is successful.
- * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method.
- * @exception E_INVALID_ARG The specified @c value is invalid value.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @param[in] value The setting information of type @c int
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method.
+ * @exception E_INVALID_ARG The specified @c value is invalid.
+ * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
+ * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result SetValue(const Tizen::Base::String& key, int value);
/**
* Sets the specific Tizen::Base::String type setting information based on the specified designators (key).
*
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/setting
*
- * @return An error code
+ * @return An error code
* @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">key name</a> of the setting information
- * @param[in] value The setting information of type Tizen::Base::String
- * @exception E_SUCCESS The method is successful.
- * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method.
- * @exception E_INVALID_ARG The specified @c value is invalid value.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @param[in] value The setting information of type Tizen::Base::String
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method.
+ * @exception E_INVALID_ARG The specified @c value is invalid.
+ * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
+ * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result SetValue(const Tizen::Base::String& key, Tizen::Base::String value);
* @privlevel public
* @privilege %http://tizen.org/privilege/setting
*
- * @return An error code
- * @param[in] filePath The file path of the wallpaper
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] filePath The file path of the wallpaper
+ * @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_FILE_NOT_FOUND The entry for the specified wallpaper file or the file path cannot be found.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result SetWallpaper(const Tizen::Base::String& filePath);
* @privlevel public
* @privilege %http://tizen.org/privilege/setting
*
- * @return An error code
- * @param[in] filePath The file path of the ringtone
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] filePath The file path of the ringtone
+ * @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_FILE_NOT_FOUND The entry for the specified wallpaper file or the file path cannot be found.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result SetRingtone(const Tizen::Base::String& filePath);
* @privlevel public
* @privilege %http://tizen.org/privilege/setting
*
- * @return An error code
+ * @return An error code
* @param[in] soundCategory The sound volume category
- * @param[in] level The sound volume level of the designated category
- * @exception E_SUCCESS The method is successful.
+ * @param[in] level The sound volume level of the designated category
+ * @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_INVALID_ARG The specified @c soundCategory is invalid.
* @exception E_OUT_OF_RANGE The specified @c level is outside the bounds of @c soundCategory.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result SetVolume(const Tizen::Base::String& soundCategory, int level);
* Adds the setting event listener. @n
* This listener is called when a setting value is changed.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] listener The setting event listener
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_ALREADY_EXIST The listener is already added.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @see RemoveSettingEventListener()
+ * @return An error code
+ * @param[in] listener The setting event listener
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_ALREADY_EXIST The listener is already added.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @see RemoveSettingEventListener()
*/
static result AddSettingEventListener(ISettingEventListener& listener);
/**
* Removes the setting event listener.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] listener The setting event listener
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The listener is not added.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @see AddSettingEventListener()
+ * @return An error code
+ * @param[in] listener The setting event listener
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The listener is not added.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @see AddSettingEventListener()
*/
static result RemoveSettingEventListener(ISettingEventListener& listener);
/**
- * Gets the specific @c bool type setting information based on the specified designators (key).
+ * Gets the @c bool type setting information for the specified designators (key).
*
- * @since 2.0
+ * @since 2.0
*
* @privlevel platform
* @privilege %http://tizen.org/privilege/settingmanager.read @n
- * (%http://tizen.org/privilege/systemsetting.read is deprecated.)
- *
- * @return An error code
- * @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">key name</a> of the setting information
- * @param[out] value The setting information of type bool
- * @exception E_SUCCESS The method is successful.
- * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * (%http://tizen.org/privilege/systemsetting.read is deprecated.)
+ *
+ * @return An error code
+ * @param[in] key
The <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">key name</a> of the setting information
+ * @param[out] value The setting information of type @c bool
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method.
+ * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
+ * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result GetValueForPrivilegedKey(const Tizen::Base::String& key, bool& value);
/**
- * Sets the specific @c bool type setting information based on the specified designators (key).
+ * Sets the @c bool type setting information for the specified designators (key).
*
- * @since 2.0
+ * @since 2.0
*
* @privlevel platform
* @privilege %http://tizen.org/privilege/settingmanager.write @n
- * (%http://tizen.org/privilege/systemsetting.write is deprecated.)
- *
- * @return An error code
- * @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">key name</a> of the setting information
- * @param[in] value The setting information of type bool
- * @exception E_SUCCESS The method is successful.
- * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method.
- * @exception E_INVALID_ARG The specified @c value is invalid value.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
+ * (%http://tizen.org/privilege/systemsetting.write is deprecated.)
+ *
+ * @return An error code
+ * @param[in] key
The <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">key name</a> of the setting information
+ * @param[in] value The setting information of type @c bool
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method.
+ * @exception E_INVALID_ARG The specified @c value is invalid value.
+ * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
* @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result SetValueForPrivilegedKey(const Tizen::Base::String& key, bool value);
/**
- * Sets the specific @c bool type setting information based on the specified designators (key) asynchronously.
+ * Sets the @c bool type setting information for the specified designators (key) asynchronously.
*
- * @since 2.0
+ * @since 2.0
* @privlevel platform
* @privilege %http://tizen.org/privilege/settingmanager.write @n
- * (%http://tizen.org/privilege/systemsetting.write is deprecated.)
+ * (%http://tizen.org/privilege/systemsetting.write is deprecated.)
*
- * @return An error code
+ * @return An error code
* @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">key name</a> of the setting information
- * @param[in] value The setting information of type bool
- * @param[in] listener The result listener.
- * @exception E_SUCCESS The method is successful.
- * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method.
- * @exception E_INVALID_ARG The specified @c value is invalid value.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_UNSUPPORTED_OPERATION The specified @c key is existed, However it is not supported by this device.
- * @exception E_IN_PROGRESS The specified key is under processing or invalid state.
- * @exception E_SYSTEM Either of the following conditions has occured:
- * - The method cannot proceed due to a severe system error.
- * - This error can occur and Wi-Fi Direct™ is not activated if the @c key is %http://tizen.org/setting/network.wifi.direct and Wi-Fi is activated.-
-Direct™ is not activated if the @c key is %http://tizen.org/setting/network.wifi.direct and Wi-Fi is activated.
-
+ * @param[in] value The setting information of type @c bool
+ * @param[in] listener The result listener
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method.
+ * @exception E_INVALID_ARG The specified @c value is invalid.
+ * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
+ * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However it is not supported by this device.
+ * @exception E_IN_PROGRESS The specified key is under processing or is in an invalid state.
+ * @exception E_SYSTEM Either of the following conditions has occured:
+ * - The method cannot proceed due to a severe system error.
+ * - Wi-Fi Direct™ is not activated if the @c key is %http://tizen.org/setting/network.wifi.direct and Wi-Fi is
+ * activated.
*/
static result SetValueAsyncForPrivilegedKey(const Tizen::Base::String& key, bool value, ISettingInfoSetValueAsyncResultListener* listener);
/**
- * Sets the specific @c bool type setting information based on the specified designators (key) asynchronously.
+ * Sets the @c bool type setting information for the specified designators (key) asynchronously.
*
- * @since 2.0
+ * @since 2.0
* @privlevel platform
* @privilege %http://tizen.org/privilege/setting
*
- * @return An error code
+ * @return An error code
* @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">key name</a> of the setting information
- * @param[in] value The setting information of type bool
- * @param[in] listener The result listener.
- * @exception E_SUCCESS The method is successful.
- * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method.
- * @exception E_INVALID_ARG The specified @c value is invalid value.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_UNSUPPORTED_OPERATION The specified @c key is existed, However it is not supported by this device.
- * @exception E_IN_PROGRESS The specified key is under processing or invalid state.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @param[in] value The setting information of type @c bool
+ * @param[in] listener The result listener
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method.
+ * @exception E_INVALID_ARG The specified @c value is invalid value.
+ * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
+ * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However it is not supported by this device.
+ * @exception E_IN_PROGRESS The specified key is under processing or is in an invalid state.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result SetValueAsync(const Tizen::Base::String& key, bool value, ISettingInfoSetValueAsyncResultListener* listener);
*
* @privlevel platform
* @privilege %http://tizen.org/privilege/settingmanager.write @n
- * (%http://tizen.org/privilege/systemsetting.write is deprecated.)
+ * (%http://tizen.org/privilege/systemsetting.write is deprecated.)
*
- * @return An error code
+ * @return An error code
* @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/settings_info.htm">key name</a> of the setting information
- * @param[in] value The setting information of type Tizen::Base::String
- * @exception E_SUCCESS The method is successful.
- * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method.
- * @exception E_INVALID_ARG The specified @c value is invalid value.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
+ * @param[in] value The setting information of type Tizen::Base::String
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method.
+ * @exception E_INVALID_ARG The specified @c value is invalid.
+ * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
* @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result SetValueForPrivilegedKey(const Tizen::Base::String& key, Tizen::Base::String value);
/**
- * Resets current device. @n
+ * Resets the current device to the default factory settings. @n
* All data is removed and device is initialized.
*
- * @since 2.0
+ * @since 2.0
*
* @privlevel platform
* @privilege %http://tizen.org/privilege/settingmanager.write @n
- * (%http://tizen.org/privilege/systemsetting.write is deprecated.)
+ * (%http://tizen.org/privilege/systemsetting.write is deprecated.)
*
- * @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @return An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result ResetToFactoryDefault(void);
/**
* @if OSPCOMPAT
* @if OSPDEPREC
- * Sets the setting event listener.
+ * Sets the specified setting event listener.
*
- * @deprecated This method is provided only for backward compatibility and will be deleted in the near future. Instead of using this method, it is recommended to use AddSettingEventListener() and RemoveSettingEventListener().
- * @since 2.0
+ * @deprecated This method is provided only for backward compatibility and will be deleted in the near future. Instead of using this method, it is
+ * recommended to use AddSettingEventListener() and RemoveSettingEventListener().
+ * @since 2.0
*
- * @return An error code
+ * @return An error code
* @param[in] pListener The setting event listener
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks If the value of the listener object (pListener) is @c null, the setting event listener is not called.
+ * @remarks If the value of the listener object (pListener) is @c null, the setting event listener is not called.
* @endif
* @endif
*/
*
* The %SystemInfo class provides system information, such as the API and platform versions, supported device features,
* and screen dimensions.
- * To get the information, you must provide the <a href="../org.tizen.native.appprogramming/html/guide/system/sysinfo.htm">SystemInfo key</a>.
+ * To get the
system information, you must provide the <a href="../org.tizen.native.appprogramming/html/guide/system/sysinfo.htm">SystemInfo key</a>.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/system/sysinfo.htm">System Information</a>.
*
public:
/**
- * Gets the specific Tizen::Base::String type system information based on the specified designators (key).
+ * Gets the Tizen::Base::String type system information based on the specified designators (key).
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/sysinfo.htm">key name</a> of the system information @n
+ * @return An error code
+ * @param[in] key
The <a href="../org.tizen.native.appprogramming/html/guide/system/sysinfo.htm">key name</a> of the system information @n
* @if OSPCOMPAT
* The following key values are updated: @n
* - Since Tizen, refer <a href="../org.tizen.native.appprogramming/html/guide/system/sysinfo.htm">here</a>.
* - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer
* <a href="../org.tizen.native.appprogramming/html/guide/system/sysinfo_deprecated.htm">here</a>.
* @endif
- * @param[out] value The system information of type Tizen::Base::String
- * @exception E_SUCCESS The method is successful.
+ * @param[out] value The system information of type Tizen::Base::String
+ * @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result GetValue(const Tizen::Base::String& key, Tizen::Base::String& value);
/**
- * Gets the specific integer type system information based on the specified designators (key).
+ * Gets the integer type system information based on the specified designators (key).
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/sysinfo.htm">key name</a> of the system information @n
+ * @return An error code
+ * @param[in] key
The <a href="../org.tizen.native.appprogramming/html/guide/system/sysinfo.htm">key name</a> of the system information @n
* @if OSPCOMPAT
* The following key values are updated: @n
* - Since Tizen, refer <a href="../org.tizen.native.appprogramming/html/guide/system/sysinfo.htm">here</a>.
* - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer
* <a href="../org.tizen.native.appprogramming/html/guide/system/sysinfo_deprecated.htm">here</a>.
* @endif
- * @param[out] value The integer type system information
- * @exception E_SUCCESS The method is successful.
+ * @param[out] value The integer type system information
+ * @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result GetValue(const Tizen::Base::String& key, int& value);
/**
- * Gets the specific double type system information based on the specified designators (key).
+ * Gets the @c double type system information based on the specified designators (key).
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/sysinfo.htm">key name</a> of the system information
- * @param[out] value The @c double type system information
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] key
The <a href="../org.tizen.native.appprogramming/html/guide/system/sysinfo.htm">key name</a> of the system information
+ * @param[out] value The @c double type system information
+ * @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result GetValue(const Tizen::Base::String& key, double& value);
/**
- * Gets the specific UuId type system information based on the specified designators (key).
+ * Gets the UuId type system information based on the specified designators (key).
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/sysinfo.htm">key name</a> of the system information
- * @param[out] value The UuId type system information
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] key
The <a href="../org.tizen.native.appprogramming/html/guide/system/sysinfo.htm">key name</a> of the system information
+ * @param[out] value The UuId type system information
+ * @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result GetValue(const Tizen::Base::String& key, Tizen::Base::UuId& value);
/**
- * Gets the specific system information based on the specified key and data type of the information.
+ * Gets the system information based on the specified key and data type of the information.
*
- * @since 2.0
+ * @since 2.0
*
- * @return A system information list
- * @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/sysinfo.htm">key name</a> of the system information @n
+ * @return The system information list
+ * @param[in] key
The <a href="../org.tizen.native.appprogramming/html/guide/system/sysinfo.htm">key name</a> of the system information @n
* @if OSPCOMPAT
* The following key values are updated @n
* - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer
* <a href="../org.tizen.native.appprogramming/html/guide/system/sysinfo_deprecated.htm">here</a>.
* @endif
- * @param[in] type The data type of the information
- * @exception E_SUCCESS The method is successful.
+ * @param[in] type The data type of the information
+ * @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static Tizen::Base::Collection::IList* GetValuesN(const Tizen::Base::String& key, SystemInfoValueType type);
/**
- * Gets the specific boolean type system information based on the specified designators (key).
+ * Gets the @c bool type system information based on the specified designators (key).
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/system/sysinfo.htm">key name</a> of the system information @n
+ * @return An error code
+ * @param[in] key
The <a href="../org.tizen.native.appprogramming/html/guide/system/sysinfo.htm">key name</a> of the system information @n
* @if OSPCOMPAT
* The following key values are updated: @n
* - Since Tizen, refer <a href="../org.tizen.native.appprogramming/html/guide/system/sysinfo.htm">here</a>.
* - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer
* <a href="../org.tizen.native.appprogramming/html/guide/system/sysinfo_deprecated.htm">here</a>.
* @endif
- * @param[out] value The @c bool type system information
- * @exception E_SUCCESS The method is successful.
+ * @param[out] value The @c bool type system information
+ * @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result GetValue(const Tizen::Base::String& key, bool& value);
/**
* Gets the platform version in the "[Major].[Minor].[Patch Version]" format.
*
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/system @n
- * (%http://tizen.org/privilege/platforminfo is deprecated.)
+ * (%http://tizen.org/privilege/platforminfo is deprecated.)
*
- * @return An error code
+ * @return An error code
* @param[out] platformVersion The platform version
- * @exception E_SUCCESS The method is successful.
+ * @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 The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result GetPlatformVersion(Tizen::Base::String& platformVersion);
/**
- * Gets the Native API version in the "[Major].[Minor]" format.
+ * Gets the native API version in the "[Major].[Minor]" format.
*
* @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/system @n
- * (%http://tizen.org/privilege/platforminfo is deprecated.)
+ * (%http://tizen.org/privilege/platforminfo is deprecated.)
*
- * @return An error code
- * @param[out] nativeApiVersion The Native API version
- * @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 The method cannot proceed due to a severe system error.
+ * @return An error code
+ * @param[out] nativeApiVersion The native API version
+ * @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 The method cannot proceed due to a severe system error.
*/
static result GetNativeApiVersion(Tizen::Base::String& nativeApiVersion);
/**
* Gets the WEB API version in the "[Major].[Minor]" format.
*
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/system @n
- * (%http://tizen.org/privilege/platforminfo is deprecated.)
+ * (%http://tizen.org/privilege/platforminfo is deprecated.)
*
- * @return An error code
+ * @return An error code
* @param[out] webApiVersion The %Tizen API version
- * @exception E_SUCCESS The method is successful.
+ * @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 The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result GetWebApiVersion(Tizen::Base::String& webApiVersion);
/**
* Gets the platform build information.
*
- * @since 2.1
+ * @since 2.1
*
* @privlevel public
* @privilege %http://tizen.org/privilege/system @n
- * (%http://tizen.org/privilege/platforminfo is deprecated.)
+ * (%http://tizen.org/privilege/platforminfo is deprecated.)
*
- * @return An error code
- * @param[out] buildInfo The %Tizen build information
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[out] buildInfo The %Tizen build information
+ * @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 The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result GetBuildInfo(Tizen::Base::String& buildInfo);
/**
* Gets the International Mobile Equipment Identity (IMEI) of the device.
*
- * @since 2.0
+ * @since 2.0
*
* @privlevel partner
* @privilege %http://tizen.org/privilege/systemmanager @n
- * (%http://tizen.org/privilege/useridentity is deprecated.)
+ * (%http://tizen.org/privilege/useridentity is deprecated.)
*
- * @return An error code
- * @param[out] imei The IMEI of the device
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[out] imei The IMEI of the device
+ * @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 The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result GetImei(Tizen::Base::String& imei);
UTC_TIME, // This enum value is deprecated. Instead of using this enum value, use UTC_TIME.
STANDARD_TIME, // This enum value is deprecated. Instead of using this enum value, use STANDARD_TIME.
WALL_TIME, // This enum value is deprecated. Instead of using this enum value, use TIME_MODE_WALL.
- TIME_MODE_UTC = UTC_TIME, /**< The UTC Time */
- TIME_MODE_STANDARD = STANDARD_TIME, /**< The Standard Time */
- TIME_MODE_WALL = WALL_TIME, /**< The Wall Time */
+ TIME_MODE_UTC = UTC_TIME, /**< The UTC Time */
+ TIME_MODE_STANDARD = STANDARD_TIME, /**< The Standard Time */
+ TIME_MODE_WALL = WALL_TIME, /**< The Wall Time */
};
class _OSP_EXPORT_ SystemTime
* @since 2.0
*
* @return An error code
- * @param[in] timeMode The time mode @c TIME_MODE_UTC, @c TIME_MODE_STANDARD, or @c TIME_MODE_WALL
+ * @param[in] timeMode The time mode which can be @c TIME_MODE_UTC, @c TIME_MODE_STANDARD, or @c TIME_MODE_WALL
* @param[out] currentTime The current system time
* @exception E_SUCCESS The method is successful.
*/
*
* @privlevel platform
* @privilege %http://tizen.org/privilege/settingmanager.write @n
- * (%http://tizen.org/privilege/systemsetting.write is deprecated.)
+ * (%http://tizen.org/privilege/systemsetting.write is deprecated.)
*
* @return An error code
- * @param[in] currentTime The current system time in UTC
- * @exception E_SUCCESS The method is successful.
+ * @param[in] currentTime The current system time in UTC
+ * @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 The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result SetCurrentTime(const Tizen::Base::DateTime& currentTime);
private:
*
* @since 2.0
*
- * The %Vibrator class handles the vibration functionality of a device. It allows you to manage the device's vibrator parameters, such as vibration count and level.
+ * The %Vibrator class handles the vibration functionality of a device. It allows the management of the device's vibrator parameters, such as the vibration count and level.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/system/vibrator_mgmt.htm">Vibrator Management</a>.
*
/**
* @struct IntensityDurationVibrationPattern
- * @brief This struct has the specified duration and a vibration intensity level.
+ * @brief This struct represents the specified duration and vibration intensity level.
*
- * The %IntensityDurationVibrationPattern struct has the specified duration and a vibration intensity level. This can be used with Vibrator::Start(IntensityDurationVibrationPattern[] patterns, int length, int repeatCount) as a custom pattern.
+ * The %IntensityDurationVibrationPattern struct represents the specified duration and vibration intensity level. This struct can be used with Vibrator::Start(IntensityDurationVibrationPattern[] patterns, int length, int repeatCount) as a custom pattern.
*
* @since 2.1
*/
struct _OSP_EXPORT_ IntensityDurationVibrationPattern
{
- int duration; /**< The duration in milliseconds when the vibrator is on @n
- * The @c duration is not allowed a negative value.
- */
+ int duration; /**< The duration in milliseconds when the vibrator is on @n
+ * The @c duration does not allow a negative value.
+ */
int intensity; /**< The vibration intensity [@c -1~ @c 100]: @n
- * @li The system default vibration intensity (-1)
- * @li The silent vibration intensity (0)
- * @li The minimum vibration intensity (1)
- * @li The maximum vibration intensity (100)
- */
+ * @li The system default vibration intensity (-1)
+ * @li The silent vibration intensity (0)
+ * @li The minimum vibration intensity (1)
+ * @li The maximum vibration intensity (100)
+ */
};
public:
/**
- * This is the default constructor for this class.
- *
+ * This is the default constructor for this class. @n
+ * The object is not fully constructed after this constructor is called.
+ * For full construction, the Construct() method must be called right after calling this constructor.
* @since 2.0
*
- * @remarks The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
*/
Vibrator(void);
/**
- * Vibrates the device with a specified array pattern that has vibration intensity and duration. @n
+ * Vibrates the device with a specified array pattern that has a vibration intensity and duration. @n
* The %Start() method returns the result immediately so that the vibration occurs simultaneously as the device runs. @n
- * If this method is called again before the previous vibration stops, the previous vibration is canceled and the new vibration starts immediately. @n
+ * If this method is called again before the previous vibration stops, the previous vibration is cancelled and the new vibration starts immediately. @n
* If a new vibrator instance triggers the vibration, the vibrator merges the previous vibration pattern with the new one in the overlapped time. @n
- * If the system alert occurs such as ring vibration and a system event notification, the vibration can be interrupted. @n
- * If the application is terminated, the vibration is canceled.
+ * If a system alert occurs such as a ring vibration or a system event notification, the vibration can be interrupted. @n
+ * If the application is terminated, the vibration is cancelled.
*
* @since 2.1
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/vibrator
*
* @return An error code
*
- * @param[in] patterns An array of @c IntensityDurationVibrationPattern
- * @param[in] length The length of @c patterns
- * @param[in] repeatCount The number of times the pattern repeats @n This value must be between @c 1 to @c 100.
- * @exception E_SUCCESS The method is successful.
+ * @param[in] patterns The array of @c IntensityDurationVibrationPattern
+ * @param[in] length The length of @c patterns
+ * @param[in] repeatCount The number of times the pattern repeats @n
+ * This value must be between @c 1 to @c 100.
+ * @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_OPERATION_FAILED The device operation has failed.
- * @remarks The vibration intensity does not apply the change, even if the system default vibration intensity is changed after starting vibration.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_OPERATION_FAILED The device operation has failed.
+ * @remarks The vibration intensity does not apply the change, even if the system default vibration intensity is changed after starting the vibration.
* @see IntensityDurationVibrationPattern
*/
result Start(IntensityDurationVibrationPattern* patterns, int length, int repeatCount = 1);
/**
* Vibrates the device with the specified pattern and level. @n
* The %Start() method returns the result immediately so that the vibration occurs simultaneously as the device runs.
- * If this method is called again before the previous vibration stops, the previous vibration is canceled and the new vibration starts immediately.
+ * If this method is called again before the previous vibration stops, the previous vibration is cancelled and the new vibration starts immediately.
*
- * @brief <i>[Deprecated]</i>
- * @deprecated This method is deprecated. Instead of using this method, use Start(IntensityDurationVibrationPattern*, int, int).
+ * @brief <i>[Deprecated]</i>
+ * @deprecated This method is deprecated. Instead of using this method, use Start(IntensityDurationVibrationPattern*, int, int).
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/vibrator
*
* @return An error code
- * @param[in] onPeriod The period in milliseconds when the vibrator is on @n
- * It should be greater than @c 0.
- * @param[in] offPeriod The period in milliseconds when the vibrator is off @n
- * It should be equal to or greater than @c 0.
- * @param[in] count The number of times to execute the given pattern @n
- * It should be greater than @c 0.
- * @param[in] level The vibration level @n
- * Ranges from [@c 0~ @c 100], where '@c 0' is a special case indicating the system default level.
+ * @param[in] onPeriod The period in milliseconds when the vibrator is on @n
+ * It should be greater than @c 0.
+ * @param[in] offPeriod The period in milliseconds when the vibrator is off @n
+ * It should be equal to or greater than @c 0.
+ * @param[in] count The number of times to execute the given pattern @n
+ * It should be greater than @c 0.
+ * @param[in] level The vibration level @n
+ * It ranges from [@c 0~ @c 100], where '@c 0' is a special case indicating the system default level.
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_DEVICE_BUSY The device cannot be approached because of other operations.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @remarks Various devices may have different vibration capabilities.
- * If the device supports only one level of vibration, then a level value between [@c 0~ @c 100] results in the default vibration.
- * If the device supports many levels of vibration, then a level value @c 0 results in the system default vibration, value @c 1 results in the lowest frequency vibration, value @c 100 results in the highest frequency vibration, and intermediate values result in intermediate vibration levels. @n
- * Devices have implementation-specific limits for the total duration of the vibration, and vibration cuts off at that limit even if the duration parameter is greater than the limit.
+ * @remarks Various devices may have different vibration capabilities. @n
+ * If the device supports only one level of vibration, then a level value between [@c 0~ @c 100] results in the default vibration. @n
+ * If the device supports many levels of vibration, then a level value @c 0 results in the system default vibration,
+ * value @c 1 results in the lowest frequency vibration, value @c 100 results in the highest frequency vibration, and intermediate values result in
+ * intermediate vibration levels. @n
+ * Devices have implementation-specific limits for the total duration of the vibration, and vibration cuts off at that limit even if the duration parameter is
+ * greater than the limit.
*
*/
result Start(long onPeriod, long offPeriod, int count, int level = 0);
/**
- * Vibrates the device for the specified duration at the specified @c level. @n
+ * Vibrates the device for the specified duration at the specified level. @n
* The %Start() method returns the result immediately so that the vibration occurs simultaneously as the device runs.
- * If this method is called again before the previous vibration stops, the previous vibration is canceled and the new vibration starts immediately.
+ * If this method is called again before the previous vibration stops, the previous vibration is cancelled and the new vibration starts immediately.
*
- * @brief <i>[Deprecated]</i>
- * @deprecated This method is deprecated. Instead of using this method, use Start(IntensityDurationVibrationPattern*, int, int).
+ * @brief <i>[Deprecated]</i>
+ * @deprecated This method is deprecated. Instead of using this method, use Start(IntensityDurationVibrationPattern*, int, int).
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/vibrator
*
* @return An error code
- * @param[in] milliseconds The duration for the vibration in milliseconds @n
- * It should be greater than @c 0.
- * @param[in] level The vibration level @n
- * Ranges from [@c 0~ @c 100], where ' @c 0' is a special case indicating the system default level.
- * @exception E_SUCCESS The method is successful.
+ * @param[in] milliseconds The duration for the vibration in milliseconds @n
+ * It should be greater than @c 0.
+ * @param[in] level The vibration level @n
+ * It ranges from [@c 0~ @c 100], where ' @c 0' is a special case indicating the system default level.
+ * @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_DEVICE_BUSY The device cannot be approached because of other operations.
* @exception E_DEVICE_FAILED The device operation has failed.
* @remarks Various devices have different vibration capabilities. @n
- * If the device supports only one level of vibration, then a level value between [@c 0~ @c 100] results in the default vibration.
- * If the device supports many levels of vibration, then a level value @c 0 results in the system default vibration, value @c 1 results in the lowest frequency vibration, value @c 100 results in the highest frequency vibration, and intermediate values result in intermediate vibration levels. @n
- * Devices have implementation-specific limits for the total duration of the vibration, and vibration cuts off at that limit even if the duration parameter is greater than the limit.
+ * If the device supports only one level of vibration, then a level value between [@c 0~ @c 100] results in the default vibration. @n
+ * If the device supports many levels of vibration, then a level value @c 0 results in the system default vibration, value @c 1 results in the lowest
+ * frequency vibration, value @c 100 results in the highest frequency vibration, and intermediate values result in intermediate vibration levels. @n
+ * Devices have implementation-specific limits for the total duration of the vibration, and vibration cuts off at that limit even if the duration parameter is
+ * greater than the limit.
*
*/
result Start(long milliseconds, int level = 0);
/**
* Turns the vibrator off.
*
- * @since 2.0
+ * @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/vibrator
*
{
/**
* @namespace Tizen::System
- * @brief This namespace contains classes and interfaces for %System.
- * @since 2.0
+ * @brief This namespace contains classes and interfaces for %System.
+ * @since 2.0
*
* @remarks @b Header @b %file: @b \#include @b <FSystem.h> @n
- * @b Library : @b osp-appfw
+ * @b Library: @b osp-appfw
*
* The %System namespace provides system management features, such as system time, alarm, vibrator, power, and device management.
* It also provides the system, setting, and runtime information.
/**
* @namespace Tizen::Text
- * @brief This namespace contains classes that encode and decode characters.
+ * @brief This namespace contains classes that encode and decode characters.
*
* @since 2.0
*
* @remarks @b Header @b %file: @b \#include @b <FText.h> @n
- * @b Library: @b osp-appfw
+ * @b Library: @b osp-appfw
*
- * The %Text namespace contains the Encoding class, which is the base class for encoding and decoding many character encodings, such as UTF-8, UCS-2, Latin-1, GSM, and ASCII. It also contains the Decoder and Encoder classes for converting text blocks. The main purpose of this namespace is to support inter-
+ *
+ * The %Text namespace contains the Encoding class, which is the base class for encoding and decoding different character encodings, such as UTF-8, UCS-2, Latin-1, GSM, and ASCII.
+ * It also contains the Decoder and Encoder classes for converting text blocks. The main purpose of this namespace is to support inter-
* operability between the various existing languages and scripts.
* %Text is a data consisting of a sequence of characters.
- * It is also defined as a series of characters that can be displayed on a
- * display terminal or printed on paper for human reading.
+ * It is also defined as a series of characters that can be displayed on a display terminal or printed on a paper for human reading.
*
* For more information on the %Text namespace features, see <a href="../org.tizen.native.appprogramming/html/guide/text/text.htm">Text Guide</a>.
*
* @since 2.0
*
* @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n
- * else @c null if an exception occurs @n
- * The buffer limit is the position of the last encoded byte plus one and the starting position is zero.
- * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
+ * else @c null if an exception occurs @n
+ * The buffer limit is the position of the last encoded byte plus one and the starting position is zero.
+ * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_INVALID_ARG The specified @c chars is empty or invalid.
* @since 2.0
*
* @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n
- * else @c null if an exception occurs @n
- * The buffer limit is the position of the last encoded byte plus one and the starting position is zero.
- * @param[in] str A string to encode
+ * else @c null if an exception occurs @n
+ * The buffer limit is the position of the last encoded byte plus one and the starting position is zero.
+ * @param[in] str The string to encode
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_INVALID_ARG The specified @c str is empty or invalid.
* @since 2.0
*
* @return An error code
- * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
- * @param[in] charCount The total number of characters to encode
- * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored
- * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance
+ * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] charCount The total number of characters to encode
+ * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored
+ * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c chars or @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
- * @exception E_OVERFLOW This operation has caused the memory to overflow, or
- * the specified @c bytes does not contain sufficient space to store the encoded characters.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c chars or @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to overflow.
+ * - The specified @c bytes does not contain sufficient space to store the encoded characters.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetChars()
*/
* @since 2.0
*
* @return An error code
- * @param[in] str A string to encode
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
- * @param[in] charCount The total number of characters to encode
- * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored
- * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c str or @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str.
- * @exception E_OVERFLOW This operation has caused the memory to overflow, or
- * the specified @c bytes does not contain sufficient space to store the encoded characters.
- * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
+ * @param[in] str The string to encode
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] charCount The total number of characters to encode
+ * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored
+ * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c str or @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to overflow.
+ * - The specified @c bytes does not contain sufficient space to store the encoded characters.
+ * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetString()
*/
virtual result GetBytes(const Tizen::Base::String& str, int charIndex, int charCount,
* @since 2.0
*
* @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n
- * else @c null if an exception occurs @n
- * The buffer limit is the position of the last decoded byte plus one and the starting position is zero.
- * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
+ * else @c null if an exception occurs @n
+ * The buffer limit is the position of the last decoded byte plus one and the starting position is zero.
+ * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_INVALID_ARG The specified @c bytes is empty or invalid.
* @since 2.0
*
* @return An error code
- * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[in] byteIndex The index from where decoding begins
- * @param[in] byteCount The total number of bytes to decode
- * @param[out] chars The Tizen::Base::WcharBuffer instance where the resultant decoded string is stored
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c bytes or @c chars is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
- * @exception E_OVERFLOW This operation has caused the memory to overflow, or
- * the specified @c chars does not contain sufficient space to store the decoded bytes.
+ * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
+ * @param[in] byteIndex The index from where the decoding begins
+ * @param[in] byteCount The total number of bytes to decode
+ * @param[out] chars The Tizen::Base::WcharBuffer instance where the resultant decoded string is stored
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes or @c chars is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to overflow.
+ * - The specified @c chars does not contain sufficient space to store the decoded bytes.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetBytes()
*/
virtual result GetChars(const Tizen::Base::ByteBuffer& bytes, int byteIndex, int byteCount, Tizen::Base::WcharBuffer& chars, int charIndex = 0) const;
/**
- * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance.
+ * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
*
* @since 2.0
*
* @return An error code
- * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[out] str A Tizen::Base::String instance @n
- * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c bytes is empty.
+ * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
+ * @param[out] str A Tizen::Base::String instance @n
+ * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
- * @remarks This method assumes that the Tizen::Base::ByteBuffer instance contains all the bytes necessary to generate the entire string.
- * If the bytes are in multiple byte arrays, use the Decoder class, which maintains state consistency
- * between multiple calls.
+ * @remarks
+ * - This method assumes that the Tizen::Base::ByteBuffer instance contains all the bytes necessary to generate the entire string.
+ * - If the bytes are in the multiple byte arrays, use the Decoder class, which maintains state consistency
+ * between multiple calls.
* @see GetBytesN()
*/
virtual result GetString(const Tizen::Base::ByteBuffer& bytes, Tizen::Base::String& str) const;
/**
- * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance.
+ * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
*
* @since 2.0
*
* @return An error code
- * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[in] index The index from where decoding begins
- * @param[in] count The total number of bytes to decode
- * @param[out] str A Tizen::Base::String instance @n
- * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes.
+ * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
+ * @param[in] index The index from where the decoding begins
+ * @param[in] count The total number of bytes to decode
+ * @param[out] str A Tizen::Base::String instance @n
+ * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
- * @remarks This method assumes that the Tizen::Base::ByteBuffer instance contains all the bytes necessary to generate the entire string.
- * If the bytes are in multiple byte arrays, use the Decoder class, which maintains state consistency
- * between multiple calls.
+ * @remarks
+ * - This method assumes that the Tizen::Base::ByteBuffer instance contains all the bytes necessary to generate the entire string.
+ * - If the bytes are in multiple byte arrays, use the Decoder class, which maintains state consistency
+ * between multiple calls.
* @see GetBytes()
*/
virtual result GetString(const Tizen::Base::ByteBuffer& bytes, int index, int count, Tizen::Base::String& str) const;
/**
- * Gets the maximum number of bytes required for encoding a given number of characters.
+ * Gets the maximum number of bytes required for encoding the given number of characters.
*
* @since 2.0
*
- * @return The maximum number of bytes required for encoding a given number of characters
- * @param[in] charCount The total number of characters to encode
- * @remarks This method determines an appropriate buffer size for the byte arrays passed to GetBytes() for encoding.
- * @see Encoding::GetByteCount()
- * @see GetBytes()
+ * @return The maximum number of bytes required for encoding the given number of characters
+ * @param[in] charCount The total number of characters to encode
+ * @remarks This method determines an appropriate buffer size for the byte arrays passed to GetBytes() for encoding.
+ * @see Encoding::GetByteCount()
*/
virtual int GetMaxByteCount(int charCount) const;
* @since 2.0
*
* @return The maximum number of characters that are generated by decoding the specified number of bytes
- * @param[in] byteCount The total number of bytes to encode
- * @remarks This method determines an appropriate buffer size for character arrays passed to
- * GetChars() or a decoder for encoding.
- * @see Encoding::GetCharCount()
- * @see GetChars()
+ * @param[in] byteCount The total number of bytes to encode
+ * @remarks This method determines an appropriate buffer size for character arrays passed to
+ * GetChars() or a decoder for encoding.
+ * @see Encoding::GetCharCount()
*/
virtual int GetMaxCharCount(int byteCount) const;
*
* @since 2.0
*
- * @return A pointer to the Encoder instance for the current encoding
- * @remarks Contrary to GetBytes(), an encoder can convert partial sequences of characters into
- * partial sequences of bytes by maintaining the appropriate state between the conversions. @n
- * At present, only the Utf8Encoding class supports this method. Other classes return @c null.
- * @see GetBytes()
+ * @return A pointer to the Encoder instance for the current encoding
+ * @remarks
+ * - Contrary to GetBytes(), an encoder can convert partial sequences of characters into
+ * partial sequences of bytes by maintaining the appropriate state between the conversions.
+ * - At present, only the Utf8Encoding class supports this method. Other classes return @c null.
*/
virtual Encoder* GetEncoderN(void) const;
*
* @since 2.0
*
- * @return A pointer to the Decoder instance for the current encoding
- * @remarks Contrary to GetChars(), a decoder can convert partial sequences of bytes
- * into partial sequences of characters by maintaining the appropriate state between the conversions. @n
- * At present, only the Utf8Encoding class supports this method. Other classes return @c null.
- *
- * @see GetChars()
+ * @return A pointer to the Decoder instance for the current encoding
+ * @remarks
+ * - Contrary to GetChars(), a decoder can convert partial sequences of bytes
+ * into partial sequences of characters by maintaining the appropriate state between the conversions.
+ * - At present, only the Utf8Encoding class supports this method. Other classes return @c null.
*/
virtual Decoder* GetDecoderN(void) const;
*
* @since 2.0
*
- * @return An encoding type
+ * @return The encoding type
*/
virtual Tizen::Base::String GetEncodingType(void) const;
*
* The %Decoder class converts blocks of encoded bytes into blocks of Unicode characters
* through successive calls to the GetCharsN() method. This class maintains state consistency information between
- * successive calls to %GetCharsN(), enabling it to decode a sequence of bytes that span adjacent blocks.
+ * successive calls to %GetCharsN() and enables it to decode a sequence of bytes that span adjacent blocks.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/text/converting_text_data_separate_blocks.htm">Converting Text Data in Separate Blocks</a>.
*
* @since 2.0
*
* @return An error code
- * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[in] byteIndex The index from where decoding begins
- * @param[in] byteCount The total number of bytes to decode
- * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
- * else @c false
- * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance
+ * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
+ * @param[in] byteIndex The index from where the decoding begins
+ * @param[in] byteCount The total number of bytes to decode
+ * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
+ * else @c false
+ * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
- * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see Encoder::GetByteCount()
*/
virtual result GetCharCount(const Tizen::Base::ByteBuffer& bytes,
* @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n
* else @c null if an exception occurs @n
* The buffer limit is the position of the last decoded byte plus one in the buffer and the starting position is zero.
- * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
- * else @c false
+ * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
+ * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
+ * else @c false
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c bytes is empty.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see Encoder::GetBytesN()
* @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n
* else @c null if an exception occurs @n
* The buffer limit is the position of the last decoded byte in the buffer and the starting position is zero.
- * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[in] byteIndex The index from where decoding begins
- * @param[in] byteCount The total number of bytes to decode
- * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
- * else @c false
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
+ * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
+ * @param[in] byteIndex The index from where the decoding begins
+ * @param[in] byteCount The total number of bytes to decode
+ * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
+ * else @c false
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
- * @remarks This method maintains state consistency between conversions.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks The pointer to the Tizen::Base::WcharBuffer instance is not terminated by a @c null character.
+ * @remarks
+ * - This method maintains state consistency between conversions.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The pointer to the Tizen::Base::WcharBuffer instance is not terminated by a @c null character.
* @see Encoder::GetBytesN()
*/
virtual Tizen::Base::WcharBuffer* GetCharsN(const Tizen::Base::ByteBuffer& bytes, int byteIndex, int byteCount,
*
* The %Encoder class converts blocks of characters to blocks of encoded bytes
* through successive calls to the GetBytesN() method. This class maintains the state consistency information between
- * successive calls to %GetBytesN(), enabling it to encode a character into a sequence of bytes,
+ * successive calls to %GetBytesN() and enables it to encode a character into a sequence of bytes,
* such as surrogate pairs, that span adjacent blocks.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/text/converting_text_data_separate_blocks.htm">Converting Text Data in Separate Blocks</a>.
* @since 2.0
*
* @return An error code
- * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
- * @param[in] charCount The total number of characters to encode
- * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
- * else @c false
- * @param[out] byteCount The total number of bytes required to encode the specified range of characters
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c chars is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
+ * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] charCount The total number of characters to encode
+ * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
+ * else @c false
+ * @param[out] byteCount The total number of bytes required to encode the specified range of characters
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c chars is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see Decoder::GetCharCount()
*/
* @since 2.0
*
* @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n
- * else @c null if an exception occurs @n
- * The buffer limit is the position of the last encoded byte plus one in the buffer and the starting position is zero.
- * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
- * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
- * else @c false
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c chars is empty.
+ * else @c null if an exception occurs @n
+ * The buffer limit is the position of the last encoded byte plus one in the buffer and the starting position is zero.
+ * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
+ * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
+ * else @c false
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c chars is empty.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see Decoder::GetCharsN()
* @since 2.0
*
* @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n
- * else @c null if an exception occurs @n
- * The buffer limit is the position of the last encoded byte in the buffer and the starting position is zero.
- * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
- * @param[in] charCount The total number of characters to encode
- * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
- * else @c false
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c chars is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
+ * else @c null if an exception occurs @n
+ * The buffer limit is the position of the last encoded byte in the buffer and the starting position is zero.
+ * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] charCount The total number of characters to encode
+ * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
+ * else @c false
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c chars is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks The pointer to the Tizen::Base::ByteBuffer instance is not terminated by a @c null character.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The pointer to the Tizen::Base::ByteBuffer instance is not terminated by a @c null character.
* @see Decoder::GetCharsN()
*/
virtual Tizen::Base::ByteBuffer* GetBytesN(const Tizen::Base::WcharBuffer& chars, int charIndex, int charCount,
* @param[in] str The string to encode
* @param[out] byteCount The total number of bytes that are required to encode the specified string
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c str is an empty string.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c str is an empty string.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks This method determines the total number of bytes
* that are generated when the specified string is encoded.
* @since 2.0
*
* @return An error code
- * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
- * @param[out] byteCount The total number of bytes required to encode the specified range of characters
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c chars is empty.
+ * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
+ * @param[out] byteCount The total number of bytes required to encode the specified range of characters
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c chars is empty.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks This method determines the total number of bytes
* that are generated when the specified array of characters are encoded.
*
* @return An error code
* @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
- * @param[in] charCount The total number of characters to encode
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] charCount The total number of characters to encode
* @param[out] byteCount The total number of bytes that are required to encode the specified range of characters
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c chars is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c chars is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks This method determines the total number of bytes
* that are generated when the specified array of characters are encoded.
* @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n
* else @c null if an exception occurs @n
* The buffer limit is the position of the last encoded byte plus one and the starting position is zero.
- * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
+ * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_INVALID_ARG The specified @c chars is invalid or empty.
* @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n
* else @c null if an exception occurs @n
* The buffer limit is the position of the last encoded byte plus one and the position is zero.
- * @param[in] str The string to encode
+ * @param[in] str The string to encode
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_INVALID_ARG The specified @c str is invalid or is an empty string.
* @since 2.0
*
* @return An error code
- * @param[in] chars The buffer containing the character array to encode
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] chars The buffer that contains the character array to encode
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
* @param[in] charCount The total number of characters to encode
* @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored
* @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c chars or @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
- * @exception E_OVERFLOW This operation has caused the memory to overflow, or the specified @c bytes does not contain sufficient space to store the encoded characters.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c chars or @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input paramter is outside the valid range defined by the method.
+ * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to overflow.
+ * - The specified @c bytes does not contain sufficient space to store the encoded characters.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks This method encodes a range of characters in Tizen::Base::WcharBuffer into a range of bytes in Tizen::Base::ByteBuffer.
* @see GetChars()
* @since 2.0
*
* @return An error code
- * @param[in] str The string to encode
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
- * @param[in] charCount The total number of characters to encode
- * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored
- * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance
+ * @param[in] str The string to encode
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] charCount The total number of characters to encode
+ * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored
+ * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c str or @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str.
- * @exception E_OVERFLOW This operation has caused the memory to overflow, or the specified @c bytes does not contain sufficient space to store the encoded characters.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c str or @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to overflow.
+ * - The specified @c bytes does not contain sufficient space to store the encoded characters.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetString()
*/
* @param[out] charCount The total number of characters that are generated by decoding a range of bytes in the specified Tizen::Base::ByteBuffer instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c bytes is empty.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks This method determines the total number of characters
* that are generated when the specified range of bytes are encoded.
*
* @return An error code
* @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[in] byteIndex The index from where decoding begins
+ * @param[in] byteIndex The index from where the decoding begins
* @param[in] byteCount The total number of bytes to decode
* @param[out] charCount The total number of characters that are generated by decoding a range of bytes in the specified Tizen::Base::ByteBuffer instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks This method determines the total number of characters
* that are generated when the specified range of bytes are encoded.
* @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n
* else @c null if an exception occurs @n
* The buffer limit is the position of the last decoded byte plus one and the starting position is zero.
- * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
+ * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_INVALID_ARG The specified @c bytes is invalid or empty.
* @since 2.0
*
* @return An error code
- * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[in] byteIndex The index from where decoding begins
- * @param[in] byteCount The total number of bytes to decode
- * @param[out] chars The Tizen::Base::WcharBuffer instance where the resultant decoded data is stored
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
+ * @param[in] byteIndex The index from where the decoding begins
+ * @param[in] byteCount The total number of bytes to decode
+ * @param[out] chars The Tizen::Base::WcharBuffer instance where the resultant decoded data is stored
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
- * @exception E_OVERFLOW This operation has caused the memory to overflow, or the specified @c chars does not contain sufficient space to store the decoded bytes.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to overflow.
+ * - The specified @c chars does not contain sufficient space to store the decoded bytes.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetBytes()
*/
* It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c bytes is empty.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
*
* @see GetBytesN()
*
* @return An error code
* @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[in] index The index from where decoding begins
+ * @param[in] index The index from where the decoding begins
* @param[in] count The total number of bytes to decode
- * @param[out] str A Tizen::Base::String instance @n
- * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
+ * @param[out] str A Tizen::Base::String instance @n
+ * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetBytes()
* @see GetString()
* @param[in] charCount The total number of characters to encode
* @remarks This method determines an appropriate buffer size for the byte arrays passed to GetBytes() for encoding.
* @see GetByteCount()
- * @see GetBytes()
*/
virtual int GetMaxByteCount(int charCount) const = 0;
* @remarks This method determines an appropriate buffer size for character arrays passed to
* GetChars() or a decoder for encoding.
* @see GetCharCount()
- * @see GetChars()
*/
virtual int GetMaxCharCount(int byteCount) const = 0;
* @since 2.0
*
* @return A pointer to the Encoder instance for the current encoding
- * @remarks Contrary to GetBytes(), an encoder can convert partial sequences of characters into
- * partial sequences of bytes by maintaining an appropriate state between the conversions.
- * Currently, only UTF-8 encoding supports this method. The other classes return a value of @c null.
- * @see GetBytes()
+ * @remarks
+ * - Contrary to GetBytes(), an encoder can convert partial sequences of characters into
+ * partial sequences of bytes by maintaining an appropriate state between the conversions.
+ * - Currently, only UTF-8 encoding supports this method. The other classes return a @c null value.
*/
virtual Encoder* GetEncoderN(void) const = 0;
* @since 2.0
*
* @return A pointer to the Decoder instance for the current encoding
- * @remarks Contrary to GetChars(), a decoder can convert partial sequences of bytes
- * into partial sequences of characters by maintaining an appropriate state between the conversions.
- * Currently, only UTF-8 encoding supports this method. The other classes return a value of @c null.
- * @see GetChars()
+ * @remarks
+ * - Contrary to GetChars(), a decoder can convert partial sequences of bytes
+ * into partial sequences of characters by maintaining an appropriate state between the conversions.
+ * - Currently, only UTF-8 encoding supports this method. The other classes return a @c null value.
*/
virtual Decoder* GetDecoderN(void) const = 0;
*
* @since 2.0
*
- * @return An encoding type
+ * @return The encoding type
*/
virtual Tizen::Base::String GetEncodingType(void) const = 0;
/**
- * Gets an encoding for the UTF-8 format.
+ * Gets the encoding for the UTF-8 format.
*
* @since 2.0
*
- * @return An encoding for the UTF-8 format
+ * @return The encoding for the UTF-8 format
*
- * @see Tizen::Text::Utf8Encoding
*/
static Utf8Encoding& GetUtf8Encoding(void);
/**
- * Gets an encoding for the UCS-2 format.
+ * Gets the encoding for the UCS-2 format.
*
* @since 2.0
*
- * @return An encoding for the UCS-2 format
+ * @return The encoding for the UCS-2 format
-*
- * @see Tizen::Text::Ucs2Encoding
*/
static Ucs2Encoding& GetUcs2Encoding(void);
/**
- * Gets an encoding for the GSM format.
+ * Gets the encoding for the GSM format.
*
* @since 2.0
*
- * @return An encoding for the GSM format
+ * @return The encoding for the GSM format
*
- * @see Tizen::Text::GsmEncoding
*/
static GsmEncoding& GetGsmEncoding(void);
/**
- * Gets an encoding for the Latin1 format.
+ * Gets the encoding for the Latin1 format.
*
* @since 2.0
*
- * @return An encoding for the Latin1 format
+ * @return The encoding for the Latin1 format
*
- * @see Tizen::Text::Latin1Encoding
*/
static Latin1Encoding& GetLatin1Encoding(void);
/**
- * Gets an encoding for the ASCII format.
+ * Gets the encoding for the ASCII format.
*
* @since 2.0
*
- * @return An encoding for the ASCII format
+ * @return The encoding for the ASCII format
*
- * @see Tizen::Text::AsciiEncoding
*/
static AsciiEncoding& GetAsciiEncoding(void);
*
* @since 2.0
*
- * @return An instance of %Encoding, @n
- * else @c null if the method fails
- * @param[in] encodingType An encoding type
+ * @return An instance of %Encoding, @n
+ * else @c null if it fails
+ * @param[in] encodingType The encoding type
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_TYPE The specified encoding type is not supported.
- * @remarks The specific error code can be accessed using the GetLastResult() method. @n
- * The supported encoding types are ASCII, GSM, UCS-2, UCS-2LE, UCS-2BE, UCS-4, UCS-4LE, UCS-4BE, UTF-8, UTF-16, UTF-16LE, UTF-16BE, @n
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The supported encoding types are ASCII, GSM, UCS-2, UCS-2LE, UCS-2BE, UCS-4, UCS-4LE, UCS-4BE, UTF-8, UTF-16, UTF-16LE, UTF-16BE, @n
* UTF-32, UTF-32LE, UTF-32BE, ISO-8859-1~16 (except ISO-8859-12), Windows-874, Windows-1250 ~ Windows-1258, @n
* KSC5601, BIG5, GB2312, Shift-JIS and ISO-2022-JP. @n
- * For more information on the supported encoding types, see <a href="../org.tizen.native.appprogramming/html/guide/text/text.htm">Encoding standards in %Tizen</a>.
+ * For more information on the supported encoding types, see
+ * <a href="../org.tizen.native.appprogramming/html/guide/text/text.htm">Encoding standards in %Tizen</a>.
* @see Tizen::Text::Encoding::GetAvailableEncodingsN()
*/
static Encoding* GetEncodingN(const Tizen::Base::String& encodingType);
*
* @since 2.0
*
- * @return An encoding type
+ * @return The encoding type
* @param[in] encoding An instance of %Encoding
*/
static Tizen::Base::String GetEncodingType(const Encoding& encoding);
*
* @since 2.0
*
- * @return A list of Tizen::Base::String instances (ASCII, UTF-8, ISO-8859-1, ISO-8859-2, Windows-1254, and so on), @n
- * else @c null if the method fails
+ * @return The list of Tizen::Base::String instances (ASCII, UTF-8, ISO-8859-1, ISO-8859-2, Windows-1254, and so on), @n
+ * else @c null if it fails
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*
* @since 2.0
*
- * @return A new buffer for storing the result of the conversion, @n
+ * @return The new buffer for storing the result of the conversion, @n
* else @c null if an exception occurs @n
- * The buffer limit is the position of the last converted byte plus one and the starting position is zero.
+ * The buffer limit is the position of the last converted byte plus one and the starting position is zero.
* @param[in] src The source of the encoding
* @param[in] dst The destination of the encoding
* @param[in] srcBytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c srcBytes is empty.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c srcBytes is empty.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see GetBytes()
*
* @return A new buffer for storing result of the conversion, @n
* else @c null if an exception occurs @n
- * The buffer limit is the position of the last converted byte plus one and the starting position is zero.
+ * The buffer limit is the position of the last converted byte plus one and the starting position is zero.
* @param[in] src The source of the encoding
* @param[in] dst The destination of the encoding
* @param[in] srcBytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored
* @param[in] count The total number of bytes to convert
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c srcBytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the specified @c index or @c count is greater than the length of the specified @c srcBytes.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c index and @c count is greater than the length of the specified @c srcBytes.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c srcBytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The specified @c index or @c count is greater than the length of the specified @c srcBytes.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c srcBytes.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see GetBytes()
* @since 2.0
*
* @return An error code
- * @param[in] str A string to encode
- * @param[out] byteCount The total number of bytes required to encode the specified string
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c str is empty.
+ * @param[in] str The string to encode
+ * @param[out] byteCount The total number of bytes required to encode the specified string
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c str is empty.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks This method determines the total number of bytes
* that are generated when the specified string is encoded.
* @since 2.0
*
* @return An error code
- * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
- * @param[out] byteCount The total number of bytes required to encode the specified range of characters
+ * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
+ * @param[out] byteCount The total number of bytes required to encode the specified range of characters
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c chars is empty.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c chars is empty.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks This method determines the total number of bytes
* that are generated when the specified array of characters is encoded.
* @since 2.0
*
* @return An error code
- * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
- * @param[in] charCount The total number of characters to encode
- * @param[out] byteCount The total number of bytes required to encode the specified range of characters
+ * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] charCount The total number of characters to encode
+ * @param[out] byteCount The total number of bytes required to encode the specified range of characters
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c chars is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c chars is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks This method determines the total number of bytes
* that are generated when the specified array of characters is encoded.
*
* @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n
* else @c null if an exception occurs @n
- * The buffer limit is the position of the last encoded byte plus one and the starting position is zero.
- * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
+ * The buffer limit is the position of the last encoded byte plus one and the starting position is zero.
+ * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_INVALID_ARG The specified @c chars is invalid or empty.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks The pointer to the Tizen::Base::ByteBuffer instance is not terminated by a @c null character.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The pointer to the Tizen::Base::ByteBuffer instance is not terminated by a @c null character.
* @see GetCharsN()
*/
virtual Tizen::Base::ByteBuffer* GetBytesN(const Tizen::Base::WcharBuffer& chars) const;
* @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n
* else @c null if an exception occurs @n
* The buffer limit is the position of the last encoded byte plus one and the starting position is zero.
- * @param[in] str A string to encode
+ * @param[in] str The string to encode
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_INVALID_ARG The specified @c str is invalid or empty.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks The pointer to the Tizen::Base::ByteBuffer instance is not terminated by a @c null character.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The pointer to the Tizen::Base::ByteBuffer instance is not terminated by a @c null character.
* @see GetString()
*/
virtual Tizen::Base::ByteBuffer* GetBytesN(const Tizen::Base::String& str) const;
* @since 2.0
*
* @return An error code
- * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
* @param[in] charCount The total number of characters to encode
* @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored
* @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c chars or @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
- * @exception E_OVERFLOW This operation has caused the memory to overflow, or the specified @c bytes does not contain sufficient space to store the encoded characters.
- * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c chars or @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to overflow.
+ * - The specified @c bytes does not contain sufficient space to store the encoded characters.
+ * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks This method encodes a range of characters in Tizen::Base::WcharBuffer into a range of bytes in Tizen::Base::ByteBuffer.
* @see GetChars()
*/
* @since 2.0
*
* @return An error code
- * @param[in] str A string to encode
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
- * @param[in] charCount The total number of characters to encode
- * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored
- * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance
+ * @param[in] str The string to encode
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] charCount The total number of characters to encode
+ * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored
+ * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c str or @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str.
- * @exception E_OVERFLOW This operation has caused the memory to overflow, or the specified @c bytes does not contain sufficient space to store the encoded characters.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c str or @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to overflow.
+ * - The specified @c bytes does not contain sufficient space to store the encoded characters.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetString()
*/
* @since 2.0
*
* @return An error code
- * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance
+ * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
+ * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c bytes is empty.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
- * @remarks This method determines the total number of characters
- * that are generated when the specified range of bytes are decoded.
+ * @remarks This method determines the total number of characters that are generated when the specified range of bytes are decoded.
* @see GetMaxCharCount()
*/
virtual result GetCharCount(const Tizen::Base::ByteBuffer& bytes, int& charCount) const;
* @since 2.0
*
* @return An error code
- * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[in] byteIndex The index from where decoding begins
- * @param[in] byteCount The total number of bytes to decode
- * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
+ * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
+ * @param[in] byteIndex The index from where the decoding begins
+ * @param[in] byteCount The total number of bytes to decode
+ * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks This method determines the total number of characters
* that are generated when the specified range of bytes are decoded.
*
* @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n
* else @c null if an exception occurs @n
- * The buffer limit is the position of the last decoded byte plus one and the starting position is zero.
- * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
+ * The buffer limit is the position of the last decoded byte plus one and the starting position is zero.
+ * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_INVALID_ARG The specified @c bytes is invalid or empty.
* @since 2.0
*
* @return An error code
- * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[in] byteIndex The index from where decoding begins
- * @param[in] byteCount The total number of bytes to decode
- * @param[out] chars The Tizen::Base::WcharBuffer instance where the resultant decoded data is stored
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
+ * @param[in] byteIndex The index from where the decoding begins
+ * @param[in] byteCount The total number of bytes to decode
+ * @param[out] chars The Tizen::Base::WcharBuffer instance where the resultant decoded data is stored
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c bytes or @c chars is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
- * @exception E_OVERFLOW This operation has caused the memory to overflow, or the specified @c chars does not contain sufficient space to store the decoded bytes.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes or @c chars is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to overflow.
+ * - The specified @c chars does not contain sufficient space to store the decoded bytes.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetBytes()
*/
Tizen::Base::WcharBuffer& chars, int charIndex = 0) const;
/**
- * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance.
+ * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
*
* @since 2.0
*
* @return An error code
- * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[out] str A Tizen::Base::String instance @n
- * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c bytes is empty.
+ * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
+ * @param[out] str A Tizen::Base::String instance @n
+ * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetBytesN()
*/
virtual result GetString(const Tizen::Base::ByteBuffer& bytes, Tizen::Base::String& str) const;
/**
- * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance.
+ * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
*
* @since 2.0
*
* @return An error code
- * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[in] index The index from where decoding begins
- * @param[in] count The total number of bytes to decode
- * @param[out] str A Tizen::Base::String instance @n
- * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
+ * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
+ * @param[in] index The index from where the decoding begins
+ * @param[in] count The total number of bytes to decode
+ * @param[out] str A Tizen::Base::String instance @n
+ * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parmater is outside the valid range defined by the method.
+ * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetBytes()
*/
*
* @since 2.0
*
- * @return A pointer to the Encoder instance for the current encoding
- * @remarks Contrary to GetBytes(), an encoder can convert partial sequences of characters into
- * partial sequences of bytes by maintaining the appropriate state between the conversions.
- * Currently only UTF-8 encoding supports this method. The other classes return a value of @c null.
- * @see GetBytes()
+ * @return A pointer to the Encoder instance for the current encoding
+ * @remarks
+ * - Contrary to GetBytes(), an encoder can convert partial sequences of characters into
+ * partial sequences of bytes by maintaining the appropriate state between the conversions.
+ * - Currently only UTF-8 encoding supports this method. The other classes return a @c null value.
*/
virtual Encoder* GetEncoderN(void) const;
*
* @since 2.0
*
- * @return A pointer to the Decoder instance for the current encoding
- * @remarks Contrary to GetChars(), a decoder can convert partial sequences of bytes
- * into partial sequences of characters by maintaining the appropriate state between the conversions.
- * Currently only UTF-8 encoding supports this method. The other classes return a value of @c null.
- * @see GetChars()
+ * @return A pointer to the Decoder instance for the current encoding
+ * @remarks
+ * - Contrary to GetChars(), a decoder can convert partial sequences of bytes
+ * into partial sequences of characters by maintaining the appropriate state between the conversions.
+ * - Currently only UTF-8 encoding supports this method. The other classes return a @c null value.
*/
virtual Decoder* GetDecoderN(void) const;
*
* @since 2.0
*
- * @return An encoding type
+ * @return The encoding type
*/
virtual Tizen::Base::String GetEncodingType(void) const;
* though the two are not identical.
* Latin1 also serves as the basis for the ANSI character set of MS Windows.
* Only the characters in ISO Latin-1 are guaranteed to be supported on an Internet website.
- * When a %Web browser, such as Internet Explorer or Firefox formats a %Web page on a client system, such as
- * Windows, it maps the ISO Latin-1 characters as best it can into the default character set.
+ * When a %Web browser, such as Internet Explorer or Firefox formats a Web page on a client system, such as
+ * Windows, it maps the ISO Latin-1 characters to the default character set in the best possible way.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/text/converting_all_text_data.htm">Converting All Text Data at Once</a>.
*
*
* @since 2.0
*
- * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n
- * else @c null if an exception occurs @n
- * The buffer limit is the position of the last encoded byte plus one and the starting position is zero.
+ * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n
+ * else @c null if an exception occurs @n
+ * The buffer limit is the position of the last encoded byte plus one and the starting position is zero.
* @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
*
* @since 2.0
*
- * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n
- * else @c null if an exception occurs @n
- * The buffer limit is the position of the last encoded byte plus one and the starting position is zero.
- * @param[in] str A string to encode
+ * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n
+ * else @c null if an exception occurs @n
+ * The buffer limit is the position of the last encoded byte plus one and the starting position is zero.
+ * @param[in] str The string to encode
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_INVALID_ARG The specified @c str is empty or invalid.
*
* @return An error code
* @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
- * @param[in] charCount The total number of characters to encode
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] charCount The total number of characters to encode
* @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored
* @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c chars or @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
- * @exception E_OVERFLOW This operation has caused the memory to overflow, or
- * the specified @c bytes does not contain sufficient space to store the encoded characters.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c chars or @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to overflow.
+ * - The specified @c bytes does not contain sufficient space to store the encoded characters.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks This method encodes a range of characters in Tizen::Base::WcharBuffer into a range of bytes in Tizen::Base::ByteBuffer.
* @see GetChars()
* @since 2.0
*
* @return An error code
- * @param[in] str A string to encode
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
- * @param[in] charCount The total number of characters to encode
+ * @param[in] str The string to encode
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] charCount The total number of characters to encode
* @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored
- * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance
+ * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c str or @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str.
- * @exception E_OVERFLOW This operation has caused the memory to overflow, or
- * the specified @c bytes does not contain sufficient space to store the encoded characters.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c str or @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parmater is outside the valid range defined by the method.
+ * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to overflow.
+ * - The specified @c bytes does not contain sufficient space to store the encoded characters.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetString()
*/
*
* @since 2.0
*
- * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n
- * else @c null if an exception occurs @n
- * The buffer limit is the position of the last decoded byte plus one and the starting position is zero.
+ * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n
+ * else @c null if an exception occurs @n
+ * The buffer limit is the position of the last decoded byte plus one and the starting position is zero.
* @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
*
* @return An error code
* @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[in] byteIndex The index from where decoding begins
+ * @param[in] byteIndex The index from where the decoding begins
* @param[in] byteCount The total number of bytes to decode
* @param[out] chars The Tizen::Base::WcharBuffer instance where the resultant decoded data is stored
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c bytes or @c chars is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
- * @exception E_OVERFLOW This operation has caused the memory to overflow, or
- * the specified @c chars does not contain sufficient space to store the decoded bytes.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes or @c chars is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to overflow.
+ * - The specified @c chars does not contain sufficient space to store the decoded bytes.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetBytes()
*/
Tizen::Base::WcharBuffer& chars, int charIndex = 0) const;
/**
- * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance.
+ * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
*
* @since 2.0
*
* It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c bytes is empty.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetBytesN()
*/
virtual result GetString(const Tizen::Base::ByteBuffer& bytes, Tizen::Base::String& str) const;
/**
- * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance.
+ * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
*
* @since 2.0
*
* @return An error code
- * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[in] index The index from where decoding begins
- * @param[in] count The total number of bytes to decode
- * @param[out] str A Tizen::Base::String instance @n
- * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
+ * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
+ * @param[in] index The index from where the decoding begins
+ * @param[in] count The total number of bytes to decode
+ * @param[out] str A Tizen::Base::String instance @n
+ * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetBytes()
*/
*
* @since 2.0
*
- * @return The maximum number of bytes required for encoding a given number of characters
+ * @return The maximum number of bytes required for encoding the given number of characters
* @param[in] charCount The total number of characters to encode
- * @remarks This method determines an appropriate buffer size for the byte arrays passed to GetBytes() for encoding.
+ * @remarks This method determines an appropriate buffer size for the byte arrays passed to GetBytes() for encoding.
* @see Encoding::GetByteCount()
*/
virtual int GetMaxByteCount(int charCount) const;
*
* @since 2.0
*
- * @return The maximum number of characters generated by decoding the specified number of bytes
+ * @return The maximum number of characters generated by decoding the specified number of bytes
* @param[in] byteCount The total number of bytes to encode
- * @remarks This method determines an appropriate buffer size for character arrays passed to
+ * @remarks This method determines an appropriate buffer size for character arrays passed to
* GetChars() or a decoder for encoding.
* @see Encoding::GetByteCount()
*/
*
* @since 2.0
*
- * @return A pointer to the Encoder instance for the current encoding
- * @remarks Contrary to GetBytes(), an encoder can convert partial sequences of characters into
- * partial sequences of bytes by maintaining the appropriate state between the conversions.
- * Currently only Utf8Encoding supports this method. Other classes return @c null.
- * @see GetBytes()
+ * @return A pointer to the Encoder instance for the current encoding
+ * @remarks
+ * - Contrary to GetBytes(), an encoder can convert partial sequences of characters into
+ * partial sequences of bytes by maintaining the appropriate state between the conversions.
+ * - Currently only Utf8Encoding supports this method. Other classes return @c null.
*/
virtual Encoder* GetEncoderN(void) const;
* @since 2.0
*
* @return A pointer to the Decoder instance for the current encoding
- * @remarks Contrary to GetChars(), a decoder can convert partial sequences of bytes
- * into partial sequences of characters by maintaining the appropriate state between the conversions.
- * Currently only Utf8Encoding supports this method. Other classes return @c null.
- * @see GetChars()
+ * @remarks
+ * - Contrary to GetChars(), a decoder can convert partial sequences of bytes
+ * into partial sequences of characters by maintaining the appropriate state between the conversions.
+ * - Currently only Utf8Encoding supports this method. Other classes return @c null.
*/
virtual Decoder* GetDecoderN(void) const;
*
* @since 2.0
*
- * @return An encoding type
+ * @return The encoding type
*/
virtual Tizen::Base::String GetEncodingType(void) const;
* @since 2.0
*
* @return An error code
- * @param[in] str A string to encode
+ * @param[in] str The string to encode
* @param[out] byteCount The total number of bytes required to encode the string
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c str is an empty string.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c str is an empty string.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks This method determines the exact number of bytes
* that are produced if the given string is encoded.
* @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
* @param[out] byteCount The total number of bytes required to encode the specified range of characters
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c chars is empty.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c chars is empty.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks This method determines the exact number of bytes
* that are produced if the given array of characters is encoded.
* @since 2.0
*
* @return An error code
- * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
- * @param[in] charCount The total number of characters to encode
- * @param[out] byteCount The total number of bytes required to encode the specified range of characters
+ * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] charCount The total number of characters to encode
+ * @param[out] byteCount The total number of bytes required to encode the specified range of characters
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c chars is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c chars is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified inout parameter is outside the valid range defined by the method.
+ * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks This method determines the exact number of bytes
* that are produced if the given array of characters is encoded.
*
* @since 2.0
*
- * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n
- * else @c null if an exception occurs @n
- * The buffer limit is the position of the last encoded byte plus one and the starting position is zero.
+ * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n
+ * else @c null if an exception occurs @n
+ * The buffer limit is the position of the last encoded byte plus one and the starting position is zero.
* @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
*
* @since 2.0
*
- * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n
- * else @c null if an exception occurs @n
- * The buffer limit is the position of the last encoded byte plus one and the starting position is zero.
- * @param[in] str A string to encode
- * @exception E_SUCCESS The method is successful.
+ * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n
+ * else @c null if an exception occurs @n
+ * The buffer limit is the position of the last encoded byte plus one and the starting position is zero.
+ * @param[in] str The string to encode
+ * @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_INVALID_ARG The specified @c str is empty or invalid.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @return An error code
* @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
* @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
- * @param[in] charCount The total number of characters to encode
+ * @param[in] charCount The total number of characters to encode
* @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored
- * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance
+ * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c chars or @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
- * @exception E_OVERFLOW This operation has caused the memory to overflow, or
- * the specified @c bytes does not contain sufficient space to store the encoded characters.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c chars or @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to overflow.
+ * - The specified @c bytes does not contain sufficient space to store the encoded characters.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks This method encodes a range of characters in a Tizen::Base::WcharBuffer into a range of bytes in a Tizen::Base::ByteBuffer.
* @see GetChars()
* @since 2.0
*
* @return An error code
- * @param[in] str A string to encode
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
- * @param[in] charCount The total number of characters to encode
+ * @param[in] str The string to encode
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] charCount The total number of characters to encode
* @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored
- * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c str or @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str.
- * @exception E_OVERFLOW This operation has caused the memory to overflow, or
- * the specified @c bytes does not contain sufficient space to store the encoded characters.
+ * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c str or @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to overflow.
+ * - The specified @c bytes does not contain sufficient space to store the encoded characters.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetString()
*/
*
* @return An error code
* @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance
+ * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c bytes is empty.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks This method determines the exact number of characters
* that are produced if the given range of bytes is converted.
*
* @return An error code
* @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[in] byteIndex The index from where decoding begins
+ * @param[in] byteIndex The index from where the decoding begins
* @param[in] byteCount The total number of bytes to decode
* @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks This method determines the exact number of characters
* that are produced if the given range of bytes is converted.
virtual result GetCharCount(const Tizen::Base::ByteBuffer& bytes, int byteIndex, int byteCount, int& charCount) const;
/**
- *Decodes an instance of Tizen::Base::ByteBuffer into an instance of Tizen::Base::WcharBuffer.
+ * Decodes an instance of Tizen::Base::ByteBuffer into an instance of Tizen::Base::WcharBuffer.
*
* @since 2.0
*
- * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n
- * else @c null if an exception occurs @n
- * The buffer limit is the position of the last decoded byte plus one and the starting position is zero.
- * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
+ * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n
+ * else @c null if an exception occurs @n
+ * The buffer limit is the position of the last decoded byte plus one and the starting position is zero.
+ * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_INVALID_ARG The specified @c bytes is empty or invalid.
*
* @return An error code
* @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[in] byteIndex The index from where decoding begins
+ * @param[in] byteIndex The index from where the decoding begins
* @param[in] byteCount The total number of bytes to decode
* @param[out] chars The Tizen::Base::WcharBuffer instance where the resultant decoded data is stored
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c bytes or @ chars is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
- * @exception E_OVERFLOW This operation has caused the memory to overflow, or
- * the specified @c chars does not contain sufficient space to store the decoded bytes.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes or @ chars is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to overflow.
+ * - The specified @c chars does not contain sufficient space to store the decoded bytes.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetBytes()
*/
Tizen::Base::WcharBuffer& chars, int charIndex = 0) const;
/**
- * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance.
+ * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
*
* @since 2.0
*
* @return An error code
- * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[out] str A Tizen::Base::String instance @n
- * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
+ * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
+ * @param[out] str A Tizen::Base::String instance @n
+ * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c bytes is empty.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetBytesN()
*/
virtual result GetString(const Tizen::Base::ByteBuffer& bytes, Tizen::Base::String& str) const;
/**
- * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance.
+ * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
*
* @since 2.0
*
* @return An error code
* @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[in] index The index from where decoding begins
+ * @param[in] index The index from where the decoding begins
* @param[in] count The total number of bytes to decode
* @param[out] str A Tizen::Base::String instance @n
- * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes.
+ * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetBytesN()
*/
/**
- * Gets the maximum number of bytes required for encoding a given number of characters.
+ * Gets the maximum number of bytes required for encoding the given number of characters.
*
* @since 2.0
*
* @return The maximum number of bytes required for encoding the given number of characters
* @param[in] charCount The total number of characters to encode
- * @remarks This method determines an appropriate buffer size for the byte arrays passed to GetBytes() for encoding.
+ * @remarks This method determines an appropriate buffer size for the byte arrays passed to GetBytes() for encoding.
* @see GetByteCount()
- * @see GetBytes()
*/
virtual int GetMaxByteCount(int charCount) const;
*
* @return The maximum number of characters generated by decoding the specified number of bytes
* @param[in] byteCount The total number of bytes to encode
- * @remarks This method determines an appropriate buffer size for the character arrays passed to
- * GetChars() or a decoder for encoding.
+ * @remarks This method determines an appropriate buffer size for the character arrays passed to
+ * GetChars() or a decoder for encoding.
* @see GetByteCount()
- * @see GetChars()
*/
virtual int GetMaxCharCount(int byteCount) const;
*
* @since 2.0
*
- * @return A pointer to the Encoder instance for the current encoding
- * @remarks Contrary to GetBytes(), an encoder can convert partial sequences of characters into
- * partial sequences of bytes by maintaining the appropriate state between the conversions.
- * Currently only Utf8Encoding supports this method. Other classes return @c null.
- * @see GetBytes()
+ * @return A pointer to the Encoder instance for the current encoding
+ * @remarks
+ * - Contrary to GetBytes(), an encoder can convert partial sequences of characters into
+ * partial sequences of bytes by maintaining the appropriate state between the conversions.
+ * - Currently only Utf8Encoding supports this method. Other classes return @c null.
*/
virtual Encoder* GetEncoderN(void) const;
*
* @since 2.0
*
- * @return A pointer to the Decoder instance for the current encoding
- * @remarks Contrary to GetChars(), a decoder can convert partial sequences of bytes
- * into partial sequences of characters by maintaining the appropriate state between the conversions.
- * Currently only Utf8Encoding supports this method. Other classes return @c null.
- *
- * @see GetChars()
+ * @return A pointer to the Decoder instance for the current encoding
+ * @remarks
+ * - Contrary to GetChars(), a decoder can convert partial sequences of bytes
+ * into partial sequences of characters by maintaining the appropriate state between the conversions.
+ * - Currently only Utf8Encoding supports this method. Other classes return @c null.
*/
virtual Decoder* GetDecoderN(void) const;
*
* @since 2.0
*
- * @return An encoding type
+ * @return The encoding type
*/
virtual Tizen::Base::String GetEncodingType(void) const;
*
* The %Utf8Decoder class converts blocks of bytes into decoded blocks of characters.
* Universal Transformation Format-8 (UTF-8) is a translated language that is used on the internet.
- * It converts the unicode into 8-bit bytes.
- * UTF-8 encoding supports all unicode character values and surrogates.
+ * It converts the Unicode into 8-bit bytes.
+ * UTF-8 encoding supports all Unicode character values and surrogates.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/text/converting_text_data_separate_blocks.htm">Converting Text Data in Separate Blocks</a>.
*
*
* @return An error code
* @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[in] byteIndex The index from where decoding begins
+ * @param[in] byteIndex The index from where the decoding begins
* @param[in] byteCount The total number of bytes to decode
* @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance
* @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
* else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
- * @exception E_INVALID_ENCODING_RANGE The conversion has failed due to invalid encoding range.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_INVALID_ENCODING_RANGE The conversion has failed due to an invalid encoding range.
*/
virtual result GetCharCount(const Tizen::Base::ByteBuffer& bytes, int byteIndex, int byteCount, int& charCount, bool flush = false) const;
*
* @since 2.0
*
- * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n
- * else @c null if an exception occurs @n
- * The buffer limit is the position of the last decoded byte plus one and the starting position is zero.
- * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
- * else @c false
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c bytes is empty.
- * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
+ * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n
+ * else @c null if an exception occurs @n
+ * The buffer limit is the position of the last decoded byte plus one and the starting position is zero.
+ * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
+ * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
+ * else @c false
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
+ * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
virtual Tizen::Base::WcharBuffer* GetCharsN(const Tizen::Base::ByteBuffer& bytes, bool flush = false) const;
* Decodes an instance of Tizen::Base::ByteBuffer into an instance of Tizen::Base::WcharBuffer as per the specified range.
*
* @since 2.0
- * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n
- * else @c null if an exception occurs @n
- * The buffer limit is the position of the last decoded byte and the starting position is zero.
+ * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n
+ * else @c null if an exception occurs @n
+ * The buffer limit is the position of the last decoded byte and the starting position is zero.
* @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[in] byteIndex The index from where decoding begins
+ * @param[in] byteIndex The index from where the decoding begins
* @param[in] byteCount The total number of bytes to decode
* @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
* else @c false
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
- * @remarks This method maintains state consistency between conversions.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks The pointer to the Tizen::Base::ByteBuffer instance is not terminated by a @c null character.
- *
+ * @remarks
+ * - This method maintains state consistency between conversions.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The pointer to the Tizen::Base::ByteBuffer instance is not terminated by a @c null character.
*/
virtual Tizen::Base::WcharBuffer* GetCharsN(const Tizen::Base::ByteBuffer& bytes, int byteIndex, int byteCount,
bool flush = false) const;
*
* The %Utf8Encoder class converts the blocks of characters into encoded blocks of bytes.
* Universal Transformation Format-8 (UTF-8) is a translated language that is used on the internet. It converts the
- * unicode into 8-bit bytes. @n UTF-8 encoding supports all unicode character values and surrogates.
- * Note that %Utf8Encoder is not used in reality, because keeping the internal state of encoding from unicode
+ * Unicode into 8-bit bytes. @n UTF-8 encoding supports all Unicode character values and surrogates.
+ * Note that %Utf8Encoder is not used in reality, because keeping the internal state of encoding from Unicode
* to UTF-8 can be avoided if the translation unit is even.
* This means that the real implementation of %Utf8Encoder is the same as that of Utf8Encoding in this state.
*
* @since 2.0
*
* @return An error code
- * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
- * @param[in] charCount The total number of characters to encode
- * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
- * else @c false
- * @param[out] byteCount The total number of bytes required to encode the specified range of characters
+ * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] charCount The total number of characters to encode
+ * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
+ * else @c false
+ * @param[out] byteCount The total number of bytes required to encode the specified range of characters
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c chars is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid, or
+ * - The specified @c chars is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see Utf8Decoder::GetCharCount()
*/
*
* @since 2.0
*
- * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n
- * else @c null if an exception occurs @n
- * The buffer limit is the position of the last encoded byte plus one and the starting position is zero.
- * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
- * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
- * else @c false
+ * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n
+ * else @c null if an exception occurs @n
+ * The buffer limit is the position of the last encoded byte plus one and the starting position is zero.
+ * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
+ * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
+ * else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c chars is empty.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c chars is empty.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see Utf8Decoder::GetCharsN()
*
* @since 2.0
*
- * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n
- * else @c null if an exception occurs @n
- * The buffer limit is the position of the last encoded byte and the starting position is zero.
- * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
- * @param[in] charCount The total number of characters to encode
+ * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n
+ * else @c null if an exception occurs @n
+ * The buffer limit is the position of the last encoded byte and the starting position is zero.
+ * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] charCount The total number of characters to encode
* @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
* else @c false
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c chars is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c chars is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks The pointer to the Tizen::Base::ByteBuffer instance is not terminated by a @c null character.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The pointer to the Tizen::Base::ByteBuffer instance is not terminated by a @c null character.
* @see Utf8Decoder::GetCharsN()
*/
virtual Tizen::Base::ByteBuffer* GetBytesN(const Tizen::Base::WcharBuffer& chars, int charIndex, int charCount,
virtual ~Utf8Encoding(void);
/**
- * Gets the total number of bytes that are generated by encoding an instance of specified string. @n
+ * Gets the total number of bytes that are generated by encoding an instance of the specified string. @n
* The %GetByteCount() method determines the total number of bytes that are generated when the specified string is encoded.
*
* @since 2.0
* @param[in] str The string to encode
* @param[out] byteCount The total number of bytes required to encode the string
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c str is an empty string.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c str is an empty string.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetMaxByteCount()
*/
* @since 2.0
*
* @return An error code
- * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
- * @param[out] byteCount The total number of bytes required to encode the specified range of characters
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c chars is empty.
- * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
+ * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
+ * @param[out] byteCount The total number of bytes required to encode the specified range of characters
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c chars is empty.
+ * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetMaxByteCount()
*/
virtual result GetByteCount(const Tizen::Base::WcharBuffer& chars, int& byteCount) const;
*
* @return An error code
* @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
- * @param[in] charCount The total number of characters to encode
- * @param[out] byteCount The total number of bytes required to encode the specified range of characters
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] charCount The total number of characters to encode
+ * @param[out] byteCount The total number of bytes required to encode the specified range of characters
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c chars is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c chars is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetMaxByteCount()
*/
*
* @since 2.0
*
- * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n
- * else @c null if an exception occurs @n
- * The buffer limit is the position of the last encoded byte plus one and the starting position is zero.
- * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG The specified @c chars is empty or invalid.
+ * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n
+ * else @c null if an exception occurs @n
+ * The buffer limit is the position of the last encoded byte plus one and the starting position is zero.
+ * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_ARG The specified @c chars is empty or invalid.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see GetCharsN()
*
* @since 2.0
*
- * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n
- * else @c null if an exception occurs @n
- * The buffer limit is the position of the last encoded byte plus one and the starting position is zero.
- * @param[in] str A string to encode
- * @exception E_SUCCESS The method is successful.
+ * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n
+ * else @c null if an exception occurs @n
+ * The buffer limit is the position of the last encoded byte plus one and the starting position is zero.
+ * @param[in] str The string to encode
+ * @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c str is an empty string.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c str is an empty string.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see GetString()
*
* @return An error code
* @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
- * @param[in] charCount The total number of characters to encode
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] charCount The total number of characters to encode
* @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored
* @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c chars or @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
- * @exception E_OVERFLOW This operation has caused the memory to overflow, or
- * the specified @c bytes does not contain sufficient space to store the encoded characters.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c chars or @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to overflow.
+ * - The specified @c bytes does not contain sufficient space to store the encoded characters.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetChars()
*/
* @since 2.0
*
* @return An error code
- * @param[in] str A string to encode
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
- * @param[in] charCount The total number of characters to encode
+ * @param[in] str The string to encode
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] charCount The total number of characters to encode
* @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored
- * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c str or @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str.
- * @exception E_OVERFLOW This operation has caused the memory to overflow, or
- * the specified @c bytes does not contain sufficient space to store the encoded characters.
- * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
+ * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c str or @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to overflow.
+ * - The specified @c bytes does not contain sufficient space to store the encoded characters.
+ * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetString()
*/
virtual result GetBytes(const Tizen::Base::String& str, int charIndex, int charCount,
* @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
* @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c bytes is empty.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetMaxCharCount()
*/
*
* @return An error code
* @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[in] byteIndex The index from where decoding begins
+ * @param[in] byteIndex The index from where the decoding begins
* @param[in] byteCount The total number of bytes to decode
- * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
+ * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetMaxCharCount()
*/
*
* @since 2.0
*
- * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n
- * else @c null if an exception occurs @n
- * The buffer limit is the position of the last decoded byte plus one and the position is zero.
- * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
+ * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n
+ * else @c null if an exception occurs @n
+ * The buffer limit is the position of the last decoded byte plus one and the position is zero.
+ * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_INVALID_ARG The specified @c bytes is empty or invalid.
- * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
+ * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see GetBytesN()
*/
*
* @return An error code
* @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[in] byteIndex The index from where decoding begins
+ * @param[in] byteIndex The index from where the decoding begins
* @param[in] byteCount The total number of bytes to decode
* @param[out] chars The Tizen::Base::WcharBuffer instance where the resultant decoded data is stored
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c bytes or @c chars is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
- * @exception E_OVERFLOW This operation has caused the memory to overflow, or
- * the specified @c chars does not contain sufficient space to store the decoded bytes.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes or @c chars is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to overflow.
+ * - The specified @c chars does not contain sufficient space to store the decoded bytes.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetBytes()
*/
Tizen::Base::WcharBuffer& chars, int charIndex = 0) const;
/**
- * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance.
+ * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
*
* @since 2.0
*
* @return An error code
* @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[out] str A Tizen::Base::String instance @n
- * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
+ * @param[out] str A Tizen::Base::String instance @n
+ * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c bytes is empty.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetBytesN()
*/
virtual result GetString(const Tizen::Base::ByteBuffer& bytes, Tizen::Base::String& str) const;
/**
- * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance.
+ * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
*
* @since 2.0
*
* @return An error code
* @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[in] index The index from where decoding begins
+ * @param[in] index The index from where the decoding begins
* @param[in] count The total number of bytes to decode
* @param[out] str A Tizen::Base::String instance @n
* It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or
- * the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or
- * the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetBytes()
*/
/**
- * Gets the maximum number of bytes required for encoding a given number of characters.
+ * Gets the maximum number of bytes required for encoding the given number of characters.
*
* @since 2.0
*
- * @return The maximum number of bytes required for encoding a given number of characters
+ * @return The maximum number of bytes required for encoding the given number of characters
* @param[in] charCount The total number of characters to encode
* @remarks This method determines an appropriate buffer size for the byte arrays passed to GetBytes() for encoding.
* @see GetByteCount()
- * @see GetBytes()
*/
virtual int GetMaxByteCount(int charCount) const;
*
* @since 2.0
*
- * @return The maximum number of characters generated by decoding the specified number of bytes
- * @param[in] byteCount The total number of bytes to encode
+ * @return The maximum number of characters generated by decoding the specified number of bytes
+ * @param[in] byteCount The total number of bytes to encode
* @remarks This method determines an appropriate buffer size for the character arrays passed to
* GetChars() or a decoder for encoding.
* @see GetCharCount()
- * @see GetChars()
*/
virtual int GetMaxCharCount(int byteCount) const;
*
* @since 2.0
*
- * @return A pointer to the Encoder instance for the current encoding
+ * @return A pointer to the Encoder instance for the current encoding
* @remarks Contrary to GetBytes(), an encoder can convert partial sequences of characters into
* partial sequences of bytes by maintaining the appropriate states between the conversions.
- * @see GetBytes()
*/
virtual Encoder* GetEncoderN(void) const;
*
* @since 2.0
*
- * @return A pointer to the Decoder instance for the current encoding
+ * @return A pointer to the Decoder instance for the current encoding
* @remarks Contrary to GetChars(), a decoder can convert partial sequences of bytes
* into partial sequences of characters by maintaining the appropriate states between the conversions.
- * @see GetChars()
*/
virtual Decoder* GetDecoderN(void) const;
*
* @since 2.0
*
- * @return An encoding type
+ * @return The encoding type
*/
virtual Tizen::Base::String GetEncodingType(void) const;
<domain name="_"/>
</request>
<assign>
+ <filesystem path="/usr/bin/nativeinfologctrl" label="_" exec_label="none"/>
</assign>
</manifest>
%config /opt/usr/etc/*
/usr/share/locale/*
%config /usr/etc/*
+%attr(755,root,app_logging) /usr/bin/nativeinfologctrl
%{_libdir}/osp/libosp-appfw.so*
%{_libdir}/osp-server/libosp-appfw-server.so*
%{_libdir}/osp-server/libosp-system-server.so*
--- /dev/null
+#!/bin/sh
+MODE=none
+OBJ=none
+VAL=none
+#echo "tizen_platform_dlog_logging_ctrl"
+case "$1" in
+get)
+ MODE=get
+;;
+set)
+ MODE=set
+;;
+
+*)
+echo "Usage: dlogctrl {get|set} {platformlog} {1|0}"
+exit 1
+esac
+
+case "$2" in
+platformlog)
+ OBJ=platformlog
+;;
+*)
+ echo "Usage: dlogctrl {get|set} {platformlog} {1|0}"
+exit 1
+esac
+
+if [ "$MODE" = "set" ]; then
+ case "$3" in
+ 1)
+ VAL=1
+ ;;
+ 0)
+ VAL=0
+ ;;
+ *)
+ echo "Usage: dlogctrl {get|set} {platformlog} {1|0}"
+ exit 1
+ esac
+fi
+
+if [ "$MODE" = "set" ]; then
+ if [ "$OBJ" = "platformlog" ] && [ "$VAL" = "1" ] ; then
+ echo 1 > /opt/etc/platformlog.conf 2>/dev/null
+ touch /home/developer/.platforminfologgingmode 2>/dev/null
+ elif [ "$OBJ" = "platformlog" ] && [ "$VAL" = "0" ] ; then
+ echo 0 > /opt/etc/platformlog.conf 2>/dev/null
+ rm /home/developer/.platforminfologgingmode 2>/dev/null
+ fi
+ echo "You must reboot this target to apply the change!"
+else
+ if [ "$OBJ" = "platformlog" ]; then
+ cat /opt/etc/platformlog.conf 2>/dev/null
+ fi
+fi
+
+exit 0
ADD_SUBDIRECTORY(appfw)
ADD_SUBDIRECTORY(osp-string)
ADD_SUBDIRECTORY(server)
-ADD_SUBDIRECTORY(system-server osp-system-server)
+ADD_SUBDIRECTORY(server/system osp-system-server)
_InProcessInfo* pInfo = __inAppManager.FindItem(reqId);
SysTryReturnVoidResult(NID_APP, pInfo != null, E_OBJ_NOT_FOUND, "[E_OBJ_NOT_FOUND] request Id %d not found.", reqId);
+ // at least listener
IAppControlResponseListener* pListener = dynamic_cast<IAppControlResponseListener*>(pInfo->pListener);
- if (pListener == null)
- {
- SysLog(NID_APP, "Empty AppControl listener callback for req %d, app %ls.", reqId, appId.GetPointer());
- return;
- }
+ SysTryReturnVoidResult(NID_APP, pListener != null, E_SYSTEM, "[E_SYSTEM] Invalid result callback for req %d, app %ls.", reqId, appId.GetPointer());
result r = E_SUCCESS;
- AppId actualAppId = appId;
- if (appId == L'c')
+ if (pListener)
{
- actualAppId.Clear();
- r = E_OPERATION_CANCELED;
- }
- SysLog(NID_APP, "Invoking callback 0x%x.", pListener);
+ AppId actualAppId = appId;
+ if (appId == L'c')
+ {
+ actualAppId.Clear();
+ r = E_OPERATION_CANCELED;
+ }
+ SysLog(NID_APP, "Invoking callback 0x%x.", pListener);
- _AppControlResponseEvent* pResponseEvent = null;
- __appControlResponseEventContainer.GetValue(reqId, pResponseEvent);
- SysLog(NID_APP, "StartResponseReceived Request Id(%d), ResponseEvent 0x%x.", reqId, pResponseEvent);
- if (pResponseEvent != null)
- {
- String oId(operationId);
- _AppControlResponseEventArg* pResponseEventArg = new (std::nothrow) _AppControlResponseEventArg(pListener, _APPCONTROL_RESPONSETYPE_START, actualAppId, oId, r, APP_CTRL_RESULT_SUCCEEDED, null, reqId, false);
+ _AppControlResponseEvent* pResponseEvent = null;
+ __appControlResponseEventContainer.GetValue(reqId, pResponseEvent);
+ SysLog(NID_APP, "StartResponseReceived Request Id(%d), ResponseEvent 0x%x.", reqId, pResponseEvent);
+ if (pResponseEvent != null)
+ {
+ String oId(operationId);
+ _AppControlResponseEventArg* pResponseEventArg = new (std::nothrow) _AppControlResponseEventArg(pListener, _APPCONTROL_RESPONSETYPE_START, actualAppId, oId, r, APP_CTRL_RESULT_SUCCEEDED, null, reqId, false);
- if (pResponseEventArg != null)
+ if (pResponseEventArg != null)
+ {
+ pResponseEvent->Fire(*pResponseEventArg);
+ SysLog(NID_APP, "pResponseEvent is Fired");
+ }
+ }
+ else
{
- pResponseEvent->Fire(*pResponseEventArg);
- SysLog(NID_APP, "pResponseEvent is Fired");
+ pListener->OnAppControlStartResponseReceived(actualAppId, operationId, r);
+ SysLog(NID_APP, "OnAppControlStartResponseReceived called directly");
}
}
else
{
- pListener->OnAppControlStartResponseReceived(actualAppId, operationId, r);
- SysLog(NID_APP, "OnAppControlStartResponseReceived called directly");
+ SysLog(NID_APP, "No listener registered.");
}
if (r == E_OPERATION_CANCELED)
}
else
{
- SysLog(NID_APP, "Empty AppControl listener.");
+ SysLogException(NID_APP, E_SYSTEM, "Invalid AppControl listener.");
}
_InProcessInfo* pProcInfo = __inAppManager.FindItemWithListener(IsMatchingProcListener, pListener);
if (pProcInfo)
{
- pProcInfo->pListener = null;
+ __inAppManager.RemoveItem(pProcInfo);
SysLog(NID_APP, "Listener 0x%x is removed from in-process stub list.", pListener);
}
}
: __appState(TERMINATED)
, __appType(_APP_TYPE_NONE)
, __appRootDirFd(-1)
+ , __appSdDirFd(-1)
, __appHandlerType(_APP_HANDLER_NONE)
, __parentWindowHandle(-1)
, __pAppName(null)
// closing may or may not succeed
close(__appRootDirFd);
+ close(__appSdDirFd);
}
_AppInfo*
strncpy(sdInfoPath, "/opt/storage/sdcard/app2sd/", strlen("/opt/storage/sdcard/app2sd/"));
strncat(sdInfoPath, pPackageId, MAX_APPID);
- int sdFd = open(sdInfoPath, O_RDONLY);
- SysLog(NID_APP, "sd root directory (%s:%d) open.", sdInfoPath, sdFd);
+ __appSdDirFd = open(sdInfoPath, O_RDONLY);
+ SysLog(NID_APP, "sd root directory (%s:%d) open.", sdInfoPath, __appSdDirFd);
char apiVersion[MAX_APIVERSION] = {0, };
char* pRet = fgets(apiVersion, MAX_APIVERSION - 1, pFile);
AppState __appState;
int __appType;
int __appRootDirFd;
+ int __appSdDirFd;
int __appHandlerType;
int __parentWindowHandle;
Tizen::Base::String __appRootPath;
msgstr "حفظ كلمة المرور؟"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "متابعة"
msgstr "Parol saxlansın?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Davam edin"
msgstr "Запаметяване на паролата?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Продължи"
msgstr "Desar la contrasenya?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Continuar"
msgstr "Uložit heslo?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Pokračovat"
msgstr "Gem adgangskode?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Fortsæt"
msgstr "Passwort speichern?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Fortsetzen"
msgstr "Αποθήκευση κωδικού;"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Συνέχεια"
msgstr "¿Guardar contraseña?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Continuar"
msgstr "¿Guardar contraseña?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Continuar"
msgstr "Kas salvestada parool?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Jätka"
msgstr "Gorde pasahitza?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Jarraitu"
msgstr "ذخیره رمز عبور؟"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "ادامه"
msgstr "Tallennetaanko salasana?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Jatka"
msgstr "Enreg. mot de passe ?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Continuer"
msgstr "Enreg. mot de passe ?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Continuer"
msgstr "Sábháil pasfhocal?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Ar aghaidh"
msgstr "Gardar contrasinal?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Continuar"
msgstr "לשמור סיסמה?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "המשך"
msgstr "पासवर्ड सेव करें?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "जारी"
msgstr "Spremiti lozinku?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Nastavi"
msgstr "Menti a jelszót?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Folytatás"
msgstr "Պահպանե՞լ գաղտնաբառը:"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Շարունակել"
msgstr "Viltu vista lykilorð?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Halda áfram"
msgstr "Salvare password?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Continua"
msgstr "暗証番号を保存しますか？"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "続行"
msgstr "შეინახავთ პაროლს?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "გაგრძელება"
msgstr "Құпиясөзді сақтау керек пе?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Жалғастыру"
msgstr "비밀번호를 저장할까요?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "계속"
msgstr "Išsaugoti slaptažodį?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Tęsti"
msgstr "Vai saglabāt paroli?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Turpināt"
msgstr "Сочувај лозинка?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Продолжи"
msgstr "Lagre passord?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Fortsett"
msgstr "Wachtwoord opslaan?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Doorgaan"
msgstr "Zapisać hasło?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Kontynuuj"
msgstr "Salvar senha?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Continuar"
msgstr "Guardar palavra-passe?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Continuar"
msgstr "Salvaţi parola?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Continuare"
msgstr "Сохранить пароль?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Продолжить"
msgstr "Uložiť heslo?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Pokračovať"
msgstr "Shranim geslo?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Nadaljuj"
msgstr "Sačuvaj šifru?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Nastavi"
msgstr "Spara lösenord?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Fortsätt"
msgstr "บันทึกรหัสผ่าน?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "ดำเนินการต่อ"
msgstr "Şifre kaydedilsin mi?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Devam"
msgstr "Зберегти пароль?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Продовжити"
msgstr "پاس ورڈ محفوظ کریں؟"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "جاری رکھیں"
msgstr "Parol saqlansinmi?"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "Davom etish"
msgstr "储存密码？"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "继续"
msgstr "儲存密碼嗎？"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "繼續"
msgstr "储存密码？"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "继续"
msgstr "儲存密碼？"
msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2"
-msgstr "Continue"
+msgstr "繼續"
${CMAKE_SOURCE_DIR}/inc
${CMAKE_SOURCE_DIR}/src/app/inc
${CMAKE_SOURCE_DIR}/src/base/inc
- ${CMAKE_SOURCE_DIR}/src/system-server/inc
+ ${CMAKE_SOURCE_DIR}/src/server/system/inc
${CMAKE_SOURCE_DIR}/src/io/inc
${CMAKE_SOURCE_DIR}/src/server/inc
${CMAKE_SOURCE_DIR}/src/system/inc
projects / platform / framework / native / appfw.git / commitdiff