* @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
- * @see IAppControlResponseListener
*/
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);
* @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.
- * @see IAppCheckpointEventListener
*
*/
result SetCheckpointEventListener(IAppCheckpointEventListener& listener);
* @remarks Active application is the top most window with focus.
* @see GetActiveApp()
* @see RemoveActiveAppEventListener()
- * @see IActiveAppEventListener
*/
result AddActiveAppEventListener(IActiveAppEventListener& listener);
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @see GetActiveApp()
* @see AddActiveAppEventListener()
- * @see IActiveAppEventListener
*/
result RemoveActiveAppEventListener(IActiveAppEventListener& listener);
* - 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.
*
-* The instance of this class can be obtained through App::GetAppResource().
+* The instance of this class can be obtained through App::GetAppResource().
+*
* The following example demonstrates how to use the %AppResource class to get strings.
*
* @code
* @exception E_UNSUPPORTED_FORMAT The image file format or specified pixel format 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.
- * @remarks 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>.
+ * @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>.
*/
Tizen::Graphics::Bitmap* GetBitmapN(const Tizen::Base::String& imagePath, Tizen::Graphics::BitmapPixelFormat pixelFormat) const;
* @exception E_UNSUPPORTED_FORMAT The image file format 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.
- * @remarks 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>.
+ * @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>.
*/
Tizen::Graphics::Bitmap* GetBitmapN(const Tizen::Base::String& imagePath) const;
* 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
- * 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>).
+ * 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.
* 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 OnAppSettingChanged()(see IAppSettingEventListener).
+ * 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>.
*
+ * @see IAppSettingEventListener
*/
class _OSP_EXPORT_ AppSetting
: public Tizen::Base::Object
*
* @since 2.0
*
- * @return A pointer to the %AppSetting instance, @n
+ * @return A 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.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks It returns an instance for the latest setting. @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static AppSetting* GetInstance(void);
*
* @since 2.0
*
- * @return A pointer to the list that contains the Tizen::Base::String instances of version list
+ * @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.
* @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.
- * @remarks The latest version string is located in the first position.
- * If the old version does not exist then return empty collection. @n
- * 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* GetAppSettingVersionListN(void);
* %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.
- * @see AppControlProviderManager::SendAppControlResult()
*/
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;
* @remarks The application control completion result is received when the requested application control
* sends the result using AppControlProviderManager::SendAppControlResult().
* @see AppControl
- * @see AppControlProviderManager::SendAppControlResult()
*/
virtual void OnAppControlCompleteResponseReceived(const AppId& appId, const Tizen::Base::String& operationId, AppCtrlResult appControlResult, const Tizen::Base::Collection::IMap* pExtraData) = 0;
* @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.
- * @see IPackageInstallationResponseListener
*/
result InstallPackage(const PackageId& packageId, const Tizen::Base::String& packagePath, IPackageInstallationResponseListener* pListener);
* @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.
* @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.
- * @see IPackageUninstallationResponseListener
*/
result UninstallPackage(const PackageId& packageId, IPackageUninstallationResponseListener* pListener);
* @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 on the predefined key-value pairs for package app filter,
- * see <a href="../org.tizen.native.appprogramming/html/guide/app/package_app_filter.htm">the predefined key-value pairs for package app filter</a>.
+ * 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.
* @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.
*
- * 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>.
- * For more information on the predefined key-value pairs for package app filter,
- * see <a href="../org.tizen.native.appprogramming/html/guide/app/package_app_filter.htm">the predefined key-value pairs for package app filter</a>.
+ * For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/package_app_filter.htm">the predefined key-value pairs for package filter</a>.
+ * 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 A specified input parameter is invalid.
* If the specified @c pColumnList is @c null, all columns are selected.
* @param[in] pWhere A filter to select desired rows to query @n
* It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as
- * column1 = 'stringValue' AND column2 = numericValue.
+ * 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
* It is an SQL 'ORDER BY' clause excluding the 'ORDER BY' itself.
* @param[out] reqId The request ID
* - The size of sending buffer has exceeded the maximum limit.
* - The number of sending requests has exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks If the value specified in the @c pWhere is string, the value must be wrapped in
- * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.
- * For more information on the SQL statement, see SQLite SQL documents.
- * @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 severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.\r
*/
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,
* @param[in] dataId A string for identifying 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 contained in the specified @c insertMap must be
- * Tizen::Base::String class.
+ * 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[out] reqId The request ID
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance has not been properly constructed.
* - The size of sending buffer has exceeded the maximum limit.
* - The number of sending requests has exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks If the value specified in the @c insertMap is string, the value must be wrapped in
- * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.
- * For more information on the SQL statement, see SQLite SQL documents.
- * @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.
+ * @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
*/
result Insert(const Tizen::Base::String& dataId, const Tizen::Base::Collection::IMap& insertMap, RequestId& reqId);
* @param[in] dataId A string for identifying 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 contained in the specified @c updateMap must be
- * Tizen::Base::String class.
+ * 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
* It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as
- * column1 = 'stringValue' AND column2 = numericValue.
+ * 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
* @param[out] reqId The request ID
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance has not been properly constructed.
* - The size of sending buffer has exceeded the maximum limit.
* - The number of sending requests has exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks If the value specified in the @c pWhere or @c updateMap is string, the value must be wrapped in
- * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.
- * For more information on the SQL statement, see SQLITE SQL documents.
- * @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.
+ * @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
*/
result Update(const Tizen::Base::String& dataId, const Tizen::Base::Collection::IMap& updateMap,
const Tizen::Base::String* pWhere, RequestId& reqId);
* @param[in] pWhere A filter to select 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.
+ * 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
* @param[out] reqId The request ID
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance has not been properly constructed.
* - The size of sending buffer has exceeded the maximum limit.
* - The number of sending requests has exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks If the value specified in the @c pWhere is string, the value must be wrapped in
- * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.
- * For more information on the SQL statement, see SQLITE SQL documents.
- * @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 severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.\r
*/
result Delete(const Tizen::Base::String& dataId, const Tizen::Base::String* pWhere, RequestId& reqId);
* @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.
- * @see AppUiState
*/
AppUiState GetAppUiState(void) const;
projects / platform / framework / native / appfw.git / commitdiff