epoc32/include/mw/aknlistquerycontrol.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
williamr@2
    20
#ifndef     __AKN_LIST_QUERY_CONTROL_H
williamr@2
    21
#define     __AKN_LIST_QUERY_CONTROL_H
williamr@2
    22
williamr@2
    23
#include <AknControl.h>
williamr@2
    24
williamr@4
    25
#include <aknPopupHeadingPane.h>
williamr@2
    26
#include <aknmessagequerycontrol.h>
williamr@2
    27
williamr@2
    28
class CEikFormattedCellListBox;
williamr@2
    29
struct TAknPopupWindowLayoutDef;
williamr@2
    30
williamr@2
    31
/**
williamr@2
    32
 * List query control class.
williamr@2
    33
 */
williamr@2
    34
class CAknListQueryControl : public CAknControl
williamr@2
    35
    {
williamr@2
    36
    public:
williamr@2
    37
        /**
williamr@2
    38
        * Constructor
williamr@2
    39
        */
williamr@2
    40
        IMPORT_C CAknListQueryControl();
williamr@2
    41
    
williamr@2
    42
        /**
williamr@2
    43
        * Constructs control from resources
williamr@2
    44
        */
williamr@2
    45
        IMPORT_C void ConstructFromResourceL(TResourceReader& aRes);
williamr@2
    46
williamr@2
    47
        /**
williamr@2
    48
        * Destructor
williamr@2
    49
        */
williamr@2
    50
        IMPORT_C virtual ~CAknListQueryControl();
williamr@2
    51
williamr@2
    52
        /**
williamr@2
    53
        * From CCoeControl
williamr@2
    54
        *
williamr@2
    55
        * @return   Minimum size of the control
williamr@2
    56
        */
williamr@2
    57
        IMPORT_C TSize MinimumSize();
williamr@2
    58
williamr@2
    59
        /**
williamr@2
    60
        * From CCoeControl
williamr@2
    61
        *   Returns number of controls inside the query control
williamr@2
    62
        * @return   Number of component controls
williamr@2
    63
        */
williamr@2
    64
        IMPORT_C TInt CountComponentControls() const;
williamr@2
    65
williamr@2
    66
        /**
williamr@2
    67
        * From CCoeControl
williamr@2
    68
        *   Returns a control determined by control id
williamr@2
    69
        * @param    anIndex     Index of a control to be returned
williamr@2
    70
        * @return   CCoeControl Pointer to control
williamr@2
    71
        */
williamr@2
    72
        IMPORT_C CCoeControl* ComponentControl(TInt anIndex) const;
williamr@2
    73
williamr@2
    74
        /**
williamr@2
    75
        * From CCoeControl
williamr@2
    76
        *   Handles key events - Gets called by CONE
williamr@2
    77
        * @param    aKeyEvent   The key event
williamr@2
    78
        * @param    aType       The type of the event
williamr@2
    79
        * @return   Indicates whether or not the key event was
williamr@2
    80
        *               used by this control
williamr@2
    81
        */
williamr@2
    82
        IMPORT_C TKeyResponse OfferKeyEventL( const TKeyEvent& aKeyEvent, TEventCode aType);
williamr@2
    83
williamr@2
    84
        /**
williamr@2
    85
        * From CCoeControl
williamr@2
    86
        *   Draws the control
williamr@2
    87
        * @param    aRect   The region of the control to be redrawn
williamr@2
    88
        */
williamr@2
    89
        IMPORT_C void Draw(const TRect& aRect) const;
williamr@2
    90
williamr@2
    91
        /**
williamr@2
    92
        * Sets layout for list query control
williamr@2
    93
        * @param aLayout    Layout to be set
williamr@2
    94
        */
williamr@2
    95
        IMPORT_C void SetLayout(TAknPopupWindowLayoutDef* aLayout);
williamr@2
    96
williamr@2
    97
        IMPORT_C void FocusChanged(TDrawNow aDrawNow);
williamr@2
    98
williamr@2
    99
        /**
williamr@2
   100
        * Returns pointer to listbox
williamr@2
   101
        * @return   Pointer to CEikFormattedCellListBox
williamr@2
   102
		*/
williamr@2
   103
        inline CEikFormattedCellListBox* Listbox() const;
williamr@2
   104
williamr@2
   105
        /**
williamr@2
   106
        * Returns pointer to heading
williamr@2
   107
        * @return   Pointer to CAknPopupHeadingPane
williamr@2
   108
		*/
williamr@2
   109
        inline CAknPopupHeadingPane* Heading() const;
williamr@2
   110
williamr@2
   111
        /**
williamr@2
   112
        * Return type of the list
williamr@2
   113
        * @return Type of the list
williamr@2
   114
        */
williamr@2
   115
        inline TInt Listtype() const;
williamr@2
   116
williamr@2
   117
        /**
williamr@2
   118
        * From CCoeControl.     
williamr@2
   119
        * Handles pointer events
williamr@2
   120
        */
williamr@2
   121
    	IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent);
williamr@2
   122
    	
williamr@2
   123
    	/**
williamr@2
   124
        * Get pointer to messageControl if such exists.
williamr@2
   125
        * @since 3.0
williamr@2
   126
        */
williamr@2
   127
        CAknMessageQueryControl* MessageBox() const;
williamr@2
   128
williamr@2
   129
    private:
williamr@2
   130
        /**
williamr@2
   131
        * From CAknControl
williamr@2
   132
        */
williamr@2
   133
        IMPORT_C void* ExtensionInterface( TUid aInterface );
williamr@2
   134
williamr@2
   135
    private:
williamr@2
   136
        CEikFormattedCellListBox* iListBox;
williamr@2
   137
        CAknPopupHeadingPane*     iHeading;
williamr@2
   138
        TInt                      iListType;
williamr@2
   139
        TAknPopupWindowLayoutDef* iLayout;
williamr@2
   140
        CAknMessageQueryControl*  iMessageBox;        
williamr@2
   141
williamr@2
   142
        TInt iSpare[1];
williamr@2
   143
williamr@2
   144
	public:
williamr@2
   145
williamr@2
   146
		/**
williamr@2
   147
		 * Deprecated - do not use
williamr@2
   148
		 */
williamr@2
   149
        inline CEikFormattedCellListBox* listbox() const;
williamr@2
   150
    };
williamr@2
   151
williamr@2
   152
inline CEikFormattedCellListBox *CAknListQueryControl::Listbox() const 
williamr@2
   153
	{ 
williamr@2
   154
	return iListBox; 
williamr@2
   155
	}
williamr@2
   156
williamr@2
   157
inline CAknPopupHeadingPane *CAknListQueryControl::Heading() const 
williamr@2
   158
    {
williamr@2
   159
    if ( iHeading && iHeading->Prompt() )
williamr@2
   160
        return iHeading;
williamr@2
   161
    return 0;
williamr@2
   162
    }
williamr@2
   163
williamr@2
   164
inline TInt CAknListQueryControl::Listtype() const 
williamr@2
   165
	{ 
williamr@2
   166
	return iListType; 
williamr@2
   167
	}
williamr@2
   168
williamr@2
   169
/**
williamr@2
   170
 * Deprecated methods
williamr@2
   171
 */
williamr@2
   172
inline CEikFormattedCellListBox* CAknListQueryControl::listbox() const 
williamr@2
   173
	{ 
williamr@2
   174
	return Listbox();
williamr@2
   175
	}
williamr@2
   176
williamr@2
   177
#endif