/**
* @class AppWidgetFrame
- * @brief This class provides the main frame window for a AppWidgetProvider.
+ * @brief This class provides the main frame window for an AppWidgetProvider.
* @since 2.1
*
- * The %AppWidgetFrame class provides the main frame window for a AppWidgetProvider. This class is the root parent of all AppWidget controls that are created by a AppWidgetProvider.
+ * The %AppWidgetFrame class is the root parent of all AppWidget controls that are created by an AppWidgetProvider.
*
*/
class _OSP_EXPORT_ AppWidgetFrame
{
public:
/**
- * The object is not fully constructed after this constructor is called.
+ * The object is not fully constructed after this constructor is called. @n
* For full construction, the Construct() method must be called right after calling this constructor.
*
* @since 2.1
virtual ~AppWidgetFrame(void);
/**
- * Initializes this instance of %AppWidgetFrame with the specified parameter.
+ * Initializes this instance of %AppWidgetFrame with a specified parameter.
*
* @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 A specified input parameter is invalid.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @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&).
result Construct(const Tizen::Graphics::FloatDimension& size);
/**
- * Initializes this instance of %AppWidgetFrame with the specified parameter.
+ * Initializes this instance of %AppWidgetFrame with a specified parameter.
*
* @since 2.1
* @feature %http://tizen.org/feature/shell.appwidget
* @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.
+ * @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&).
* @since 2.1
*
* @feature %http://tizen.org/feature/shell.appwidget
- *
- * @return A pointer to the %AppWidgetManager instance, @n
- * else @c null if it fails
- *
+ * @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.
+ * @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 - The specific error code can be accessed using the GetLastResult() method.
- * - Before calling this method, check whether the feature is supported by
+ * @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&).
*/
static AppWidgetManager* GetInstance(void);
Tizen::Base::Collection::IList* GetAppWidgetProviderInfoListN(void) const;
/**
- * Gets a AppWidgetProviderInfo of the specified AppWidget provider.
+ * Gets an AppWidgetProviderInfo of the specified AppWidget provider.
*
* @since 2.1
*
AppWidgetProviderInfo* GetAppWidgetProviderInfoN(const Tizen::App::AppId& appId, const Tizen::Base::String& providerName) const;
/**
- * Gets the AppWidgetProviderInfo of the default AppWidget provider in the package.
+ * Gets an AppWidgetProviderInfo of the default AppWidget provider in the package.
*
* @since 2.1
*
AppWidgetProviderInfo* GetDefaultAppWidgetProviderInfoN(const Tizen::App::PackageId& packageId) const;
/**
- * Sets a AppWidget request listener. @n
+ * 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.
*
/**
* @class AppWidgetPopup
- * @brief This class provides the popup for a AppWidgetProvider.
+ * @brief This class provides the popup for an AppWidgetProvider.
* @since 2.1
*
- * The %AppWidgetPopup class supports detailed screen for a AppWidgetProvider.
+ * The %AppWidgetPopup class supports detailed screen for an AppWidgetProvider.
*
*/
class _OSP_EXPORT_ AppWidgetPopup
{
public:
/**
- * The object is not fully constructed after this constructor is called.
+ * The object is not fully constructed after this constructor is called. @n
* For full construction, the Construct() method must be called right after calling this constructor.
*
* @since 2.1
virtual ~AppWidgetPopup(void);
/**
- * Initializes this instance of %AppWidgetPopup with the specified parameter.
+ * Initializes this instance of %AppWidgetPopup with a specified parameter.
*
* @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 A specified input parameter is invalid.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @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&).
result Construct(const Tizen::Graphics::FloatDimension& size);
/**
- * Initializes this instance of %AppWidgetPopup with the specified parameter.
+ * Initializes this instance of %AppWidgetPopup with a specified parameter.
*
* @since 2.1
* @feature %http://tizen.org/feature/shell.appwidget
* @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.
+ * @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&).
* else @c null if an error occurs
* @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
+ * @remarks
+ * - 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.
- * @remarks 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.
- * @remarks 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;
/**
- * Translates the specified position to the client coordinates.
+ * Translates a specified position to the client coordinates.
*
* @since 2.1
*
- * @return The float position in relative to the top-left corner of the client-area, @n
+ * @return The float position in 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.
+ * @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 the specified client position to the control coordinate.
+ * Translates a specified client position to the control coordinate.
*
* @since 2.1
*
- * @return The float position in relative to the top-left corner of the %Popup control, @n
+ * @return The float position in 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()
/**
* @file FShellAppWidgetPopupProvider.h
- * @brief This is the header file for the AppWidgetPopupProvider class.
+ * @brief This is the header file for the %AppWidgetPopupProvider class.
*
* This header file contains the declarations of the %AppWidgetPopupProvider class.
*/
/**
* @class AppWidgetPopupProvider
- * @brief This class is the abstract base class of all AppWidget popup provider
+ * @brief This class is the abstract base class of all the AppWidget popup providers.
*
* @since 2.1
*
- * The %AppWidgetPopupProvider class is a base class which represents a AppWidget popup provider
+ * The %AppWidgetPopupProvider class is a base class that represents an AppWidget popup provider.
*/
class _OSP_EXPORT_ AppWidgetPopupProvider
: public Tizen::Base::Object
virtual ~AppWidgetPopupProvider(void);
/**
- * Called when the AppWidget popup provider is required to be created @n
+ * Called when the AppWidget popup provider is required to be created.
*
* @since 2.1
*
- * @param[in] userInfo User information that specifed when the AppWidget is added
* @return @c true if the method is successful, @n
* else @c false
- *
- * @remarks AppWidgetPopup should be created and set here
- * @see SetAppWidgetPopup
+ * @param[in] userInfo User information that specifies when the AppWidget is added
+ * @remarks AppWidgetPopup should be created and set here.
+ * @see SetAppWidgetPopup()
*/
virtual bool OnAppWidgetPopupProviderInitializing(const Tizen::Base::String& userInfo) = 0;
/**
- * Called when the AppWidget popup provider is required to be destroyed @n
+ * Called when the AppWidget popup provider is required to be destroyed.
*
* @since 2.1
*/
virtual void OnAppWidgetPopupProviderTerminating(void) = 0;
/**
- * Sets the AppWidget popup to the AppWidget popup provider
+ * Sets the AppWidget popup to the AppWidget popup provider.
*
* @since 2.1
*
* @return An error code
- * @param[in] pAppWidgetPopup The pointer to AppWidgetPopup instance to be set to the AppWidget
+ * @param[in] pAppWidgetPopup The pointer to the AppWidgetPopup instance that is set to AppWidget
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The pointer to the AppWidgetFrame is null, or not constructed yet.
+ * @exception E_INVALID_ARG The pointer to AppWidgetFrame is @c null, or not constructed as yet.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- *
- * @remarks This function should be called only in OnAppWidgetPopupProviderInitializing.
- * @remarks AppWidgetPopup instance ownership is transferred to platform. After AppWidgetPopupProvider::OnAppWidgetPopupProviderTerminating() is called, AppWidgetPopup instance is removed automatically. AppWidgetPopup instance reuse is not allowed.
+ * @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.
*/
result SetAppWidgetPopup(Tizen::Shell::AppWidgetPopup* pAppWidgetPopup);
/**
- * Gets the AppWidget popup
+ * Gets the AppWidget popup.
*
* @since 2.1
*
- * @return The AppWidgetPopup instnace, or null if any AppWidgetPopup is set yet.
+ * @return The AppWidgetPopup instance, @n
+ * else @c null if any %AppWidgetPopup is not set as yet
*/
Tizen::Shell::AppWidgetPopup* GetAppWidgetPopup(void);
/**
- * Gets the AppWidget popup from the AppWidget
+ * Gets the AppWidget popup from the AppWidget.
*
* @since 2.1
*
- * @return The AppWidgetPopup instnace, or null if any AppWidgetPopup is set yet.
+ * @return The AppWidgetPopup instance, @n
+ * else @c null if any %AppWidgetPopup is not set as yet
*/
const Tizen::Shell::AppWidgetPopup* GetAppWidgetPopup(void) const;
/**
* @file FShellAppWidgetProvider.h
- * @brief This is the header file for the AppWidgetProvider class.
+ * @brief This is the header file for the %AppWidgetProvider class.
*
- * This header file contains the declarations of the %AppManager class.
+ * This header file contains the declarations of the %AppWidgetProvider class.
*/
#ifndef _FSHELL_APPWIDGET_PROVIDER_H_
*
* @since 2.1
*
- * The %AppWidgetProvider class is an abstract base class, which represents a AppWidget provider.
+ * The %AppWidgetProvider class is an abstract base class that represents an AppWidget provider.
*/
class _OSP_EXPORT_ AppWidgetProvider
: public Tizen::Base::Object
*
* @since 2.1
*
+ * @return @c true if the method is successful, @n
+ * else @c false
* @param[in] width The width of the AppWidget
* @param[in] height The height of the AppWidget
* @param[in] userInfo User information that is specified when the AppWidget is added
- *
- * @return @c true if the method is successful, @n
- * else @c false
- *
* @remarks AppWidgetFrame should be created and set here.
* @see SetAppWidgetFrame()
*
*
* @since 2.1
*
- * @param[in] argument User information to update the AppWidget provider @n
- * This parameter is delivered from AppWidgetProvider::RequestUpdate().
- *
* @return @c true if the method is successful, @n
* else @c false
- *
- * @remarks This method is called when UpdatePeriod timer is expired or AppWidgetManager::RequestUpdate() is called.@n
+ * @param[in] argument User information to update the AppWidget provider @n
+ * This parameter is delivered from AppWidgetProvider::RequestUpdate().
+ * @remarks This method is called when UpdatePeriod timer is expired or AppWidgetManager::RequestUpdate() is called.
*/
virtual bool OnAppWidgetProviderUpdating(const Tizen::Base::String& argument) = 0;
/**
- * Sets the AppWidgetFrame instance to the AppWidgetProvider instance.
+ * Sets the AppWidgetFrame instance to the %AppWidgetProvider instance.
*
* @since 2.1
*
* @return An error code
- * @param[in] pAppWidgetFrame The AppWidgetFrame instance to set as the AppWidgetProvider instance
+ * @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_SYSTEM The method cannot proceed due to a severe system error.
- *
- * @remarks This method should be called only within the OnAppWidgetProviderInitializing() method.
- * @remarks The AppWidgetFrame instance ownership is transferred to the platform. After AppWidgetProvider::OnAppWidgetProviderTerminating() is called, the AppWidgetPopup instance is removed automatically. The %AppWidgetFrame instance reuse is not allowed.
+ * @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 AppWidgetPopup instance is removed automatically. The %AppWidgetFrame instance reuse is not allowed.
*/
result SetAppWidgetFrame(AppWidgetFrame* pAppWidgetFrame);
/**
- * Gets the AppWidgetFrame instance from the AppWidgetProvider instance.
+ * Gets the AppWidgetFrame instance from the %AppWidgetProvider instance.
*
* @since 2.1
*
- * @return The AppWidgetFrame instance, or @c null if any %AppWidgetFrame is not set yet
+ * @return The AppWidgetFrame instance, @n
+ * else @c null if any %AppWidgetFrame is not set as yet
*/
AppWidgetFrame* GetAppWidgetFrame(void);
/**
- * Gets the AppWidgetFrame instance from the AppWidgetProvider instance.
+ * Gets the AppWidgetFrame instance from the %AppWidgetProvider instance.
*
* @since 2.1
*
- * @return The AppWidgetFrame instance, or @c null if any %AppWidgetFrame is not set yet
+ * @return The AppWidgetFrame instance, @n
+ * else @c null if any %AppWidgetFrame is not set as yet
*/
const AppWidgetFrame* GetAppWidgetFrame(void) const;
*
* @since 2.1
*
- * @return The application name
+ * @return The provider name
*/
Tizen::Base::String GetName(void) const;
/**
- * Gets the display name of a AppWidget. @n
+ * Gets the display name of an AppWidget. @n
* If the system language setting is changed, the %GetDisplayName() method returns the localized application name.
- * The display name is displayed in applications that showing AppWidget such as Launcher, and so on.
+ * The display name is displayed in applications showing AppWidget such as Launcher, and so on.
*
* @since 2.1
*
- * @return The display name of a AppWidget
+ * @return The display name of an AppWidget
*/
Tizen::Base::String GetDisplayName(void) const;
bool IsDefault(void) const;
/**
- * Gets a list of AppWidgetSizeInfo of a AppWidget.
+ * Gets a list of AppWidgetSizeInfo of an AppWidget.
*
* @since 2.1
*
result RequestUpdate(const Tizen::App::AppId& appId, const Tizen::Base::String& providerName, const Tizen::Base::String& argument = L"");
/**
- * Requests a AppWidget viewer (for example, Home screen, Lock screen) to add the specified AppWidget.
+ * Requests an AppWidget viewer (for example, Home screen, Lock screen) to add the specified AppWidget.
*
* @since 2.1
* @privlevel public
* @privilege %http://tizen.org/privilege/appwidgetprovider.install
*
* @param[in] providerAppId The ID of the application providing AppWidget
- * @param[in] providerName The name of AppWidget provider to add
- * @param[in] alternateText Alternate text displayed in the AppWidgetView while the AppWidgetProvider is initializing or unavailable.
+ * @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_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 add AppWidget of other application package. @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 a AppWidget viewer to add a AppWidget, AppWidget provider should support 1x1 size AppWidget, but the specified AppWidget provider does not support 1x1 size.
+ * 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.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- *
- * @remarks Only AppWidget provider that is packaged with the caller application can be added by this method.
+ * @remarks Only the AppWidget provider that is packaged with the caller application can be added by this method.
* @see AppWidgetManager::SetAppWidgetRequestListener()
*/
result AddAppWidget(const Tizen::App::AppId& providerAppId, const Tizen::Base::String& providerName, const Tizen::Base::String& alternateText, const Tizen::Base::String& userInfo);
/**
- * Sets a AppWidgetProvider factory. @n
+ * Sets an AppWidgetProvider factory. @n
* The factory is called when 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.
result SetAppWidgetProviderFactory(IAppWidgetProviderFactory& factory);
/**
- * Sets a AppWidgetPopupProvider factory. @n
+ * Sets an AppWidgetPopupProvider factory. @n
* The factory is called when 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.
/**
* @class AppWidgetView
- * @brief This class provides the view control for a AppWidgetViewer.
+ * @brief This class provides the view control for an AppWidgetViewer.
* @since 2.1
*
* The %AppWidgetView class shows a drawn buffer by AppWidgetProvider.
{
public:
/**
- * The object is not fully constructed after this constructor is called.
+ * The object is not fully constructed after this constructor is called. @n
* For full construction, the Construct() method must be called right after calling this constructor.
*
* @since 2.1
* @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. @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.
+ * @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&).
* @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. @n
- * @param[in] userInfo Extra data to deliver to AppWidget provider
+ * 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.
+ * @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&).
result Construct(const Tizen::App::AppId& appId, const Tizen::Base::String& providerName, const Tizen::Graphics::FloatRectangle& rect, const Tizen::Base::String& userInfo);
/**
- * Gets a AppWidgetProviderInfo of the specified AppWidget provider.
- *
- * @since 2.1
- *
- * @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.
- * @exception E_OBJ_NOT_FOUND The specified AppWidget provider is not found.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- */
+ * Gets an AppWidgetProviderInfo of the specified AppWidget provider.
+ *
+ * @since 2.1
+ *
+ * @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.
+ * @exception E_OBJ_NOT_FOUND The specified AppWidget provider is not found.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
+ */
AppWidgetProviderInfo* GetAppWidgetProviderInfoN(void) const;
/**
/**
* @interface IAppWidgetPopupProviderFactory
- * @brief This interface defines the factory for the %AppWidgetPopupProvider creation
+ * @brief This interface is the factory interface for creating the AppWidgetPopupProvider instance.
*
* @since 2.1
*
- * The %IAppWidgetPopupProviderFactory is the factory interface for creating the %AppWidgetPopupProvider instance.
- * The %AppWidgetManager calls CreateInstance() when an instance of %IAppWidgetPopupProvider is required.
+ * The %IAppWidgetPopupProviderFactory interface is the factory interface for creating the AppWidgetPopupProvider instance.
+ * The AppWidgetManager instance calls CreateInstance() when an instance of IAppWidgetPopupProvider is required.
*
* @see AppWidgetManager
*/
virtual ~IAppWidgetPopupProviderFactory(void) {};
/**
- * Creates a AppWidgetPopupProvider instance. @n
+ * Creates an AppWidgetPopupProvider instance. @n
* Called when the %AppWidgetPopupProvider creation request is received from the appwidget service. @n
* Applications that provide the AppWidget functionality must implement this listener.
*
* @since 2.1
*
- * @param[in] providerName The AppWidget provider name
- * @param[in] userInfo User information that specified when the AppWidget is added
+ * @param[in] providerName The name of the AppWidget provider
+ * @param[in] userInfo User information that specifies when the AppWidget is added
*/
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 AppWidgetManager calls CreateInstance() when an instance of %AppWidgetProvider is required.
+ * The AppWidgetManager instance calls CreateInstance() when an instance of %AppWidgetProvider is required.
* Applications that provide the %AppWidgetProvider functionality must implement this interface.
*
* @see AppWidgetManager
*
* @since 2.1
*
- * @param[in] providerName The AppWidget provider name
+ * @param[in] providerName The name of the AppWidget provider
* @param[in] width The width of the AppWidget
* @param[in] height The height of the AppWidget
- * @param[in] userInfo User information that specifes when the AppWidget is added
+ * @param[in] userInfo User information that specifies when the AppWidget is added
*/
virtual AppWidgetProvider* CreateInstance(const Tizen::Base::String& providerName, float width, float height, const Tizen::Base::String& userInfo) = 0;
/**
* @interface IAppWidgetRequestListener
- * @brief This interface defines a listener for a AppWidget viewer (for example, Home screen, Lock screen) that receives request to add AppWidget.
+ * @brief This interface defines a listener for an AppWidget viewer (for example, Home screen, Lock screen) that receives request to add AppWidget.
*
* @since 2.1
*
- * The %IAppWidgetRequestListener interface defines a listener for a AppWidget viewer (for example, Home screen, Lock screen) that receives request to add AppWidget.
+ * The %IAppWidgetRequestListener interface defines a listener for an AppWidget viewer (for example, Home screen, Lock screen) that receives request to add AppWidget.
*/
class _OSP_EXPORT_ IAppWidgetRequestListener
: virtual public Tizen::Base::Runtime::IEventListener
virtual ~IAppWidgetRequestListener(void) {}
/**
- * Called when requested to add a AppWidget. @n
- * The AppWidget viewer application such as the Home screen can get callback request to add a AppWidget by implementing this listener.
+ * 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.
*
* @since 2.1
*
* @param[in] appId The application ID of the application providing AppWidget
- * @param[in] providerName The name of AppWidget provider to add
+ * @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
- * @remarks This method is invoked only in the main thread
+ * @remarks This method is invoked only in the main thread.
* @see AppWidgetManager::AddAppWidget()
*/
virtual void OnAppWidgetAddRequested(const Tizen::App::AppId& appId, const Tizen::Base::String& providerName, const Tizen::Base::String& text, const Tizen::Base::String& userInfo) = 0;
// This method is for internal use only. Using this method can cause behavioral, security-related,
// and consistency-related issues in the application.
//
- // Following method is reserved and may change its name at any time without prior notice.
+ // This method is reserved and may change its name at any time without prior notice.
//
virtual void IAppWidgetViewEventListener_Reserved1(void) {}
// This method is for internal use only. Using this method can cause behavioral, security-related,
// and consistency-related issues in the application.
//
- // Following method is reserved and may change its name at any time without prior notice.
+ // This method is reserved and may change its name at any time without prior notice.
//
virtual void IAppWidgetViewEventListener_Reserved2(void) {}
// This method is for internal use only. Using this method can cause behavioral, security-related,
// and consistency-related issues in the application.
//
- // Following method is reserved and may change its name at any time without prior notice.
+ // This method is reserved and may change its name at any time without prior notice.
//
virtual void IAppWidgetViewEventListener_Reserved3(void) {}
// This method is for internal use only. Using this method can cause behavioral, security-related,
// and consistency-related issues in the application.
//
- // Following method is reserved and may change its name at any time without prior notice.
+ // This method is reserved and may change its name at any time without prior notice.
//
virtual void IAppWidgetViewEventListener_Reserved4(void) {}
// This method is for internal use only. Using this method can cause behavioral, security-related,
// and consistency-related issues in the application.
//
- // Following method is reserved and may change its name at any time without prior notice.
+ // This method is reserved and may change its name at any time without prior notice.
//
virtual void IAppWidgetViewEventListener_Reserved5(void) {}
};
*
* @since 2.1
*
- * The %IBadgeEventListener interface defines a listener for for the Home screen that receives badge updated event.
+ * The %IBadgeEventListener interface defines a listener for the Home screen that receives badge updated event.
*/
class _OSP_EXPORT_ IBadgeEventListener
: virtual public Tizen::Base::Runtime::IEventListener
virtual ~IBadgeEventListener(void) {}
/**
- * Called when requested to add a shortcut @n
+ * Called when a badge number has been updated.
*
- * @param[in] appId The application ID that badge number updated
- * @param[in] badgeNumber Updated badge number
+ * @since 2.1
+ *
+ * @param[in] appId The application ID 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()
*/
*
* @since 2.1
*
- * The %IShortcutRequestListener interface defines a listener for for the Home application that receives request to add a shortcut.
+ * The %IShortcutRequestListener interface defines a listener for the Home application that receives request to add a shortcut.
- * The following example demonstrates how to starts the application when added shortcut is selected by user.
+ * The following example demonstrates how to start the application when the added shortcut is selected by the user.
* @code
#include <FShell.h>
#include <FApp.h>
virtual ~IShortcutRequestListener(void) {}
/**
- * Called when requested to add the shortcut.
+ * Called when requested to add a shortcut.
*
- * @param[in] appId The application ID
- * @param[in] displayName The display name of shortcut
- * @param[in] iconFilePath The icon file path
- * @param[in] uriData Uri that will be delivered by IAppControlProviderEventListener::OnAppControlRequestReceived(), when the application is started via shortcut.
- * @see ShortcutManager::AddShortcut()
+ * @since 2.1
+ *
+ * @param[in] appId The application ID
+ * @param[in] displayName The display name of 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.
*
- * @remarks If uriData is specified, application should be started by AppControl with http://tizen.org/appcontrol/operation/view operation, when it's launched from the Home application via shortcut.
- * Or else application should be started by AppControl with default opertaion (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, 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/Fapp_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;
/**
- * Called when requested to remove the shortcut.
+ * Called when requested to remove a shortcut.
+ *
+ * @since 2.1
*
* @param[in] appId The application ID
* @param[in] displayName The display name of shortcut
- *
- * @remarks If there are one more shortcuts with duplicated appId and displayName, all of them should be removed.
- *
+ * @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;
/**
* @file FShellLockManager.h
- * @brief This is the header file for the LockManager class.
+ * @brief This is the header file for the %LockManager class.
*
* This header file contains the declarations of the %LockManager class.
*/
/**
* @class LockManager
- * @brief Manages state of lock screen.
+ * @brief This class manages state of lock screen.
*
* @since 2.1
*
* @final This class is not intended for extension.
*
- * The %LockManager class manages information of lock screen.
+ * The %LockManager class manages state of lock 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_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
/**
* Unlocks current lock screen.
-
- * @privlevel platform
- * @privilege %http://tizen.org/privilege/lockmanager
*
* @since 2.1
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/lockmanager
*
* @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 Can't unlock, because secure mode is enabled.
+ * @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 API call has no effect while secure mode is enabled.
+ * @remarks This method call has no effect while secure mode is enabled.
*/
result Unlock(void);
* @param[in] launchArguments The message for the application
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - A specified input parameter is invalid.
- * - The specified @c badgeNumber is less than @c 0 or the @c badgeNumber is greater than Shell::MAX_NOTIFICATION_BADGE_NUMBER.
+ * - 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 @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_OPERATION_FAILED The operation has failed.
* @return An error code
* @param[in] request The notification request
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
* The request may have various pieces of information such as alert text, title text, launch arguments, and so on.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/notification @n
* (%http://tizen.org/privilege/notificationmanager is deprecated.)
* @param[in] request The notification request
* @exception E_SUCCESS The method is successful.
* @exception E_APP_NOT_INSTALLED The application is not installed.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
* Removes the notification message 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.)
* @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.
+ * - The specified input parameter is invalid. @n
* - The specified @c messageText is empty or the length of @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.
* @return An error code
* @param[in] request The notification request
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
* The request may have various information like alert text, title text, launch arguments, and so on.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/notification @n
* (%http://tizen.org/privilege/notificationmanager is deprecated.)
* @param[in] appId The application ID
* @param[in] request The notification request
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_APP_NOT_INSTALLED The application is not installed.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* Removes the notification message for 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.)
* (%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
+ * else @c -1 if the method fails
* @param[in] appId The application ID
* @exception E_SUCCESS The method is successful.
* @exception E_OPERATION_FAILED The operation has failed.
int GetBadgeNumberByAppId(const Tizen::App::AppId& appId);
/**
- * Notifies the user with a message. It will disappear in a few seconds.
+ * Notifies the user with a message. @n
+ * It will disappear in a few seconds.
*
* @since 2.1
* @privlevel public
* - The specified @c messageText is empty or the length of @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 Message is displayed in the status bar.
+ * @remarks The message is displayed in the status bar.
*/
result NotifyTextMessage(const Tizen::Base::String& messageText);
* @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
- * The maximum size is 16 kilo bytes.
+ * @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
+ * The maximum size is @c 16 kilo bytes.
* @param[in] request The notification request
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks For more information on the implicit AppControl resolution, see <a href="../org.tizen.native.appprogramming/html/guide/app/resolving_appcontrols.htm">Resolving AppControls</a>.
+ * @remarks For more information on the implicit AppControl resolution, see <a href="../org.tizen.native.appprogramming/html/guide/app/resolving_appcontrols.htm">here</a>.
*
*/
result NotifyByAppControl(const Tizen::Base::String& operationId, const Tizen::Base::String* pUriData, const Tizen::Base::String* pDataType,
* @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
- * The maximum size is 16 kilo bytes.
+ * @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
+ * The maximum size is @c 16 kilo bytes.
* @param[in] request The notification request
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks For more information on the implicit AppControl resolution, see <a href="../org.tizen.native.appprogramming/html/guide/app/resolving_appcontrols.htm">Resolving AppControls</a>.
+ * @remarks For more information on the implicit AppControl resolution, see <a href="../org.tizen.native.appprogramming/html/guide/app/resolving_appcontrols.htm">here</a>.
*/
result NotifyOngoingActivityByAppControl(const Tizen::Base::String& operationId, const Tizen::Base::String* pUriData, const Tizen::Base::String* pDataType,
const Tizen::Base::Collection::IMap* pExtraData, const NotificationRequest& request);
/**
- * Adds an IBadgeEventListener event listener to the NotificationManager @n
+ * Adds an IBadgeEventListener instance to the %NotificationManager instance. @n
* The listener gets notified when a badge number is updated. @n
*
* @since 2.1
*
* @return An error code
- * @param[in] listener The listener to be added.
+ * @param[in] listener The listener to add
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_ALREADY_EXIST The listener is already added.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- *
- * @see NotificationManager::Notify()
- * @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 caller should manage the listener object properly.
+ * @see NotificationManager::Notify()
*/
result AddBadgeEventListener(IBadgeEventListener& listener);
/**
- * Removes an IBadgeEventListener event listener from the NotificationManager @n
+ * Removes an IBadgeEventListener instance from the %NotificationManager instance.
*
* @since 2.1
*
* @return An error code
- * @param[in] listener The listener to be removed.
+ * @param[in] listener The listener to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The listner is not found.
+ * @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 caller should manage the listener object properly.
*/
result RemoveBadgeEventListener(IBadgeEventListener& listener);
* @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.
- * @remarks @c text is displayed according to notification layout, and the length of the text is depends on the font attributes or variable font width. @n
- * @c text is mandatory for a notification.
+ * @remarks
+ * - @c text is displayed according to 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);
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c appMessage is empty or the length of @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 %NotificationRequest 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);
* @param[in] soundPath The file path of the sound file
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified path is invalid.
- * @remarks If the format of the sound file is not valid, then the sound file is not played properly when the notification message is displayed. @n
- * If @c soundPath is not set, the default sound is played when the %NotificationRequest instance is delivered to the NotificationManager::Notify() method.
+ * @remarks
+ * - If the format of the sound file is not valid, then the sound file is not played properly when the notification message is displayed.
+ * - If @c soundPath is not set, the default sound is played when the %NotificationRequest instance is delivered to the NotificationManager::Notify() method.
*/
result SetSoundFilePath(const Tizen::Base::String& soundPath);
*
* @since 2.1
*
- * @return A string list of detail information text
+ * @return A string list of message text
*/
Tizen::Base::Collection::IList* GetMessageTextListN(void) const;
* @since 2.1
*
* @return An error code
- * @param[in] pTextList A list of detail information text
+ * @param[in] pTextList A list of message text
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c pTextList is empty or the length of individual text is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
- * @remarks This information is only meaningful when the notification style is Shell::NOTIFICATION_STYLE_NORMAL. @n
+ * @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.
*/
result SetMessageTextList(const Tizen::Base::Collection::IList* pTextList);
* @param[in] pThumbnailPathList A list of the thumbnail image file path
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified path is invalid.
- * @remarks This information is only meaningful when then notification style is Shell::NOTIFICATION_STYLE_THUMBNAIL.
+ * @remarks This information is only meaningful when the notification style is Shell::NOTIFICATION_STYLE_THUMBNAIL.
*/
result SetMessageThumbnailFilePathList(const Tizen::Base::Collection::IList* pThumbnailPathList);
* @since 2.1
*
* @return An error code
- * @param[in] notificationCountText The event count text
+ * @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.
* @remarks This information is only meaningful when the notification style is Shell::NOTIFICATION_STYLE_NORMAL.
{
public:
/**
- * The object is not fully constructed after this constructor is called.
+ * The object is not fully constructed after this constructor is called. @n
* For full construction, the Construct() method must be called right after calling this constructor.
*
* @since 2.0
virtual ~QuickPanelFrame(void);
/**
- * Initializes this instance of %QuickPanelFrame with the specified parameter.
+ * Initializes this instance of %QuickPanelFrame with a specified parameter.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
*
result Construct(int height);
/**
- * Initializes this instance of %QuickPanelFrame and child controls with the specified resource ID. @n
+ * Initializes this instance of %QuickPanelFrame and child controls with a specified resource ID. @n
*
* The %Construct() method first attempts to find the resource file in the folder that corresponds to the current screen resolution. @n
* 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 "res/screen-size-normal/" folder.
+ * the density folder that corresponds to the current screen size category @b "res/screen-size-normal/" folder.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
*
* Initializes this instance of %QuickPanelFrame with the specified parameters.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
*
* Constructs and initializes an instance of %QuickPanelFrame with the specified parameters.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
*
/**
* @class ShortcutManager
- * @brief Helps an application can add its shortcut to the Home app.
+ * @brief This class helps an application to add its shortcut to the Home app.
*
* @since 2.1
*
* @final This class is not intended for extension.
*
- * The %ShortcutManager class helps an application can add its shortcut to the Home app.
+ * The %ShortcutManager class helps an application to add its shortcut to the Home app.
*/
class _OSP_EXPORT_ ShortcutManager
: public Tizen::Base::Object
static ShortcutManager* GetInstance(void);
/**
- * Request the Home app to add the spefied shortcut.
+ * Adds a shortcut to Home app.
*
+ * @since 2.1
* @privlevel public
* @privilege http::tizen.org/privilege/shortcut.install
*
- * @since 2.1
- *
* @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 IAppControlProviderEventListener::OnAppControlRequestReceived(), when the application start via shortcut.
- * @param[in] allowDuplication Flag to allow duplicate shortcut.
+ * @param[in] uriData Uri that will be delivered by IAppControlProviderEventListener::OnAppControlRequestReceived(), when the application is started using a shortcut.
+ * @param[in] allowDuplication Flag to allow 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.
- * For more information on shared directory, see <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/io_overview.htm">I/O Overview</a>.
- * For more information on icon file, see <a href="../org.tizen.native.appprogramming/html/app_dev_process/manifest_general.htm">General Information</a>.
+ * @remarks
+ * - Icon file should be placed in sub directory of 'shared/res' to be used by the Home app.
+ * 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 uriData is specified, application will be started by AppControl with http://tizen.org/appcontrol/operation/view operation, when it's launched from the Home app via shortcut.
- * Or else application will be started by AppControl with default operation(http://tizen.org/appcontrol/operation/main).
+ * - 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).
*
* @see IAppControlEventListener::OnAppControlRequestReceived()
* @see IShortcutRequestListener::OnShortcutAddRequested()
result AddShortcut(const Tizen::App::AppId& appId, const Tizen::Base::String& displayName, const Tizen::Base::String& iconPath, const Tizen::Base::String& uriData, bool allowDuplication = true );
/**
- * Requests the Home app to remove the specified shortcut.
+ * Removes a shortcut from Home app.
*
+ * @since 2.1
* @privlevel public
* @privilege %http://tizen.org/privilege/shortcut
*
- * @since 2.1
- *
* @return An error code
* @param[in] appId The application ID
* @param[in] displayName The display name of 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 one more shortcuts with duplicated appId and displayName in the Home app, All of them will be removed.
+ * @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.
*
* @see IShortcutRequestListener::OnShortcutRemoveRequested()
*/
* @since 2.1
*
* @return An error code
- * @param[in] listener The event listener
+ * @param[in] listener The event listener to add
* @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.
result AddShortcutRequestListener(IShortcutRequestListener& listener);
/**
- * Removes an IShortcutRequestListener from the %ShortcutManager. @n
+ * Removes an IShortcutRequestListener from the %ShortcutManager.
*
* @since 2.1
*
* @return An error code
- * @param[in] listener The event listener
+ * @param[in] listener The event listener to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The listner is not found.
+ * @exception E_OBJ_NOT_FOUND The listener is not found.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result RemoveShortcutRequestListener(IShortcutRequestListener& listener);
projects / platform / framework / native / shell.git / commitdiff