textinput/peninputcommonctrlsjp/inc/peninputjapanesepredictivecelllistboxdata.h
changeset 0 eb1f2e154e89
equal deleted inserted replaced
-1:000000000000 0:eb1f2e154e89
       
     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:  Predictive Candidate list cellist data box
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef CPENINPUTJAPANESEPREDICTIVECELLLISTBOXDATA_H
       
    20 #define CPENINPUTJAPANESEPREDICTIVECELLLISTBOXDATA_H
       
    21 
       
    22 // INCLUDES
       
    23 #include <eikfrlbd.h>   // CFormattedCellListBoxData
       
    24 
       
    25 // CONSTANTS
       
    26 
       
    27 // FORWARD DECLARATIONS
       
    28 class CPeninputJapanesePredictiveWnd;
       
    29 
       
    30 // CLASS DECLARATION
       
    31 
       
    32 /**
       
    33 *  CPeninputJapanesePredictiveCellListBoxData class.
       
    34 *
       
    35 *  @lib peninputcommonctrlsjp.lib
       
    36 *  @since 2.6
       
    37 */
       
    38 class CPeninputJapanesePredictiveCellListBoxData
       
    39         : public CFormattedCellListBoxData
       
    40     {
       
    41     public:  // Constructors and destructor
       
    42         /**
       
    43         * Two-phased constructor.
       
    44         */
       
    45         static CPeninputJapanesePredictiveCellListBoxData* NewL();
       
    46 
       
    47     public: // New functions
       
    48         /**
       
    49         * Set a starting x-point and ending to highlight
       
    50         * @since 2.6
       
    51         * @param aHighlightStartXPos    a starting x-point
       
    52         * @param aHighlightEndXPos      a ending x-point
       
    53         */
       
    54         void SetHighlightArea(TInt aHighlightStartXPos,
       
    55                               TInt aHighlightEndXPos);
       
    56 
       
    57     public: // Functions from CFormattedCellListBoxData
       
    58 
       
    59         /**
       
    60         * From CFormattedCellListBoxData Draw() is the most important method in
       
    61         * CPeninputJapanesePredictiveCellListBoxData.
       
    62         * This is the only method that needs to be implemented in this class and
       
    63         * it draws the whole listi tem.
       
    64         * @since 0.0
       
    65         * @param aProperties Properties attached to the list item
       
    66         * @param aGc Graphics context used for drawing the list item
       
    67         * @param aText a text string describing the list item cells
       
    68         * @param aRect the area of the screen for the whole list item
       
    69         * @param aHighlight whether the list item is selected
       
    70         * @param aColors the colours used for drawing the item
       
    71         * @return None.
       
    72         */
       
    73         virtual void Draw(TListItemProperties aProperties,
       
    74                           CWindowGc& aGc,
       
    75                           const TDesC* aText,
       
    76                           const TRect& aRect,
       
    77                           TBool aHighlight,
       
    78                           const TColors& aColors) const;
       
    79 
       
    80         /**
       
    81         * From CFormattedCellListBoxData
       
    82         * Show hightlight area in listbox
       
    83         * @since 2.6
       
    84         * @param aGc        Gc
       
    85         * @param aItemRect  rect to highlight
       
    86         * @param aHighlight ETrue is highlight. EFalse is non-highlight.
       
    87         */
       
    88         void DrawDefaultHighlight(CWindowGc &aGc,
       
    89                                   const TRect &aItemRect,
       
    90                                   TBool aHighlight) const;
       
    91 
       
    92         void SetWnd(CPeninputJapanesePredictiveWnd* aWnd);
       
    93 
       
    94     private:    // Data
       
    95         TInt iHighlightStartXPos;
       
    96         TInt iHighlightEndXPos;
       
    97         CPeninputJapanesePredictiveWnd* iWnd;
       
    98     };
       
    99 
       
   100 #endif  // CPENINPUTJAPANESEPREDICTIVECELLLISTBOXDATA_H
       
   101 
       
   102 // End of File