CAknNoteControl::TIndex Class Reference

API published in: S60 1st Ed

Link against: avkon.lib eikctl.lib eikcdlg.lib

Capability Information

Required Capabilities

None

#include <aknnotecontrol.h>

Detailed Description

Manage indexes into LAF tables.

NP stands for "Note Popup"

WNP stands for "Waiting/progress Note Popup"

NWIP stands for "Note With Image Popup"


Public Member Functions
  TIndex (TInt aNumberOfLines, TBool aHasNti=EFalse, TSize aImageSize=TSize(0, 0))
  C++ default constructor.
TInt  Lines () const
  Returns number of lines.
TInt  WNPWindowTextsLine1 (TInt aLineNum) const
  Return index into table "Waiting/progress Note Popup Window Texts Line 1".
TInt  NWIPWindowTextsLine1L (TInt aLineNum) const
  Return Left index into table "Note With Image Popup Window Texts Line 1".
TInt  NWIPWindowTextsLine1R (TInt aLineNum) const
  Return Right index into table "Note With Image Popup Window Texts Line 1".
TInt  NWIPWindowTextsLine1B (TInt aLineNum) const
  Return Bottom index into table "Note With Image Popup Window Texts Line 1".
TInt  NWIPWindowTextsLine1W (TInt aLineNum) const
  Return Width index into table "Note With Image Popup Window Texts Line 1".
TInt  PopupNoteWindow () const
  Return indexes for table AKN_LAYOUT_WINDOW_popup_note_window.
TInt  PopupNoteWaitWindow () const
  Return indexes for table AKN_LAYOUT_WINDOW_popup_note_wait_window.

Constructor & Destructor Documentation

CAknNoteControl::TIndex::TIndex (  TInt  aNumberOfLines,
TBool  aHasNti = EFalse,
TSize  aImageSize = TSize(0, 0)
) 
 

C++ default constructor.

Parameters:
aNumberOfLines  Number of lines.
aHasNti  Determines whether or not there is a number type indication (NTI).
aImageSize  Image size.

Member Function Documentation

TInt CAknNoteControl::TIndex::Lines (   )  const
 

Returns number of lines.

Returns:
Number of lines.
TInt CAknNoteControl::TIndex::NWIPWindowTextsLine1B (  TInt  aLineNum  )  const
 

Return Bottom index into table "Note With Image Popup Window Texts Line 1".

Index is the same as the number of text lines minus one. See table in *.lay and LAF specs for working out indexes.

Parameters:
aLineNum  Line number.
Returns:
Bottom index into table "Note With Image Popup Window Texts Line 1".
TInt CAknNoteControl::TIndex::NWIPWindowTextsLine1L (  TInt  aLineNum  )  const
 

Return Left index into table "Note With Image Popup Window Texts Line 1".

Index depends on number of text lines, whether or not there is a number type indication (NTI). See table in *.lay and LAF specs for working out indexes.

Parameters:
aLineNum  Line number.
Returns:
Left index into table "Note With Image Popup Window Texts Line 1".
TInt CAknNoteControl::TIndex::NWIPWindowTextsLine1R (  TInt  aLineNum  )  const
 

Return Right index into table "Note With Image Popup Window Texts Line 1".

Index depends on number of text lines and image size. See table in *.lay and LAF specs for working out indexes.

Table has 3 dimensions:-

  • Dimension 1 is the line number
  • Dimension 2 is the image width
  • Dimension 3 is the image height
Parameters:
aLineNum  Line number.
Returns:
Right index into table "Note With Image Popup Window Texts Line 1".
TInt CAknNoteControl::TIndex::NWIPWindowTextsLine1W (  TInt  aLineNum  )  const
 

Return Width index into table "Note With Image Popup Window Texts Line 1".

Index depends on number of text lines, whether or not there is a number type indication (NTI) and image size. See table in *.lay and LAF specs for working out indexes.

Table has 4 dimensions:-

  • Dimension 1 indicates the presence of an NTI(index 0 = NO NTI, index 1 = NTI)
  • Dimension 2 is the line number
  • Dimension 3 is the image width
  • Dimension 4 is the image height
Parameters:
aLineNum  Line number.
Returns:
Width index into table "Note With Image Popup Window Texts Line 1".
TInt CAknNoteControl::TIndex::PopupNoteWaitWindow (   )  const
 

Return indexes for table AKN_LAYOUT_WINDOW_popup_note_wait_window.

If there are 0-2 lines the index is 0. If there are 3 lines the index is 1, if there are 4 lines the index is 2.

Returns:
Indexes for table AKN_LAYOUT_WINDOW_popup_note_wait_window.
TInt CAknNoteControl::TIndex::PopupNoteWindow (   )  const
 

Return indexes for table AKN_LAYOUT_WINDOW_popup_note_window.

If there are 0-2 lines the index is 0. If there are 3 lines the index is 1, if there are 4 or more lines the index is 2.

Returns:
Indexes for table AKN_LAYOUT_WINDOW_popup_note_window.
TInt CAknNoteControl::TIndex::WNPWindowTextsLine1 (  TInt  aLineNum  )  const
 

Return index into table "Waiting/progress Note Popup Window Texts Line 1".

Index depends on the number of text lines and whether or not there is a number type indication (NTI). See table in *.lay and LAF specs for working out indexes.

Parameters:
aLineNum  Line number.
Returns:
Index into table "Waiting/progress Note Popup Window Texts Line 1".
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top