CHgScroller Class Reference

class CHgScroller : public CCoeControl

Inherits from

Public Member Functions
~CHgScroller ()
IMPORT_C void AddItem ( CHgItem *)
IMPORT_C void ClearFlags ( TInt )
IMPORT_C void DisableScrollBuffer ()
void Draw (const TRect &)
IMPORT_C void EnableScrollBufferL ( MHgScrollBufferObserver &, TInt , TInt )
IMPORT_C TInt FirstIndexOnScreen ()
IMPORT_C TInt Flags ()
void FocusChanged ( TDrawNow )
IMPORT_C void GetMarkedItemsL ( RArray < TInt > &)
void HandlePointerEventL (const TPointerEvent &)
void HandleResourceChange ( TInt )
IMPORT_C TBool HightlightItem (const TDesC &)
IMPORT_C void InitScreenL (const TRect &, RWsSession &)
IMPORT_C void InitScreenL (const TRect &)
TCoeInputCapabilities InputCapabilities ()
IMPORT_C void InsertItem ( CHgItem *, TInt )
IMPORT_C TInt ItemCount ()
IMPORT_C CHgItem & ItemL ( TInt )
IMPORT_C TInt ItemsOnScreen ()
IMPORT_C void Mark ( TInt )
IMPORT_C void MarkAll ()
TKeyResponse OfferKeyEventL (const TKeyEvent &, TEventCode )
IMPORT_C void RefreshScreen ( TInt )
IMPORT_C void RemoveItem ( TInt )
IMPORT_C void Reset ()
IMPORT_C void ResizeL ( TInt )
IMPORT_C TInt SelectedIndex ()
TSelectionMode SelectionMode ()
IMPORT_C void SetDefaultIconL ( CGulIcon *)
IMPORT_C void SetEmptyTextL (const TDesC &)
IMPORT_C void SetFirstIndexOnScreen ( TInt )
IMPORT_C void SetFlags ( TInt )
IMPORT_C void SetItem ( CHgItem *, TInt )
IMPORT_C void SetMarkingObserver ( MHgMarkingObserver &)
IMPORT_C void SetMenuProviderL ( MObjectProvider *)
IMPORT_C void SetScrollBarTypeL ( THgScrollBarType )
IMPORT_C void SetSelectedIndex ( TInt )
void SetSelectionMode ( TSelectionMode )
IMPORT_C void SetSelectionObserver ( MHgSelectionObserver &)
void SizeChanged ()
IMPORT_C void UnMark ( TInt )
IMPORT_C void UnMarkAll ()
Protected Member Functions
CHgScroller ( TInt , CGulIcon *)
TInt CollectionExtension ( TUint , TAny *&, TAny *)
TUint CollectionState ()
void ConstructL (const TRect &, RWsSession *)
TInt CurrentIndex ()
void DoDraw (const TRect &)
TBool DoHandleKeyEvent (const TKeyEvent &)
void FitRowToView ( TInt )
void FitSelectionToView ()
void FitTopItemToView ( TInt )
TInt GetSelected ( TPoint )
void HandleLongTapEventL (const TPoint &, const TPoint &)
void HandleScrollbarVisibilityChange ( TBool )
void HandleSizeChanged ()
void HandleViewPositionChanged ( TBool )
TBool HasHighlight ()
void InitDrawBuffer ()
void InitItemsL ()
void InitPhysicsL ()
TBool IsDisplayed ( TInt )
void ItemActionMenuClosed ()
TInt MarqueeCallback ( TAny *)
void PhysicEmulationEnded ()
void SelectionChanged ()
TSize TotalSize ()
TPoint ViewPosition ()
void ViewPositionChanged (const TPoint &, TBool , TUint )
Private Member Functions
void DoKeyScrolling ()
void HandleDownEventL (const TPointerEvent &)
void HandleDragEventL (const TPointerEvent &)
void HandleGainingForeground ()
void HandleItemCountChanged ()
TKeyResponse HandleKeyEvent (const TKeyEvent &)
void HandleLosingForeground ()
void HandleNaviStripChar (const TChar &)
TBool HandleScrollbarEventL (const TPointerEvent &)
void HandleSelectionL ()
void HandleUpEventL (const TPointerEvent &)
TInt HighlightTimerCallback ( TAny *)
void InitGraphicsL ()
void InitScrollbarL ()
void KeyEventDown ()
void KeyEventUp ()
TInt KeyScrollingTimerCallback ( TAny *)
void LaunchHighlightTimer ()
void Release ( TInt , TInt )
void ReleasePopupFont ()
void ScrollBarPositionChanged (const TPoint &)
void SetHighlightL ()
void StopKeyScrolling ()
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()
CCoeControl::AccumulatedZoom()const
CCoeControl::ActivateGc()const
CCoeControl::ActivateL()
CCoeControl::BackedUpWindow()const
CCoeControl::Background()const
CCoeControl::CCoeControl()
CCoeControl::CCoeControl(CCoeEnv *)
CCoeControl::CCoeControl(const CCoeControl &)
CCoeControl::CapturesPointer()const
CCoeControl::ClaimPointerGrab(TBool)
CCoeControl::ClaimPointerGrab(TInt,TBool)
CCoeControl::CloseWindow()
CCoeControl::ComponentArrayExists()const
CCoeControl::ComponentControl(TInt)const
CCoeControl::Components()
CCoeControl::Components()const
CCoeControl::ConstructFromResourceL(TResourceReader &)
CCoeControl::ControlContext()const
CCoeControl::ControlEnv()const
CCoeControl::CopyControlContextFrom(const CCoeControl *)
CCoeControl::CountComponentControls()const
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &)
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode)
CCoeControl::CreateWindowL()
CCoeControl::CreateWindowL(RWindowGroup *)
CCoeControl::CreateWindowL(RWindowTreeNode &)
CCoeControl::CreateWindowL(const CCoeControl *)
CCoeControl::CustomGc()const
CCoeControl::DeactivateGc()const
CCoeControl::DrawBackground(const TRect &)const
CCoeControl::DrawDeferred()const
CCoeControl::DrawForeground(const TRect &)const
CCoeControl::DrawNow()const
CCoeControl::DrawNow(const TRect &)const
CCoeControl::DrawableWindow()const
CCoeControl::EnableDragEvents()
CCoeControl::EnableReportControlStateChange(TBool)
CCoeControl::EnableWindowTransparency()
CCoeControl::FindBackground()const
CCoeControl::FindFontProvider()const
CCoeControl::GetColor(TInt,TRgb &)const
CCoeControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
CCoeControl::GetGc()const
CCoeControl::GetHelpContext(TCoeHelpContext &)const
CCoeControl::GrabbingComponent()const
CCoeControl::GrabbingComponent(TInt)const
CCoeControl::HandleComponentControlsResourceChange(TInt)
CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray *,CCoeControl *,TInt)
CCoeControl::HandlePointerBufferReadyL()
CCoeControl::HandleRedrawEvent(const TRect &)const
CCoeControl::HasBorder()const
CCoeControl::HitTest()const
CCoeControl::IgnoreEventsUntilNextPointerUp()
CCoeControl::Index(const CCoeControl *)const
CCoeControl::InitComponentArrayL()
CCoeControl::IsActivated()const
CCoeControl::IsBackedUp()const
CCoeControl::IsBeingDestroyed()const
CCoeControl::IsBlank()const
CCoeControl::IsDimmed()const
CCoeControl::IsFocused()const
CCoeControl::IsNonFocusing()const
CCoeControl::IsReadyToDraw()const
CCoeControl::IsVisible()const
CCoeControl::LayoutManager()const
CCoeControl::MakeVisible(TBool)
CCoeControl::MaximumWidth()const
CCoeControl::MinimumSize()
CCoeControl::MopSupplyObject(TTypeUid)
CCoeControl::NotifyFontChange(const CCoeFontProvider *)
CCoeControl::Observer()const
CCoeControl::OverrideColorL(TInt,TRgb)
CCoeControl::OwnsWindow()const
CCoeControl::Parent()
CCoeControl::Parent()const
CCoeControl::Position()const
CCoeControl::PositionChanged()
CCoeControl::PositionRelativeToScreen()const
CCoeControl::PrepareForFocusGainL()
CCoeControl::PrepareForFocusLossL()
CCoeControl::ProcessPointerBufferReadyL()
CCoeControl::ProcessPointerEventL(const TPointerEvent &)
CCoeControl::Rect()const
CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const
CCoeControl::RecursivelyMergedInputCapabilities()const
CCoeControl::RefetchPixelMappingL()
CCoeControl::RemoveFromParent()
CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent)
CCoeControl::RequestRelayout(const CCoeControl *)
CCoeControl::ResetGc()const
CCoeControl::ScreenFont(const TCoeFont &)const
CCoeControl::SetAdjacent(TInt)
CCoeControl::SetAllowStrayPointers()
CCoeControl::SetBackground(const MCoeControlBackground *)
CCoeControl::SetBlank()
CCoeControl::SetCanDrawOutsideRect()
CCoeControl::SetComponentsToInheritVisibility(TBool)
CCoeControl::SetContainerWindowL(RBackedUpWindow &)
CCoeControl::SetContainerWindowL(RWindow &)
CCoeControl::SetContainerWindowL(const CCoeControl &)
CCoeControl::SetControlContext(MCoeControlContext *)
CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
CCoeControl::SetCustomGc(CWindowGc *)
CCoeControl::SetDimmed(TBool)
CCoeControl::SetExtent(const TPoint &,const TSize &)
CCoeControl::SetExtentToWholeScreen()
CCoeControl::SetFocus(TBool,TDrawNow)
CCoeControl::SetFocusing(TBool)
CCoeControl::SetFontProviderL(const CCoeFontProvider &)
CCoeControl::SetGc(CWindowGc *)const
CCoeControl::SetGloballyCapturing(TBool)
CCoeControl::SetHitTest(const MCoeControlHitTest *)
CCoeControl::SetLayoutManagerL(MCoeLayoutManager *)
CCoeControl::SetMaximumWidth(TInt)
CCoeControl::SetMopParent(MObjectProvider *)
CCoeControl::SetNeighbor(CCoeControl *)
CCoeControl::SetNonFocusing()
CCoeControl::SetObserver(MCoeControlObserver *)
CCoeControl::SetParent(CCoeControl *)
CCoeControl::SetPointerCapture(TBool)
CCoeControl::SetPosition(const TPoint &)
CCoeControl::SetRect(const TRect &)
CCoeControl::SetSize(const TSize &)
CCoeControl::SetSizeWithoutNotification(const TSize &)
CCoeControl::SetTextBaselineSpacing(TInt)
CCoeControl::SetUniqueHandle(TInt)
CCoeControl::SetZoomFactorL(TInt,TZoomType)
CCoeControl::Size()const
CCoeControl::SystemGc()const
CCoeControl::TextBaselineOffset(const TSize &)const
CCoeControl::TextDrawer(TInt)const
CCoeControl::UniqueHandle()const
CCoeControl::Window()const
CCoeControl::WriteInternalStateL(RWriteStream &)const
CCoeControl::WriteInternalStateNowL(RWriteStream &)const
CCoeControl::ZoomWithType()const
CCoeControl::operator=(const CCoeControl &)
CCoeControl::~CCoeControl()
Public Member Enumerations
enum THgScrollBarType { EHgScrollerScrollBar  = 0, EHgScrollerLetterStrip , EHgScrollerTimeStrip , EHgScrollerLetterStripLite }
enum THgScrollerMode {
EHgScrollerSelectionMode  = 0x0001, EHgScrollerSearchWithQWERTY  = 0x0002, EHgScrollerKeyMarkingDisabled  = 0x0004, EHgScrollerScreenFreeze  = 0x0008, EHgScrollerForceDoubleClick  = 0x0010, EHgScrollerFlatStatusPane  = 0x0020
}
enum TSelectionMode { ENoSelection  = 0, ESelectionPossible , ESelectionMark , ESelectionUnMark }
Protected Member Enumerations
enum TKeyScrollingState { ENoKeyScrolling  = 0, EKeyScrollingUp , EKeyScrollingDown , EKeyScrollingLeft , EKeyScrollingRight }
Inherited Enumerations
CCoeControl:TZoomType
Protected Attributes
CAknItemActionMenu * iActionMenu
TInt iCurrentRow
CGulIcon * iDefaultIcon
CAknLongTapDetector * iDetector
CHgDrawUtils * iDrawUtils
HBufC * iEmptyText
TInt iFlags
TInt iFocusedIndex
TInt iHeight
CPeriodic * iHighlightTimer
TSize iImageSize
CHgIndicatorManager * iIndicatorManager
TSize iIndicatorSize
TInt iItemCount
RPointerArray < CHgItem > iItems
TInt iItemsOnScreen
TInt iKeyRepeats
enum CHgScroller::TKeyScrollingState iKeyScrollingState
CPeriodic * iKeyScrollingTimer
CHgKeyUtils * iKeyUtils
TBool iLandscapeScrolling
CHgScrollBufferManager * iManager
MHgMarkingObserver * iMarkingObserver
TInt iOldWinPos
TBool iPanning
CAknPhysics * iPhysics
TBool iPointerDown
THgPopupDrawer * iPopupDrawer
CFont * iPopupFont
RBuf iPopupText1
RBuf iPopupText2
TPoint iPrev
TBool iResetViewPosition
TInt iRowHeight
THgScrollBarType iScrollBarType
CHgScrollbar * iScrollbar
TInt iSelectedIndex
TSelectionMode iSelectionMode
MHgSelectionObserver * iSelectionObserver
TBool iSelectionToFocusedItem
TBool iShowHighlight
TPoint iStart
TTime iStartTime
CHgTextFind * iTextFind
RBuf iUpperCaseTitle
TPoint iViewPosition
TInt iWidth
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize

Constructor & Destructor Documentation

CHgScroller(TInt, CGulIcon *)

CHgScroller ( TInt aItemCount,
CGulIcon * aDefaultIcon
) [protected]

Parameters

TInt aItemCount
CGulIcon * aDefaultIcon

~CHgScroller()

IMPORT_C ~CHgScroller ( ) [virtual]

Member Functions Documentation

AddItem(CHgItem *)

IMPORT_C void AddItem ( CHgItem * aItem )

Adds Item.

Parameters

CHgItem * aItem New item. Ownership transferred.

ClearFlags(TInt)

IMPORT_C void ClearFlags ( TInt aFlags )

Clear mode flags. Possible values are defined in THgScrollerMode.

Parameters

TInt aFlags flags to be cleared.

CollectionExtension(TUint, TAny *&, TAny *)

TInt CollectionExtension ( TUint aExtensionId,
TAny *& a0,
TAny * a1
) [protected]

Parameters

TUint aExtensionId
TAny *& a0
TAny * a1

CollectionState()

TUint CollectionState ( ) const [protected]

ConstructL(const TRect &, RWsSession *)

void ConstructL ( const TRect & aRect,
RWsSession * aSession
) [protected]

Usage:

         #include <featdiscovery.h>
  #include <featureinfo.h> // for feature definitions

  // replace <featureUIDx> with a real UID )

  // If querying only one feature, it is more efficient to use the class
  // via the static method, IsFeatureSupportedL().
  // When querying more than one feature, it is more efficient to use the
  // class by creating an instance and calling the IsSupported() method.

  // Static way of using the class:
  TBool isSupported = CFeatureDiscovery::IsFeatureSupportedL(<featureUIDx>);

  // Dynamic way of using the class using NewL():

  // Call NewL() to create an instance of CFeatureDiscovery.
  CFeatureDiscovery* testA = CFeatureDiscovery::NewL();

  // Call the exported IsSupported() method to query whether features
  // are supported in the current environment or not.
  TBool usbSupported = testA->IsSupported(<featureUIDx>);
  TBool mmcSupported = testA->IsSupported(<featureUIDx>);

  // Delete the created instance of CFeatureDiscovery.
  delete testA;

  // Dynamic way of using the class using NewLC():

  // Call NewLC() to create an instance of CFeatureDiscovery.
  // The method leaves the instance of the object on the cleanup stack.
  CFeatureDiscovery* testB = CFeatureDiscovery::NewLC();

  // Call the exported IsSupported() method to query whether features
  // are supported in the current environment or not.
  TBool wcdmaSupported = testB->IsSupported(<featureUIDx>);
  TBool gsmSupported = testB->IsSupported(<featureUIDx>);

  // Dynamic way of using multiple feature query. This is preferred
  // way to fetch support statuses if there are several features to be
  // queried, because it involves less inter-process communication.

  TFeatureSet featset;
  User::LeaveIfError( featset.Append( <featureUIDx> ) );
  User::LeaveIfError( featset.Append( <featureUIDx> ) );
  TInt err = testB->FeaturesSupported( featset );
	if(!err)
		{
			TBool uid1Supported = featset.IsFeatureSupported(<featureUIDx>);
			TBool uid2Supported = featset.IsFeatureSupported(<featureUIDx>);
			// ... or whether all QUERIED features are supported
			TBool allSupported = featset.AreAllFeaturesSupported();
		}
  // featset cleans array up in destructor on scope exit

  // Pop and delete the created instance of CFeatureDiscovery.
  CleanupStack::PopAndDestroy();
        

Parameters

const TRect & aRect
RWsSession * aSession

CurrentIndex()

TInt CurrentIndex ( ) [protected, pure virtual]

DisableScrollBuffer()

IMPORT_C void DisableScrollBuffer ( )

Disables Scrollbuffer.

DoDraw(const TRect &)

void DoDraw ( const TRect & aRect ) const [protected, pure virtual]

Parameters

const TRect & aRect

DoHandleKeyEvent(const TKeyEvent &)

TBool DoHandleKeyEvent ( const TKeyEvent & aKeyEvent ) [protected, pure virtual]

Parameters

const TKeyEvent & aKeyEvent

DoKeyScrolling()

void DoKeyScrolling ( ) [private]

Move view based on key scolling mode.

Draw(const TRect &)

void Draw ( const TRect & aRect ) const [virtual]

Parameters

const TRect & aRect

EnableScrollBufferL(MHgScrollBufferObserver &, TInt, TInt)

IMPORT_C void EnableScrollBufferL ( MHgScrollBufferObserver & aObserver,
TInt aBufferSize,
TInt aBufferTreshold
)

Enables Buffering.

Parameters

MHgScrollBufferObserver & aObserver Buffer change observer.
TInt aBufferSize The size of the buffer.
TInt aBufferTreshold The minimum change needed for buffer to be modified.

FirstIndexOnScreen()

IMPORT_C TInt FirstIndexOnScreen ( )

Gives the first index on the screen.

Note: The index is not guaranteed to be in the range of the scroller items. Index can be negative if the scroller is scrolled to the way up or over the count - 1 if scrolled way down.

FitRowToView(TInt)

void FitRowToView ( TInt aRow ) [protected]

Parameters

TInt aRow

FitSelectionToView()

void FitSelectionToView ( ) [protected, pure virtual]

FitTopItemToView(TInt)

void FitTopItemToView ( TInt aIndex ) [protected, pure virtual]

Parameters

TInt aIndex

Flags()

IMPORT_C TInt Flags ( )

Get flags. Possible values are defined in THgScrollerMode.

FocusChanged(TDrawNow)

void FocusChanged ( TDrawNow aDrawNow ) [virtual]

Parameters

TDrawNow aDrawNow

GetMarkedItemsL(RArray< TInt > &)

IMPORT_C void GetMarkedItemsL ( RArray < TInt > & aIndexes )

Gets all marked item indexes.

Parameters

RArray < TInt > & aIndexes On return contains the indexes of marked items.

GetSelected(TPoint)

TInt GetSelected ( TPoint aPosition ) const [protected, pure virtual]

Parameters

TPoint aPosition

HandleDownEventL(const TPointerEvent &)

void HandleDownEventL ( const TPointerEvent & aEvent ) [private]

Parameters

const TPointerEvent & aEvent

HandleDragEventL(const TPointerEvent &)

void HandleDragEventL ( const TPointerEvent & aEvent ) [private]

Parameters

const TPointerEvent & aEvent

HandleGainingForeground()

void HandleGainingForeground ( ) [private]

HandleItemCountChanged()

void HandleItemCountChanged ( ) [private]

HandleKeyEvent(const TKeyEvent &)

TKeyResponse HandleKeyEvent ( const TKeyEvent & aKeyEvent ) [private]

Parameters

const TKeyEvent & aKeyEvent

HandleLongTapEventL(const TPoint &, const TPoint &)

void HandleLongTapEventL ( const TPoint & aPenEventLocation,
const TPoint & aPenEventScreenLocation
) [protected]

Parameters

const TPoint & aPenEventLocation
const TPoint & aPenEventScreenLocation

HandleLosingForeground()

void HandleLosingForeground ( ) [private]

HandleNaviStripChar(const TChar &)

void HandleNaviStripChar ( const TChar & aChar ) [private]

Parameters

const TChar & aChar

HandlePointerEventL(const TPointerEvent &)

void HandlePointerEventL ( const TPointerEvent & aEvent ) [virtual]

Parameters

const TPointerEvent & aEvent

HandleResourceChange(TInt)

void HandleResourceChange ( TInt aType ) [virtual]

Parameters

TInt aType

HandleScrollbarEventL(const TPointerEvent &)

TBool HandleScrollbarEventL ( const TPointerEvent & aEvent ) [private]

Parameters

const TPointerEvent & aEvent

HandleScrollbarVisibilityChange(TBool)

void HandleScrollbarVisibilityChange ( TBool aVisible ) [protected, pure virtual]

Parameters

TBool aVisible

HandleSelectionL()

void HandleSelectionL ( ) [private]

HandleSizeChanged()

void HandleSizeChanged ( ) [protected, pure virtual]

HandleUpEventL(const TPointerEvent &)

void HandleUpEventL ( const TPointerEvent & aEvent ) [private]

Parameters

const TPointerEvent & aEvent

HandleViewPositionChanged(TBool)

void HandleViewPositionChanged ( TBool aUpdateScrollbar = ETrue ) [protected, virtual]

Parameters

TBool aUpdateScrollbar = ETrue

HasHighlight()

TBool HasHighlight ( ) const [protected]

HighlightTimerCallback(TAny *)

TInt HighlightTimerCallback ( TAny * aPtr ) [private, static]

Callback method for highlight timer.

Parameters

TAny * aPtr Pointer to an instance of CHgScroller class.

HightlightItem(const TDesC &)

IMPORT_C TBool HightlightItem ( const TDesC & aHighlightText )

Highlights item based on the descriptor given.

Parameters

const TDesC & aHighlightText Text to be searched.

InitDrawBuffer()

void InitDrawBuffer ( ) const [protected]

InitGraphicsL()

void InitGraphicsL ( ) [private]

InitItemsL()

void InitItemsL ( ) [protected, pure virtual]

InitPhysicsL()

void InitPhysicsL ( ) [protected]

InitScreenL(const TRect &, RWsSession &)

IMPORT_C void InitScreenL ( const TRect & aRect,
RWsSession & aSession
)

Re-inits the grid display area. DSA version.

Parameters

const TRect & aRect New display rect
RWsSession & aSession Window server session for DSA

InitScreenL(const TRect &)

IMPORT_C void InitScreenL ( const TRect & aRect )

Re-inits the grid display area. Non-DSA version.

Parameters

const TRect & aRect New display rect

InitScrollbarL()

void InitScrollbarL ( ) [private]

InputCapabilities()

TCoeInputCapabilities InputCapabilities ( ) const [virtual]

InsertItem(CHgItem *, TInt)

IMPORT_C void InsertItem ( CHgItem * aItem,
TInt aIndex
)

Inserts item at index postion.

Parameters

CHgItem * aItem New item. Ownership transferred.
TInt aIndex The index of the item.

IsDisplayed(TInt)

TBool IsDisplayed ( TInt aIndex ) [protected, pure virtual]

Parameters

TInt aIndex

ItemActionMenuClosed()

void ItemActionMenuClosed ( ) [protected]

ItemCount()

IMPORT_C TInt ItemCount ( ) const

Fetch item count.

ItemL(TInt)

IMPORT_C CHgItem & ItemL ( TInt aIndex )

Get item at specified index.

Parameters

TInt aIndex Index of the item that is returned

ItemsOnScreen()

IMPORT_C TInt ItemsOnScreen ( )

How many items fit on one screen.

KeyEventDown()

void KeyEventDown ( ) [private]

KeyEventUp()

void KeyEventUp ( ) [private]

KeyScrollingTimerCallback(TAny *)

TInt KeyScrollingTimerCallback ( TAny * aPtr ) [private, static]

Callback method for key scrolling timer.

Parameters

TAny * aPtr Pointer to an instance of CHgScroller class.

LaunchHighlightTimer()

void LaunchHighlightTimer ( ) [private]

Launches the highlight timer.

Mark(TInt)

IMPORT_C void Mark ( TInt aIndex )

Marks item at index position.

Parameters

TInt aIndex Index of the item that is marked.

MarkAll()

IMPORT_C void MarkAll ( )

Marks all items.

MarqueeCallback(TAny *)

TInt MarqueeCallback ( TAny * aSelf ) [protected, static]

Parameters

TAny * aSelf

OfferKeyEventL(const TKeyEvent &, TEventCode)

TKeyResponse OfferKeyEventL ( const TKeyEvent & aKeyEvent,
TEventCode aType
) [virtual]

Parameters

const TKeyEvent & aKeyEvent
TEventCode aType

PhysicEmulationEnded()

void PhysicEmulationEnded ( ) [protected]

RefreshScreen(TInt)

IMPORT_C void RefreshScreen ( TInt aIndex )

Refreshes screen.

Parameters

TInt aIndex Index that was modified.

Release(TInt, TInt)

void Release ( TInt aReleaseStart,
TInt aReleaseEnd
) [private]

Parameters

TInt aReleaseStart
TInt aReleaseEnd

ReleasePopupFont()

void ReleasePopupFont ( ) [private]

RemoveItem(TInt)

IMPORT_C void RemoveItem ( TInt aIndex )

Removes item at index position. Removed item is deleted.

Parameters

TInt aIndex The index of the item.

Reset()

IMPORT_C void Reset ( )

Removes all items and presents empty text

ResizeL(TInt)

IMPORT_C void ResizeL ( TInt aItemCount )

Resizes Grid/List.

Parameters

TInt aItemCount New Count of items.

ScrollBarPositionChanged(const TPoint &)

void ScrollBarPositionChanged ( const TPoint & aNewPosition ) [private]

Parameters

const TPoint & aNewPosition

SelectedIndex()

IMPORT_C TInt SelectedIndex ( )

SelectionChanged()

void SelectionChanged ( ) [protected]

SelectionMode()

TSelectionMode SelectionMode ( ) const

Get current selection mode. Used in internal key marking implemention.

SetDefaultIconL(CGulIcon *)

IMPORT_C void SetDefaultIconL ( CGulIcon * aDefaultIcon )

Sets new default icon.

Parameters

CGulIcon * aDefaultIcon New default icon to be used in scroller.

SetEmptyTextL(const TDesC &)

IMPORT_C void SetEmptyTextL ( const TDesC & aEmptyText )

Set text that is displayed when there are no items in the view.

Parameters

const TDesC & aEmptyText Empty text.

SetFirstIndexOnScreen(TInt)

IMPORT_C void SetFirstIndexOnScreen ( TInt aFirstIndexOnScreen )

Sets the first index on the screen.

Parameters

TInt aFirstIndexOnScreen The index of the first item on the screen.

SetFlags(TInt)

IMPORT_C void SetFlags ( TInt aFlags )

Set mode flags. Possible values are defined in THgScrollerMode.

Parameters

TInt aFlags flags to bet set.

SetHighlightL()

void SetHighlightL ( ) [private]

Sets highlight to focused item.

SetItem(CHgItem *, TInt)

IMPORT_C void SetItem ( CHgItem * aItem,
TInt aIndex
)

Resets item at the index position. Old item is deleted.

Parameters

CHgItem * aItem New item. Ownership transferred.
TInt aIndex The index of the item.

SetMarkingObserver(MHgMarkingObserver &)

IMPORT_C void SetMarkingObserver ( MHgMarkingObserver & aObserver )

Sets marking observer.

Parameters

MHgMarkingObserver & aObserver marking observer.

SetMenuProviderL(MObjectProvider *)

IMPORT_C void SetMenuProviderL ( MObjectProvider * aMenuProvider )

Parameters

MObjectProvider * aMenuProvider

SetScrollBarTypeL(THgScrollBarType)

IMPORT_C void SetScrollBarTypeL ( THgScrollBarType aType )

Set scrollbar type.

Parameters

THgScrollBarType aType ScrollBar type

SetSelectedIndex(TInt)

IMPORT_C void SetSelectedIndex ( TInt aIndex )

Sets selected index.

Parameters

TInt aIndex new selected index. Selection is also made visible.

SetSelectionMode(TSelectionMode)

void SetSelectionMode ( TSelectionMode aMode )

Set selection mode. Used in internal key marking implemention.

Parameters

TSelectionMode aMode New selection mode.

SetSelectionObserver(MHgSelectionObserver &)

IMPORT_C void SetSelectionObserver ( MHgSelectionObserver & aObserver )

Sets selection observer.

Parameters

MHgSelectionObserver & aObserver Selection observer.

SizeChanged()

void SizeChanged ( ) [virtual]

StopKeyScrolling()

void StopKeyScrolling ( ) [private]

Sets item highlight and stops the scrolling timer.

TotalSize()

TSize TotalSize ( ) const [protected, pure virtual]

UnMark(TInt)

IMPORT_C void UnMark ( TInt aIndex )

Unmarks item at index position.

Parameters

TInt aIndex Index of the item that is unmarked.

UnMarkAll()

IMPORT_C void UnMarkAll ( )

Unmarks all items.

ViewPosition()

TPoint ViewPosition ( ) const [protected]

ViewPositionChanged(const TPoint &, TBool, TUint)

void ViewPositionChanged ( const TPoint & aNewPosition,
TBool aDrawNow,
TUint aFlags
) [protected]

Parameters

const TPoint & aNewPosition
TBool aDrawNow
TUint aFlags

Member Enumerations Documentation

Enum THgScrollBarType

Enumerators

EHgScrollerScrollBar = 0
EHgScrollerLetterStrip
EHgScrollerTimeStrip
EHgScrollerLetterStripLite

Enum THgScrollerMode

Enumerators

EHgScrollerSelectionMode = 0x0001
EHgScrollerSearchWithQWERTY = 0x0002
EHgScrollerKeyMarkingDisabled = 0x0004
EHgScrollerScreenFreeze = 0x0008
EHgScrollerForceDoubleClick = 0x0010
EHgScrollerFlatStatusPane = 0x0020

Enum TKeyScrollingState

Enumerators

ENoKeyScrolling = 0
EKeyScrollingUp
EKeyScrollingDown
EKeyScrollingLeft
EKeyScrollingRight

Enum TSelectionMode

Enumerators

ENoSelection = 0
ESelectionPossible
ESelectionMark
ESelectionUnMark

Member Data Documentation

CAknItemActionMenu * iActionMenu

CAknItemActionMenu * iActionMenu [protected]

TInt iCurrentRow

TInt iCurrentRow [protected]

CGulIcon * iDefaultIcon

CGulIcon * iDefaultIcon [protected]

CAknLongTapDetector * iDetector

CAknLongTapDetector * iDetector [protected]

CHgDrawUtils * iDrawUtils

CHgDrawUtils * iDrawUtils [protected]

HBufC * iEmptyText

HBufC * iEmptyText [protected]

TInt iFlags

TInt iFlags [protected]

TInt iFocusedIndex

TInt iFocusedIndex [protected]

TInt iHeight

TInt iHeight [protected]

CPeriodic * iHighlightTimer

CPeriodic * iHighlightTimer [protected]

TSize iImageSize

TSize iImageSize [protected]

CHgIndicatorManager * iIndicatorManager

CHgIndicatorManager * iIndicatorManager [protected]

TSize iIndicatorSize

TSize iIndicatorSize [protected]

TInt iItemCount

TInt iItemCount [protected]

RPointerArray< CHgItem > iItems

RPointerArray < CHgItem > iItems [protected]

TInt iItemsOnScreen

TInt iItemsOnScreen [protected]

TInt iKeyRepeats

TInt iKeyRepeats [protected]

enum CHgScroller::TKeyScrollingState iKeyScrollingState

enum CHgScroller::TKeyScrollingState iKeyScrollingState [protected]

CPeriodic * iKeyScrollingTimer

CPeriodic * iKeyScrollingTimer [protected]

CHgKeyUtils * iKeyUtils

CHgKeyUtils * iKeyUtils [protected]

TBool iLandscapeScrolling

TBool iLandscapeScrolling [protected]

CHgScrollBufferManager * iManager

CHgScrollBufferManager * iManager [protected]

MHgMarkingObserver * iMarkingObserver

MHgMarkingObserver * iMarkingObserver [protected]

TInt iOldWinPos

TInt iOldWinPos [protected]

TBool iPanning

TBool iPanning [protected]

CAknPhysics * iPhysics

CAknPhysics * iPhysics [protected]

TBool iPointerDown

TBool iPointerDown [protected]

THgPopupDrawer * iPopupDrawer

THgPopupDrawer * iPopupDrawer [protected]

CFont * iPopupFont

CFont * iPopupFont [protected]

RBuf iPopupText1

RBuf iPopupText1 [protected]

RBuf iPopupText2

RBuf iPopupText2 [protected]

TPoint iPrev

TPoint iPrev [protected]

TBool iResetViewPosition

TBool iResetViewPosition [protected]

TInt iRowHeight

TInt iRowHeight [protected]

THgScrollBarType iScrollBarType

THgScrollBarType iScrollBarType [protected]

CHgScrollbar * iScrollbar

CHgScrollbar * iScrollbar [protected]

TInt iSelectedIndex

TInt iSelectedIndex [protected]

TSelectionMode iSelectionMode

TSelectionMode iSelectionMode [protected]

MHgSelectionObserver * iSelectionObserver

MHgSelectionObserver * iSelectionObserver [protected]

TBool iSelectionToFocusedItem

TBool iSelectionToFocusedItem [protected]

TBool iShowHighlight

TBool iShowHighlight [protected]

TPoint iStart

TPoint iStart [protected]

TTime iStartTime

TTime iStartTime [protected]

CHgTextFind * iTextFind

CHgTextFind * iTextFind [protected]

RBuf iUpperCaseTitle

RBuf iUpperCaseTitle [protected]

TPoint iViewPosition

TPoint iViewPosition [protected]

TInt iWidth

TInt iWidth [protected]