Symbian^3 Application Developer Library >

CFsTreeList Class Reference

class CFsTreeList : public CBase

CFsTreeList is a component for creating and displaying hierarchical list using tree data structure.

Inherits from

Public Member Functions
~CFsTreeList ()
IMPORT_C void AddObserverL (MFsTreeListObserver &)
void BeginUpdate ()
IMPORT_C TFsTreeItemId Child (const TFsTreeItemId , const TUint )
IMPORT_C TUint ChildIndex (const TFsTreeItemId , const TFsTreeItemId )
IMPORT_C void CollapseNodeL (const TFsTreeItemId )
IMPORT_C TBool Contains (const TFsTreeItemId )
IMPORT_C TUint Count ()
IMPORT_C TUint CountChildren (const TFsTreeItemId )
IMPORT_C void DisableKineticScrolling ( TBool )
void EndUpdateL ()
IMPORT_C void ExpandNodeL (const TFsTreeItemId )
IMPORT_C TInt FadeInEffectTime ()
IMPORT_C TInt FadeOutEffectTime ()
IMPORT_C TFsTreeItemId FocusedItem ()
IMPORT_C TInt GetItemDisplayRectTarget (const TFsTreeItemId , TAlfRealRect &)
IMPORT_C void GetMarkedItemsL ( RFsTreeItemIdList &)
IMPORT_C void GetScrollTime ( TInt &, TReal &)
IMPORT_C TFsTreeListScrollbars HasScrollBars ()
IMPORT_C void HideListL (const TBool , const TBool )
IMPORT_C TInt Indentation ()
IMPORT_C TFsTreeItemId InsertItemL (MFsTreeItemData &, MFsTreeItemVisualizer &, const TFsTreeItemId , const TInt , const TBool )
IMPORT_C TFsTreeItemId InsertNodeL (MFsTreeItemData &, MFsTreeNodeVisualizer &, const TFsTreeItemId , const TInt , const TBool )
IMPORT_C TBool IsEmpty (const TFsTreeItemId )
IMPORT_C TBool IsExpanded (const TFsTreeItemId )
IMPORT_C TBool IsFocused ()
IMPORT_C TBool IsItemsAlwaysExtended ()
IMPORT_C TBool IsMarked (const TFsTreeItemId )
IMPORT_C TBool IsNode (const TFsTreeItemId )
IMPORT_C MFsTreeItemData & ItemData (const TFsTreeItemId )
IMPORT_C CFsTreeList * ItemMenu ( TFsTreeItemId )
IMPORT_C MFsTreeItemVisualizer & ItemVisualizer (const TFsTreeItemId )
IMPORT_C TUint Level (const TFsTreeItemId )
IMPORT_C TFsTreeListLoopingType LoopingType ()
IMPORT_C void MarkItemL (const TFsTreeItemId , TBool )
IMPORT_C TFsTreeListMarkType MarkType ()
IMPORT_C void MoveItemL (const TFsTreeItemId , const TFsTreeItemId , const TInt )
IMPORT_C CFsTreeList * NewL (CFsTreeVisualizerBase &, CAlfEnv &)
IMPORT_C TFsTreeItemId Parent (const TFsTreeItemId )
IMPORT_C void RemoveAllL ()
IMPORT_C void RemoveChildrenL (const TFsTreeItemId )
IMPORT_C void RemoveL (const TFsTreeItemId )
IMPORT_C void RemoveObserver (MFsTreeListObserver &)
IMPORT_C TFsScrollbarVisibility ScrollbarVisibility ()
IMPORT_C void SetBorderL (const TBool , CAlfTexture *)
IMPORT_C void SetDirectTouchMode (const TBool )
IMPORT_C void SetFadeInEffectTime ( TInt )
IMPORT_C void SetFadeOutEffectTime ( TInt )
IMPORT_C void SetFocusedItemL (const TFsTreeItemId )
IMPORT_C void SetFocusedL (const TBool )
IMPORT_C void SetIndentationL (const TInt )
IMPORT_C void SetItemDataL (MFsTreeItemData &, const TFsTreeItemId )
IMPORT_C void SetItemVisualizerL (MFsTreeItemVisualizer &, const TFsTreeItemId )
IMPORT_C void SetItemsAlwaysExtendedL ( TBool )
IMPORT_C void SetLoopingType (const TFsTreeListLoopingType )
IMPORT_C void SetMarkTypeL (const TFsTreeListMarkType )
IMPORT_C void SetScrollBarsL (const TFsTreeListScrollbars )
IMPORT_C void SetScrollTime ( TInt , TReal )
IMPORT_C void SetScrollbarVisibilityL (const TFsScrollbarVisibility )
IMPORT_C void SetShadowL (const TBool )
IMPORT_C void SetSlideInDirection ( MFsTreeVisualizer::TFsSlideEffect )
IMPORT_C void SetSlideInDuration ( TInt )
IMPORT_C void SetSlideOutDirection ( MFsTreeVisualizer::TFsSlideEffect )
IMPORT_C void SetSlideOutDuration ( TInt )
IMPORT_C void SetTextMarqueeCycleStartDelay (const TInt )
IMPORT_C void SetTextMarqueeRepetitions (const TInt )
IMPORT_C void SetTextMarqueeSpeed (const TInt )
IMPORT_C void SetTextMarqueeStartDelay (const TInt )
IMPORT_C void SetTextMarqueeType (const TFsTextMarqueeType )
IMPORT_C void SetTreeVisualizer (CFsTreeVisualizerBase &)
IMPORT_C void ShowListL (const TBool , const TBool )
IMPORT_C MFsTreeVisualizer::TFsSlideEffect SlideInDirection ()
IMPORT_C TInt SlideInDuration ()
IMPORT_C MFsTreeVisualizer::TFsSlideEffect SlideOutDirection ()
IMPORT_C TInt SlideOutDuration ()
IMPORT_C TInt TextMarqueeCycleStartDelay ()
IMPORT_C TInt TextMarqueeRepetitions ()
IMPORT_C TInt TextMarqueeSpeed ()
IMPORT_C TInt TextMarqueeStartDelay ()
IMPORT_C TFsTextMarqueeType TextMarqueeType ()
IMPORT_C CFsAlfTextStyleManager & TextStyleManager ()
IMPORT_C CAlfControl * TreeControl ()
IMPORT_C CFsTreeVisualizerBase & TreeVisualizer ()
IMPORT_C void TreeVisualizerEventL (const TFsTreeVisualizerEvent, const TFsTreeItemId , const TPoint &)
Protected Member Functions
CFsTreeList (CAlfEnv &, CFsTreeVisualizerBase &)
IMPORT_C void ConstructL (CAlfEnv &)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Public Member Enumerations
enum TFsTreeListMarkType { EFsTreeListNonMarkable , EFsTreeListMarkable , EFsTreeListMultiMarkable }
enum TFsTreeListScrollbars { EFsTreeListNoScrollbars , EFsTreeListVerticalScrollbar }
Protected Attributes
CAlfEnv * iEnv
TFsTreeItemId iFocusedItem
TFsTreeListScrollbars iHasScrollBars
TBool iIsLooping
TBool iListFocused
TFsTreeListMarkType iMarkType
RFsTreeListObservers iObservers
CFsAlfTextStyleManager * iTextStyleManager
CFsTree * iTree
CFsTreeControl * iTreeControl
CFsTreeVisualizerBase * iTreeVisualizer

Constructor & Destructor Documentation

CFsTreeList(CAlfEnv &, CFsTreeVisualizerBase &)

IMPORT_C CFsTreeList ( CAlfEnv & aEnv,
CFsTreeVisualizerBase & aTreeV
) [protected]

C++ constructor

Parameters

CAlfEnv & aEnv
CFsTreeVisualizerBase & aTreeV

~CFsTreeList()

IMPORT_C ~CFsTreeList ( ) [virtual]

C++ destructor

Member Functions Documentation

AddObserverL(MFsTreeListObserver &)

IMPORT_C void AddObserverL ( MFsTreeListObserver & aTreeListObserver )

Adds observer to the list of observers

Parameters

MFsTreeListObserver & aTreeListObserver Reference to the list observer

BeginUpdate()

void BeginUpdate ( )

MFsTreeBatchProcessing::BeginUpdate

Child(const TFsTreeItemId, const TUint)

IMPORT_C TFsTreeItemId Child ( const TFsTreeItemId aNodeId,
const TUint aIndex
) const

Gets the id of a child of the specified node with the position given

panic
EFsListPanicInvalidItemId The specified item id was not found in the list
panic
EFsListPanicInvalidItemType Item id was passed instead of the node id
panic
EFsListPanicIndexOutOfRange Specified index exceeds node's number of children

Parameters

const TFsTreeItemId aNodeId Id of a node
const TUint aIndex Index of the child

ChildIndex(const TFsTreeItemId, const TFsTreeItemId)

IMPORT_C TUint ChildIndex ( const TFsTreeItemId aNodeId,
const TFsTreeItemId aItemId
) const

Returns the index of a child for a given parent

panic
EFsListPanicInvalidItemId The specified item id was not found in the list
panic
EFsListPanicInvalidItemType Item id was passed instead of the node id
panic
EFsListPanicIndexOutOfRange Specified index exceeds node's number of children

Parameters

const TFsTreeItemId aNodeId Id of a node
const TFsTreeItemId aItemId Id of a child

CollapseNodeL(const TFsTreeItemId)

IMPORT_C void CollapseNodeL ( const TFsTreeItemId aNodeId )

Collapses the node. Does nothing when the node is already collapsed.

panic
EFsListPanicInvalidItemId The specified item id was not found in the list
panic
EFsListPanicInvalidItemType Item id was passed instead of the node id

Parameters

const TFsTreeItemId aNodeId Id of a node

ConstructL(CAlfEnv &)

IMPORT_C void ConstructL ( CAlfEnv & aEnv ) [protected]

Second phase constructor

Parameters

CAlfEnv & aEnv Reference to the UI toolkit environment

Contains(const TFsTreeItemId)

IMPORT_C TBool Contains ( const TFsTreeItemId aItemId ) const

Checks whether the item with specified id belongs to the list

Parameters

const TFsTreeItemId aItemId Id of an item

Count()

IMPORT_C TUint Count ( ) const

Counts elements in the list

CountChildren(const TFsTreeItemId)

IMPORT_C TUint CountChildren ( const TFsTreeItemId aNodeId ) const

Gets the number of children of the given node

panic
EFsListPanicInvalidItemId The specified item id was not found in the list
panic
EFsListPanicInvalidItemType Item id was passed instead of the node id

Parameters

const TFsTreeItemId aNodeId Id of the node

DisableKineticScrolling(TBool)

IMPORT_C void DisableKineticScrolling ( TBool aDisable )

Disables kinetic scrolling (Drag events will not scroll the list).

Parameters

TBool aDisable ETrue if kinetic scrolling should be disabled.

EndUpdateL()

void EndUpdateL ( )

MFsTreeBatchProcessing::EndUpdateL

ExpandNodeL(const TFsTreeItemId)

IMPORT_C void ExpandNodeL ( const TFsTreeItemId aNodeId )

Expands the node. Does nothing when the node is already expanded.

panic
EFsListPanicInvalidItemId The specified item id was not found in the list
panic
EFsListPanicInvalidItemType Item id was passed instead of the node id

Parameters

const TFsTreeItemId aNodeId Id of a node

FadeInEffectTime()

IMPORT_C TInt FadeInEffectTime ( )

The functions returns fade-in's effect duration.

FadeOutEffectTime()

IMPORT_C TInt FadeOutEffectTime ( )

The functions returns fade-out's effect duration.

FocusedItem()

IMPORT_C TFsTreeItemId FocusedItem ( ) const

Gets the currently focused (highlighted) item id

GetItemDisplayRectTarget(const TFsTreeItemId, TAlfRealRect &)

IMPORT_C TInt GetItemDisplayRectTarget ( const TFsTreeItemId aItemId,
TAlfRealRect & aRect
)

Returns the items's target bounding rectangle in display coordinates if the item is visible. Display coordinates are defined relative to the display's visible area.

Parameters

const TFsTreeItemId aItemId Item's ID.
TAlfRealRect & aRect Out parameter. If successfull, contains item's target rectangle.

GetMarkedItemsL(RFsTreeItemIdList &)

IMPORT_C void GetMarkedItemsL ( RFsTreeItemIdList & aMarkedItems ) const

Gets the list of marked items

Parameters

RFsTreeItemIdList & aMarkedItems Reference to the array that the list will copy array of marked items' ids to

GetScrollTime(TInt &, TReal &)

IMPORT_C void GetScrollTime ( TInt & aScrollTime,
TReal & aScrollAcceleration
)

Function gets the values of scroll speed and its acceleration rate.

Parameters

TInt & aScrollTime Time (in miliseconds) at which the list items are scrolled.
TReal & aScrollAcceleration Rate of scroll acceleration when the up/down key is pressed for a long time.

HasScrollBars()

IMPORT_C TFsTreeListScrollbars HasScrollBars ( ) const

OLD API - to be removed. Returns information about scrollbars used by list visual

HideListL(const TBool, const TBool)

IMPORT_C void HideListL ( const TBool aFadeOut = EFalse,
const TBool aSlideOut = EFalse
)

Hides the list.

Parameters

const TBool aFadeOut = EFalse Defines if list visual should or shouldn't fade out from the screen.
const TBool aSlideOut = EFalse ETrue if slide out effect should be used,EFalse if not

Indentation()

IMPORT_C TInt Indentation ( ) const

Returns information whether list enables indention or not

InsertItemL(MFsTreeItemData &, MFsTreeItemVisualizer &, const TFsTreeItemId, const TInt, const TBool)

IMPORT_C TFsTreeItemId InsertItemL ( MFsTreeItemData & aItemD,
MFsTreeItemVisualizer & aItemV,
const TFsTreeItemId aParentId,
const TInt aIndex = -1,
const TBool aAllowRefresh = ETrue
)

Inserts new item as a child of parent given by Id with the given position

panic
EFsListPanicParentIdNotFound The specified parent id was not found
panic
EFsListPanicIndexOutOfRange Specified index exceeds node's number of children

Parameters

MFsTreeItemData & aItemD Pointer to item's data
MFsTreeItemVisualizer & aItemV Pointer to item's visualizer
const TFsTreeItemId aParentId Id of parent node
const TInt aIndex = -1 Position of new item in the list of parent's children (if omitted, the item is inserted as last)
const TBool aAllowRefresh = ETrue Blocks/Allows view update after an item has been added to the tree list. Currently works only with scrollbar update.

InsertNodeL(MFsTreeItemData &, MFsTreeNodeVisualizer &, const TFsTreeItemId, const TInt, const TBool)

IMPORT_C TFsTreeItemId InsertNodeL ( MFsTreeItemData & aItemD,
MFsTreeNodeVisualizer & aNodeV,
const TFsTreeItemId aParentId,
const TInt aIndex = -1,
const TBool aAllowRefresh = ETrue
)

Inserts new node as a child of parent given by Id with the given position

panic
EFsListPanicParentIdNotFound The specified parent id was not found
panic
EFsListPanicIndexOutOfRange Specified index exceeds node's number of children

Parameters

MFsTreeItemData & aItemD Pointer to node's data
MFsTreeNodeVisualizer & aNodeV
const TFsTreeItemId aParentId Id of parent node
const TInt aIndex = -1 Position of new node in the list of parent's children (if omitted, the node is inserted as last)
const TBool aAllowRefresh = ETrue

IsEmpty(const TFsTreeItemId)

IMPORT_C TBool IsEmpty ( const TFsTreeItemId aNodeId =  KFsTreeRootID ) const

Checks if a node has children, if parameter is omitted, root of the list is checked to indicate if the list is empty

panic
EFsListPanicInvalidItemId The specified item id was not found in the list
panic
EFsListPanicInvalidItemType Item id was passed instead of the node id

Parameters

const TFsTreeItemId aNodeId =  KFsTreeRootID Id of a node

IsExpanded(const TFsTreeItemId)

IMPORT_C TBool IsExpanded ( const TFsTreeItemId aNodeId )

Checks whether the node with specified id is expanded.

panic
EFsListPanicInvalidItemId The specified item id was not found in the list
panic
EFsListPanicInvalidItemType Item id was passed instead of the node id

Parameters

const TFsTreeItemId aNodeId Id of a node

IsFocused()

IMPORT_C TBool IsFocused ( ) const

Returns state of the focus

IsItemsAlwaysExtended()

IMPORT_C TBool IsItemsAlwaysExtended ( )

IsMarked(const TFsTreeItemId)

IMPORT_C TBool IsMarked ( const TFsTreeItemId aItemId ) const

Checks whether the item with specified id is marked.

panic
EFsListPanicInvalidItemId The specified item id was not found in the list.

Parameters

const TFsTreeItemId aItemId Id of an item.

IsNode(const TFsTreeItemId)

IMPORT_C TBool IsNode ( const TFsTreeItemId aItemId ) const

Checks whether the item with specified id is a node

panic
EFsListPanicInvalidItemId The specified item id was not found in the list

Parameters

const TFsTreeItemId aItemId Id of an item

ItemData(const TFsTreeItemId)

IMPORT_C MFsTreeItemData & ItemData ( const TFsTreeItemId aItemId ) const

Gets the reference to the item/node data (const)

panic
EFsListPanicInvalidItemId The specified item id was not found in the list

Parameters

const TFsTreeItemId aItemId Id of the item/node

ItemMenu(TFsTreeItemId)

IMPORT_C CFsTreeList * ItemMenu ( TFsTreeItemId aItemId )

Returns item visualizer for given item id.

Parameters

TFsTreeItemId aItemId

ItemVisualizer(const TFsTreeItemId)

IMPORT_C MFsTreeItemVisualizer & ItemVisualizer ( const TFsTreeItemId aItemId ) const

Gets the reference to the item visualizer (const)

panic
EFsListPanicInvalidItemId The specified item id was not found in the list

Parameters

const TFsTreeItemId aItemId Id of the item

Level(const TFsTreeItemId)

IMPORT_C TUint Level ( const TFsTreeItemId aItemId ) const

Returns the level of an item in tree.

Parameters

const TFsTreeItemId aItemId Id of an item.

LoopingType()

IMPORT_C TFsTreeListLoopingType LoopingType ( ) const

Returns information about looping type of the list.

MarkItemL(const TFsTreeItemId, TBool)

IMPORT_C void MarkItemL ( const TFsTreeItemId aItemId,
TBool aMarked
)

Marks the item.

panic
EFsListPanicInvalidItemId The specified item id was not found in the list
panic
EFsListPanicIsNonMarkable The list is non-markable

Parameters

const TFsTreeItemId aItemId Id of an item
TBool aMarked ETrue to set item marked, EFalse to unmarked.

MarkType()

IMPORT_C TFsTreeListMarkType MarkType ( ) const

Returns information whether list is markable, non-markable or multi-markable

MoveItemL(const TFsTreeItemId, const TFsTreeItemId, const TInt)

IMPORT_C void MoveItemL ( const TFsTreeItemId aItemId,
const TFsTreeItemId aTargetNode,
const TInt aIndex = -1
)

Moves the item with given Id to the list of children of parent with given id

panic
EFsListPanicInvalidItemId The specified item id was not found in the list
panic
EFsListPanicParentIdNotFound The specified parent id was not found
panic
EFsListPanicInvalidItemType Item id was passed as a second param instead of the node id
panic
EFsListPanicIndexOutOfRange Specified index exceeds node's number of children

Parameters

const TFsTreeItemId aItemId Id of the item to be moved
const TFsTreeItemId aTargetNode Id of the new parent node
const TInt aIndex = -1 Position of the item in the list of new parent's children (if omitted, the item/node is inserted as last)

NewL(CFsTreeVisualizerBase &, CAlfEnv &)

IMPORT_C CFsTreeList * NewL ( CFsTreeVisualizerBase & aTreeV,
CAlfEnv & aEnv
) [static]

Two-phased constructor

Parameters

CFsTreeVisualizerBase & aTreeV Pointer to the class responsible for visualizing tree structure
CAlfEnv & aEnv Reference to the UI toolkit environment

Parent(const TFsTreeItemId)

IMPORT_C TFsTreeItemId Parent ( const TFsTreeItemId aItemId ) const

Gets the parent's id for the specified item. If KFsTreeRootID is passed then KFsTreeNoneID is returned.

panic
EFsListPanicInvalidItemId The specified item id was not found in the list

Parameters

const TFsTreeItemId aItemId Id of an item

RemoveAllL()

IMPORT_C void RemoveAllL ( )

Removes all items from the list.

RemoveChildrenL(const TFsTreeItemId)

IMPORT_C void RemoveChildrenL ( const TFsTreeItemId aNodeId )

Removes all children of the given node.

panic
EFsListPanicInvalidItemId The specified item id was not found in the list
panic
EFsListPanicInvalidItemType Item id was passed instead of the node id

Parameters

const TFsTreeItemId aNodeId Id of the node

RemoveL(const TFsTreeItemId)

IMPORT_C void RemoveL ( const TFsTreeItemId aItemId )

Removes the item with given Id from the list. If aItemId is a node all its children will be removed as well.

panic
EFsListPanicInvalidItemId The specified item id was not found in the list

Parameters

const TFsTreeItemId aItemId Id of the item to be removed

RemoveObserver(MFsTreeListObserver &)

IMPORT_C void RemoveObserver ( MFsTreeListObserver & aTreeListObserver )

Removes observer from the list of observers

panic
ETreeListPanicObserverNotFound The given observer was not registered previously

Parameters

MFsTreeListObserver & aTreeListObserver Reference to the list observer

ScrollbarVisibility()

IMPORT_C TFsScrollbarVisibility ScrollbarVisibility ( ) const

Returns information about scrollbars used by list visual

SetBorderL(const TBool, CAlfTexture *)

IMPORT_C void SetBorderL ( const TBool aVisible,
CAlfTexture * aBorderTexture = 0
) [virtual]

Sets visiblity of the border

Parameters

const TBool aVisible
CAlfTexture * aBorderTexture = 0

SetDirectTouchMode(const TBool)

IMPORT_C void SetDirectTouchMode ( const TBool aDirectTouchMode )

Sets direct touch mode.

Parameters

const TBool aDirectTouchMode ETrue if list should work as in direct touch, EFalse otherwise.

SetFadeInEffectTime(TInt)

IMPORT_C void SetFadeInEffectTime ( TInt aFadeTime )

The functions sets fade-in's effect duration.

Parameters

TInt aFadeTime A time in miliseconds for fade in effect.

SetFadeOutEffectTime(TInt)

IMPORT_C void SetFadeOutEffectTime ( TInt aFadeTime )

The functions sets fade-out's effect duration.

Parameters

TInt aFadeTime A time in miliseconds for fade-out effect.

SetFocusedItemL(const TFsTreeItemId)

IMPORT_C void SetFocusedItemL ( const TFsTreeItemId aItemId )

Sets the focus (highlight) upon the item with given id

panic
EFsListPanicInvalidItemId The specified item id was not found in the list

Parameters

const TFsTreeItemId aItemId Id of the item that is to be focused (highlighted)

SetFocusedL(const TBool)

IMPORT_C void SetFocusedL ( const TBool aFocused )

Sets focus state of list component

Parameters

const TBool aFocused status of the focus to be set

SetIndentationL(const TInt)

IMPORT_C void SetIndentationL ( const TInt aIndentation )

Enables or disables indention for list

Parameters

const TInt aIndentation Indentation in pixels.

SetItemDataL(MFsTreeItemData &, const TFsTreeItemId)

IMPORT_C void SetItemDataL ( MFsTreeItemData & aData,
const TFsTreeItemId aItemId
)

Sets the reference to the item/node data

panic
EFsListPanicInvalidItemId The specified item id was not found in the list

Parameters

MFsTreeItemData & aData Reference to the item/node data
const TFsTreeItemId aItemId Id of the item/node

SetItemVisualizerL(MFsTreeItemVisualizer &, const TFsTreeItemId)

IMPORT_C void SetItemVisualizerL ( MFsTreeItemVisualizer & aVisualizer,
const TFsTreeItemId aItemId
)

Sets the reference to the item visualizer

panic
EFsListPanicInvalidItemId The specified item id was not found in the list

Parameters

MFsTreeItemVisualizer & aVisualizer Reference to the new item's visualizer
const TFsTreeItemId aItemId Id of the item

SetItemsAlwaysExtendedL(TBool)

IMPORT_C void SetItemsAlwaysExtendedL ( TBool aAlwaysExtended )

The functions sets wether all item in the list should be always in extended state or in normal state. The list view is refreshed.

Parameters

TBool aAlwaysExtended ETrue if items should be always extended. EFalse if items should be in normal state.

SetLoopingType(const TFsTreeListLoopingType)

IMPORT_C void SetLoopingType ( const TFsTreeListLoopingType aLoopingType )

Sets type of list's looping.

Parameters

const TFsTreeListLoopingType aLoopingType type of list looping.

SetMarkTypeL(const TFsTreeListMarkType)

IMPORT_C void SetMarkTypeL ( const TFsTreeListMarkType aFlag )

Enables or disables marking of list items

Parameters

const TFsTreeListMarkType aFlag Type of markability for the list

SetScrollBarsL(const TFsTreeListScrollbars)

IMPORT_C void SetScrollBarsL ( const TFsTreeListScrollbars aFlag )

Old API - to be removed

Parameters

const TFsTreeListScrollbars aFlag Scrollbar type for the list

SetScrollTime(TInt, TReal)

IMPORT_C void SetScrollTime ( TInt aScrollTime,
TReal aScrollAcceleration = 0.0
)

Function sets the time of list scroll per item and the scroll acceleration rate.

Parameters

TInt aScrollTime Time (in miliseconds) at which the list items are scrolled.
TReal aScrollAcceleration = 0.0 Rate of scroll acceleration when the up/down key is pressed for a long time. This is multiplied by the number of up/down key repeats. Acceleration rate should be in 0.0-1.0 range.

SetScrollbarVisibilityL(const TFsScrollbarVisibility)

IMPORT_C void SetScrollbarVisibilityL ( const TFsScrollbarVisibility aVisibility )

Enables or disables scrollbars

Parameters

const TFsScrollbarVisibility aVisibility

SetShadowL(const TBool)

IMPORT_C void SetShadowL ( const TBool aVisible )

Sets visiblity of the shadow

Parameters

const TBool aVisible

SetSlideInDirection(MFsTreeVisualizer::TFsSlideEffect)

IMPORT_C void SetSlideInDirection ( MFsTreeVisualizer::TFsSlideEffect aDirection )

The function sets direction of the slide in effect.

Parameters

MFsTreeVisualizer::TFsSlideEffect aDirection A direction of the slide in effect.

SetSlideInDuration(TInt)

IMPORT_C void SetSlideInDuration ( TInt aTimeMiliseconds )

The function sets duration of the slide-in effect.

Parameters

TInt aTimeMiliseconds Slide in time in milliseconds.

SetSlideOutDirection(MFsTreeVisualizer::TFsSlideEffect)

IMPORT_C void SetSlideOutDirection ( MFsTreeVisualizer::TFsSlideEffect aDirection )

The function sets direction of the slide out effect.

Parameters

MFsTreeVisualizer::TFsSlideEffect aDirection A direction of the slide out effect.

SetSlideOutDuration(TInt)

IMPORT_C void SetSlideOutDuration ( TInt aTimeMiliseconds )

The function sets duration of the slide-out effect.

Parameters

TInt aTimeMiliseconds Slide out time in milliseconds.

SetTextMarqueeCycleStartDelay(const TInt)

IMPORT_C void SetTextMarqueeCycleStartDelay ( const TInt aCycleStartDelay )

Sets a delay for each cycle start.

Parameters

const TInt aCycleStartDelay Time after which the text marquee cycle starts (in miliseconds).

SetTextMarqueeRepetitions(const TInt)

IMPORT_C void SetTextMarqueeRepetitions ( const TInt aMarqueeRepetitions )

Sets repetitions number of marquee cycle.

Parameters

const TInt aMarqueeRepetitions

SetTextMarqueeSpeed(const TInt)

IMPORT_C void SetTextMarqueeSpeed ( const TInt aPixelsPerSec )

Sets the speed of marquee.

Parameters

const TInt aPixelsPerSec How many pixels per second.

SetTextMarqueeStartDelay(const TInt)

IMPORT_C void SetTextMarqueeStartDelay ( const TInt aStartDelay )

Sets delay for text marquee start.

Parameters

const TInt aStartDelay Time after which the text marquee starts (in miliseconds).

SetTextMarqueeType(const TFsTextMarqueeType)

IMPORT_C void SetTextMarqueeType ( const TFsTextMarqueeType aMarquee )

Sets the type of text marquee.

Parameters

const TFsTextMarqueeType aMarquee Type of marquee.

SetTreeVisualizer(CFsTreeVisualizerBase &)

IMPORT_C void SetTreeVisualizer ( CFsTreeVisualizerBase & aTreeV )

Sets a tree visualizer for the list

Parameters

CFsTreeVisualizerBase & aTreeV Reference to the tree visualizer that the tree list will be using

ShowListL(const TBool, const TBool)

IMPORT_C void ShowListL ( const TBool aFadeIn = EFalse,
const TBool aSlideIn = EFalse
)

Displays the list.

Parameters

const TBool aFadeIn = EFalse Defines if list visual should or shouldn't fade in to the screen.
const TBool aSlideIn = EFalse ETrue if slide in effect should be used, EFalse if not.

SlideInDirection()

IMPORT_C MFsTreeVisualizer::TFsSlideEffect SlideInDirection ( ) const

The function returns direction of the slide in effect.

SlideInDuration()

IMPORT_C TInt SlideInDuration ( ) const

The function returns slide in effect's duration.

SlideOutDirection()

IMPORT_C MFsTreeVisualizer::TFsSlideEffect SlideOutDirection ( ) const

The function returns direction of the slide out effect.

SlideOutDuration()

IMPORT_C TInt SlideOutDuration ( ) const

The function returns slide out effect's duration.

TextMarqueeCycleStartDelay()

IMPORT_C TInt TextMarqueeCycleStartDelay ( ) const

Returns a delay for each cycle start.

TextMarqueeRepetitions()

IMPORT_C TInt TextMarqueeRepetitions ( ) const

Returns repetitions number of marquee cycle.

TextMarqueeSpeed()

IMPORT_C TInt TextMarqueeSpeed ( ) const

Returns the speed of marquee.

TextMarqueeStartDelay()

IMPORT_C TInt TextMarqueeStartDelay ( ) const

Returns delay for text marquee.

TextMarqueeType()

IMPORT_C TFsTextMarqueeType TextMarqueeType ( ) const

Returns the type of text marquee.

TextStyleManager()

IMPORT_C CFsAlfTextStyleManager & TextStyleManager ( ) const

Gets the reference to the text style manager.

TreeControl()

IMPORT_C CAlfControl * TreeControl ( ) const

Returns a hitckcock control associated with the component.

TreeVisualizer()

IMPORT_C CFsTreeVisualizerBase & TreeVisualizer ( ) const

Gets the reference to the tree visualizer

TreeVisualizerEventL(const TFsTreeVisualizerEvent, const TFsTreeItemId, const TPoint &)

IMPORT_C void TreeVisualizerEventL ( const TFsTreeVisualizerEvent aEvent,
const TFsTreeItemId aId,
const TPoint & aPoint
) const [virtual]

Parameters

const TFsTreeVisualizerEvent aEvent
const TFsTreeItemId aId
const TPoint & aPoint

Member Enumerations Documentation

Enum TFsTreeListMarkType

Pre-defined types of markability in list

Enumerators

EFsTreeListNonMarkable
EFsTreeListMarkable
EFsTreeListMultiMarkable

Enum TFsTreeListScrollbars

Pre-defined types of scrolling in list OLD API - to be removed.

Enumerators

EFsTreeListNoScrollbars
EFsTreeListVerticalScrollbar

Member Data Documentation

CAlfEnv * iEnv

CAlfEnv * iEnv [protected]

Alf env

TFsTreeItemId iFocusedItem

TFsTreeItemId iFocusedItem [protected]

Id of the focused item

TFsTreeListScrollbars iHasScrollBars

TFsTreeListScrollbars iHasScrollBars [protected]

part of OLD API - to be removed. SScrollbar flag

TBool iIsLooping

TBool iIsLooping [protected]

Loop flag

TBool iListFocused

TBool iListFocused [protected]

The list has focus or not.

TFsTreeListMarkType iMarkType

TFsTreeListMarkType iMarkType [protected]

Type of markability

RFsTreeListObservers iObservers

RFsTreeListObservers iObservers [protected]

Array of observers

CFsAlfTextStyleManager * iTextStyleManager

CFsAlfTextStyleManager * iTextStyleManager [protected]

Text style manager. Own

CFsTree * iTree

CFsTree * iTree [protected]

Tree data structure clas Own

CFsTreeControl * iTreeControl

CFsTreeControl * iTreeControl [protected]

Controller class for the list Own

CFsTreeVisualizerBase * iTreeVisualizer

CFsTreeVisualizerBase * iTreeVisualizer [protected]

Visualizer class Not own

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.