Symbian^3 Application Developer Library >

CAknListLoader Class Reference

class CAknListLoader

CAknListLoader is a CCoeStatic class with only static functions. When the static functions are used CAknListLoader tries to find the singleton using CCoeEnv::Static().

If the singleton is not yet created when calling CreateTfxGc this function will create the singleton and try to load the ECOM plugin that implements the MAknListBoxTfxPlugin API. This ECOM plugin instance is then used by static functions.

Since
S60 v3.2
Public Member Functions
~CAknListLoader ()
IMPORT_C CWindowGc * CreateTfxGc (CEikListBox &)
IMPORT_C CWindowGc * CreateTfxGc (CEikMenuPane &, TInt &, TInt &)
IMPORT_C CWindowGc * CreateTfxGc (CAknTreeList &, TInt &, TInt &, TInt &, TInt &)
IMPORT_C CWindowGc * CreateTfxGc (CCoeControl &)
IMPORT_C void InvalidateAll ()
IMPORT_C TInt LongTap (MAknListBoxTfxInternal::TLongTapEvent, TInt , const TPoint *)
IMPORT_C void RemoveTfxGc ( CWindowGc *)
IMPORT_C MAknListBoxTfx * TfxApi ( CWindowGc *)
IMPORT_C MAknListBoxTfxInternal * TfxApiInternal ( CWindowGc *)
Private Member Functions
CAknListLoader ()
CAknListLoader * Static ()
Private Attributes
RPointerArray < CWindowGc > iGcArray
MAknListBoxTfxPlugin * iListBoxPlugin
TUid iListBoxPluginEComDtorUID

Constructor & Destructor Documentation

CAknListLoader()

CAknListLoader ( ) [private]

~CAknListLoader()

~CAknListLoader ( )

Member Functions Documentation

CreateTfxGc(CEikListBox &)

IMPORT_C CWindowGc * CreateTfxGc ( CEikListBox & aListBox ) [static]

If the singleton instance of CAknListLoader is not already created this function will try to create it, it will then try to load an ECOM implementation of the MAknListBoxTfxPlugin API. The singleton will own the ECOM instance. The function used the ECOM instance to create a CTfxGc.

Since
S60 3.2

Parameters

CEikListBox & aListBox The ListBox for which the gc that is returned should be used.

CreateTfxGc(CEikMenuPane &, TInt &, TInt &)

IMPORT_C CWindowGc * CreateTfxGc ( CEikMenuPane & aMenuPane,
TInt & aTopIndex,
TInt & aItemsThatFitInView
) [static]

If the singleton instance of CAknListLoader is not already created this function will try to create it, it will then try to load an ECOM implementation of the MAknListBoxTfxPlugin API. The singleton will own the ECOM instance. The function used the ECOM instance to create a CTfxGc.

Since
S60 3.2

Parameters

CEikMenuPane & aMenuPane The menupane for which the gc that is returned should be used.
TInt & aTopIndex A value containing the top item index.
TInt & aItemsThatFitInView A value containing number of items that fit in view.

CreateTfxGc(CAknTreeList &, TInt &, TInt &, TInt &, TInt &)

IMPORT_C CWindowGc * CreateTfxGc ( CAknTreeList & aTreeList,
TInt & aTopIndex,
TInt & aBottomIndex,
TInt & aHighlightIndex,
TInt & aRows
) [static]

Create a transition graphics context.

Parameters

CAknTreeList & aTreeList The treelist to animate.
TInt & aTopIndex A value containing the top item index.
TInt & aBottomIndex
TInt & aHighlightIndex
TInt & aRows

CreateTfxGc(CCoeControl &)

IMPORT_C CWindowGc * CreateTfxGc ( CCoeControl & aAdapter ) [static]

Create a transition graphics context.

Parameters

CCoeControl & aAdapter The adapter to animate.

InvalidateAll()

IMPORT_C void InvalidateAll ( ) [static]

Invalidates all images in all lists.

LongTap(MAknListBoxTfxInternal::TLongTapEvent, TInt, const TPoint *)

IMPORT_C TInt LongTap ( MAknListBoxTfxInternal::TLongTapEvent aEvent,
TInt aDuration = 0,
const TPoint * aPoint = NULL
) [static]

Supplies long tap information.

Since
S60 5.0

Parameters

MAknListBoxTfxInternal::TLongTapEvent aEvent EStart, EFinish, or EAbort
TInt aDuration = 0 The total duration until long tap menu is showing ( used if aRun == ETrue )
const TPoint * aPoint = NULL The point that is clicked ( used if aRun == ETrue )

RemoveTfxGc(CWindowGc *)

IMPORT_C void RemoveTfxGc ( CWindowGc * aGc ) [static]

Removes the CWindowGc from the list of TfxGc:s.

This function is called when a CTfxGc is deleted, and should not be called from anywere else.

Since
S60 3.2

Parameters

CWindowGc * aGc The gc to be removed.

Static()

CAknListLoader * Static ( ) [private, static]

TfxApi(CWindowGc *)

IMPORT_C MAknListBoxTfx * TfxApi ( CWindowGc * aGc ) [static]

Used to get the instance of MAknListBoxTfx that belongs to the CWindowGc aGc. If aGc is a CTfxGc this function will return the MAknListBoxTfx instance, otherwise it will return NULL

Since
S60 3.2

Parameters

CWindowGc * aGc the gc for which the MAknListBoxTfx instance should be retrieved

TfxApiInternal(CWindowGc *)

IMPORT_C MAknListBoxTfxInternal * TfxApiInternal ( CWindowGc * aGc ) [static]

Used to get the instance of MAknListBoxTfxInternal that belongs to the CWindowGc aGc. If aGc is a CTfxGc this function will return the MAknListBoxTfxInternal instance, otherwise it will return NULL

Since
S60 3.2

Parameters

CWindowGc * aGc the gc for which the MAknListBoxTfxInternal instance should be retrieved

Member Data Documentation

RPointerArray< CWindowGc > iGcArray

RPointerArray < CWindowGc > iGcArray [private]

MAknListBoxTfxPlugin * iListBoxPlugin

MAknListBoxTfxPlugin * iListBoxPlugin [private]

TUid iListBoxPluginEComDtorUID

TUid iListBoxPluginEComDtorUID [private]

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.