X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFAppIMapDataControlProviderEventListener.h;h=ebc8562d5706d7f661cdab01c4090fa32a078a74;hb=20597a73bc3098301ba91a48378f3ef009c3be96;hp=a16c7531eb93f42810f4da9ff9a6d539a33403d0;hpb=0bf9d8266092861a3deae012144d7712494f3fe9;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FAppIMapDataControlProviderEventListener.h b/inc/FAppIMapDataControlProviderEventListener.h index a16c753..ebc8562 100644 --- a/inc/FAppIMapDataControlProviderEventListener.h +++ b/inc/FAppIMapDataControlProviderEventListener.h @@ -33,11 +33,11 @@ namespace Tizen { namespace App /** * @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 @@ -177,7 +177,7 @@ class _OSP_EXPORT_ IMapDataControlProviderEventListener 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 @@ -185,74 +185,74 @@ public: 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;