fep/aknfep/UiPlugins/AknFepUiInterface/AvkonImpl/inc/AknFepUIAvkonCtrlJapanesePredictiveListboxView.h
author Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
Fri, 19 Feb 2010 23:09:27 +0200
branchRCL_3
changeset 3 f5a1e66df979
parent 0 eb1f2e154e89
permissions -rw-r--r--
Revision: 201003 Kit: 201007

/*
* Copyright (c) 2003 Nokia Corporation and/or its subsidiary(-ies). 
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of "Eclipse Public License v1.0""
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:            Predictive Candidate list
*
*/












#ifndef CAKNFEPUICTRLJAPANESEPREDICTIVELISTBOXVIEW_H
#define CAKNFEPUICTRLJAPANESEPREDICTIVELISTBOXVIEW_H

// INCLUDES

// CONSTANTS

// FORWARD DECLARATIONS

// CLASS DECLARATION

/**
*  CAknFepUICtrlJapanesePredictiveListboxView draws all the list items and manages
*  the area of the screen allocated for list itself. In particular,
*  this class does not handle margins of the whole list.
*
*  @lib AknFep.lib
*  @since 2.6
*/
NONSHARABLE_CLASS(CAknFepUICtrlJapanesePredictiveListboxView) : public CListBoxView
    {
    public: // New functions
        /**
        * Return the selected candidate number currently
        * @since 2.6
        * @return candidate number
        */
        TInt CurrentCandidateNo() const;    

        /**
        * Set current candidate number
        * @since 2.6
        * @param    aCandidateNo    candidate number
        * @return   item index including candidate number
        */
        TInt SetCurrentCandidateNo(TInt aCandidateNo); 

        /**
        * Return previous candidate number
        * @since 2.6
        * @return candidate number
        */
        TInt PreviousItem();

        /**
        * Return next candidate number
        * @since 2.6
        * @return candidate number
        */
        TInt NextItem();

        /**
        * Return candidate number of previous line
        * @since 2.6
        * @return candidate number
        */
        TInt PreviousLineItem();

        /**
        * Return candidate number of next line
        * @since 2.6
        * @return candidate number
        */
        TInt NextLineItem();

        /**
        * Return the selected candidate number currently
        * @since 3.2
        * @return candidate number
        */
        TInt OldCandidateNo() const;

        /**
        * Set current candidate number from point
        * @since 3.2
        * @param aLineNo        line number
        * @param aPoint         position
        * @return candidate number
        */
        TInt SetCurrentCandidateNo(TInt aLineNo, const TPoint& aPoint);

    public: // from CListBoxView
        virtual void DrawItem(TInt aItemIndex) const;

    private:    // Data
        TInt iCurrentCandidateNo;
        TInt iOldCandidateNo;
    };

#endif  // CAKNFEPUICTRLJAPANESEPREDICTIVELISTBOXVIEW_H

// End of File