public:
/**
- * @brief The start and end property ranges for this control.
+ * @brief Enumeration for the start and end property ranges for this control.
* @SINCE_1_0.0
*/
enum PropertyRange
};
/**
- * @brief An enumeration of properties belonging to the WidgetView class.
+ * @brief Enumeration for the instance of properties belonging to the WidgetView class.
* @privlevel public
* @privilege %http://tizen.org/privilege/widget.viewer
* @SINCE_1_0.0
// Event side properties
/**
- * @brief name "widgetId", Get the id of the widget, type string, read-only
+ * @brief name "widgetId", Get the id of the widget, type string, read-only.
* @SINCE_1_0.0
*/
WIDGET_ID = PROPERTY_START_INDEX,
/**
- * @brief name "instanceId", type string, read-only
+ * @brief name "instanceId", type string, read-only.
* @SINCE_1_0.0
*/
INSTANCE_ID,
/**
- * @brief name "contentInfo", type string, read-only
+ * @brief name "contentInfo", type string, read-only.
* @SINCE_1_0.0
*/
CONTENT_INFO,
/**
- * @brief name "title", type string, read-only
+ * @brief name "title", type string, read-only.
* @SINCE_1_0.0
*/
TITLE,
/**
- * @brief name "updatePeriod", type float, read-only
+ * @brief name "updatePeriod", type float, read-only.
* @SINCE_1_0.0
*/
UPDATE_PERIOD,
/**
- * @brief name "preview", type boolean if it is a show/hide flag, map otherwise
+ * @brief name "preview", type boolean if it is a show/hide flag, map otherwise.
* @SINCE_1_0.0
*/
PREVIEW,
/**
- * @brief name "loadingText", type boolean if it is a show/hide flag, map otherwise
+ * @brief name "loadingText", type boolean if it is a show/hide flag, map otherwise.
* @SINCE_1_0.0
*/
LOADING_TEXT,
/**
- * @brief name "widgetStateFaulted", type boolean
+ * @brief name "widgetStateFaulted", type boolean.
* @SINCE_1_0.0
*/
WIDGET_STATE_FAULTED,
/**
- * @brief name "permanentDelete", type boolean
+ * @brief name "permanentDelete", type boolean.
* @SINCE_1_0.0
*/
PERMANENT_DELETE,
/**
- * @brief Create widget view.
+ * @brief Creates a widget view.
*
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/widget.viewer
- * @param[in] widgetId The widget id.
- * @param[in] contentInfo Contents that will be given to the widget instance.
- * @param[in] width The widget width.
- * @param[in] height The widget height.
- * @param[in] updatePeriod The period of updating contents of the widget.
- * @return A handle to WidgetView.
+ * @param[in] widgetId The widget id
+ * @param[in] contentInfo Contents that will be given to the widget instance
+ * @param[in] width The widget width
+ * @param[in] height The widget height
+ * @param[in] updatePeriod The period of updating contents of the widget
+ * @return A handle to WidgetView
*/
static WidgetView New( const std::string& widgetId, const std::string& contentInfo, int width, int height, float updatePeriod );
/**
- * @brief Downcast a handle to WidgetView handle.
+ * @brief Downcasts a handle to WidgetView handle.
*
- * If the BaseHandle points is a WidgetView the downcast returns a valid handle.
- * If not the returned handle is left empty.
+ * If the BaseHandle points is a WidgetView, the downcast returns a valid handle.
+ * If not, the returned handle is left empty.
*
* @since_tizen 3.0
* @param[in] handle Handle to an object
- * @return handle to a WidgetView or an empty handle
+ * @return Handle to a WidgetView or an empty handle
*/
static WidgetView DownCast( BaseHandle handle );
* @brief Copy constructor.
*
* @since_tizen 3.0
- * @param[in] handle The handle to copy from.
+ * @param[in] handle The handle to copy from
*/
WidgetView( const WidgetView& handle );
* @brief Assignment operator.
*
* @since_tizen 3.0
- * @param[in] handle The handle to copy from.
- * @return A reference to this.
+ * @param[in] handle The handle to copy from
+ * @return A reference to this
*/
WidgetView& operator=( const WidgetView& handle );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @since_tizen 3.0
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/widget.viewer
- * @return true on success, false otherwise.
+ * @return @c true on success, @c false otherwise
*/
bool PauseWidget();
/**
- * @brief Resume a given widget.
+ * @brief Resumes a given widget.
*
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/widget.viewer
- * @return true on success, false otherwise.
+ * @return @c true on success, @c false otherwise
*/
bool ResumeWidget();
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/widget.viewer
- * @return true on success, false otherwise.
+ * @return @c true on success, @c false otherwise
*/
bool CancelTouchEvent();
/**
- * @brief Activate a widget in faulted state.
+ * @brief Activates a widget in faulted state.
* A widget in faulted state MUST be activated before adding the widget.
*
* @since_tizen 3.0
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/widget.viewer
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
WidgetViewSignalType& WidgetAddedSignal();
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/widget.viewer
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
WidgetViewSignalType& WidgetDeletedSignal();
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/widget.viewer
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
WidgetViewSignalType& WidgetCreationAbortedSignal();
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/widget.viewer
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
WidgetViewSignalType& WidgetContentUpdatedSignal();
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/widget.viewer
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
WidgetViewSignalType& WidgetUpdatePeriodChangedSignal();
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/widget.viewer
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
WidgetViewSignalType& WidgetFaultedSignal();
* @brief Creates a handle using the WidgetView::Internal implementation.
*
* @since_tizen 3.0
- * @param[in] implementation The WidgetView implementation.
+ * @param[in] implementation The WidgetView implementation
*/
DALI_INTERNAL WidgetView( Internal::WidgetView& implementation );
* @brief Allows the creation of this control from an Internal::CustomActor pointer.
*
* @since_tizen 3.0
- * @param[in] internal A pointer to the internal CustomActor.
+ * @param[in] internal A pointer to the internal CustomActor
*/
DALI_INTERNAL WidgetView( Dali::Internal::CustomActor* internal );
};
public:
/**
- * @brief Create widget view manager.
+ * @brief Creates widget view manager.
*
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/widget.viewer
- * @param[in] application Application class for the widget view manager.
- * @param[in] appId App ID of app with widget viewer dali.
- * @return A handle to WidgetViewManager.
+ * @param[in] application Application class for the widget view manager
+ * @param[in] appId App ID of app with widget viewer dali
+ * @return A handle to WidgetViewManager
*/
static WidgetViewManager New( Application application, const std::string& appId );
/**
- * @brief Downcast a handle to WidgetViewManager handle.
+ * @brief Downcasts a handle to WidgetViewManager handle.
*
- * If the BaseHandle points is a WidgetViewManager the downcast returns a valid handle.
- * If not the returned handle is left empty.
+ * If the BaseHandle points is a WidgetViewManager, the downcast returns a valid handle.
+ * If not, the returned handle is left empty.
*
* @since_tizen 3.0
* @param[in] handle Handle to an object
- * @return handle to a WidgetViewManager or an empty handle
+ * @return Handle to a WidgetViewManager or an empty handle
*/
static WidgetViewManager DownCast( BaseHandle handle );
* @brief Copy constructor.
*
* @since_tizen 3.0
- * @param[in] handle The handle to copy from.
+ * @param[in] handle The handle to copy from
*/
WidgetViewManager( const WidgetViewManager& handle );
* @brief Assignment operator.
*
* @since_tizen 3.0
- * @param[in] handle The handle to copy from.
- * @return A reference to this.
+ * @param[in] handle The handle to copy from
+ * @return A reference to this
*/
WidgetViewManager& operator=( const WidgetViewManager& handle );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @since_tizen 3.0
~WidgetViewManager();
/**
- * @brief Creates a new widget view object
+ * @brief Creates a new widget view object.
*
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/widget.viewer
- * @param[in] widgetId The widget id.
- * @param[in] contentInfo Contents that will be given to the widget instance.
- * @param[in] width The widget width.
- * @param[in] height The widget height.
- * @param[in] updatePeriod The period of updating contents of the widget.
- * @return A handle to WidgetView.
+ * @param[in] widgetId The widget id
+ * @param[in] contentInfo Contents that will be given to the widget instance
+ * @param[in] width The widget width
+ * @param[in] height The widget height
+ * @param[in] updatePeriod The period of updating contents of the widget
+ * @return A handle to WidgetView
*/
WidgetView AddWidget( const std::string& widgetId, const std::string& contentInfo, int width, int height, float updatePeriod );
* @brief Creates a handle using the WidgetView::Internal implementation.
*
* @since_tizen 3.0
- * @param[in] implementation The WidgetViewManager implementation.
+ * @param[in] implementation The WidgetViewManager implementation
*/
explicit DALI_INTERNAL WidgetViewManager( Internal::WidgetViewManager* implementation );
};