Collapse all Symbian^3 Product Developer Library

Alf::IMulModelAccessor Class Reference

class Alf::IMulModelAccessor : public Alf::IAlfModel

An interface for accessing data model. Widgets use this interface to interact with Model. Data model implements this interface.

Inherits from

Alf::IMulModelAccessor
- Alf::IAlfModel
  - Alf::IAlfInterfaceBase

Public Member Functions
int	AbsoluteIndex(int)
void	AddModelObserver(IMulModelObserver *)
int	BottomOffset()
int	BottomWindowOffset()
int	CurrentItemCount()
int	Highlight()
bool	IsItemMarked(int)
bool	IsLoopingOn()
const MulVisualItem &	Item(int)
int	RearBottomOffset()
int	RearTopOffset()
int	RelativeIndex(int)
void	RemoveModelObserver(IMulModelObserver *)
void	ScrollWindow(int)
void	SetHighlight(int)
void	SetMarkedIndex(MulWidgetDef::TMulWidgetMarkingType, int)
void	SetVisibleWindow(int, int)
mulwidget::TLogicalTemplate	Template()
int	TopOffset()
int	TopWindowOffset()

Member Functions Documentation

AbsoluteIndex(int)

int

AbsoluteIndex

(

int

aRelativeIndex

)

[pure virtual]

Returns Absolute index from relative index

Parameters

int aRelativeIndex

Relative index

AddModelObserver(IMulModelObserver *)

void

AddModelObserver

(

IMulModelObserver *

aObserver

)

[pure virtual]

Add model state change observer.

Parameters

IMulModelObserver * aObserver

Observer- ownserhip is not transferred

BottomOffset()

int

BottomOffset

(

)

const [pure virtual]

Return visible window bottom offset

BottomWindowOffset()

int

BottomWindowOffset

(

)

const [pure virtual]

Return visible window bottom offset

CurrentItemCount()

int

CurrentItemCount

(

)

[pure virtual]

Function to get the count of items currently present in the model. This includes hidden items.

Highlight()

int

Highlight

(

)

[pure virtual]

Function to get the highlighted item index.

IsItemMarked(int)

bool

IsItemMarked

(

int

aIndex

)

[pure virtual]

Check weather item at specified index is marked or not.

Parameters

int aIndex

Absolute index of item

IsLoopingOn()

bool

IsLoopingOn

(

)

[pure virtual]

Return whather currently looping is on or not

Item(int)

const MulVisualItem &

Item

(

int

aAbsoluteIndex

)

[pure virtual]

Returns the visual item at the specified absolute index

Parameters

int aAbsoluteIndex

RearBottomOffset()

int

RearBottomOffset

(

)

const [pure virtual]

Return rear buffer bottom offset

RearTopOffset()

int

RearTopOffset

(

)

const [pure virtual]

Return rear buffer top offset

RelativeIndex(int)

int

RelativeIndex

(

int

aAbsoluteIndex

)

const [pure virtual]

Returns relative index from absolute index.

Parameters

int aAbsoluteIndex

Abosulte index

RemoveModelObserver(IMulModelObserver *)

void

RemoveModelObserver

(

IMulModelObserver *

aObserver

)

[pure virtual]

Eemove model state change observer.

Parameters

IMulModelObserver * aObserver

Observer- ownserhip is not transferred

ScrollWindow(int)

void

ScrollWindow

(

int

aItemIndex

)

[pure virtual]

Scroll Window to mention item index it will check that data window needs to be updated or not and if required it update data window

item index

Exceptions

invaid_argument

exception

Parameters

int aItemIndex

SetHighlight(int)

void

SetHighlight

(

int

aItemIndex

)

[pure virtual]

The function to set a particular item as highlighted.

Exceptions

Invalid_argument

Throws this exception if index is not a valid index.

Parameters

int aItemIndex

SetMarkedIndex(MulWidgetDef::TMulWidgetMarkingType, int)

void	SetMarkedIndex	(	MulWidgetDef::TMulWidgetMarkingType	aType,
			int	aIndex
		)	[pure virtual]

Function for setting the item Marked or Unmarked. For mark and unmark operations, index of item should be provided.

Exceptions

Invalid

Argument, if type is specified as mark-all and unmark-all.

Parameters

MulWidgetDef::TMulWidgetMarkingType aType	Type of marking operation to be performed.
int aIndex

SetVisibleWindow(int, int)

void	SetVisibleWindow	(	int	aWindowSize,
			int	aPageTopIndex = -1
		)	[pure virtual]

Set visible data window for model.

Parameters

int aWindowSize
int aPageTopIndex = -1

Template()

mulwidget::TLogicalTemplate

Template

(

)

[pure virtual]

Return default template

TopOffset()

int

TopOffset

(

)

const [pure virtual]

Return visible window top offset

TopWindowOffset()

int

TopWindowOffset

(

)

const [pure virtual]

Return visible window top offset