Collapse all Symbian^3 Product Developer Library

Alf::IAlfViewWidget Class Reference

class Alf::IAlfViewWidget : public Alf::IAlfContainerWidget

An interface for the view widget.

Since: S60 ?S60_version

Inherits from

Alf::IAlfViewWidget
- Alf::IAlfContainerWidget
  - Alf::IAlfWidget
    - Alf::IAlfInterfaceBase

Public Member Functions
	~IAlfViewWidget()
void	acceptEvents(bool)
bool	controlPaneEnabled()
void	enableControlPane(bool)
void	enableStatusPane(bool)
bool	eventsAccepted()
int	getViewStackPosition()
void	setRect(const TRect &)
void	setSkinBackground(TAknsItemID)
void	show(bool)
bool	shown()
TAknsItemID	skinBackground()
bool	statusPaneEnabled()
const IfId &	type()
void	useSkinBackground(bool)
bool	usingSkinBackground()

Inherited Functions
	Alf::IAlfContainerWidget::addWidget(IAlfWidget &)
	Alf::IAlfContainerWidget::applyLayout(IAlfLayoutManager &)
	Alf::IAlfContainerWidget::getWidget(int)const
	Alf::IAlfContainerWidget::getWidgetIndex(IAlfWidget &)const
	Alf::IAlfContainerWidget::removeWidget(int)
	Alf::IAlfContainerWidget::widgetCount()const
	Alf::IAlfContainerWidget::~IAlfContainerWidget()
	Alf::IAlfInterfaceBase::makeInterface(IAlfInterfaceBase *)
	Alf::IAlfInterfaceBase::makeInterface(const IfId &)
	Alf::IAlfInterfaceBase::~IAlfInterfaceBase()
	Alf::IAlfWidget::control()const
	Alf::IAlfWidget::model()
	Alf::IAlfWidget::parent()const
	Alf::IAlfWidget::setChildFocus(bool)
	Alf::IAlfWidget::setControl(CAlfWidgetControl *,bool)
	Alf::IAlfWidget::setModel(IAlfModel *,bool)
	Alf::IAlfWidget::setPresentation(const char *)
	Alf::IAlfWidget::widgetName()const
	Alf::IAlfWidget::~IAlfWidget()

Constructor & Destructor Documentation

~IAlfViewWidget()

~IAlfViewWidget

(

)

[inline, virtual]

Virtual destructor.

Member Functions Documentation

acceptEvents(bool)

void

acceptEvents

(

bool

aAccept = true

)

[pure virtual]

API to make the view widget accept events.

Since: S60 ?S60_version

Parameters

bool aAccept = true

true if the view is to accept inputs, else false default value is true

controlPaneEnabled()

bool

controlPaneEnabled

(

)

[pure virtual]

API to check whether the control pane is enabled

Since: S60 ?S60_version

enableControlPane(bool)

void

enableControlPane

(

bool

aEnable = true

)

[pure virtual]

API to hide/show Avkon control pane If the AlfDisplay bound to the view widget does not occupy the entire client rectangle, this API has no effect.

Since: S60 ?S60_version

Parameters

bool aEnable = true

true to enable the control pane, else false the default value is true.

enableStatusPane(bool)

void

enableStatusPane

(

bool

aEnable = true

)

[pure virtual]

API to enable/disable Avkon status pane

Since: S60 ?S60_version

Parameters

bool aEnable = true

true to enable the status pane, else false the default value is true.

eventsAccepted()

bool

eventsAccepted

(

)

[pure virtual]

API to check whether the view accepts events

Since: S60 ?S60_version

getViewStackPosition()

int

getViewStackPosition

(

)

const [pure virtual]

Returns the position of the view on the view stack. This tells the view Z-coordinate position relative to other views. Top-most view returns zero. Views under that have a growing number of position. If the view is hidden -1 is returned. Only view widgets are taken into consideration in the position calculation. Other control groups in the display roster are ignored. For example, position zero doesn't mean that the control group of this view would be top-most.

Only top-most view is activate while all other views are being deactivate.

show()

setRect(const TRect &)

void

setRect

(

const TRect &

aDisplayRect

)

[pure virtual]

API to Set the display area of the view widget. This will set the alfdisplay area with param passed Client need to call this api with screen/apprect to make view full screen or application rect

Since: S60 ?S60_version

Parameters

const TRect & aDisplayRect

setSkinBackground(TAknsItemID)

void

setSkinBackground

(

TAknsItemID

aSkinID

)

[pure virtual]

API to use Skin with the given ID to be used as view widget's background. Also enables skin background. See IAlfViewWidget::useSkinBackground()

Since: S60 ?S60_version

Parameters

TAknsItemID aSkinID

show(bool)

void

show

(

bool

aShow = true

)

[pure virtual]

This will show the view widget. The view widget will be shown on the top of the view stack. If the view was already shown it will be moved on top of the view stack.

getViewStackPosition()

Since: S60 ?S60_version

Parameters

bool aShow = true

true if the view is to be shown, false if the view will be hidden. The view is not shown, till this api is called with true parameter.

shown()

bool

shown

(

)

[pure virtual]

API to check whether the view is shown

Since: S60 ?S60_version

skinBackground()

TAknsItemID

skinBackground

(

)

[pure virtual]

API to get the Avkon Skin ID being used as view widget's background. Use IAlfViewWidget::usingSkinBackground() to check if this is being used.

Since: S60 ?S60_version

statusPaneEnabled()

bool

statusPaneEnabled

(

)

[pure virtual]

API to check whether the status pane is enabled

Since: S60 ?S60_version

type()

const IfId &

type

(

)

[static, inline]

Getter for the type identifier of this interface.

Since: S60 ?S60_version

useSkinBackground(bool)

void

useSkinBackground

(

bool

aSkinBackground = true

)

[pure virtual]

API to enable/disable Avkon Skin to be used as view widget's background.

Since: S60 ?S60_version

Parameters

bool aSkinBackground = true

true if the view has to use Avkon Skin as background. false otherwise.

usingSkinBackground()

bool

usingSkinBackground

(

)

[pure virtual]

API to check whether skin info is being used for background or not

Since: S60 ?S60_version