AknListBoxLayouts Class Reference

Link against: avkon.lib eikcoctl.lib eikctl.lib

Capability Information

Required Capabilities

None

#include <aknlists.h>

Detailed Description

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.


Static Public Member Functions
static IMPORT_C void  SetupStandardListBox (CEikListBox &aListBox)
  Setup borders etc.
static void  SetupGridPos (CAknGrid &aGrid, const TAknWindowLineLayout &aLayout)
  Setup grid position since 2.0.
static IMPORT_C void  SetupGridPos (CAknGrid &aGrid, TInt l, TInt t, TInt, TInt, TInt W, TInt H)
  Setup grid position.
static IMPORT_C void  SetupListboxPos (CEikListBox &aListBox, TInt startx, TInt starty, TInt, TInt, TInt, TInt height)
  Setup list position.
static void  SetupListboxPosL (CEikListBox &aListBox, const TAknWindowLineLayout &aLayout)
static IMPORT_C void  SetupStandardColumnListbox (CColumnListBoxItemDrawer *aItemDrawer)
  Setup text foreground and background colors to default.
static IMPORT_C void  SetupStandardFormListbox (CFormattedCellListBoxItemDrawer *aItemDrawer)
  Setup text foreground and background colors to default.
static IMPORT_C void  SetupStandardGrid (CAknGrid &aGrid)
  Setup text foreground and background colors to default.
static 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)
  Setup a single graphics cell of list item.
static 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)
  Setup a single text cell of list item.
static IMPORT_C void  SetupColumnTextCell (CEikListBox &aListBox, CColumnListBoxItemDrawer *aItemDrawer, TInt index, const TAknTextLineLayout &aLayout, TInt startx, TInt endx)
  Setup a single text cell of list item.
static IMPORT_C void  SetupFormGfxCell (CEikListBox &aListBox, CFormattedCellListBoxItemDrawer *aItemDrawer, TInt index, TInt l, TInt t, TInt, TInt, TInt W, TInt H, TPoint p1, TPoint p2)
  Setup a single graphics cell of list item.
static IMPORT_C void  SetupGridFormGfxCell (CAknGrid &aListBox, CFormattedCellListBoxItemDrawer *aItemDrawer, TInt index, TInt l, TInt t, TInt, TInt, TInt W, TInt H, TPoint aP1, TPoint aP2)
  Setup a single graphics cell of list item.
static IMPORT_C void  SetupGridFormGfxCell (CAknGrid &aGrid, CFormattedCellListBoxItemDrawer *aItemDrawer, TInt aIndex, const TAknWindowLineLayout &aLine, TPoint &aP1, TPoint &aP2)
  Setup a single graphics cell of list item.
static 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)
  Setup a single text cell of list item.
static 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)
  Setup a single text cell of list item.
static IMPORT_C void  SetupFormTextCell (CEikListBox &aListBox, CFormattedCellListBoxItemDrawer *aItemDrawer, TInt index, const TAknTextLineLayout &aLayout, const TPoint &p1, const TPoint &p2)
  Setup a single text cell of list item.
static IMPORT_C void  SetupFormAntiFlickerTextCell (CEikListBox &aListBox, CFormattedCellListBoxItemDrawer *aItemDrawer, TInt index, const TAknTextLineLayout &aLayout, const TPoint &p1, const TPoint &p2)
  Setup a single text cell of list item.
static IMPORT_C void  SetupColumnGfxCell (CEikListBox &aListBox, CColumnListBoxItemDrawer *aItemDrawer, TInt aIndex, const TAknWindowLineLayout &aLayout, TInt startx, TInt endx)
  Setup a graphic element for a column listbox using aknlayout.dll.
static IMPORT_C void  SetupFormGfxCell (CEikListBox &aListBox, CFormattedCellListBoxItemDrawer *aItemDrawer, TInt index, const TAknWindowLineLayout &aLayout, const TPoint &p1, const TPoint &p2)
  Setup a single graphics cell of list item using aknlayout.dll.
static IMPORT_C void  SetupListboxPos (CEikListBox &aListBox, const TAknWindowLineLayout &aLayout)
  Setup a graphic element for a column listbox using aknlayout.dll.
static TInt  AdjustPopupLayoutData (const TRect &aScreenRect)
  This function returns a correct offset to revise layout data.

Member Function Documentation

static TInt AknListBoxLayouts::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.

Since:
S60 5.0
Parameters:
aScreenRect  Size of Screen.
Returns:
Offset of listscroll_menu_pane's layout
static IMPORT_C void AknListBoxLayouts::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.

static IMPORT_C void AknListBoxLayouts::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.

static IMPORT_C void AknListBoxLayouts::SetupColumnTextCell (  CEikListBox &  aListBox,
CColumnListBoxItemDrawer *  aItemDrawer,
TInt  index,
const TAknTextLineLayout &  aLayout,
TInt  startx,
TInt  endx
)  [static]
 

Setup a single text cell of list item.

static IMPORT_C void AknListBoxLayouts::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.

static IMPORT_C void AknListBoxLayouts::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

static IMPORT_C void AknListBoxLayouts::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

static IMPORT_C void AknListBoxLayouts::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.

static IMPORT_C void AknListBoxLayouts::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.

static IMPORT_C void AknListBoxLayouts::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.

static IMPORT_C void AknListBoxLayouts::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.

static IMPORT_C void AknListBoxLayouts::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

static IMPORT_C void AknListBoxLayouts::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..)

static IMPORT_C void AknListBoxLayouts::SetupGridPos (  CAknGrid &  aGrid,
TInt  l,
TInt  t,
TInt  ,
TInt  ,
TInt  W,
TInt  H
)  [static]
 

Setup grid position.

static void AknListBoxLayouts::SetupGridPos (  CAknGrid &  aGrid,
const TAknWindowLineLayout &  aLayout
)  [static]
 

Setup grid position since 2.0.

static IMPORT_C void AknListBoxLayouts::SetupListboxPos (  CEikListBox &  aListBox,
const TAknWindowLineLayout &  aLayout
)  [static]
 

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

static IMPORT_C void AknListBoxLayouts::SetupListboxPos (  CEikListBox &  aListBox,
TInt  startx,
TInt  starty,
TInt  ,
TInt  ,
TInt  ,
TInt  height
)  [static]
 

Setup list position.

static void AknListBoxLayouts::SetupListboxPosL (  CEikListBox &  aListBox,
const TAknWindowLineLayout &  aLayout
)  [static]
 
static IMPORT_C void AknListBoxLayouts::SetupStandardColumnListbox (  CColumnListBoxItemDrawer *  aItemDrawer  )  [static]
 

Setup text foreground and background colors to default.

static IMPORT_C void AknListBoxLayouts::SetupStandardFormListbox (  CFormattedCellListBoxItemDrawer *  aItemDrawer  )  [static]
 

Setup text foreground and background colors to default.

static IMPORT_C void AknListBoxLayouts::SetupStandardGrid (  CAknGrid &  aGrid  )  [static]
 

Setup text foreground and background colors to default.

static IMPORT_C void AknListBoxLayouts::SetupStandardListBox (  CEikListBox &  aListBox  )  [static]
 

Setup borders etc.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top