* @since 2.0
*
* @remarks @b Header @b %file: @b \#include @b <FShell.h> @n
- * @b Library : @b osp-shell
+ * @b Library: @b osp-shell
*
- * The %Shell namespace contains the classes for %Tizen shell management, including posting notifications, handling shortcuts, and using appwidget.
+ * The %Shell namespace contains classes for %Tizen shell management, including posting notifications, handling shortcuts, and using appwidget.
* @n@n
* For more information on the %Shell namespace features, see <a href="../org.tizen.native.appprogramming/html/guide/shell/shell_namespace.htm">Shell Guide</a>.
*
* @since 2.1
* @feature %http://tizen.org/feature/shell.appwidget
* @return An error code
- * @param[in] size The new width and height
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @param[in] size The new width and height
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
- * @remarks Before calling this method, check whether the feature is supported by
- * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @remarks Before calling this method, check whether the feature is supported by
+ * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
* @see AppWidgetProvider::OnAppWidgetProviderInitializing()
*/
result Construct(const Tizen::Graphics::FloatDimension& size);
* @since 2.1
* @feature %http://tizen.org/feature/shell.appwidget
* @return An error code
- * @param[in] layout The layout for both the portrait and landscape mode
- * @param[in] size The new width and height
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @param[in] layout The layout for both the portrait and landscape mode
+ * @param[in] size The new width and height
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @remarks Before calling this method, check whether the feature is supported by
- * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
+ * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
* @see AppWidgetProvider::OnAppWidgetProviderInitializing()
*/
result Construct(const Tizen::Ui::Layout& layout, const Tizen::Graphics::FloatDimension& size);
/**
* @class AppWidgetManager
- * @brief This class manages static information of all the AppWidgets and provides APIs for AppWidget viewer (such as the Home screen).
+ * @brief This class manages the static information of all the AppWidgets and provides APIs for AppWidget viewers (such as the Home screen).
*
* @since 2.1
*
* @since 2.1
*
* @feature %http://tizen.org/feature/shell.appwidget
- * @return A pointer to the %AppWidgetManager instance, @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.
+ * @return A pointer to the %AppWidgetManager instance, @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_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @remarks
- * - The specific error code can be accessed using the GetLastResult() method.
- * - Before calling this method, check whether the feature is supported by
- * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - Before calling this method, check whether the feature is supported by
+ * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
*/
static AppWidgetManager* GetInstance(void);
/**
- * Gets a list of installed AppWidgetProviderInfo.
+ * Gets the list of installed AppWidgetProviderInfo.
*
* @since 2.1
*
- * @return A pointer to the array list that contains all AppWidgetProviderInfo of installed AppWidgetProvider, @n
+ * @return A pointer to the array list that contains the AppWidgetProviderInfo of installed AppWidgetProviders, @n
* else @c null if an error occurs
*
* @exception E_SUCCESS The method is successful.
Tizen::Base::Collection::IList* GetAppWidgetProviderInfoListN(void) const;
/**
- * Gets an AppWidgetProviderInfo of the specified AppWidget provider.
+ * Gets the AppWidgetProviderInfo of the specified AppWidget provider.
*
* @since 2.1
*
* @return A pointer to the AppWidgetProviderInfo instance of the specified AppWidgetProvider, @n
* else @c null if an error occurs
- * @param[in] appId The ID of the application that provides AppWidget
- * @param[in] providerName The name of the AppWidget provider
+ * @param[in] appId The ID of the application that provides the AppWidget
+ * @param[in] providerName The name of the AppWidget provider
* @exception E_SUCCESS The method is successful.
* @exception E_APP_NOT_INSTALLED The application is not installed.
* @exception E_OBJ_NOT_FOUND The specified AppWidget provider is not found.
AppWidgetProviderInfo* GetAppWidgetProviderInfoN(const Tizen::App::AppId& appId, const Tizen::Base::String& providerName) const;
/**
- * Gets an AppWidgetProviderInfo of the default AppWidget provider in the package.
+ * Gets the AppWidgetProviderInfo of the default AppWidget provider in the package.
*
* @since 2.1
*
- * @return A pointer to the AppWidgetProviderInfo instance of the default AppWidgetProvider, @n
- * else @c null if there is no default AppWidget provider or if an error occurs
+ * @return A pointer to the AppWidgetProviderInfo instance of the default AppWidgetProvider, @n
+ * else @c null if there is no default AppWidget provider or an error occurs
* @param[in] packageId The ID of the package that contains the AppWidget provider
* @exception E_SUCCESS The method is successful.
* @exception E_APP_NOT_INSTALLED The application is not installed.
/**
* Sets an AppWidget request listener. @n
* The listener gets notified when the request is received. @n
- * To unset the listener, pass a @c null value to the @c pListener parameter.
+ * To unset the listener, pass a @c null value to @c pListener.
*
- * @since 2.1
+ * @since 2.1
*
- * @return An error code
- * @param[in] pListener The pointer to the listener to receive request to add AppWidget
+ * @return An error code
+ * @param[in] pListener A pointer to the listener that receives the request for adding AppWidget
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks Platform does not have the ownership of this pointer, so caller should manage the listener object properly.
- * @see IAppWidgetRequestListener
+ * @remarks Platform does not have the ownership of this pointer, so the caller should manage the listener object properly.
*/
result SetAppWidgetRequestListener(IAppWidgetRequestListener* pListener);
* @brief This class provides the popup for an %AppWidgetProvider.
* @since 2.1
*
- * The %AppWidgetPopup class supports detailed screen for an AppWidgetProvider.
+ * The %AppWidgetPopup class supports the detailed screen for an AppWidgetProvider.
*
*/
class _OSP_EXPORT_ AppWidgetPopup
* @since 2.1
* @feature %http://tizen.org/feature/shell.appwidget
* @return An error code
- * @param[in] size The new width and height
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @param[in] size The new width and height
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @remarks Before calling this method, check whether the feature is supported by
- * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
+ * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
* @see AppWidgetPopupProvider::OnAppWidgetPopupProviderInitializing()
*/
result Construct(const Tizen::Graphics::FloatDimension& size);
* @since 2.1
* @feature %http://tizen.org/feature/shell.appwidget
* @return An error code
- * @param[in] layout The layout for both the portrait and landscape mode
- * @param[in] size The new width and height
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @param[in] layout The layout for both the portrait and landscape mode
+ * @param[in] size The new width and height
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @remarks Before calling this method, check whether the feature is supported by
- * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
+ * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
* @see AppWidgetPopupProvider::OnAppWidgetPopupProviderInitializing()
*/
result Construct(const Tizen::Ui::Layout& layout, const Tizen::Graphics::FloatDimension& size);
* @exception E_SUCCESS The method is successful.
* @exception E_RESOURCE_UNAVAILABLE The required resource is currently unavailable.
* @remarks
- * - This method allocates a Tizen::Graphics::Canvas whose bounds are equal to that of the client area of the %AppWidgetPopup instance. @n
+ * - This method allocates a Tizen::Graphics::Canvas whose bounds are equal to that of the client area of the %AppWidgetPopup instance. @n
* It is the responsibility of the developers to deallocate the canvas after use.
- * - The canvas is valid only if the properties of the parent control of the canvas remain unchanged. @n
+ * - The canvas is valid only if the properties of the parent control of the canvas remain unchanged. @n
* Therefore, delete the previously allocated canvas and create a new canvas using the %GetClientAreaCanvasN() method if the size or position of the
* control is changed.
- * - The specific error code can be accessed using the GetLastResult() method.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Graphics::Canvas* GetClientAreaCanvasN(void) const;
*
* @since 2.1
*
- * @return The float position in relative to the top-left corner of the client area, @n
+ * @return The float position relative to the top-left corner of the client area, @n
* else @c (-1.0f,-1.0f) if the instance is invalid
* @param[in] controlPosition The float position relative to the top-left corner of the %AppWidgetPopup instance
* @see TranslateToControlPosition()
Tizen::Graphics::FloatPoint TranslateToClientAreaPosition(const Tizen::Graphics::FloatPoint& controlPosition) const;
/**
- * Translates a specified client position to the control coordinate.
+ * Translates a specified client position to the control coordinates.
*
* @since 2.1
*
- * @return The float position in relative to the top-left corner of the Popup control, @n
+ * @return The float position relative to the top-left corner of the Popup control, @n
* else @c (-1.0f,-1.0f) if the instance is invalid
* @param[in] clientPosition The float position relative to the top-left corner of the client area
* @see TranslateToClientAreaPosition()
virtual ~AppWidgetPopupProvider(void);
/**
- * Called when the AppWidget popup provider is required to be created.
+ * Called when an AppWidget popup provider has to be created.
*
* @since 2.1
*
virtual bool OnAppWidgetPopupProviderInitializing(const Tizen::Base::String& userInfo) = 0;
/**
- * Called when the AppWidget popup provider is required to be destroyed.
+ * Called when an AppWidget popup provider has to be destroyed.
*
* @since 2.1
*/
virtual void OnAppWidgetPopupProviderTerminating(void) = 0;
/**
- * Sets the AppWidget popup to the AppWidget popup provider.
+ * Sets the AppWidget popup for an AppWidget popup provider.
*
* @since 2.1
*
* @return An error code
- * @param[in] pAppWidgetPopup The pointer to the AppWidgetPopup instance that is set to AppWidget
+ * @param[in] pAppWidgetPopup A pointer to the AppWidgetPopup instance that is set to AppWidget
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The pointer to AppWidgetPopup is @c null, or not constructed as yet.
+ * @exception E_INVALID_ARG The pointer to AppWidgetPopup is either @c null or is not constructed as yet.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks
- * - This method should be called only in OnAppWidgetPopupProviderInitializing().
- * - The AppWidgetPopup instance ownership is transferred to platform. After AppWidgetPopupProvider::OnAppWidgetPopupProviderTerminating() is called, the %AppWidgetPopup instance is removed automatically. The %AppWidgetPopup instance reuse is not allowed.
+ * - This method should be called only in OnAppWidgetPopupProviderInitializing().
+ * - The AppWidgetPopup instance ownership is transferred to platform. After AppWidgetPopupProvider::OnAppWidgetPopupProviderTerminating() is called, the %AppWidgetPopup instance is removed automatically. The %AppWidgetPopup instance reuse is not allowed.
*/
result SetAppWidgetPopup(Tizen::Shell::AppWidgetPopup* pAppWidgetPopup);
* @since 2.1
*
* @return The AppWidgetPopup instance, @n
- * else @c null if any %AppWidgetPopup is not set as yet
+ * else @c null if an %AppWidgetPopup is not set as yet
*/
Tizen::Shell::AppWidgetPopup* GetAppWidgetPopup(void);
* @since 2.1
*
* @return The AppWidgetPopup instance, @n
- * else @c null if any %AppWidgetPopup is not set as yet
+ * else @c null if an %AppWidgetPopup is not set as yet
*/
const Tizen::Shell::AppWidgetPopup* GetAppWidgetPopup(void) const;
virtual ~AppWidgetProvider(void);
/**
- * Called when the AppWidget provider is created or initialized.
+ * Called when an AppWidget provider is created or initialized.
*
* @since 2.1
*
* @param[in] height The height of the AppWidget
* @param[in] userInfo User information that is specified when the AppWidget is added
* @remarks AppWidgetFrame should be created and set here. @n
- * If this method returns @c false, the AppWidget provider will be terminated.
+ * If this method returns @c false, the AppWidget provider is terminated.
* @see AppWidgetProviderManager::AddAppWidget()
* @see SetAppWidgetFrame()
*
virtual bool OnAppWidgetProviderInitializing(float width, float height, const Tizen::Base::String& userInfo) = 0;
/**
- * Called when the AppWidget provider is destroyed or terminated.
+ * Called when an AppWidget provider is destroyed or terminated.
*
* @since 2.1
*/
virtual void OnAppWidgetProviderTerminating(void) = 0;
/**
- * Called when the correspondent AppWidget is removed from the AppWidget viewer application (such as the Home screen). @n
- * If AppWidget provider state is stored in a persistent storage such as registry or DB, it can be destroyed by implementing this pure virtual function.
+ * Called when the corresponding AppWidget is removed from an AppWidget viewer application (such as the Home screen). @n
+ * If the AppWidget provider's state is stored in a persistent storage such as a registry or DB, it can be destroyed by implementing this pure virtual function.
*
* @since 2.1
*
virtual void OnAppWidgetProviderRemoved(void) = 0;
/**
- * Called when AppWidget is updated. @n
- * AppWidget provider can be updated by implementing this pure virtual function.
+ * Called when an AppWidget is updated. @n
+ * The AppWidget provider can be updated by implementing this pure virtual function.
*
* @since 2.1
*
* This parameter is delivered from AppWidgetProvider::RequestUpdate().
* @remarks
* - This method is called when the UpdatePeriod timer expires or AppWidgetManager::RequestUpdate() is called.
- * - If this method returns @c false, the AppWidget provider will be removed.
+ * - If this method returns @c false, the AppWidget provider is removed.
*/
virtual bool OnAppWidgetProviderUpdating(const Tizen::Base::String& argument) = 0;
* @return An error code
* @param[in] pAppWidgetFrame The AppWidgetFrame instance to set as the %AppWidgetProvider instance
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The pointer to AppWidgetFrame is @c null, or not constructed as yet.
+ * @exception E_INVALID_ARG The pointer to AppWidgetFrame is either @c null or is not constructed as yet.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks
- * - This method should be called only within the OnAppWidgetProviderInitializing() method.
- * - The AppWidgetFrame instance ownership is transferred to the platform. After AppWidgetProvider::OnAppWidgetProviderTerminating() is called, the %AppWidgetFrame instance is removed automatically. The %AppWidgetFrame instance reuse is not allowed.
+ * - This method should be called only within the OnAppWidgetProviderInitializing() method.
+ * - The AppWidgetFrame instance ownership is transferred to the platform. After AppWidgetProvider::OnAppWidgetProviderTerminating() is called, the %AppWidgetFrame instance is removed automatically. The %AppWidgetFrame instance reuse is not allowed.
*/
result SetAppWidgetFrame(AppWidgetFrame* pAppWidgetFrame);
* @since 2.1
*
* @return The AppWidgetFrame instance, @n
- * else @c null if any %AppWidgetFrame is not set as yet
+ * else @c null if an %AppWidgetFrame is not set as yet
*/
AppWidgetFrame* GetAppWidgetFrame(void);
* @since 2.1
*
* @return The AppWidgetFrame instance, @n
- * else @c null if any %AppWidgetFrame is not set as yet
+ * else @c null if an %AppWidgetFrame is not set as yet
*/
const AppWidgetFrame* GetAppWidgetFrame(void) const;
*
* @since 2.1
*
- * @param[in] rhs An instance of %AppWidgetProviderInfo
+ * @param[in] rhs An instance of %AppWidgetProviderInfo to copy
*/
AppWidgetProviderInfo(const AppWidgetProviderInfo& rhs);
Tizen::Base::String GetName(void) const;
/**
- * Gets the display name of an AppWidget provider. @n
+ * Gets the display name of the AppWidget provider. @n
* If the system language setting is changed, the %GetDisplayName() method returns the localized application name.
* The display name is displayed in applications showing AppWidget such as Launcher, and so on.
*
* @since 2.1
*
- * @return The display name of an AppWidget
+ * @return The display name of the AppWidget
*/
Tizen::Base::String GetDisplayName(void) const;
/**
- * Gets the icon path of an application.
+ * Gets the icon path of the application.
*
* @since 2.1
*
- * @return The icon path of an application @n
- * An empty string is returned if there is no value.
+ * @return The icon path of the application, @n
+ * else an empty string if there is no value
*/
Tizen::Base::String GetIconPath(void) const;
/**
- * Gets the ID of the application that exports AppControl to configure the AppWidget.
+ * Gets the ID of an application that exports AppControl to configure the AppWidget.
*
* @since 2.1
*
- * @return The ID of the application that exports AppControl to configure the AppWidget. @n
- * An empty string is returned if there is no value.
+ * @return The ID of the application that exports AppControl to configure the AppWidget, @n
+ * else an empty string if there is no value
*
* The following example demonstrates how to start the application control that is exported for AppWidget configuration.
*
Tizen::Base::String GetConfigurationAppControlAppId(void) const;
/**
- * Checks whether the specified AppWidget provider is the default provider or not.
+ * Checks whether the specified AppWidget provider is the default provider.
*
* @since 2.1
*
* else @c false
*
* @remarks
- * - Default AppWidget provider, providing AppWidget that represents an application.
- * - Home application can show AppWidget instead of a shortcut that consists of an icon and text for applications that include the default AppWidget provider.
+ * - A default AppWidget provider, provides the AppWidget that represents an application.
+ * - A home application can show an AppWidget instead of a shortcut that consists of an icon and text, for applications that include the default AppWidget provider.
*/
bool IsDefault(void) const;
/**
- * Gets a list of AppWidgetSizeInfo of an AppWidget.
+ * Gets the list that contains the AppWidgetSizeInfo of the AppWidget.
*
* @since 2.1
*
- * @return A pointer to the array list that contains all AppWidgetSizeInfo of the AppWidgetProvider instance, @n
+ * @return A pointer to the array list that contains the AppWidgetSizeInfo of the AppWidgetProvider instance, @n
* else @c null if an error occurs
* @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.
* @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>.
- * @remarks
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @remarks
* - The specific error code can be accessed using the GetLastResult() method.
- * - Before calling this method, check whether the feature is supported by
- * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
+ * - Before calling this method, check whether the feature is supported by Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
*/
static AppWidgetProviderManager* GetInstance(void);
/**
- * Requests AppWidget service to trigger the specified AppWidget update.
+ * Requests an AppWidget service to trigger the specified AppWidget update.
*
* @since 2.1
*
- * @param[in] appId The appId that provides AppWidget
- * @param[in] providerName The name of the AppWidget provider @n
- For more information, see <a href="../org.tizen.native.appprogramming/html/app_dev_process/manifest_dynamicbox.htm">Setting Dynamic Box Manifest</a>.
+ * @param[in] appId The ID of the application providing the AppWidget
+ * @param[in] providerName The name of the AppWidget provider
* @param[in] argument User information for the AppWidget provider @n
- * This parameter will be delivered as parameter of AppWidgetProvider::OnAppWidgetProviderUpdating().
+ * This parameter is delivered as a parameter of AppWidgetProvider::OnAppWidgetProviderUpdating().
* @exception E_SUCCESS The method is successful.
* @exception E_APP_NOT_INSTALLED The application is not installed.
* @exception E_OBJ_NOT_FOUND The specified AppWidget provider is not found.
- * @exception E_CERTIFICATE_VERIFICATION_FAILED The application is not permitted to request to update AppWidget of other application package. @n
+ * @exception E_CERTIFICATE_VERIFICATION_FAILED The application is not permitted to request for updating the AppWidget of other application packages. @n
* To get permission, the target application is signed with the same certificate.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @see AppWidgetProvider::OnAppWidgetProviderUpdating()
* @remarks
- * - When the specified Dynamic Box is implemented with Web app, argument will not be delivered.
+ * - When the specified Dynamic Box is implemented with a Web app, the argument is not delivered.
* - Regarding appId, please note that IDs of each applications will be changed except root application, when you make a package with multiple applications. @n
* For more information, see <a href="../org.tizen.native.appprogramming/html/app_dev_process/packaging_app.htm">Packaging a Multi-project Application</a> to specify appId properly.
*/
* @privlevel public
* @privilege %http://tizen.org/privilege/appwidgetprovider.install
*
- * @param[in] providerAppId The ID of the application providing AppWidget
+ * @param[in] providerAppId The ID of the application providing the AppWidget
* @param[in] providerName The name of the AppWidget provider to add
* @param[in] alternateText Alternate text displayed in the AppWidgetView instance while the AppWidgetProvider instance is initializing or is unavailable
* @param[in] userInfo User information for the AppWidget provider
* @exception E_APP_NOT_INSTALLED The application is not installed.
* @exception E_OBJ_NOT_FOUND The specified AppWidget provider is not found.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_CERTIFICATE_VERIFICATION_FAILED The application is not permitted to request to add AppWidget of other application package. @n
+ * @exception E_CERTIFICATE_VERIFICATION_FAILED The application is not permitted to request for adding the AppWidget of other application packages. @n
* To get permission, the target application is signed with the same certificate.
* @exception E_UNSUPPORTED_OPERATION The specified AppWidget provider does not support this operation. @n
- * To request an AppWidget viewer to add an AppWidget, AppWidget provider should support 1x1 size AppWidget, but the specified AppWidget provider does not support 1x1 size.
- * @exception E_CONNECTION_FAILED The viewer application does not set a listener to receive this request.
+ * To request an AppWidget viewer to add an AppWidget, the AppWidget provider should support a 1x1 size AppWidget, but the specified AppWidget provider does not support 1x1 size.
+ * @exception E_CONNECTION_FAILED The viewer application has not set a listener to receive this request.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks Only the AppWidget provider that is packaged with the caller application can be added by this method.
* @see AppWidgetManager::SetAppWidgetRequestListener()
/**
* Sets an AppWidgetProvider factory. @n
- * The factory is called when AppWidgetProvider needs to be created.
+ * The factory is called when an AppWidgetProvider needs to be created.
* The %SetAppWidgetProviderFactory() method should be called in App::OnAppInitializing(), to receive the event correctly.
* Implementing AppWidgetProviderFactory is mandatory to provide AppWidget functionality.
*
* @since 2.1
*
* @return An error code
- * @param[in] factory The factory to create concrete AppWidgetProvider
+ * @param[in] factory The factory to create a concrete AppWidgetProvider
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The application's attribute does not meet the condition to provide AppWidget.
+ * @exception E_INVALID_OPERATION The application's attribute does not meet the condition to provide an AppWidget.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @see IAppWidgetProviderFactory
*/
result SetAppWidgetProviderFactory(IAppWidgetProviderFactory& factory);
/**
* Sets an AppWidgetPopupProvider factory. @n
- * The factory is called when AppWidgetPopupProvider needs to be created.
+ * The factory is called when an AppWidgetPopupProvider needs to be created.
* The %SetAppWidgetPopupProviderFactory() method should be called in App::OnAppInitializing(), to receive the event correctly.
* Implementing AppWidgetPopupProviderFactory is mandatory to provide AppWidgetPopup functionality.
*
* @since 2.1
*
* @return An error code
- * @param[in] factory The factory to create concrete AppWidgetPopupProvider
+ * @param[in] factory The factory to create a concrete AppWidgetPopupProvider
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The application's attribute does not meet the condition to provide AppWidget popup.
+ * @exception E_INVALID_OPERATION The application's attribute does not meet the condition to provide an AppWidget popup.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @see IAppWidgetPopupProviderFactory
*/
result SetAppWidgetPopupProviderFactory(IAppWidgetPopupProviderFactory& factory);
/**
* @class AppWidgetSizeInfo
- * @brief This class provides methods to retrieve size and image path for preview.
+ * @brief This class provides methods to retrieve the size and image path for a preview.
*
* @since 2.1
*
- * The %AppWidgetSizeInfo class provides methods to retrieve size and image path for preview.
+ * The %AppWidgetSizeInfo class provides methods to retrieve the size and image path for a preview.
*/
class _OSP_EXPORT_ AppWidgetSizeInfo
: public Tizen::Base::Object
*
* @since 2.1
*
- * @param[in] rhs An instance of %AppWidgetSizeInfo
+ * @param[in] rhs An instance of %AppWidgetSizeInfo to copy
*/
AppWidgetSizeInfo(const AppWidgetSizeInfo& rhs);
Tizen::Graphics::FloatDimension GetSize(void) const;
/**
- * Gets the image path for preview of the size.
+ * Gets the image path for a preview.
*
* @since 2.1
*
- * @return The image path for preview
+ * @return The image path for the preview
*/
Tizen::Base::String GetPreviewImagePath(void) const;
*
* @return @c true if the AppWidget viewer needs to decorate the frame of the Dynamic Box for the size, @n
* else @c false
- * @remarks Decoration depends on the current AppWidget viewer implementation.
+ * @remarks The decoration depends on the current AppWidget viewer implementation.
*/
bool IsDecorationFrameUsed(void) const;
//
/**
- * @file FShellAppWidgetView.h
+ * @file FShellAppWidgetView.h
* @brief This is the header file for the %AppWidgetView class.
*
* This header file contains the declarations of the %AppWidgetView class.
/**
* @class AppWidgetView
- * @brief This class provides the view control for an AppWidgetViewer.
+ * @brief This class provides the view control for an %AppWidgetViewer.
* @since 2.1
*
- * The %AppWidgetView class shows a drawn buffer by AppWidgetProvider.
+ * The %AppWidgetView class shows a buffer drawn by the AppWidgetProvider.
*
*/
class _OSP_EXPORT_ AppWidgetView
* @since 2.1
* @feature %http://tizen.org/feature/shell.appwidget
* @return An error code
- * @param[in] appId The AppId of the installed application
- * @param[in] providerName The name of the AppWidget provider
- * @param[in] rect An instance of the Tizen::Graphics::FloatRectangle class @n
- * This instance represents the x and y coordinates of the top-left corner @n
- * of the created window along with its width and height.
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_APP_NOT_INSTALLED The application is not installed.
- * @exception E_OBJ_NOT_FOUND The specified AppWidget provider is not found.
+ * @param[in] appId The ID of the installed application
+ * @param[in] providerName The name of the AppWidget provider
+ * @param[in] rect An instance of the Tizen::Graphics::FloatRectangle class @n
+ * This instance represents the x and y coordinates of the top-left corner @n
+ * of the created window along with its width and height.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_APP_NOT_INSTALLED The application is not installed.
+ * @exception E_OBJ_NOT_FOUND The specified AppWidget provider is not found.
* @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @remarks Before calling this method, check whether the feature is supported by
- * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
+ * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
*/
result Construct(const Tizen::App::AppId& appId, const Tizen::Base::String& providerName, const Tizen::Graphics::FloatRectangle& rect);
* @since 2.1
* @feature %http://tizen.org/feature/shell.appwidget
* @return An error code
- * @param[in] appId The AppId of the installed application
- * @param[in] providerName The name of the AppWidget provider
- * @param[in] rect An instance of the Tizen::Graphics::FloatRectangle class @n
- * This instance represents the x and y coordinates of the top-left corner @n
- * of the created window along with its width and height.
- * @param[in] userInfo The extra data to deliver to the AppWidget provider
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_APP_NOT_INSTALLED The application is not installed.
- * @exception E_OBJ_NOT_FOUND The specified AppWidget provider is not found.
+ * @param[in] appId The ID of the installed application
+ * @param[in] providerName The name of the AppWidget provider
+ * @param[in] rect An instance of the Tizen::Graphics::FloatRectangle class @n
+ * This instance represents the x and y coordinates of the top-left corner @n
+ * of the created window along with its width and height.
+ * @param[in] userInfo The extra data to deliver to the AppWidget provider
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_APP_NOT_INSTALLED The application is not installed.
+ * @exception E_OBJ_NOT_FOUND The specified AppWidget provider is not found.
* @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @remarks Before calling this method, check whether the feature is supported by
- * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
+ * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
*/
result Construct(const Tizen::App::AppId& appId, const Tizen::Base::String& providerName, const Tizen::Graphics::FloatRectangle& rect, const Tizen::Base::String& userInfo);
/**
- * Gets an AppWidgetProviderInfo of the specified AppWidget provider.
+ * Gets the AppWidgetProviderInfo of the specified AppWidget provider.
*
* @since 2.1
*
- * @return A pointer to the AppWidgetProviderInfo of the specified AppWidgetProvider@n
+ * @return A pointer to the AppWidgetProviderInfo of the specified AppWidgetProvider @n
* else @c null if an error occurs
* @exception E_SUCCESS The method is successful.
* @exception E_APP_NOT_INSTALLED The application is not installed.
* @since 2.1
* @return An error code
* @param[in] listener The listener to add @n
- * The listener must be allocated at heap, not stack.
+ * The listener must be allocated as a heap and not a stack.
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_ALREADY_EXIST The listener has already been added.
* @see RemoveAppWidgetViewEventListener()
* @since 2.1
* @return An error code
* @param[in] listener The listener to remove @n
- * The listener should be referring to previously allocated instance which is passed as an argument to AddAppWidgetViewEventListener().
+ * The listener should be referring to a previously allocated instance which is passed as an argument to AddAppWidgetViewEventListener().
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified listener cannot be found.
* @see AddAppWidgetViewEventListener()
/**
* @interface IAppWidgetPopupProviderFactory
- * @brief This interface is the factory interface for creating the %AppWidgetPopupProvider instance.
+ * @brief This interface is the factory interface for creating a %AppWidgetPopupProvider instance.
*
* @since 2.1
*
- * The %IAppWidgetPopupProviderFactory interface is the factory interface for creating the AppWidgetPopupProvider instance.
- * The AppWidgetProviderManager instance calls CreateInstance() when an instance of AppWidgetPopupProvider is required.
+ * The %IAppWidgetPopupProviderFactory interface is the factory interface for creating an AppWidgetPopupProvider instance.
+ * The %AppWidgetProviderManager instance calls CreateInstance() when an instance of %AppWidgetPopupProvider is required.
*
* @see AppWidgetProviderManager
*/
* @since 2.1
*
* @param[in] providerName The name of the AppWidget provider
- * @param[in] userInfo User information that specifies when the AppWidget is added
+ * @param[in] userInfo User information that specifies when the AppWidget is added
* @see AppWidgetProviderManager::AddAppWidget()
*/
virtual AppWidgetPopupProvider* CreateInstance(const Tizen::Base::String& providerName, const Tizen::Base::String& userInfo) = 0;
* @since 2.1
*
* The %IAppWidgetProviderFactory interface defines a factory for the AppWidgetProvider creation.
- * The AppWidgetProviderManager instance calls CreateInstance() when an instance of %AppWidgetProvider is required.
+ * The %AppWidgetProviderManager instance calls CreateInstance() when an instance of %AppWidgetProvider is required.
* Applications that provide the %AppWidgetProvider functionality must implement this interface.
*
* @see AppWidgetProviderManager
virtual ~IAppWidgetProviderFactory(void) {};
/**
- * Called when the AppWidgetProvider creation request is received from the appwidget service. @n
+ * Called when an AppWidgetProvider creation request is received from the appwidget service. @n
* Applications that provide the %AppWidgetProvider functionality must implement this pure virtual method.
*
* @since 2.1
/**
* Called when requested to add an AppWidget. @n
- * The AppWidget viewer application such as the Home screen can get callback request to add an AppWidget by implementing this listener.
+ * The AppWidget viewer application such as the Home screen can get a callback request to add an AppWidget by implementing this listener.
*
* @since 2.1
*
- * @param[in] appId The application ID of the application providing AppWidget
+ * @param[in] appId The ID of the application providing the AppWidget
* @param[in] providerName The name of the AppWidget provider to add
* @param[in] text Alternative text for the AppWidget
* @param[in] userInfo User information for the AppWidget provider
/**
* @interface IAppWidgetViewEventListener
- * @brief This interface defines a listener for the %AppWidgetView that receives %AppWidgetProvider removed event.
+ * @brief This interface defines a listener for the %AppWidgetView that receives the %AppWidgetProvider remove event.
*
* @since 2.1
*
- * The %IAppWidgetViewEventListener interface defines a listener for the AppWidgetView that receives AppWidgetProvider removed event.
+ * The %IAppWidgetViewEventListener interface defines a listener for the AppWidgetView that receives the AppWidgetProvider remove event.
*/
class _OSP_EXPORT_ IAppWidgetViewEventListener
: public Tizen::Base::Runtime::IEventListener
virtual ~IAppWidgetViewEventListener(void) {}
/**
- * Called when a AppWidgetProvider instance is about to be removed. @n
+ * Called when an AppWidgetProvider instance is to be removed. @n
*
* @since 2.1
*
/**
* @interface IBadgeEventListener
- * @brief This interface defines a listener for the Home screen that receives badge updated event.
+ * @brief This interface defines a listener for the Home screen that receives a badge updated event.
*
* @since 2.1
*
- * The %IBadgeEventListener interface defines a listener for the Home screen that receives badge updated event.
+ * The %IBadgeEventListener interface defines a listener for the Home screen that receives a badge updated event.
*/
class _OSP_EXPORT_ IBadgeEventListener
: virtual public Tizen::Base::Runtime::IEventListener
*
* @since 2.1
*
- * @param[in] appId The application ID that updates the badge number
+ * @param[in] appId The ID of the application that updates the badge number
* @param[in] badgeNumber The updated badge number
* @remarks This method is invoked only in the main thread.
* @see NotificationManager::Notify()
/**
* @interface IShortcutRequestListener
- * @brief This interface defines a listener for the Home application that receives request to add a shortcut.
+ * @brief This interface defines a listener for the Home application that receives a request to add a shortcut.
*
* @since 2.1
*
- * The %IShortcutRequestListener interface defines a listener for the Home application that receives request to add a shortcut.
+ * The %IShortcutRequestListener interface defines a listener for the Home application that receives a request to add a shortcut.
* The following example demonstrates how to start the application when the added shortcut is selected by the user.
* @code
*
* @since 2.1
*
- * @param[in] appId The application ID
- * @param[in] displayName The display name of shortcut
+ * @param[in] appId The application ID
+ * @param[in] displayName The display name of the shortcut
* @param[in] iconFilePath The icon file path
- * @param[in] uriData Uri that will be delivered by IAppControlProviderEventListener::OnAppControlRequestReceived(), when the application is started using a shortcut.
+ * @param[in] uriData The Uri that is delivered by IAppControlProviderEventListener::OnAppControlRequestReceived(), when the application is started using a shortcut.
*
- * @remarks If @c uriData is specified, application should be started by AppControl with %http://tizen.org/appcontrol/operation/view operation, when it is launched from the Home application using a shortcut.
- * Or else application should be started by AppControl with default operation (%http://tizen.org/appcontrol/operation/main).
- * For more information on the AppControl class, see <a href="../org.tizen.native.appprogramming/html/guide/app/app_controls.htm">Application Controls</a>, and <a href="../org.tizen.native.appprogramming/html/guide/app/delivering_launch_arguments.htm">Delivering Launch Arguments</a>.
+ * @remarks If @c uriData is specified, the application should be started by AppControl with %http://tizen.org/appcontrol/operation/view operation, when it is launched from the Home application using a shortcut.
+ * Or else the application should be started by AppControl with the default operation (%http://tizen.org/appcontrol/operation/main).
+ * For more information on the
%AppControl class, see <a href="../org.tizen.native.appprogramming/html/guide/app/app_controls.htm">Application Controls</a>, and <a href="../org.tizen.native.appprogramming/html/guide/app/delivering_launch_arguments.htm">Delivering Launch Arguments</a>.
* @see ShortcutManager::AddShortcut()
*/
virtual void OnShortcutAddRequested(const Tizen::App::AppId& appId, const Tizen::Base::String& displayName, const Tizen::Base::String& iconFilePath, const Tizen::Base::String& uriData) = 0;
* @since 2.1
*
* @param[in] appId The application ID
- * @param[in] displayName The display name of shortcut
- * @remarks If there are more than one shortcuts with duplicated @c appId and @c displayName, all of them should be removed.
+ * @param[in] displayName The display name of the shortcut
+ * @remarks If there are more than one shortcuts with duplicated @c appId and @c displayName, all of them should be removed.
* @see ShortcutManager::RemoveShortcut()
*/
virtual void OnShortcutRemoveRequested(const Tizen::App::AppId& appId, const Tizen::Base::String& displayName) = 0;
/**
* @class LockManager
- * @brief This class manages state of lock screen.
+ * @brief This class manages the state of a locked screen.
*
* @since 2.1
*
* @final This class is not intended for extension.
*
- * The %LockManager class manages state of lock screen.
+ * The %LockManager class manages the state of a locked screen.
*/
class _OSP_EXPORT_ LockManager
: public Tizen::Base::Object
*
* @return A pointer to the %LockManager instance, @n
* else @c null if it fails
- * @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 The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
bool IsLocked(void) const;
/**
- * Checks whether password lock screen is enabled by Settings.
+ * Checks whether the password locked screen is enabled by Settings.
*
* @since 2.1
*
- * @return @c true if password lock screen is enabled,
+ * @return @c true if the password locked screen is enabled,
* else @c false
*/
bool IsSecureMode(void) const;
/**
- * Unlocks current lock screen.
+ * Unlocks the currently locked screen.
*
* @since 2.1
* @privlevel platform
* @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_OPERATION The application cannot unlock because the secure mode is enabled.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks This method call has no effect while secure mode is enabled.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @remarks This method call has no effect when the secure mode is enabled.
*/
result Unlock(void);
/**
* @enum OngoingActivityType
*
- * Defines the notification type for an ongoing activity.
+ * Defines the notification types for an ongoing activity.
*
* @since 2.0
*/
enum OngoingActivityType
{
- ONGOING_ACTIVITY_TYPE_TEXT = 1, /**< The progress is indicated with a text */
- ONGOING_ACTIVITY_TYPE_PROGRESS_BYTE, /**< The progress is indicated with the number of bytes */
- ONGOING_ACTIVITY_TYPE_PROGRESS_PERCENTAGE /**< The progress is indicated with percentage */
+ ONGOING_ACTIVITY_TYPE_TEXT = 1, /**< The progress is indicated with a text */
+ ONGOING_ACTIVITY_TYPE_PROGRESS_BYTE, /**< The progress is indicated with the number of bytes */
+ ONGOING_ACTIVITY_TYPE_PROGRESS_PERCENTAGE /**< The progress is indicated as a percentage */
};
/**
*/
enum NotificationStyle
{
- NOTIFICATION_STYLE_NORMAL = 1, /**< The notification is normal style */
- NOTIFICATION_STYLE_THUMBNAIL /**< The notification is thumbnail style */
+ NOTIFICATION_STYLE_NORMAL = 1, /**< The notification is in the normal style */
+ NOTIFICATION_STYLE_THUMBNAIL /**< The notification is in the thumbnail style */
};
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
*
- * @return The current badge number if the method is successful, @n
- * else @c -1 if the method fails
+ * @return The current badge number, @n
+ * else @c -1 if it fails
* @exception E_SUCCESS The method is successful.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
int GetBadgeNumber(void);
/**
- * Notifies the user who has @c badgeNumber as a badge number.
+ * Notifies the user who has @c badgeNumber as the badge number.
*
* @since 2.0
* @privlevel public
* @return An error code
* @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
+ * @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 or the @c badgeNumber is greater than Shell::MAX_NOTIFICATION_BADGE_NUMBER.
+ * - The specified @c badgeNumber is either less than @c 0 or greater than Shell::MAX_NOTIFICATION_BADGE_NUMBER.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
* @return An error code
* @param[in] messageText The notification message
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
* - The specified input parameter is invalid.
- * - The specified @c messageText is empty or the length of the @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * - The specified @c messageText is empty.
+ * - The length of the @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
result Notify(const Tizen::Base::String& messageText);
/**
- * Notifies the user who has @c badgeNumber as badge number with a message.
+ * Notifies the user who has @c badgeNumber as the badge number with a message.
*
* @since 2.0
* @privlevel public
* @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
- * - The specified @c messageText is empty or the length of the @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
- * - The specified @c badgeNumber is less than @c 0 or the @c badgeNumber is greater than Shell::MAX_NOTIFICATION_BADGE_NUMBER.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c messageText is empty.
+ * - The length of the @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * - The specified @c badgeNumber is either less than @c 0 or greater than Shell::MAX_NOTIFICATION_BADGE_NUMBER.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
result Notify(const Tizen::Base::String& messageText, int badgeNumber);
/**
- * Notifies the user who has @c badgeNumber as badge number with a message. @n
+ * Notifies the user who has @c badgeNumber as the badge number with a message. @n
* If the user selects this 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 Tizen::App::IAppControlProviderEventListener::OnAppControlRequestReceived().
* @param[in] badgeNumber The badge number
* @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
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
* - A specified input parameter is invalid. @n
- * - The specified @c badgeNumber is less than @c 0 or the @c badgeNumber is greater than Shell::MAX_NOTIFICATION_BADGE_NUMBER. @n
- * - The specified @c messageText is empty or the length of the @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH. @n
- * - The specified @c launchArguments is empty or the length of @c launchArguments is greater than Shell::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH.
+ * - The specified @c badgeNumber is either less than @c 0 or greater than Shell::MAX_NOTIFICATION_BADGE_NUMBER.
+ * - The specified @c messageText is empty.
+ * - The length of the @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * - The specified @c launchArguments is empty.
+ * - The length of the @c launchArguments is greater than Shell::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
* @privilege %http://tizen.org/privilege/notification
*
* @return An error code
- * @exception E_SUCCESS The method is successful.
+ * @exception E_SUCCESS The method is successful.
* @exception E_OPERATION_FAILED The operation has failed.
* @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.
* @exception E_SUCCESS The method is successful.
* @exception E_APP_NOT_INSTALLED The application is not installed.
* @exception E_OPERATION_FAILED The operation has failed.
- * @exception E_PRIVILEGE_DENIED The application did not have the privilege to call this method.
+ * @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.
*/
result RemoveNotificationByAppId(const Tizen::App::AppId& appId);
/**
- * Notifies the user about the ongoing activity using a message.
+ * Notifies the user about an ongoing activity using a message.
*
* @since 2.0
* @privlevel public
* @return An error code
* @param[in] messageText The notification message
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The specified input parameter is invalid. @n
- * - The specified @c messageText is empty or the length of the @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The specified @c messageText is empty.
+ * - The length of the @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
result NotifyOngoingActivity(const Tizen::Base::String& messageText);
/**
- * Notifies the user about the ongoing activity using a message. @n
+ * Notifies the user about an ongoing activity using a message. @n
* If the user selects 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 Tizen::App::IAppControlProviderEventListener::OnAppControlRequestReceived().
* @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 specified @c messageText is empty or the length of the @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH. @n
- * - The specified @c launchArguments is empty or the length of @c launchArguments is greater than Shell::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c messageText is empty.
+ * - The length of the @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * - The specified @c launchArguments is empty.
+ * - The length of the @c launchArguments is greater than Shell::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
result NotifyOngoingActivity(const Tizen::Base::String& messageText, const Tizen::Base::String& launchArguments);
/**
- * Notifies the user about the ongoing activity using a request message. @n
+ * Notifies the user about an ongoing activity using a request message. @n
* The request may have various pieces of information such as alert text, title text, launch arguments, and so on.
*
* @since 2.0
result NotifyOngoingActivity(const NotificationRequest& request);
/**
- * Notifies the user about the ongoing activity using a request message. @n
+ * Notifies the user about an ongoing activity using a request message. @n
* The request may have various information like alert text, title text, launch arguments, and so on.
*
* @since 2.0
result NotifyOngoingActivityByAppId(const Tizen::App::AppId& appId, const NotificationRequest& request);
/**
- * Removes the notification message for the ongoing activity.
+ * Removes the notification message for an ongoing activity.
*
* @since 2.0
* @privlevel public
result RemoveOngoingActivityNotification(void);
/**
- * Removes the notification message for ongoing activity on behalf of the specified application.
+ * Removes the notification message for an ongoing activity on behalf of the specified application.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/notification @n
* (%http://tizen.org/privilege/notificationmanager is deprecated.)
*
- * @return The current badge number if the method is successful, @n
- * else @c -1 if the method fails
+ * @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_OPERATION_FAILED The operation has failed.
* @return An error code
* @param[in] messageText The notification message
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
* - The specified input parameter is invalid.
- * - The specified @c messageText is empty or the length of the @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * - The specified @c messageText is empty.
+ * - The length of the @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks The message is displayed in the status bar.
result NotifyTextMessage(const Tizen::Base::String& messageText);
/**
- * Notifies the user using a request message and try implicit AppControl resolution when the user selects the message on the notification area. @n
+ * Notifies the user using a request message and tries implicit AppControl resolution when the user selects the message on the notification area. @n
* The request may have various information like alert text, title text, launch arguments, and so on.
*
* @since 2.1
* @param[in] operationId The operation ID
* @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 Tizen::Base::String and the value is of type %Tizen::Base::String to deliver to the resolved application @n
+ * @param[in] pExtraData A pointer to an 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 to deliver to the resolved application @n
* The maximum size is @c 16 kilo bytes.
* @param[in] request The notification request
* @exception E_SUCCESS The method is successful.
const Tizen::Base::Collection::IMap* pExtraData, const NotificationRequest& request);
/**
- * Notifies the user about the ongoing activity using a request message and try implicit AppControl resolution when the user selects the message on the notification area. @n
+ * Notifies the user about an ongoing activity using a request message and tries implicit AppControl resolution when the user selects the message on the notification area. @n
* The request may have various information like alert text, title text, launch arguments, and so on.
*
* @since 2.1
* @param[in] operationId The operation ID
* @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 Tizen::Base::String and the value is of type %Tizen::Base::String to deliver to the resolved application @n
+ * @param[in] pExtraData A pointer to an 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 to deliver to the resolved application @n
* The maximum size is @c 16 kilo bytes.
* @param[in] request The notification request
* @exception E_SUCCESS The method is successful.
* @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.
- * @remarks Internally platform does not have the ownership of this pointer, so caller should manage the listener object properly.
+ * @remarks Internally platform does not have the ownership of this pointer, so the caller should manage the listener object properly.
* @see NotificationManager::Notify()
*/
result AddBadgeEventListener(IBadgeEventListener& listener);
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The listener is not found.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks Internally platform does not have the ownership of this pointer, so caller should manage the listener object properly.
+ * @remarks Internally platform does not have the ownership of this pointer, so the caller should manage the listener object properly.
*/
result RemoveBadgeEventListener(IBadgeEventListener& listener);
*
* @final This class is not intended for extension.
*
- * The %NotificationRequest class provides methods for handling a notification request. The request can contain following
+ * The %NotificationRequest class provides methods for handling a notification request. The request can contain the following
* items:
- * -# Constructing element of the notification area such as a notification title or alert text
+ * -# Constructing an element of the notification area such as a notification title or alert text
* -# Information of the indicator area such as an alert text
- * -# The path of the sound file to play when user selects the notification message of the notification area
- * -# The badge number or badge offset for notification area or main menu
+ * -# The path of the sound file to play when a user selects the notification message of the notification area
+ * -# The badge number or badge offset for the notification area or main menu
*
* %NotificationRequest are of 2 types: bound to an application or not bound to any application. If %NotificationRequest is bound to an application, then
* the associated application is launched by selecting the item in the notification area. Nothing happens when an unbounded %NotificationRequest is selected from a notification area.
*
* @param[in] appBinding Set to @c true to bind %NotificationRequest to the destination application, @n
* else @c false
- * @remarks Selecting the posted notification in the notification area leads to launch of the associated application
+ * @remarks Selecting the posted notification in the notification area leads to the launch of the associated application
* if %NotificationRequest is bound to the destination application.
* @see SetAlertText()
*/
*
* @since 2.0
*
- * @param[in] rhs An instance of %NotificationRequest
+ * @param[in] rhs An instance of %NotificationRequest to copy
*/
NotificationRequest(const NotificationRequest& rhs);
*
* @since 2.0
*
- * @param[in] rhs An instance of %NotificationRequest
+ * @param[in] rhs An instance of %NotificationRequest to copy
*/
NotificationRequest& operator =(const NotificationRequest& rhs);
virtual int GetHashCode(void) const;
/**
- * Gets the badge number of a notification message.
+ * Gets the badge number of the notification message.
*
* @since 2.0
*
int GetBadgeNumber(void) const;
/**
- * Sets the badge number of a notification message. @n
- * %NotificationRequest has either badge number or badge number offset.
- * If the badge number is set using %SetBadgeNumber(), then previous badge offset value is set to @c 0.
+ * Sets the badge number of the notification message. @n
+ * %NotificationRequest has either a badge number or a badge number offset.
+ * If the badge number is set using %SetBadgeNumber(), then the previous badge offset value is set to @c 0.
*
* @since 2.0
*
* @return An error code
* @param[in] value The badge number value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c value is less than @c 0 or greater than Shell::MAX_NOTIFICATION_BADGE_NUMBER.
+ * @exception E_INVALID_ARG The specified @c value is either less than @c 0 or greater than Shell::MAX_NOTIFICATION_BADGE_NUMBER.
*/
result SetBadgeNumber(int value);
/**
- * Gets the badge number offset of a notification message.
+ * Gets the badge number offset of the notification message.
*
* @since 2.0
*
/**
* Sets the badge number offset of the notification message. @n
- * %NotificationRequest has either badge number or badge number offset.
- * If the badge number offset is set using %SetBadgeOffset(), then previous badge number value is set to @c -1 and ignored. @n
+ * %NotificationRequest has either a badge number or a badge number offset.
+ * If the badge number offset is set using %SetBadgeOffset(), then the previous badge number value is set to @c -1 and is ignored. @n
*
- * When posting the notification message, badge offset value is added to the current badge number,
- * which can be acquired by NotificationManager::GetBadgeNumber(). Setting badge offset to @c 0
+ * When posting a notification message, the badge offset value is added to the current badge number,
+ * which can be acquired by NotificationManager::GetBadgeNumber(). Setting the badge offset to @c 0
* means explicitly specifying not to change the current badge value with the notification message.
*
* @since 2.0
result SetBadgeOffset(int value);
/**
- * Gets the alert text of a notification message.
+ * Gets the alert text of the notification message.
*
* @since 2.0
*
Tizen::Base::String GetAlertText(void) const;
/**
- * Sets an alert text of a notification message.
+ * Sets the alert text of the notification message.
*
* @since 2.0
*
* @return An error code
* @param[in] text The alert text
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c text is empty or the length of @c text is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c text is empty.
+ * - The length of the @c text is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
* @remarks
* - @c text is displayed according to the notification layout, and the length of the @c text depends on the font attributes or the variable font width.
* - @c text is mandatory for a notification.
result SetAlertText(const Tizen::Base::String& text);
/**
- * Gets the application message of a notification message.
+ * Gets the application message of the notification message.
*
* @since 2.0
*
- * @return The message for application
+ * @return The message for the application
*/
Tizen::Base::String GetAppMessage(void) const;
/**
- * Sets the application message of a notification message. @n
+ * Sets the application message of the notification message. @n
* @c appMessage is delivered as the value of the %http://tizen.org/appcontrol/data/notification key
* for Tizen::App::IAppControlProviderEventListener::OnAppControlRequestReceived().
*
* @return An error code
* @param[in] appMessage The message for the application
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c appMessage is empty or the length of the @c appMessage is greater than Shell::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c appMessage is empty.
+ * - The length of the @c appMessage is greater than Shell::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH.
* @exception E_INVALID_OPERATION This instance is not bound to the application.
* @remarks This method returns @c E_INVALID_OPERATION if the %NotificationRequest instance is not bound to the application.
*/
result SetAppMessage(const Tizen::Base::String& appMessage);
/**
- * Gets the title text of a notification message.
+ * Gets the title text of the notification message.
*
* @since 2.0
*
Tizen::Base::String GetTitleText(void) const;
/**
- * Sets the title text of a notification message.
+ * Sets the title text of the notification message.
*
* @since 2.0
*
* @return An error code
* @param[in] title The title text
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c title is empty or the length of the @c title is greater than Shell::MAX_NOTIFICATION_TITLE_LENGTH.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c title is empty.
+ * - The length of the @c title is greater than Shell::MAX_NOTIFICATION_TITLE_LENGTH.
* @remarks If the @c title is not set, the application name is displayed.
*/
result SetTitleText(const Tizen::Base::String& title);
/**
- * Gets the file path of the icon image for a notification message.
+ * Gets the file path of the icon image for the notification message.
*
* @since 2.0
*
- * @return The file path of an icon image
+ * @return The file path of the icon image
*/
Tizen::Base::String GetIconFilePath(void) const;
/**
- * Sets the file path of the icon image for a notification message.
+ * Sets the file path of the icon image for the notification message.
*
* @since 2.0
*
* @return An error code
- * @param[in] iconPath The file path of the icon image
- * @exception E_SUCCESS The method is successful.
+ * @param[in] iconPath The file path of the icon image
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified path is invalid.
* @remarks If the @c iconPath is not set, the application icon is displayed.
* The @c iconPath should start with the directory path returned by Tizen::App::App::GetAppSharedPath().
result SetIconFilePath(const Tizen::Base::String& iconPath);
/**
- * Gets the file path of a sound file that is played for the notification message.
+ * Gets the file path of the sound file that is played for the notification message.
*
* @since 2.0
*
Tizen::Base::String GetSoundFilePath(void) const;
/**
- * Sets the file path of the sound file that is played for the notification message.
+ * Sets the file path of the sound file that is played for a notification message.
*
* @since 2.0
*
OngoingActivityType GetOngoingActivityType(void) const;
/**
- * Sets the notification type for an ongoing activity.
+ * Sets the notification type for the ongoing activity.
*
* @since 2.0
*
* @return An error code
- * @param[in] type The notification type for an ongoing activity
+ * @param[in] type The notification type for the ongoing activity
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The current progress value is not compatible to the specified @c type.
* @remarks This information is only meaningful when the %NotificationRequest instance is delivered to the NotificationManager::NotifyOngoingActivity() method.
result SetOngoingActivityType(OngoingActivityType type = ONGOING_ACTIVITY_TYPE_TEXT);
/**
- * Gets the progress value for an ongoing activity notification.
+ * Gets the progress value for the ongoing activity notification.
*
* @since 2.0
*
* @return An error code
* @param[in] value The progress value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The specified @c value is less than @c 0.
- * - The specified @c value does not lie between @c 0 and @c 100 for Shell::ONGOING_ACTIVITY_TYPE_PROGRESS_PERCENTAGE.
- * - The notification type for an ongoing activity is not set.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c value is less than @c 0.
+ * - The specified @c value does not lie between @c 0 and @c 100 for Shell::ONGOING_ACTIVITY_TYPE_PROGRESS_PERCENTAGE.
+ * - The notification type for an ongoing activity is not set.
* @exception E_INVALID_OPERATION This instance is in an invalid state. @n
* OngoingActivityType must be either Shell::ONGOING_ACTIVITY_TYPE_PROGRESS_BYTE or Shell::ONGOING_ACTIVITY_TYPE_PROGRESS_PERCENTAGE.
* @see SetOngoingActivityType()
result SetOngoingActivityProgress(int value);
/**
- * Gets the style of a notification message.
+ * Gets the style of the notification message.
*
* @since 2.1
*
NotificationStyle GetNotificationStyle(void) const;
/**
- * Sets the style of a notification message.
+ * Sets the style of the notification message.
*
* @since 2.1
*
result SetNotificationStyle(NotificationStyle style);
/**
- * Gets a list of message text for a notification message.
+ * Gets the list of message texts for the notification message.
*
* @since 2.1
*
- * @return A string list of message text
+ * @return The string list of message texts
*/
Tizen::Base::Collection::IList* GetMessageTextListN(void) const;
/**
- * Sets a string list of message text for a notification message.
+ * Sets the string list of message texts for the notification message.
*
* @since 2.1
*
* @return An error code
- * @param[in] pTextList A list of message text
+ * @param[in] pTextList The string list of message texts
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c pTextList is empty or the length of @c pTextList is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
- * @remarks This information is only meaningful when the notification style is Shell::NOTIFICATION_STYLE_NORMAL. @n
- * Use the tab(\\t) character to separate the columns.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c pTextList is empty.
+ * - The length of @c pTextList is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * @remarks
+ * - This information is only meaningful when the notification style is Shell::NOTIFICATION_STYLE_NORMAL. @n
+ * - Use the tab(\\t) character to separate the columns.
*/
result SetMessageTextList(const Tizen::Base::Collection::IList* pTextList);
/**
- * Gets a list of the message thumbnail image absolute file path for a notification message.
+ * Gets the list of message thumbnail image absolute file paths for the notification message.
*
* @since 2.1
*
- * @return A string list of thumbnail image file path
+ * @return The string list of thumbnail image file paths
*/
Tizen::Base::Collection::IList* GetMessageThumbnailFilePathListN(void) const;
/**
- * Sets a string list of the message thumbnail image absolute file path for a notification message.
+ * Sets the string list of message thumbnail image absolute file paths for the notification message.
*
* @since 2.1
*
* @return An error code
- * @param[in] pThumbnailPathList A list of the thumbnail image file path
+ * @param[in] pThumbnailPathList The list of thumbnail image file paths
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified path is invalid.
- * @remarks This information is only meaningful when the notification style is Shell::NOTIFICATION_STYLE_THUMBNAIL.
- * The path of the thumbnail image should start with the directory path returned by Tizen::App::App::GetAppSharedPath().
+ * @remarks
+ * - This information is only meaningful when the notification style is Shell::NOTIFICATION_STYLE_THUMBNAIL.
+ * - The path of the thumbnail image should start with the directory path returned by Tizen::App::App::GetAppSharedPath().
*/
result SetMessageThumbnailFilePathList(const Tizen::Base::Collection::IList* pThumbnailPathList);
/**
- * Gets the notification count text of a notification message.
+ * Gets the notification count text of the notification message.
*
* @since 2.1
*
Tizen::Base::String GetNotificationCountText(void) const;
/**
- * Sets the notification count text of a notification message.
+ * Sets the notification count text of the notification message.
*
* @since 2.1
*
* @return An error code
* @param[in] notificationCountText The notification count text
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c notificationCountText is empty or the length of @c notificationCountText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c notificationCountText is empty.
+ * - The length of @c notificationCountText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
* @remarks This information is only meaningful when the notification style is Shell::NOTIFICATION_STYLE_NORMAL.
*/
result SetNotificationCountText(const Tizen::Base::String& notificationCountText);
/**
- * Gets the absolute file path of the background image for a notification message.
+ * Gets the absolute file path of the background image for the notification message.
*
* @since 2.1
*
- * @return The file path of a background image file
+ * @return The file path of the background image file
*/
Tizen::Base::String GetBackgroundImageFilePath(void) const;
/**
- * Sets the absolute file path of the background image for a notification message.
+ * Sets the absolute file path of the background image for the notification message.
*
* @since 2.1
*
result SetBackgroundImageFilePath(const Tizen::Base::String& imagePath);
/**
- * Gets the properties of a notification light operation.
+ * Gets the properties of the notification light operation.
*
* @since 2.2
*
void GetLight(Tizen::Graphics::Color& color, int& onTime, int& offTime) const;
/**
- * Sets the properties of a notification light operation.
+ * Sets the properties of the notification light operation.
*
* @since 2.2
*
* @remarks
* - This method has effects only on devices with notification light.
* - The light flash continuously toggles on (@c onTime) and off (@c offTime).
- * - To turn the light off, set Color(0, 0, 0, 0) to @c color or set @c 0 to @c onTime.
+ * - To turn the light off, set @c color to Color(0, 0, 0, 0) or set @c onTime to @c 0.
*/
result SetLight(const Tizen::Graphics::Color& color, int onTime, int offTime);
//
/**
-* @file FShellQuickPanelFrame.h
+* @file FShellQuickPanelFrame.h
* @brief This is the header file for the %QuickPanelFrame class.
*
* This header file contains the declarations of the %QuickPanelFrame class.
/**
* @class QuickPanelFrame
* @brief This class is an implementation of a %QuickPanelFrame.
-* @since 2.0
+* @since 2.0
*
* The %QuickPanelFrame class provides the main container for a QuickPanel panel.
* It is an ultimate parent of all %QuickPanel controls.
/**
* Initializes this instance of %QuickPanelFrame with a specified parameter.
*
- * @since 2.0
- * @privlevel public
+ * @since 2.0
+ * @privlevel public
* @privilege %http://tizen.org/privilege/notification
*
* @return An error code
- * @param[in] height The height of %QuickPanelFrame
- * @exception E_SUCCESS The method is successful.
+ * @param[in] height The height of %QuickPanelFrame
+ * @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 @c height is less than or equal to @c 0.
+ * @exception E_INVALID_ARG The specified @c height is less than or equal to @c 0.
*/
result Construct(int height);
* If it fails to find the resource file, it searches in other folders in the following order when CoordinateSystem is Logical in the application manifest file @n
* the density folder that corresponds to the current screen size category @b "res/screen-size-normal/" folder.
*
- * @since 2.0
- * @privlevel public
+ * @since 2.0
+ * @privlevel public
* @privilege %http://tizen.org/privilege/notification
*
- * @return An error code
- * @param[in] resourceId The resource ID describing the %QuickPanelFrame control
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] resourceId The resource ID describing the %QuickPanelFrame control
+ * @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 file corresponding to the specified @c resourceId cannot be found.
* @exception E_INVALID_FORMAT The file format corresponding to the specified @c resourceId is invalid.
/**
* Initializes this instance of %QuickPanelFrame with the specified parameters.
*
- * @since 2.0
- * @privlevel public
+ * @since 2.0
+ * @privlevel public
* @privilege %http://tizen.org/privilege/notification
*
* @return An error code
- * @param[in] layout The layout for both the portrait and landscape mode
- * @param[in] height The height of %QuickPanelFrame
- * @exception E_SUCCESS The method is successful.
+ * @param[in] layout The layout for both the portrait and landscape mode
+ * @param[in] height The height of %QuickPanelFrame
+ * @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 @c height is less than or equal to @c 0.
*/
/**
* Constructs and initializes an instance of %QuickPanelFrame with the specified parameters.
*
- * @since 2.0
- * @privlevel public
+ * @since 2.0
+ * @privlevel public
* @privilege %http://tizen.org/privilege/notification
*
* @return An error code
* @param[in] portraitLayout The layout for the portrait mode
- * @param[in] landscapeLayout The layout for the landscape mode
- * @param[in] height The height of %QuickPanelFrame
- * @exception E_SUCCESS The method is successful.
+ * @param[in] landscapeLayout The layout for the landscape mode
+ * @param[in] height The height of %QuickPanelFrame
+ * @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 @c height is less than or equal to @c 0.
*/
result Construct(const Tizen::Ui::Layout& portraitLayout, const Tizen::Ui::Layout& landscapeLayout, int height);
- /*
+ /**
* Initializes this instance of %QuickPanelFrame with the specified parameter.
*
* @since 2.1
* @privilege %http://tizen.org/privilege/notification
*
* @return An error code
- * @param[in] height The height of %QuickPanelFrame
- * @exception E_SUCCESS The method is successful.
+ * @param[in] height The height of %QuickPanelFrame
+ * @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 @c height is less than or equal to @c 0.0f.
*/
result Construct(float height);
- /*
+ /**
* Initializes this instance of %QuickPanelFrame with the specified parameters.
*
* @since 2.1
* @privilege %http://tizen.org/privilege/notification
*
* @return An error code
- * @param[in] layout The layout for both the portrait and landscape mode
- * @param[in] height The height of %QuickPanelFrame
- * @exception E_SUCCESS The method is successful.
+ * @param[in] layout The layout for both the portrait and landscape mode
+ * @param[in] height The height of %QuickPanelFrame
+ * @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 @c height is less than or equal to @c 0.0f.
*/
result Construct(const Tizen::Ui::Layout& layout, float height);
- /*
+ /**
* Constructs and initializes an instance of %QuickPanelFrame with the specified parameters.
*
* @since 2.1
*
* @return An error code
* @param[in] portraitLayout The layout for the portrait mode
- * @param[in] landscapeLayout The layout for the landscape mode
- * @param[in] height The height of %QuickPanelFrame
- * @exception E_SUCCESS The method is successful.
+ * @param[in] landscapeLayout The layout for the landscape mode
+ * @param[in] height The height of %QuickPanelFrame
+ * @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 @c height is less than or equal to @c 0.0f.
*/
/**
* Adds an IOrientationEventListener instance. @n
- * The added listener can listen to the orientation changed events that are fired when the orientation mode of the screen is changed.
+ * The added listener can listen to the orientation change events that are fired when the orientation mode of the screen is changed.
*
* @since 2.0
*
* @param[in] listener The listener to add @n
- * The listener must be allocated at heap, not stack.
+ * The listener must be allocated as a heap and not a stack.
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_ALREADY_EXIST The listener is already added.
+ * @exception E_OBJ_ALREADY_EXIST The listener is already added.
* @see RemoveOrientationEventListener()
*/
result AddOrientationEventListener(Tizen::Ui::IOrientationEventListener& listener);
/**
* Removes an IOrientationEventListener instance. @n
- * The removed listener cannot listen to the events when they are fired.
+ * The removed listener cannot listen to the events that are fired.
*
* @since 2.0
*
* @param[in] listener The listener to remove @n
- * The listener should be referring to previously allocated instance that is passed as an argument to AddOrientationEventListener().
+ * The listener should be referring to a previously allocated instance that is passed as an argument to AddOrientationEventListener().
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified @c listener is not found.
* @see AddOrientationEventListener()
*
* @since 2.0
*
- * @return An error code
- * @param[in] height The height of %QuickPanelFrame
- * @exception E_SUCCESS The method was successful.
+ * @return An error code
+ * @param[in] height The height of %QuickPanelFrame
+ * @exception E_SUCCESS The method was successful.
* @exception E_INVALID_ARG The @c height is less than or equal to @c 0.
*/
result SetHeight(int height);
- /*
- * Sets the height of the %QuickPanelFrame.
+ /**
+ * Sets the height of %QuickPanelFrame.
*
* @since 2.1
* @return An error code
- * @param[in] height The height of %QuickPanelFrame
- * @exception E_SUCCESS The method was successful.
- * @exception E_INVALID_ARG The @c height is less than or equal to @c 0.0f.
+ * @param[in] height The height of %QuickPanelFrame
+ * @exception E_SUCCESS The method was successful.
+ * @exception E_INVALID_ARG The @c height is less than or equal to @c 0.
*/
result SetHeight(float height);
*
* @since 2.1
*
- * @return A pointer to the %ShortcutManager instance, @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.
+ * @return A pointer to the %ShortcutManager instance, @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 The specific error code can be accessed using the GetLastResult() method.
*/
static ShortcutManager* GetInstance(void);
* @privlevel public
* @privilege %http://tizen.org/privilege/shortcut.install
*
- * @return An error code
- * @param[in] appId The application ID
- * @param[in] displayName The display name of shortcut
- * @param[in] iconPath The icon file path
- * @param[in] uriData Uri that will be delivered by Tizen::App::IAppControlProviderEventListener::OnAppControlRequestReceived(), when the application is started using a shortcut.
- * @param[in] allowDuplication Flag to allow duplicate shortcut
+ * @return An error code
+ * @param[in] appId The application ID
+ * @param[in] displayName The display name of the shortcut
+ * @param[in] iconPath The icon file path
+ * @param[in] uriData Uri that is delivered by Tizen::App::IAppControlProviderEventListener::OnAppControlRequestReceived(), when the application is started using a shortcut.
+ * @param[in] allowDuplication Flag to allow a duplicate shortcut
*
* @exception E_SUCCESS The method is successful.
* @exception E_APP_NOT_INSTALLED The application is not installed.
* @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
- * - Icon file should be placed in sub directory of 'shared/res' to be used by the Home app. @n
- * For more information on shared directory, see <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/io_overview.htm">I/O Overview</a>
+ * @remarks
+ * - The icon file should be placed in the sub directory of 'shared/res' to be used by the Home app. @n
+ * For more information on shared directory, see <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/io_overview.htm">I/O Overview</a>
* and see <a href="../org.tizen.native.appprogramming/html/app_dev_process/manifest_general.htm">General Information</a> for icon file.
- * - If @c uriData is specified, application will be started by AppControl with %http://tizen.org/appcontrol/operation/view operation, when it is launched from the Home app using a shortcut.
- * Or else application will be started by AppControl with default operation(%http://tizen.org/appcontrol/operation/main). @n
+ * - If @c uriData is specified, the application is started by AppControl with %http://tizen.org/appcontrol/operation/view operation, when it is launched from the Home app using a shortcut.
+ * Or else application it is started by AppControl with the default operation(%http://tizen.org/appcontrol/operation/main). @n
* For more information on this, see <a href="../org.tizen.native.appprogramming/html/guide/app/delivering_launch_arguments.htm">Delivering Launch Arguments</a>.
*
* @see Tizen::App::IAppControlProviderEventListener::OnAppControlRequestReceived()
* @see IShortcutRequestListener::OnShortcutAddRequested()
*
- * The following example demonstrates how to add shortcut.
+ * The following example demonstrates how to add a shortcut.
*
* @code
* #include <FApp.h>
* @privlevel public
* @privilege %http://tizen.org/privilege/shortcut.install
*
- * @return An error code
- * @param[in] appId The application ID
- * @param[in] displayName The display name of shortcut
+ * @return An error code
+ * @param[in] appId The application ID
+ * @param[in] displayName The display name of the shortcut
* @exception E_SUCCESS The method is successful.
* @exception E_APP_NOT_INSTALLED The application is not installed.
* @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 If there are more than one shortcuts with duplicated @c appId and @c displayName in the Home app, all of them will be removed.
+ * @remarks If there is more than one shortcut with duplicate @c appId and @c displayName in the Home app, all of them are removed.
*
* @see IShortcutRequestListener::OnShortcutRemoveRequested()
*/
// limitations under the License.
//
/**
- * @file FShellTypes.h
+ * @file FShellTypes.h
* @brief This is the header file for the definitions of constants and enumerators in the %Shell namespace.
*
- * This header file contains definitions for the constants and enumerators in the %Shell namespace.
+ * This header file contains definitions for the constants and enumerators in the Shell namespace.
*/
#ifndef _FSHELL_TYPES_H_
projects / platform / framework / native / shell.git / commitdiff