AknListBoxLayouts Class Reference

class AknListBoxLayouts

AknListBoxLayouts Building listbox layouts from European Avkon LAF.

The LAF specification has 3 kinds of tables: Graphics tables Text tables Pane coordinates The graphics tables map to SetupColumnGfxCell() and SetupFormGfxCell() The text tables map to SetupColumnTextCell() and SetupFormGfxCell() The pane coordinates map to SetupListboxPos().

This class is mostly useless if you don't have LAF specification available!

You probably want to use predefined layouts; See CAknSingleStyleListBox.

NOTE: This class is old design. You should consider looking at aknutils.h: AknLayoutUtils whenever you want to build things from the LAF specification.

Public Member Functions
TInt AdjustPopupLayoutData(const TRect &)
IMPORT_C voidSetupColumnGfxCell(CEikListBox &, CColumnListBoxItemDrawer *, TInt, TInt, TInt, TInt, TInt, TInt, TInt, TInt, TInt)
IMPORT_C voidSetupColumnGfxCell(CEikListBox &, CColumnListBoxItemDrawer *, TInt, const TAknWindowLineLayout &, TInt, TInt)
IMPORT_C voidSetupColumnTextCell(CEikListBox &, CColumnListBoxItemDrawer *, TInt, const CFont *, TInt, TInt, TInt, TInt, TInt, CGraphicsContext::TTextAlign, TInt, TInt)
IMPORT_C voidSetupColumnTextCell(CEikListBox &, CColumnListBoxItemDrawer *, TInt, const TAknTextLineLayout &, TInt, TInt)
IMPORT_C voidSetupFormAntiFlickerTextCell(CEikListBox &, CFormattedCellListBoxItemDrawer *, TInt, const CFont *, TInt, TInt, TInt, TInt, TInt, CGraphicsContext::TTextAlign, TPoint, TPoint)
IMPORT_C voidSetupFormAntiFlickerTextCell(CEikListBox &, CFormattedCellListBoxItemDrawer *, TInt, const TAknTextLineLayout &, const TPoint &, const TPoint &)
IMPORT_C voidSetupFormGfxCell(CEikListBox &, CFormattedCellListBoxItemDrawer *, TInt, TInt, TInt, TInt, TInt, TInt, TInt, TPoint, TPoint)
IMPORT_C voidSetupFormGfxCell(CEikListBox &, CFormattedCellListBoxItemDrawer *, TInt, const TAknWindowLineLayout &, const TPoint &, const TPoint &)
IMPORT_C voidSetupFormTextCell(CEikListBox &, CFormattedCellListBoxItemDrawer *, TInt, const CFont *, TInt, TInt, TInt, TInt, TInt, CGraphicsContext::TTextAlign, TPoint, TPoint)
IMPORT_C voidSetupFormTextCell(CEikListBox &, CFormattedCellListBoxItemDrawer *, TInt, const TAknTextLineLayout &, const TPoint &, const TPoint &)
IMPORT_C voidSetupGridFormGfxCell(CAknGrid &, CFormattedCellListBoxItemDrawer *, TInt, TInt, TInt, TInt, TInt, TInt, TInt, TPoint, TPoint)
IMPORT_C voidSetupGridFormGfxCell(CAknGrid &, CFormattedCellListBoxItemDrawer *, TInt, const TAknWindowLineLayout &, TPoint &, TPoint &)
voidSetupGridPos(CAknGrid &, const TAknWindowLineLayout &)
IMPORT_C voidSetupGridPos(CAknGrid &, TInt, TInt, TInt, TInt, TInt, TInt)
IMPORT_C voidSetupListboxPos(CEikListBox &, TInt, TInt, TInt, TInt, TInt, TInt)
IMPORT_C voidSetupListboxPos(CEikListBox &, const TAknWindowLineLayout &)
voidSetupListboxPosL(CEikListBox &, const TAknWindowLineLayout &)
IMPORT_C voidSetupStandardColumnListbox(CColumnListBoxItemDrawer *)
IMPORT_C voidSetupStandardFormListbox(CFormattedCellListBoxItemDrawer *)
IMPORT_C voidSetupStandardGrid(CAknGrid &)
IMPORT_C voidSetupStandardListBox(CEikListBox &)

Member Functions Documentation

AdjustPopupLayoutData(const TRect &)

TInt AdjustPopupLayoutData(const TRect &aScreenRect)[static]

This function returns a correct offset to revise layout data.

Attention: The function is only effective for QHD lanscape model. It always return 0 in QVGA, QVGA2, VGA and VAG3. A panic will take place if it is used in other models.

S60 5.0

Offset of listscroll_menu_pane's layout

Parameters

const TRect & aScreenRectSize of Screen.

SetupColumnGfxCell(CEikListBox &, CColumnListBoxItemDrawer *, TInt, TInt, TInt, TInt, TInt, TInt, TInt, TInt, TInt)

IMPORT_C voidSetupColumnGfxCell(CEikListBox &aListBox,
CColumnListBoxItemDrawer *aItemDrawer,
TIntindex,
TIntl,
TIntt,
TIntr,
TIntb,
TIntW,
TIntH,
TIntstartx,
TIntendx
)[static]

Setup a single graphics cell of list item

Parameters

CEikListBox & aListBox
CColumnListBoxItemDrawer * aItemDrawer
TInt index
TInt l
TInt t
TInt r
TInt b
TInt W
TInt H
TInt startx
TInt endx

SetupColumnGfxCell(CEikListBox &, CColumnListBoxItemDrawer *, TInt, const TAknWindowLineLayout &, TInt, TInt)

IMPORT_C voidSetupColumnGfxCell(CEikListBox &aListBox,
CColumnListBoxItemDrawer *aItemDrawer,
TIntaIndex,
const TAknWindowLineLayout &aLayout,
TIntstartx,
TIntendx
)[static]

Setup a graphic element for a column listbox using aknlayout.dll

Parameters

CEikListBox & aListBox
CColumnListBoxItemDrawer * aItemDrawer
TInt aIndex
const TAknWindowLineLayout & aLayout
TInt startx
TInt endx

SetupColumnTextCell(CEikListBox &, CColumnListBoxItemDrawer *, TInt, const CFont *, TInt, TInt, TInt, TInt, TInt, CGraphicsContext::TTextAlign, TInt, TInt)

IMPORT_C voidSetupColumnTextCell(CEikListBox &aListBox,
CColumnListBoxItemDrawer *aItemDrawer,
TIntindex,
const CFont *font,
TInt,
TIntlm,
TIntrm,
TIntB,
TInt,
CGraphicsContext::TTextAlignaAlign,
TIntstartx,
TIntendx
)[static]

Setup a single text cell of list item

Parameters

CEikListBox & aListBox
CColumnListBoxItemDrawer * aItemDrawer
TInt index
const CFont * font
TInt
TInt lm
TInt rm
TInt B
TInt
CGraphicsContext::TTextAlign aAlign
TInt startx
TInt endx

SetupColumnTextCell(CEikListBox &, CColumnListBoxItemDrawer *, TInt, const TAknTextLineLayout &, TInt, TInt)

IMPORT_C voidSetupColumnTextCell(CEikListBox &aListBox,
CColumnListBoxItemDrawer *aItemDrawer,
TIntindex,
const TAknTextLineLayout &aLayout,
TIntstartx,
TIntendx
)[static]

Setup a single text cell of list item

Parameters

CEikListBox & aListBox
CColumnListBoxItemDrawer * aItemDrawer
TInt index
const TAknTextLineLayout & aLayout
TInt startx
TInt endx

SetupFormAntiFlickerTextCell(CEikListBox &, CFormattedCellListBoxItemDrawer *, TInt, const CFont *, TInt, TInt, TInt, TInt, TInt, CGraphicsContext::TTextAlign, TPoint, TPoint)

IMPORT_C voidSetupFormAntiFlickerTextCell(CEikListBox &aListBox,
CFormattedCellListBoxItemDrawer *aItemDrawer,
TIntindex,
const CFont *font,
TInt,
TIntlm,
TInt,
TIntB,
TIntW,
CGraphicsContext::TTextAlignaAlign,
TPointp1,
TPointp2
)[static]

Setup a single text cell of list item

This is for removing flicker for settings

Parameters

CEikListBox & aListBox
CFormattedCellListBoxItemDrawer * aItemDrawer
TInt index
const CFont * font
TInt
TInt lm
TInt
TInt B
TInt W
CGraphicsContext::TTextAlign aAlign
TPoint p1
TPoint p2

SetupFormAntiFlickerTextCell(CEikListBox &, CFormattedCellListBoxItemDrawer *, TInt, const TAknTextLineLayout &, const TPoint &, const TPoint &)

IMPORT_C voidSetupFormAntiFlickerTextCell(CEikListBox &aListBox,
CFormattedCellListBoxItemDrawer *aItemDrawer,
TIntindex,
const TAknTextLineLayout &aLayout,
const TPoint &p1,
const TPoint &p2
)[static]

Setup a single text cell of list item

This is for removing flicker for settings

Parameters

CEikListBox & aListBox
CFormattedCellListBoxItemDrawer * aItemDrawer
TInt index
const TAknTextLineLayout & aLayout
const TPoint & p1
const TPoint & p2

SetupFormGfxCell(CEikListBox &, CFormattedCellListBoxItemDrawer *, TInt, TInt, TInt, TInt, TInt, TInt, TInt, TPoint, TPoint)

IMPORT_C voidSetupFormGfxCell(CEikListBox &aListBox,
CFormattedCellListBoxItemDrawer *aItemDrawer,
TIntindex,
TIntl,
TIntt,
TInt,
TInt,
TIntW,
TIntH,
TPointp1,
TPointp2
)[static]

Setup a single graphics cell of list item

Parameters

CEikListBox & aListBox
CFormattedCellListBoxItemDrawer * aItemDrawer
TInt index
TInt l
TInt t
TInt
TInt
TInt W
TInt H
TPoint p1
TPoint p2

SetupFormGfxCell(CEikListBox &, CFormattedCellListBoxItemDrawer *, TInt, const TAknWindowLineLayout &, const TPoint &, const TPoint &)

IMPORT_C voidSetupFormGfxCell(CEikListBox &aListBox,
CFormattedCellListBoxItemDrawer *aItemDrawer,
TIntindex,
const TAknWindowLineLayout &aLayout,
const TPoint &p1,
const TPoint &p2
)[static]

Setup a single graphics cell of list item using aknlayout.dll

Parameters

CEikListBox & aListBox
CFormattedCellListBoxItemDrawer * aItemDrawer
TInt index
const TAknWindowLineLayout & aLayout
const TPoint & p1
const TPoint & p2

SetupFormTextCell(CEikListBox &, CFormattedCellListBoxItemDrawer *, TInt, const CFont *, TInt, TInt, TInt, TInt, TInt, CGraphicsContext::TTextAlign, TPoint, TPoint)

IMPORT_C voidSetupFormTextCell(CEikListBox &aListBox,
CFormattedCellListBoxItemDrawer *aItemDrawer,
TIntindex,
const CFont *font,
TInt,
TIntlm,
TInt,
TIntB,
TIntW,
CGraphicsContext::TTextAlignaAlign,
TPointp1,
TPointp2
)[static]

Setup a single text cell of list item

Parameters

CEikListBox & aListBox
CFormattedCellListBoxItemDrawer * aItemDrawer
TInt index
const CFont * font
TInt
TInt lm
TInt
TInt B
TInt W
CGraphicsContext::TTextAlign aAlign
TPoint p1
TPoint p2

SetupFormTextCell(CEikListBox &, CFormattedCellListBoxItemDrawer *, TInt, const TAknTextLineLayout &, const TPoint &, const TPoint &)

IMPORT_C voidSetupFormTextCell(CEikListBox &aListBox,
CFormattedCellListBoxItemDrawer *aItemDrawer,
TIntindex,
const TAknTextLineLayout &aLayout,
const TPoint &p1,
const TPoint &p2
)[static]

Setup a single text cell of list item

Parameters

CEikListBox & aListBox
CFormattedCellListBoxItemDrawer * aItemDrawer
TInt index
const TAknTextLineLayout & aLayout
const TPoint & p1
const TPoint & p2

SetupGridFormGfxCell(CAknGrid &, CFormattedCellListBoxItemDrawer *, TInt, TInt, TInt, TInt, TInt, TInt, TInt, TPoint, TPoint)

IMPORT_C voidSetupGridFormGfxCell(CAknGrid &aListBox,
CFormattedCellListBoxItemDrawer *aItemDrawer,
TIntindex,
TIntl,
TIntt,
TInt,
TInt,
TIntW,
TIntH,
TPointaP1,
TPointaP2
)[static]

Setup a single graphics cell of list item

This version is needed for grid cells. (the FormGfxCell works in most cases, but this is needed if you want exact positioning of the erased area..)

Parameters

CAknGrid & aListBox
CFormattedCellListBoxItemDrawer * aItemDrawer
TInt index
TInt l
TInt t
TInt
TInt
TInt W
TInt H
TPoint aP1
TPoint aP2

SetupGridFormGfxCell(CAknGrid &, CFormattedCellListBoxItemDrawer *, TInt, const TAknWindowLineLayout &, TPoint &, TPoint &)

IMPORT_C voidSetupGridFormGfxCell(CAknGrid &aGrid,
CFormattedCellListBoxItemDrawer *aItemDrawer,
TIntaIndex,
const TAknWindowLineLayout &aLine,
TPoint &aP1,
TPoint &aP2
)[static]

Setup a single graphics cell of list item

This version is needed for grid cells. (the FormGfxCell works in most cases, but this is needed if you want exact positioning of the erased area..) since 2.6

Parameters

CAknGrid & aGrid
CFormattedCellListBoxItemDrawer * aItemDrawer
TInt aIndex
const TAknWindowLineLayout & aLine
TPoint & aP1
TPoint & aP2

SetupGridPos(CAknGrid &, const TAknWindowLineLayout &)

voidSetupGridPos(CAknGrid &aGrid,
const TAknWindowLineLayout &aLayout
)[static]

Setup grid position since 2.0

Parameters

CAknGrid & aGrid
const TAknWindowLineLayout & aLayout

SetupGridPos(CAknGrid &, TInt, TInt, TInt, TInt, TInt, TInt)

IMPORT_C voidSetupGridPos(CAknGrid &aGrid,
TIntl,
TIntt,
TInt,
TInt,
TIntW,
TIntH
)[static]

Setup grid position

Parameters

CAknGrid & aGrid
TInt l
TInt t
TInt
TInt
TInt W
TInt H

SetupListboxPos(CEikListBox &, TInt, TInt, TInt, TInt, TInt, TInt)

IMPORT_C voidSetupListboxPos(CEikListBox &aListBox,
TIntstartx,
TIntstarty,
TInt,
TInt,
TInt,
TIntheight
)[static]

Setup list position

Parameters

CEikListBox & aListBox
TInt startx
TInt starty
TInt
TInt
TInt
TInt height

SetupListboxPos(CEikListBox &, const TAknWindowLineLayout &)

IMPORT_C voidSetupListboxPos(CEikListBox &aListBox,
const TAknWindowLineLayout &aLayout
)[static]

Setup a graphic element for a column listbox using aknlayout.dll

Parameters

CEikListBox & aListBox
const TAknWindowLineLayout & aLayout

SetupListboxPosL(CEikListBox &, const TAknWindowLineLayout &)

voidSetupListboxPosL(CEikListBox &aListBox,
const TAknWindowLineLayout &aLayout
)[static]

Parameters

CEikListBox & aListBox
const TAknWindowLineLayout & aLayout

SetupStandardColumnListbox(CColumnListBoxItemDrawer *)

IMPORT_C voidSetupStandardColumnListbox(CColumnListBoxItemDrawer *aItemDrawer)[static]

Setup text foreground and background colors to default

Parameters

CColumnListBoxItemDrawer * aItemDrawer

SetupStandardFormListbox(CFormattedCellListBoxItemDrawer *)

IMPORT_C voidSetupStandardFormListbox(CFormattedCellListBoxItemDrawer *aItemDrawer)[static]

Setup text foreground and background colors to default

Parameters

CFormattedCellListBoxItemDrawer * aItemDrawer

SetupStandardGrid(CAknGrid &)

IMPORT_C voidSetupStandardGrid(CAknGrid &aGrid)[static]

Setup text foreground and background colors to default

Parameters

CAknGrid & aGrid

SetupStandardListBox(CEikListBox &)

IMPORT_C voidSetupStandardListBox(CEikListBox &aListBox)[static]

Setup borders etc.

Parameters

CEikListBox & aListBox
© Nokia 2010.