* @brief This class provides the main frame window for a AppWidgetProvider.
* @since 2.1
*
- * The %AppWidgetFrame is the root parent of all AppWidget controls that are created by a AppWidgetProvider.
+ * 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.
*
*/
class _OSP_EXPORT_ AppWidgetFrame
public:
/**
* The object is not fully constructed after this constructor is called.
- * For full construction, the Construct() method must be called after calling this constructor.
+ * For full construction, the Construct() method must be called right after calling this constructor.
*
* @since 2.1
*/
* @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.\r
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.\r
- * remarks Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods.
- * @see AppWidgetProvider::OnAppWidgetProviderInitialize()
+ * @remarks Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods.
+ * @see AppWidgetProvider::OnAppWidgetProviderInitializing()
*/
result Construct(const Tizen::Graphics::FloatDimension& size);
* @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.\r
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.\r
- * remarks Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods.
- * @see AppWidgetProvider::OnAppWidgetProviderInitialize()
+ * @remarks Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods.
+ * @see AppWidgetProvider::OnAppWidgetProviderInitializing()
*/
result Construct(const Tizen::Ui::Layout& layout, const Tizen::Graphics::FloatDimension& size);
// 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 AppWidgetFrame_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 AppWidgetFrame_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 AppWidgetFrame_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 AppWidgetFrame_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 AppWidgetFrame_Reserved5(void) {}
* @brief This class provides the popup for a AppWidgetProvider.
* @since 2.1
*
- * The %AppWidgetPopup supports detailed screen for a AppWidgetProvider.
+ * The %AppWidgetPopup class supports detailed screen for a AppWidgetProvider.
*
*/
class _OSP_EXPORT_ AppWidgetPopup
public:
/**
* The object is not fully constructed after this constructor is called.
- * For full construction, the Construct() method must be called after calling this constructor.
+ * For full construction, the Construct() method must be called right after calling this constructor.
*
* @since 2.1
*/
virtual ~AppWidgetPopup(void);
/**
- * Initializes this instance of %AppWidgetFrame with the specified parameter.
+ * Initializes this instance of %AppWidgetPopup with the specified parameter.
*
* @since 2.1
* @feature %http://tizen.org/feature/shell.appwidget
* @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.\r
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.\r
- * remarks Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods.
- * @see AppWidgetProvider::OnAppWidgetPopupProviderInitialize()
+ * @remarks Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods.
+ * @see AppWidgetProvider::OnAppWidgetPopupProviderInitializing()
*/
result Construct(const Tizen::Graphics::FloatDimension& size);
/**
- * Initializes this instance of %AppWidgetFrame with the specified parameter.
+ * Initializes this instance of %AppWidgetPopup with the specified parameter.
*
* @since 2.1
* @feature %http://tizen.org/feature/shell.appwidget
* @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.\r
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.\r
- * remarks Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods.
- * @see AppWidgetProvider::OnAppWidgetPopupProviderInitialize()
+ * @remarks Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods.
+ * @see AppWidgetProvider::OnAppWidgetPopupProviderInitializing()
*/
result Construct(const Tizen::Ui::Layout& layout, const Tizen::Graphics::FloatDimension& size);
*
* @since 2.1
*
- * @return The bounds of the client area in a FloatRectangle instance
+ * @return The bounds of the client area in a Tizen::Graphics::FloatRectangle instance
*/
Tizen::Graphics::FloatRectangle GetClientAreaBounds(void) const;
/**
- * Creates and returns a graphics canvas whose bounds (position and size) are equal to the bounds of the client area of the %AppWidgetPopup.
+ * Gets a graphics canvas whose bounds (position and size) are equal to the bounds of the client area of the %AppWidgetPopup instance.
*
* @since 2.1
*
- * @return The graphic canvas of the %AppWidgetPopup, @n
+ * @return The graphic canvas of the %AppWidgetPopup instance, @n
* 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 The method allocates a Tizen::Graphics::Canvas whose bounds are equal to that of the client area of the % AppWidgetPopup. @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
* Therefore, delete the previously allocated canvas and create a new canvas using the GetClientAreaCanvasN() method if the size or position of the
*
* @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.
+ * @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;
// 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 AppWidgetPopup_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 AppWidgetPopup_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 AppWidgetPopup_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 AppWidgetPopup_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 AppWidgetPopup_Reserved5(void) {}
* @brief This class provides the view control for a AppWidgetViewer.
* @since 2.1
*
- * The %AppWidgetView shows a drawn buffer by AppWidgetProvider.
+ * The %AppWidgetView class shows a drawn buffer by AppWidgetProvider.
*
*/
class _OSP_EXPORT_ AppWidgetView
public:
/**
* The object is not fully constructed after this constructor is called.
- * For full construction, the Construct() method must be called after calling this constructor.
+ * For full construction, the Construct() method must be called right after calling this constructor.
*
* @since 2.1
*/
virtual ~AppWidgetView(void);
/**
- * Initializes this instance of %AppWidgetView with the specified parameter.
+ * Initializes this instance of %AppWidgetView with the specified parameters.
*
* @since 2.1
* @feature %http://tizen.org/feature/shell.appwidget\r
* @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 FloatRectangle class @n
+ * @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
* @exception E_SUCCESS The method is successful.
* @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.\r
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.\r
- * remarks Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods.\r
+ * @remarks Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods.
*/
result Construct(const Tizen::App::AppId& appId, const Tizen::Base::String& providerName, const Tizen::Graphics::FloatRectangle& rect);
/**
- * Initializes this instance of %AppWidgetView with the specified parameter.
+ * Initializes this instance of %AppWidgetView with the specified parameters.
*
* @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 FloatRectangle class @n
+ * @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 be delivered to AppWidget provider
+ * @param[in] userInfo Extra data to deliver to 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.\r
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.\r
- * remarks Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods.
+ * @remarks Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods.
*/
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 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.
+ */
AppWidgetProviderInfo* GetAppWidgetProviderInfoN(void) const;
- /*
+ /**
* Adds an IAppWidgetViewEventListener instance. @n
*
* @since 2.1
*/
result AddAppWidgetViewEventListener(IAppWidgetViewEventListener& listener);
- /*
+ /**
* Removes an IAppWidgetViewEventListener instance. @n
* The removed listener cannot listen to the events when they are fired.
*
// 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 AppWidgetView_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 AppWidgetView_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 AppWidgetView_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 AppWidgetView_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 AppWidgetView_Reserved5(void) {}
: public Tizen::Base::Runtime::IEventListener
{
public:
- /*\r
+ /**\r
* This polymorphic destructor should be overridden if required.\r
* This way, the destructors of the derived classes are called when the destructor of this interface is called.\r
*\r
*/
virtual ~IAppWidgetViewEventListener(void) {}
- /*\r
+ /**\r
* Called when a AppWidgetProvider instance is about to be removed. @n
*\r
* @since 2.1\r
projects / platform / framework / native / shell.git / commitdiff