* @section WATCHFACE_COMPLICATION_MODULE_OVERVIEW Overview
* The watch applications can request data shared by other watchface complication provider applications using watchface complication.
* And the watchface complication provider application can share data with watchface application using watchface complication.
- * However, only service applications can provide their own data to the watch applicaiton.
+ * However, only service applications can provide their own data to the watch application.
* The watch application also can request editing about their resources like complication and design elements to editor using watchface complication. *
*
* @section WATCHFACE_COMPLICATION_MODULE_FEATURE Related Features
* This API is related with the following features:
- * - http://tizen.org/feature/watch_app
+ * - http://tizen.org/feature/watch_app\n
* You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.
* To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.
* More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature Element</b>.</a>
* \#include <watchface-editable.h>
*
* @section WATCHFACE_COMPLICATION_EDITABLE_MODULE_OVERVIEW Overview
- * It provides service that request editting watchface editable data to editor and receive result from editor.
+ * It provides service that request editing watchface editable data to editor and receive result from editor.
*/
/**
* @code
#include <watchface-complication-provider.h>
{
- watchface_complication_provider_add_update_request_cb("PROVIDER_ID",
+ watchface_complication_provider_add_update_requested_cb("PROVIDER_ID",
_watchface_complication_provider_update_requested_cb, NULL);
}
* @endcode
* @code
#include <watchface-complication-provider.h>
{
- watchface_complication_provider_remove_update_request_cb("PROVIDER_ID",
- _watchface_complication_provider_update_requested_cb, NULL);
+ watchface_complication_provider_remove_update_requested_cb("PROVIDER_ID",
+ _watchface_complication_provider_update_requested_cb);
}
* @endcode
*/
watchface_complication_provider_update_requested_cb callback);
/**
- * @brief Notifys to the complication that there is an update.
+ * @brief Notifies to the complication that there is an update.
* @details Complication automatically requests data when notify is received.
* @since_tizen 5.0
* @privilege http://tizen.org/privilege/datasharing
* @param[in] handle The editable handle
* @param[in] context The new context data of complication provider.
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @param[in] handle The editable handle
* @param[out] is_editing The value that tell it's editing mode.
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
/**
* @brief Gets provider app's setup context data.
* @details Context data will be passed to the complication provider application
- * through the app_control event callaback's app_control_h handle parameter
+ * through the app_control event callback's app_control_h handle parameter
* @since_tizen 5.0
* @remarks This function is for complication provider's setup application which
* speicified in provider app's manifest file with setup-appid attribute.
* @param[in] handle The editable handle
* @param[out] context app's setup context data
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @param[in] shared_data The data which will be shared with watch application
* @param[in] type The data type of shared_data
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @param[in] shared_data The data which will be shared with watch application
* @param[in] short_text The short text data
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @param[in] shared_data The data which will be shared with watch application
* @param[in] long_text The long text data
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @brief Sets title data for shared data.
* @since_tizen 5.0
* @remarks @a title can be added only for #WATCHFACE_COMPLICATION_TYPE_SHORT_TEXT,
- * #WATCHFACE_COMPLICATION_TYPE_LONG_TEXT, EWATCHFACE_COMPLICATION_TYPE_RANGED_VALUE type shared data.
+ * #WATCHFACE_COMPLICATION_TYPE_LONG_TEXT, #WATCHFACE_COMPLICATION_TYPE_RANGED_VALUE type shared data.
* @param[in] shared_data The data which will be shared with watch application
* @param[in] title The title text data
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @param[in] shared_data The data which will be shared with watch application
* @param[in] timestamp The timestamp data
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @param[in] shared_data The data which will be shared with watch application
* @param[in] image_path The image path data
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @param[in] min_value The minimum value
* @param[in] max_value The max value
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @param[in] shared_data The data which will be shared with watch application
* @param[in] icon_path The icon path data
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @param[in] shared_data The data which will be shared with watch application
* @param[in] extra_data The extra data
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @param[in] handle The app control handle
* @param[out] is_touch_launch The value that tell it's launched by touch.
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WATCHFACE_COMPLICATION_ERROR_NOT_SUPPORTED Not supported
* @param[in] handle The app control handle
* @param[out] provider_id The provider id of touched complication
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @param[in] handle The app control handle
* @param[out] type The complication type of touched complication
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @param[in] handle The app control handle
* @param[out] context The complication context of touched complication
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
/**
* @brief Sends request the provider to update the complication.
* @since_tizen 5.0
+ * @privilege http://tizen.org/privilege/appmanager.launch
+ * @privilege http://tizen.org/privilege/datasharing
* @remarks The watchface complication provider application can declare
* privileges for specific provider id in manifest xml file, in that case,
* the watchface application needs those privileges to use this function.
* If your app doesn't have those privileges, this function will return #WATCHFACE_COMPLICATION_ERROR_PERMISSION_DENIED.
- * @privilege http://tizen.org/privilege/appmanager.launch
- * @privilege http://tizen.org/privilege/datasharing
* @param[in] handle Complication handle
* @return #WATCHFACE_COMPLICATION_ERROR_NONE if success, other value if failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Success
* @param[in] data The data received from complication provider app
* @param[out] type The data type
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WATCHFACE_COMPLICATION_ERROR_NO_DATA No data
* @param[in] data The data received from complication provider app
* @param[out] short_text The short text data
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @param[in] data The data received from complication provider app
* @param[out] long_text The long text data
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @param[in] data The data received from complication provider app
* @param[out] title The title text data
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @param[in] data The data received from complication provider app
* @param[out] timestamp The timestamp
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WATCHFACE_COMPLICATION_ERROR_NO_DATA No data
* @param[in] data The data received from complication provider app
* @param[out] image_path The image path data
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @param[out] min_value The minimum value
* @param[out] max_value The max value
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WATCHFACE_COMPLICATION_ERROR_NO_DATA No data
* @param[in] data The data received from complication provider app
* @param[out] icon_path The icon path data
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @param[in] data The data received from complication provider app
* @param[out] extra_data The extra data
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
char **extra_data);
/**
- * @brief Launchs current complication's provider application.
+ * @brief Launches current complication's provider application.
* @details This function launchs the provider application with extra data,
* so that provider can tell it is launched by touching.
* @since_tizen 5.0
+ * @privilege http://tizen.org/privilege/appmanager.launch
+ * @privilege http://tizen.org/privilege/datasharing
* @remarks The watchface complication provider application can declare
* privileges for specific provider id in manifest xml file, in that case,
* the watchface application needs those privileges to use this function.
* If your app doesn't have those privileges, this function will return #WATCHFACE_COMPLICATION_ERROR_PERMISSION_DENIED.
- * @privilege http://tizen.org/privilege/appmanager.launch
- * @privilege http://tizen.org/privilege/datasharing
* @param[in] handle The complication handle
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @retval #WATCHFACE_COMPLICATION_ERROR_DB Database error
* @retval #WATCHFACE_COMPLICATION_ERROR_NOT_SUPPORTED Not supported
* @see watchface_complication_provider_is_touch_launch()
- * @see watchface_complication_provider_get_touch_launch_provider_id()
- * @see watchface_complication_provider_get_touch_launch_type()
+ * @see watchface_complication_provider_get_touch_launch_get_provider_id()
+ * @see watchface_complication_provider_get_touch_launch_get_type()
* @par Sample code:
* @code
#include <watchface-complication.h>
* Created allowed list should be destroyed after applied.
* @param[in] handle The complication allowed list handle
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @since_tizen 5.0
* @param[in] handle The complication allowed list handle
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WATCHFACE_COMPLICATION_ERROR_NOT_SUPPORTED Not supported
* @since_tizen 5.0
* @param[in] handle The complication allowed list handle
* @param[in] provider_id The complication provider id
- * @param[in] types The complication types, values of #complication_type_e combiled with bitwise 'or'
+ * @param[in] types The complication types, values of #watchface_complication_type_e combinded with bitwise 'or'
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @param[in] handle The complication allowed list handle
* @param[in] provider_id The complication provider id
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WATCHFACE_COMPLICATION_ERROR_NOT_SUPPORTED Not supported
* @param[in] handle The complication allowed list handle
* @param[in] index Index
* @param[out] provider_id The complication provider id
- * @param[out] types The complication types, values of #complication_type_e combiled with bitwise 'or'
+ * @param[out] types The complication types, values of #watchface_complication_type_e combinded with bitwise 'or'
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WATCHFACE_COMPLICATION_ERROR_IO_ERROR I/O error
char **provider_id, int *types);
/**
- * @brief Applys the allowed list to a complication.
+ * @brief Applies the allowed list to a complication.
* @details After using this function, the editor will display providers included in the allowed list handle.
* @since_tizen 5.0
* @param[in] handle The complication handle
* @param[in] list_handle The allowed list handle
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @since_tizen 5.0
* @param[in] handle The complication allowed list handle
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WATCHFACE_COMPLICATION_ERROR_NOT_SUPPORTED Not supported
*/
/**
- * @addtogroup WATCHFACE_COMPLICATION_MODULE
+ * @addtogroup WATCHFACE_COMPLICATION_EDITABLE_MODULE
* @{
*/
* @param[in] editor_appid The name of editor
* The @a editor_appid can be used only in the callback. To use outside, make a copy.
* @param[in] user_data The user data passed from the callback function
- * @see editable_on_edit_ready_cb_add()
+ * @see watchface_editable_add_edit_ready_cb()
*/
typedef void (*watchface_editable_edit_ready_cb)(
watchface_editable_container_h handle,
* @remarks Created candidates list should be destroyed after used.
* @param[in] handle The candidates list handle
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @param[in] handle The candidates list handle
* @param[in] candidate The candidate data
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
{
watchface_editable_geo_h geo;
complication_candidates_list_h list_handle;
- bundle *candidate;
+ bundle *candidate1;
+ bundle *candidate2;
int ret;
ret = watchface_editable_candidates_list_create(&list_handle);
if (ret != WATCHFACE_COMPLICATION_ERROR_NONE)
return;
- candidate = bundle_create();
- if (candidate == NULL)
- goto err;
- bundle_add_str(candidate, "TEST_COLOR", "RED");
+ candidate1 = bundle_create();
+ bundle_add_str(candidate1, "TEST_COLOR", "RED");
+ watchface_editable_candidates_list_add(list_handle, candidate1);
- ret = watchface_editable_candidates_list_add(list_handle, candidate);
- if (ret != WATCHFACE_COMPLICATION_ERROR_NONE)
- goto err;
-
- candidate = bundle_create();
- if (candidate == NULL)
- goto err;
- bundle_add_str(candidate, "TEST_COLOR", "YELLOW");
-
- ret = watchface_editable_candidates_list_add(list_handle, candidate);
- if (ret != WATCHFACE_COMPLICATION_ERROR_NONE)
- goto err;
+ candidate2 = bundle_create();
+ bundle_add_str(candidate2, "TEST_COLOR", "YELLOW");
+ watchface_editable_candidates_list_add(list_handle, candidate2);
watchface_editable_geometry_create(&geo);
watchface_editable_geometry_set(geo, 50, 50, 100, 100);
- ret = watchface_editable_add_design_element(handle, COLOR_EDIT, cur_idx,
- complication_candidates_list_h, geo, "Color");
- watchface_editable_geometry_destroy(geo);
- if (ret != WATCHFACE_COMPLICATION_ERROR_NONE)
- goto err;
-err:
- if (candidate)
- bundle_free(candidate);
+ ret = watchface_editable_add_design_element(handle, COLOR_EDIT, cur_idx,
+ list_handle, geo, "Color");
+ watchface_editable_geometry_destroy(geo);
watchface_editable_candidates_list_destroy(list_handle);
}
* @endcode
* @since_tizen 5.0
* @param[in] handle The complication allowed list handle
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WATCHFACE_COMPLICATION_ERROR_NOT_SUPPORTED Not supported
{
watchface_editable_geo_h geo;
complication_candidates_list_h list_handle;
- bundle *candidate;
+ bundle *candidate1;
+ bundle *candidate2;
int ret;
ret = watchface_editable_candidates_list_create(&list_handle);
if (ret != WATCHFACE_COMPLICATION_ERROR_NONE)
return;
- candidate = bundle_create();
- if (candidate == NULL)
- goto err;
- bundle_add_str(candidate, "TEST_COLOR", "RED");
-
- ret = watchface_editable_candidates_list_add(list_handle, candidate);
- if (ret != WATCHFACE_COMPLICATION_ERROR_NONE)
- goto err;
+ candidate1 = bundle_create();
+ bundle_add_str(candidate1, "TEST_COLOR", "RED");
+ watchface_editable_candidates_list_add(list_handle, candidate1);
- candidate = bundle_create();
- if (candidate == NULL)
- goto err;
- bundle_add_str(candidate, "TEST_COLOR", "YELLOW");
-
- ret = watchface_editable_candidates_list_add(list_handle, candidate);
- if (ret != WATCHFACE_COMPLICATION_ERROR_NONE)
- goto err;
+ candidate2 = bundle_create();
+ bundle_add_str(candidate2, "TEST_COLOR", "YELLOW");
+ watchface_editable_candidates_list_add(list_handle, candidate2);
watchface_editable_geometry_create(&geo);
watchface_editable_geometry_set(geo, 50, 50, 100, 100);
- ret = watchface_editable_add_design_element(handle, COLOR_EDIT, cur_idx,
- complication_candidates_list_h, geo, "Color");
- watchface_editable_geometry_destroy(geo);
- if (ret != WATCHFACE_COMPLICATION_ERROR_NONE)
- goto err;
-err:
- if (candidate)
- bundle_free(candidate);
+ ret = watchface_editable_add_design_element(handle, COLOR_EDIT, cur_idx,
+ list_handle, geo, "Color");
+ watchface_editable_geometry_destroy(geo);
watchface_editable_candidates_list_destroy(list_handle);
}
* @endcode
const char *editor_appid, void *user_data)
{
watchface_editable_geo_h geo;
- bundle *selected_data = NULL;
- bundle *candidate;
complication_candidates_list_h list_handle;
+ bundle *candidate1;
+ bundle *candidate2;
int ret;
- int cur_idx = 0;
ret = watchface_editable_candidates_list_create(&list_handle);
if (ret != WATCHFACE_COMPLICATION_ERROR_NONE)
return;
- candidate = bundle_create();
- if (candidate == NULL)
- goto err;
- bundle_add_str(candidate, "TEST_COLOR", "RED");
-
- ret = watchface_editable_candidates_list_add(list_handle, candidate);
- if (ret != WATCHFACE_COMPLICATION_ERROR_NONE)
- goto err;
-
- candidate = bundle_create();
- if (candidate == NULL)
- goto err;
- bundle_add_str(candidate, "TEST_COLOR", "YELLOW");
-
- ret = watchface_editable_candidates_list_add(list_handle, candidate);
- if (ret != WATCHFACE_COMPLICATION_ERROR_NONE)
- goto err;
+ candidate1 = bundle_create();
+ bundle_add_str(candidate1, "TEST_COLOR", "RED");
+ watchface_editable_candidates_list_add(list_handle, candidate1);
- watchface_editable_load_current_data(COLOR_EDIT, &selected_data);
- if (selected_data) {
- bundle_get_str(selected_data, "TEST_COLOR", &cur_color);
- if (strcmp(cur_color, "YELLOW") == 0)
- cur_idx = 1;
- }
+ candidate2 = bundle_create();
+ bundle_add_str(candidate2, "TEST_COLOR", "YELLOW");
+ watchface_editable_candidates_list_add(list_handle, candidate2);
watchface_editable_geometry_create(&geo);
watchface_editable_geometry_set(geo, 50, 50, 100, 100);
+
ret = watchface_editable_add_design_element(handle, COLOR_EDIT, cur_idx,
list_handle, geo, "Color");
- if (ret != WATCHFACE_COMPLICATION_ERROR_NONE)
- goto err;
- watchface_editable_geometry_destroy(geo);
-
- ret = watchface_editable_request_edit(handle,
- _watchface_editable_update_requested_cb, user_data);
- if (ret != WATCHFACE_COMPLICATION_ERROR_NONE)
- goto err;
-
-err:
- if (candidate)
- bundle_free(candidate);
+ watchface_editable_geometry_destroy(geo);
watchface_editable_candidates_list_destroy(list_handle);
-
}
* @endcode
*/
* @remarks The @a handle should be released using watchface_editable_geometry_destroy().
* @param[out] handle The editable geometry handle
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @retval #WATCHFACE_COMPLICATION_ERROR_NOT_SUPPORTED Not supported
- * @see watchface_editable_geometry_destory()
+ * @see watchface_editable_geometry_destroy()
* @see watchface_editable_add_complication()
* @see watchface_editable_add_design_element()
* @see watchface_editable_geometry_set()
* @since_tizen 5.0
* @param[in] handle The editable geometry handle
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WATCHFACE_COMPLICATION_ERROR_NOT_SUPPORTED Not supported
* @param[in] w The editable geometry width
* @param[in] h The editable geometry height
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WATCHFACE_COMPLICATION_ERROR_NOT_SUPPORTED Not supported
* @param[out] w The editable geometry width
* @param[out] h The editable geometry height
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WATCHFACE_COMPLICATION_ERROR_NOT_SUPPORTED Not supported
int watchface_editor_remove_request_edit_cb(watchface_editor_request_edit_cb cb);
/**
- * @brief Applys changes in edit mode.
+ * @brief Applies changes in edit mode.
* @since_tizen 5.0
* @privilege http://tizen.org/privilege/datasharing
* @return #WATCHFACE_COMPLICATION_ERROR_NONE if success, other value if failure
int watchface_editor_notify_edit_ready(const char *appid);
/**
- * @brief Copys the editable list.
+ * @brief Copies the editable list.
* @since_tizen 5.0
* @remarks The @a dest should be released using watchface_editor_editable_list_destroy().
* @param[in] source The editable list
* @param[in] handle The editable handle
* @param[in] context The new context data
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
int watchface_editor_set_context(watchface_editable_h handle, bundle *context);
/**
- * @brief Launchs editable's setup app.
+ * @brief Launches editable's setup app.
* @since_tizen 5.0
* @privilege http://tizen.org/privilege/appmanager.launch
* @privilege http://tizen.org/privilege/datasharing
* @param[in] cb The setup result callback
* @param[in] user_data The setup result callback's user data
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @param[in] handle The editable handle
* @param[out] exist The flag whether setup app is exist or not
* @return #WATCHFACE_COMPLICATION_ERROR_NONE on success,
- * otherwise an error code (see WATCHFACE_COMPLICATION_ERROR_XXX) on failure
+ * otherwise an error code (see #watchface_complication_error_e) on failure
* @retval #WATCHFACE_COMPLICATION_ERROR_NONE Successful
* @retval #WATCHFACE_COMPLICATION_ERROR_OUT_OF_MEMORY Out of memory
* @retval #WATCHFACE_COMPLICATION_ERROR_INVALID_PARAMETER Invalid parameter
projects / platform / core / appfw / watchface-complication.git / commitdiff