1 /*

     2 * Copyright (c) 2002-2007 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0""

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Candidate list CellListBoxData

    15 *

    16 */

    17 

    18 

    19 #ifndef CPENINPUTJAPANESECANDIDATECELLLISTBOXDATA_H

    20 #define CPENINPUTJAPANESECANDIDATECELLLISTBOXDATA_H

    21 

    22 // INCLUDES

    23 #include <eikfrlbd.h>   // CFormattedCellListBoxData

    24 

    25 // CONSTANTS

    26 

    27 // FORWARD DECLARATIONS

    28 

    29 // CLASS DECLARATION

    30 

    31 /**

    32 *  CPeninputJapaneseCandidateCellListBoxDatae class.

    33 *

    34 *  @lib peninputcommonctrlsjp.lib

    35 *  @since 3.2

    36 */

    37 class CPeninputJapaneseCandidateCellListBoxData

    38         : public CFormattedCellListBoxData

    39     {

    40     public:  // Constructors and destructor

    41         /**

    42         * Two-phased constructor.

    43         */

    44         static CPeninputJapaneseCandidateCellListBoxData* NewL();

    45 

    46     public: // Functions from CFormattedCellListBoxData

    47         /**

    48         * From CFormattedCellListBoxData Draw() is the most important method

    49         * in CPeninputJapaneseCandidateCellListBoxData.

    50         * This is the only method that needs to be implemented in this class

    51         * and it draws the whole list item.

    52         * @since 2.6

    53         * @param aProperties Properties attached to the list item

    54         * @param aGc Graphics context used for drawing the list item

    55         * @param aText a text string describing the list item cells

    56         * @param aRect the area of the screen for the whole list item

    57         * @param aHighlight whether the list item is selected

    58         * @param aColors the colours used for drawing the item

    59         */

    60         virtual void Draw(TListItemProperties aProperties,

    61                           CWindowGc& aGc,

    62                           const TDesC* aText,

    63                           const TRect& aRect,

    64                           TBool aHighlight, 

    65                           const TColors& aColors) const;

    66 

    67         /**

    68         * From CFormattedCellListBoxData DrawDefaultHighlight() is ...

    69         * @since 2.6

    70         * @param aGc 

    71         * @param aItemRect

    72         * @param aHighlight

    73         */

    74         void DrawDefaultHighlight(CWindowGc& aGc,

    75                                   const TRect& aItemRect,

    76                                   TBool aHighlight) const;

    77     private:

    78         /**

    79         * @internal

    80         * From CFormattedCellListBoxData Draw() is the most important method

    81         * in CPeninputJapaneseCandidateCellListBoxData.

    82         * This is the only method that needs to be implemented in this class

    83         * and it draws the whole list item.

    84         * @since 2.6

    85         * @param aProperties Properties attached to the list item

    86         * @param aGc Graphics context used for drawing the list item

    87         * @param aText a text string describing the list item cells

    88         * @param aItemRect the area of the screen for the whole list item

    89         * @param aHighlight whether the list item is selected

    90         * @param aColors the colours used for drawing the item

    91         */

    92         void DrawFormattedCandidate( TListItemProperties& aProperties,

    93                            CWindowGc& aGc,

    94                            const TDesC* aText,

    95                            const TRect& aItemRect,

    96                            TBool aHighlight,

    97                            const TColors& aColors ) const;

    98     };

    99 

   100 #endif  // CPENINPUTJAPANESECANDIDATECELLLISTBOXDATA_H

   101 

   102 // End of File