CAknSelectionListDialog() Default constructor.

~CAknSelectionListDialog() Destructor.

ComponentControl() From CCoeControl

ConstructL() Second phase constructor.

CountComponentControls() From CCoeControl

CreateCustomControlL() creates own list or grid layouts.

Normal implementation of this method is:

         SEikControlInfo CreateCustomControlL(TInt aControlType)
     {
     CCoeControl *control = NULL;
     if ( aControlType == EMyCtGridLayout )
         {
         // CMyOddStyleGrid should be derived from CAknFormattedCellListBox or CEikColumnListBox.
         control = new(ELeave)CMyOddStyleGrid;
         } 
     SEikControlInfo info = {control,0,0};
     return info;
     }
        

Draw() from CCoeControl

ExitViaIdle()

Callback function to exit dialog after selecting something with tapping it. This prevents dialog to be destroyed before dialog page's handlepointereventl is fully completed.

From CAknControl

FindBox() accessor to findbox control

HandleListBoxEventL() From MEikListBoxObserver Handles listbox events.

From CCoeControl . Handles pointer events

IconArray()

Icons, images and thumbnails are in this array.

The list items are tab separated strings with fixed format. Some of the numbers in the list item strings are indexes to this array.

This array can be modified by MDesCArray::MdcaPoint() method or at construction of dialog; after PrepareLC() call.

IsAcceptableListBoxType() : Detection of list and grid layouts

The CAknSelectionList only works with certain list and grid layouts.

You will get Panic() if you use your own list/grid layouts and you do not have this method implemented!

If you add new list layouts, you should implement this method to publish the type of the layout using this method. This is especially the case where you use CAknSelectionGrid with your own grid layout. (as there are no predefined grid layouts, you need to do this every time you use a selection grid)

         EAknCtSingleListBox
     EAknCtSingleNumberListBox
     EAknCtSingleHeadingListBox
     EAknCtSingleGraphicListBox
     EAknCtSingleGraphicHeadingListBox
     EAknCtSingleNumberHeadingListBox
     EAknCtSingleLargeListBox
     EAknCtDoubleListBox
     EAknCtDoubleNumberListBox
     EAknCtDoubleTimeListBox
     EAknCtDoubleLargeListBox
     EAknCtDoubleGraphicListBox
     EAknCtSettingListBox
     EAknCtSettingNumberListBox
        

         TBool IsAcceptableListBoxType(TInt aControlType, TBool &aIsFormattedCellList)
     {
     if (aControlType == EMyCtGridLayout)
         {
         // CAknGrid is-a formattedcelllistbox.
         aIsFormattedCellList = ETrue;
         return ETrue;
         }
     else
        {
        return EFalse;
        }
     }
        

IsFormattedCellListBox() used to check whether listbox control is a CEikFormattedCellListBox or a CEikColumnListBox . If you derive from IsAcceptableListBoxType() you must take care of the aIsFormattedCellListParameter to make this method to work correctly.

ListBox() accessor to listbox control

CAknSelectionListDialog::NewL()

Static factory constructor. Uses two phase construction and leaves nothing on the CleanupStack .

CAknSelectionListDialog::NewLC()

Static factory constructor. Uses two phase construction and leaves created object in CleanupStack .

OfferKeyEventL() From CCoeControl

OkToExitL() From CAknDialog . This is not called if the Cancel button is activated unless the EEikDialogFlagNotifyEsc flag has been set.

PreLayoutDynInitL() From CAknDialog .

PreLayoutDynInitL() From CAknDialog .

ProcessCommandL() From CAknDialog . Processes commands and passes commands to FindBox and ListBox as needed.

SelectionListProcessCommandL() handles selection list and markable list default commands.

For markable lists, this method handles EAknCmdMark, EAknCmdUnmark, EAknMarkAll, EAknUnmarkAll defined in options menu pane R_AVKON_MENUPANE_MARKABLE_LIST.

SetIconArrayL()

Icons, images and thumbnails are in this array.

The list items are tab separated strings with fixed format. Some of the numbers in the list item strings are indexes to this array.

This array can be modified by MDesCArray::MdcaPoint() method or at construction of dialog; after PrepareLC() call.

SetSizeAndPosition() From CAknDialog . Sets dialog's size to whole main pane.

SetupFind()

Provides a way to enable and disable find and find popup on runtime. You still need entry with id EFindControl to resource file for the find, this is only for disabling existing find element.

CAknSelectionListDialog::TFindType Determines what kind of findbox should be used. Note, that a fixed findbox is not available with all list types.

iEnterKeyPressed Set as ETrue if EAknCmdOpen is handled in ProcessCommandL() . This will eventually cause OkToExitL() to be called with EAknSoftkeyOk as aButtonId.