Symbian^3 Application Developer Library >

MFsTreeVisualizer Class Reference

class MFsTreeVisualizer

MFsTreeVisualizer is an interface for the tree visualizers.
Public Member Functions
~MFsTreeVisualizer ()
void CollapseAllL ()
void ExpandAllL ()
TFsTreeItemId FocusedItem ()
TBool HandleKeyEventL (const TAlfEvent &)
TBool HandlePointerEventL (const TAlfEvent &)
void HideList (const TBool , const TBool )
TBool IsFocused (const TFsTreeItemId )
TBool IsItemsAlwaysExtended ()
TInt ItemExpansionDelay ()
TFsTreeListLoopingType LoopingType ()
void NotifyControlVisibilityChange ( TBool )
void RefreshListViewL ()
MFsTreeItemData * RootItemData ()
MFsTreeNodeVisualizer * RootNodeVisualizer ()
void SetEmptyListTextL (const TDesC &)
void SetFocusedItemL ( TFsTreeItemId , TBool )
void SetItemExpansionDelay (const TInt )
void SetItemSeparatorColor (const TRgb &)
void SetItemSeparatorSize (const TSize )
void SetItemsAlwaysExtendedL ( TBool )
void SetLoopingType (const TFsTreeListLoopingType )
void SetSlideInDirection ( TFsSlideEffect )
void SetSlideInDuration ( TInt )
void SetSlideOutDirection ( TFsSlideEffect )
void SetSlideOutDuration ( TInt )
void SetTextMarqueeRepetitions (const TInt )
void SetTextMarqueeSpeed (const TInt )
void SetTextMarqueeStartDelay (const TInt )
void SetTextMarqueeType (const TFsTextMarqueeType )
void ShowListL (const TBool , const TBool )
TFsSlideEffect SlideInDirection ()
TInt SlideInDuration ()
TFsSlideEffect SlideOutDirection ()
TInt SlideOutDuration ()
TInt TextMarqueeRepetitions ()
TInt TextMarqueeSpeed ()
TInt TextMarqueeStartDelay ()
TFsTextMarqueeType TextMarqueeType ()
void UpdateItemL (const TFsTreeItemId )
Public Member Enumerations
enum TFsSlideEffect { ESlideNone  = 0, ESlideFromTop , ESlideFromBottom , ESlideFromRight , ESlideFromLeft }

Constructor & Destructor Documentation

~MFsTreeVisualizer()

~MFsTreeVisualizer ( ) [inline, virtual]

C++ destructor

Member Functions Documentation

CollapseAllL()

void CollapseAllL ( ) [pure virtual]

ExpandAllL()

void ExpandAllL ( ) [pure virtual]

FocusedItem()

TFsTreeItemId FocusedItem ( ) const [pure virtual]

Returns item id of the currently focused item.

HandleKeyEventL(const TAlfEvent &)

TBool HandleKeyEventL ( const TAlfEvent & aEvent ) [pure virtual]

Handles key event forwarded by the controller.

Parameters

const TAlfEvent & aEvent Key event to handle.

HandlePointerEventL(const TAlfEvent &)

TBool HandlePointerEventL ( const TAlfEvent & aEvent ) [pure virtual]

Handles key event forwarded by the controller.

Parameters

const TAlfEvent & aEvent Pointer event to investigate.

HideList(const TBool, const TBool)

void HideList ( const TBool aFadeOut = EFalse,
const TBool aSlideOut = EFalse
) [pure virtual]

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

IsFocused(const TFsTreeItemId)

TBool IsFocused ( const TFsTreeItemId aItem ) const [pure virtual]

Checks if the specified item is focused.

Parameters

const TFsTreeItemId aItem Item to be checked.

IsItemsAlwaysExtended()

TBool IsItemsAlwaysExtended ( ) [pure virtual]

ItemExpansionDelay()

TInt ItemExpansionDelay ( ) const [pure virtual]

Gets the delay for the item expansion animation.

LoopingType()

TFsTreeListLoopingType LoopingType ( ) const [pure virtual]

Returns information about looping type of the list.

NotifyControlVisibilityChange(TBool)

void NotifyControlVisibilityChange ( TBool aIsVisible ) [pure virtual]

Parameters

TBool aIsVisible

RefreshListViewL()

void RefreshListViewL ( ) [pure virtual]

Refreshes all visible items in the list.

RootItemData()

MFsTreeItemData * RootItemData ( ) [pure virtual]

Gets a pointer to the root's item data object.

RootNodeVisualizer()

MFsTreeNodeVisualizer * RootNodeVisualizer ( ) [pure virtual]

Gets a pointer to the root's item visualizer object.

SetEmptyListTextL(const TDesC &)

void SetEmptyListTextL ( const TDesC & aText ) [pure virtual]

The function sets a text for empty list's view.

Parameters

const TDesC & aText Text to be displayed.

SetFocusedItemL(TFsTreeItemId, TBool)

void SetFocusedItemL ( TFsTreeItemId aItem,
TBool aCheckFocus = ETrue
) [pure virtual]

Sets the specified item as focused.

panic
EFsListPanicInvalidItemID Item with specified ID is not found.

Parameters

TFsTreeItemId aItem indicates item to be focused.
TBool aCheckFocus = ETrue

SetItemExpansionDelay(const TInt)

void SetItemExpansionDelay ( const TInt aDelay ) [pure virtual]

Sets the delay for the item expansion animation.

Parameters

const TInt aDelay Delay in miliseconds.

SetItemSeparatorColor(const TRgb &)

void SetItemSeparatorColor ( const TRgb & aColor ) [pure virtual]

Parameters

const TRgb & aColor

SetItemSeparatorSize(const TSize)

void SetItemSeparatorSize ( const TSize aSize ) [pure virtual]

Parameters

const TSize aSize

SetItemsAlwaysExtendedL(TBool)

void SetItemsAlwaysExtendedL ( TBool aAlwaysExtended ) [pure virtual]

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)

void SetLoopingType ( const TFsTreeListLoopingType aLoopingType ) [pure virtual]

Sets type of list's looping.

Parameters

const TFsTreeListLoopingType aLoopingType type of list looping.

SetSlideInDirection(TFsSlideEffect)

void SetSlideInDirection ( TFsSlideEffect aDirection ) [pure virtual]

The function sets direction of the slide in effect.

Parameters

TFsSlideEffect aDirection A direction of the slide in effect.

SetSlideInDuration(TInt)

void SetSlideInDuration ( TInt aTimeMiliseconds ) [pure virtual]

The function sets duration of the slide-in effect.

Parameters

TInt aTimeMiliseconds Slide in time in milliseconds.

SetSlideOutDirection(TFsSlideEffect)

void SetSlideOutDirection ( TFsSlideEffect aDirection ) [pure virtual]

The function sets direction of the slide out effect.

Parameters

TFsSlideEffect aDirection A direction of the slide out effect.

SetSlideOutDuration(TInt)

void SetSlideOutDuration ( TInt aTimeMiliseconds ) [pure virtual]

The function sets duration of the slide-out effect.

Parameters

TInt aTimeMiliseconds Slide out time in milliseconds.

SetTextMarqueeRepetitions(const TInt)

void SetTextMarqueeRepetitions ( const TInt aMarqueeRepetitions ) [pure virtual]

Sets repetitions number of marquee cycle.

Parameters

const TInt aMarqueeRepetitions

SetTextMarqueeSpeed(const TInt)

void SetTextMarqueeSpeed ( const TInt aPixelsPerSec ) [pure virtual]

Sets the speed of marquee.

Parameters

const TInt aPixelsPerSec How many pixels per second.

SetTextMarqueeStartDelay(const TInt)

void SetTextMarqueeStartDelay ( const TInt aStartDelay ) [pure virtual]

Sets delay for text marquee start.

Parameters

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

SetTextMarqueeType(const TFsTextMarqueeType)

void SetTextMarqueeType ( const TFsTextMarqueeType aMarquee ) [pure virtual]

Sets the type of text marquee.

Parameters

const TFsTextMarqueeType aMarquee Type of marquee.

ShowListL(const TBool, const TBool)

void ShowListL ( const TBool aFadeIn = EFalse,
const TBool aSlideIn = EFalse
) [pure virtual]

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()

TFsSlideEffect SlideInDirection ( ) const [pure virtual]

The function returns direction of the slide in effect.

SlideInDuration()

TInt SlideInDuration ( ) const [pure virtual]

The function returns slide in effect's duration.

SlideOutDirection()

TFsSlideEffect SlideOutDirection ( ) const [pure virtual]

The function returns direction of the slide out effect.

SlideOutDuration()

TInt SlideOutDuration ( ) const [pure virtual]

The function returns slide out effect's duration.

TextMarqueeRepetitions()

TInt TextMarqueeRepetitions ( ) const [pure virtual]

Gets repetitions number of marquee cycle.

TextMarqueeSpeed()

TInt TextMarqueeSpeed ( ) const [pure virtual]

Gets the speed of marquee.

TextMarqueeStartDelay()

TInt TextMarqueeStartDelay ( ) const [pure virtual]

Gets delay for text marquee.

TextMarqueeType()

TFsTextMarqueeType TextMarqueeType ( ) const [pure virtual]

Gets the type of text marquee.

UpdateItemL(const TFsTreeItemId)

void UpdateItemL ( const TFsTreeItemId aItemId ) [pure virtual]

Refreshes all visible items in the list.

Parameters

const TFsTreeItemId aItemId

Member Enumerations Documentation

Enum TFsSlideEffect

Pre-defined slide effects directions

Enumerators

ESlideNone = 0
ESlideFromTop
ESlideFromBottom
ESlideFromRight
ESlideFromLeft

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.