WidgetView is a class for displaying the widget image and controlling the widget. Input events that WidgetView gets are delivered to the widget. More...

Inheritance diagram for Dali::WidgetView::WidgetView:

Classes
struct	Property
	An enumeration of properties belonging to the WidgetView class. More...
Public Types
enum	PropertyRange
	The start and end property ranges for this control. More...
typedef Signal< void(WidgetView) >	WidgetViewSignalType
	WidgetView signal type.
Public Member Functions
	WidgetView ()
	Creates an empty handle.
	WidgetView (const WidgetView &handle)
	Copy constructor.
WidgetView &	operator= (const WidgetView &handle)
	Assignment operator.
	~WidgetView ()
	Destructor.
bool	PauseWidget ()
	Pauses a given widget.
bool	ResumeWidget ()
	Resume a given widget.
bool	CancelTouchEvent ()
	Cancels touch event procedure. If you call this function after feed the touch down event, the widget will get ON_HOLD events. If a widget gets ON_HOLD event, it will not do anything even if you feed touch up event.
void	ActivateFaultedWidget ()
	Activate a widget in faulted state. A widget in faulted state MUST be activated before adding the widget.
bool	TerminateWidget ()
	Terminates a widget instance.
WidgetViewSignalType &	WidgetAddedSignal ()
	This signal is emitted when the widget is added.
WidgetViewSignalType &	WidgetDeletedSignal ()
	This signal is emitted when the widget is deleted.
WidgetViewSignalType &	WidgetCreationAbortedSignal ()
	This signal is emitted when the widget creation is aborted.
WidgetViewSignalType &	WidgetContentUpdatedSignal ()
	This signal is emitted when the widget content is updated.
WidgetViewSignalType &	WidgetUpdatePeriodChangedSignal ()
	This signal is emitted when the widget update period is changed.
WidgetViewSignalType &	WidgetFaultedSignal ()
	This signal is emitted when the widget process is not running.
Static Public Member Functions
static WidgetView	New (const std::string &widgetId, const std::string &contentInfo, int width, int height, float updatePeriod)
	Create widget view.
static WidgetView	DownCast (BaseHandle handle)
	Downcast a handle to WidgetView handle.

Detailed Description

WidgetView is a class for displaying the widget image and controlling the widget. Input events that WidgetView gets are delivered to the widget.

Signals | Signal Name | Method | |-----------------------------|----------------------------------------| | widgetAdded | WidgetAddedSignal() | | widgetDeleted | WidgetDeletedSignal() | | widgetCreationAborted | WidgetCreationAbortedSignal() | | widgetContentUpdated | WidgetContentUpdatedSignal() | | widgetUpdatePeriodChanged | WidgetUpdatePeriodChangedSignal() | | widgetFaulted | WidgetFaultedSignal() |

Since :: 3.0

Member Typedef Documentation

typedef Signal< void ( WidgetView ) > Dali::WidgetView::WidgetView::WidgetViewSignalType

WidgetView signal type.

Since :: 3.0

Member Enumeration Documentation

enum Dali::WidgetView::WidgetView::PropertyRange

The start and end property ranges for this control.

Since :: 3.0

Enumerator:

PROPERTY_START_INDEX

Since :: 3.0

PROPERTY_END_INDEX

Reserve property indices.

Since :: 3.0

Reimplemented from Dali::Toolkit::Control.

Constructor & Destructor Documentation

Dali::WidgetView::WidgetView::WidgetView ( )

Creates an empty handle.

Since :: 3.0

Dali::WidgetView::WidgetView::WidgetView ( const WidgetView & handle )

Copy constructor.

Since :: 3.0

Parameters:

[in] handle The handle to copy from.

Dali::WidgetView::WidgetView::~WidgetView ( )

Destructor.

This is non-virtual since derived Handle types must not contain data or virtual methods.

Since :: 3.0

Member Function Documentation

void Dali::WidgetView::WidgetView::ActivateFaultedWidget ( )

Activate a widget in faulted state. A widget in faulted state MUST be activated before adding the widget.

Since :: 3.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

bool Dali::WidgetView::WidgetView::CancelTouchEvent ( )

Cancels touch event procedure. If you call this function after feed the touch down event, the widget will get ON_HOLD events. If a widget gets ON_HOLD event, it will not do anything even if you feed touch up event.

Since :: 3.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Returns:: true on success, false otherwise.

static WidgetView Dali::WidgetView::WidgetView::DownCast ( BaseHandle handle ) [static]

Downcast 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.

Since :: 3.0

Parameters:

[in] handle Handle to an object

Returns:: handle to a WidgetView or an empty handle

Reimplemented from Dali::Toolkit::Control.

static WidgetView Dali::WidgetView::WidgetView::New	(	const std::string &	widgetId,
		const std::string &	contentInfo,
		int	width,
		int	height,
		float	updatePeriod
	)		`[static]`

Create widget view.

Since :: 3.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Parameters:

[in]	widgetId	The widget id.
[in]	contentInfo	Contents that will be given to the widget instance.
[in]	width	The widget width.
[in]	height	The widget height.
[in]	updatePeriod	The period of updating contents of the widget.

Returns:: A handle to WidgetView.

WidgetView& Dali::WidgetView::WidgetView::operator= ( const WidgetView & handle )

Assignment operator.

Since :: 3.0

Parameters:

[in] handle The handle to copy from.

Returns:: A reference to this.

bool Dali::WidgetView::WidgetView::PauseWidget ( )

Pauses a given widget.

Since :: 3.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Returns:: true on success, false otherwise.

bool Dali::WidgetView::WidgetView::ResumeWidget ( )

Resume a given widget.

Since :: 3.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Returns:: true on success, false otherwise.

bool Dali::WidgetView::WidgetView::TerminateWidget ( )

Terminates a widget instance.

Since :: 4.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Returns:: true on success, false otherwise.

WidgetViewSignalType& Dali::WidgetView::WidgetView::WidgetAddedSignal ( )

This signal is emitted when the widget is added.

Since :: 3.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Returns:: The signal to connect to.

WidgetViewSignalType& Dali::WidgetView::WidgetView::WidgetContentUpdatedSignal ( )

This signal is emitted when the widget content is updated.

Since :: 3.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Returns:: The signal to connect to.

WidgetViewSignalType& Dali::WidgetView::WidgetView::WidgetCreationAbortedSignal ( )

This signal is emitted when the widget creation is aborted.

Since :: 3.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Returns:: The signal to connect to.

WidgetViewSignalType& Dali::WidgetView::WidgetView::WidgetDeletedSignal ( )

This signal is emitted when the widget is deleted.

Since :: 3.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Returns:: The signal to connect to.

WidgetViewSignalType& Dali::WidgetView::WidgetView::WidgetFaultedSignal ( )

This signal is emitted when the widget process is not running.

Since :: 3.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Returns:: The signal to connect to.

WidgetViewSignalType& Dali::WidgetView::WidgetView::WidgetUpdatePeriodChangedSignal ( )

This signal is emitted when the widget update period is changed.

Since :: 3.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Returns:: The signal to connect to.

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation