Symbian^3 Application Developer Library >

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
IMPORT_C void SetupColumnGfxCell ( CEikListBox &, CColumnListBoxItemDrawer *, TInt , TInt , TInt , TInt , TInt , TInt , TInt , TInt , TInt )
IMPORT_C void SetupColumnGfxCell ( CEikListBox &, CColumnListBoxItemDrawer *, TInt , const TAknWindowLineLayout &, TInt , TInt )
IMPORT_C void SetupColumnTextCell ( CEikListBox &, CColumnListBoxItemDrawer *, TInt , const CFont *, TInt , TInt , TInt , TInt , TInt , CGraphicsContext::TTextAlign , TInt , TInt )
IMPORT_C void SetupColumnTextCell ( CEikListBox &, CColumnListBoxItemDrawer *, TInt , const TAknTextLineLayout &, TInt , TInt )
IMPORT_C void SetupFormAntiFlickerTextCell ( CEikListBox &, CFormattedCellListBoxItemDrawer *, TInt , const CFont *, TInt , TInt , TInt , TInt , TInt , CGraphicsContext::TTextAlign , TPoint , TPoint )
IMPORT_C void SetupFormAntiFlickerTextCell ( CEikListBox &, CFormattedCellListBoxItemDrawer *, TInt , const TAknTextLineLayout &, const TPoint &, const TPoint &)
IMPORT_C void SetupFormGfxCell ( CEikListBox &, CFormattedCellListBoxItemDrawer *, TInt , TInt , TInt , TInt , TInt , TInt , TInt , TPoint , TPoint )
IMPORT_C void SetupFormGfxCell ( CEikListBox &, CFormattedCellListBoxItemDrawer *, TInt , const TAknWindowLineLayout &, const TPoint &, const TPoint &)
IMPORT_C void SetupFormTextCell ( CEikListBox &, CFormattedCellListBoxItemDrawer *, TInt , const CFont *, TInt , TInt , TInt , TInt , TInt , CGraphicsContext::TTextAlign , TPoint , TPoint )
IMPORT_C void SetupFormTextCell ( CEikListBox &, CFormattedCellListBoxItemDrawer *, TInt , const TAknTextLineLayout &, const TPoint &, const TPoint &)
IMPORT_C void SetupGridFormGfxCell ( CAknGrid &, CFormattedCellListBoxItemDrawer *, TInt , TInt , TInt , TInt , TInt , TInt , TInt , TPoint , TPoint )
IMPORT_C void SetupGridFormGfxCell ( CAknGrid &, CFormattedCellListBoxItemDrawer *, TInt , const TAknWindowLineLayout &, TPoint &, TPoint &)
void SetupGridPos ( CAknGrid &, const TAknWindowLineLayout &)
IMPORT_C void SetupGridPos ( CAknGrid &, TInt , TInt , TInt , TInt , TInt , TInt )
IMPORT_C void SetupListboxPos ( CEikListBox &, TInt , TInt , TInt , TInt , TInt , TInt )
IMPORT_C void SetupListboxPos ( CEikListBox &, const TAknWindowLineLayout &)
void SetupListboxPosL ( CEikListBox &, const TAknWindowLineLayout &)
IMPORT_C void SetupStandardColumnListbox ( CColumnListBoxItemDrawer *)
IMPORT_C void SetupStandardFormListbox ( CFormattedCellListBoxItemDrawer *)
IMPORT_C void SetupStandardGrid ( CAknGrid &)
IMPORT_C void SetupStandardListBox ( CEikListBox &)

Member Functions Documentation

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

IMPORT_C void SetupColumnGfxCell ( CEikListBox & aListBox,
CColumnListBoxItemDrawer * aItemDrawer,
TInt index,
TInt l,
TInt t,
TInt r,
TInt b,
TInt W,
TInt H,
TInt startx,
TInt endx
) [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 void SetupColumnGfxCell ( CEikListBox & aListBox,
CColumnListBoxItemDrawer * aItemDrawer,
TInt aIndex,
const TAknWindowLineLayout & aLayout,
TInt startx,
TInt endx
) [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 void SetupColumnTextCell ( CEikListBox & aListBox,
CColumnListBoxItemDrawer * aItemDrawer,
TInt index,
const CFont * font,
TInt ,
TInt lm,
TInt rm,
TInt B,
TInt ,
CGraphicsContext::TTextAlign aAlign,
TInt startx,
TInt endx
) [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 void SetupColumnTextCell ( CEikListBox & aListBox,
CColumnListBoxItemDrawer * aItemDrawer,
TInt index,
const TAknTextLineLayout & aLayout,
TInt startx,
TInt endx
) [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 void SetupFormAntiFlickerTextCell ( CEikListBox & aListBox,
CFormattedCellListBoxItemDrawer * aItemDrawer,
TInt index,
const CFont * font,
TInt ,
TInt lm,
TInt ,
TInt B,
TInt W,
CGraphicsContext::TTextAlign aAlign,
TPoint p1,
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 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 void SetupFormAntiFlickerTextCell ( CEikListBox & aListBox,
CFormattedCellListBoxItemDrawer * aItemDrawer,
TInt index,
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 void SetupFormGfxCell ( CEikListBox & aListBox,
CFormattedCellListBoxItemDrawer * aItemDrawer,
TInt index,
TInt l,
TInt t,
TInt ,
TInt ,
TInt W,
TInt H,
TPoint p1,
TPoint p2
) [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 void SetupFormGfxCell ( CEikListBox & aListBox,
CFormattedCellListBoxItemDrawer * aItemDrawer,
TInt index,
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 void SetupFormTextCell ( CEikListBox & aListBox,
CFormattedCellListBoxItemDrawer * aItemDrawer,
TInt index,
const CFont * font,
TInt ,
TInt lm,
TInt ,
TInt B,
TInt W,
CGraphicsContext::TTextAlign aAlign,
TPoint p1,
TPoint p2
) [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 void SetupFormTextCell ( CEikListBox & aListBox,
CFormattedCellListBoxItemDrawer * aItemDrawer,
TInt index,
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 void SetupGridFormGfxCell ( CAknGrid & aListBox,
CFormattedCellListBoxItemDrawer * aItemDrawer,
TInt index,
TInt l,
TInt t,
TInt ,
TInt ,
TInt W,
TInt H,
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..)

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 void SetupGridFormGfxCell ( CAknGrid & aGrid,
CFormattedCellListBoxItemDrawer * aItemDrawer,
TInt aIndex,
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 &)

void SetupGridPos ( 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 void SetupGridPos ( CAknGrid & aGrid,
TInt l,
TInt t,
TInt ,
TInt ,
TInt W,
TInt H
) [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 void SetupListboxPos ( CEikListBox & aListBox,
TInt startx,
TInt starty,
TInt ,
TInt ,
TInt ,
TInt height
) [static]

Setup list position

Parameters

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

SetupListboxPos(CEikListBox &, const TAknWindowLineLayout &)

IMPORT_C void SetupListboxPos ( 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 &)

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

Parameters

CEikListBox & aListBox
const TAknWindowLineLayout & aLayout

SetupStandardColumnListbox(CColumnListBoxItemDrawer *)

IMPORT_C void SetupStandardColumnListbox ( CColumnListBoxItemDrawer * aItemDrawer ) [static]

Setup text foreground and background colors to default

Parameters

CColumnListBoxItemDrawer * aItemDrawer

SetupStandardFormListbox(CFormattedCellListBoxItemDrawer *)

IMPORT_C void SetupStandardFormListbox ( CFormattedCellListBoxItemDrawer * aItemDrawer ) [static]

Setup text foreground and background colors to default

Parameters

CFormattedCellListBoxItemDrawer * aItemDrawer

SetupStandardGrid(CAknGrid &)

IMPORT_C void SetupStandardGrid ( CAknGrid & aGrid ) [static]

Setup text foreground and background colors to default

Parameters

CAknGrid & aGrid

SetupStandardListBox(CEikListBox &)

IMPORT_C void SetupStandardListBox ( CEikListBox & aListBox ) [static]

Setup borders etc.

Parameters

CEikListBox & aListBox

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.