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:  common layout window for UI interface of VKB and HWR : japanese

    15 *

    16 */

    17 

    18 

    19 #ifndef C_PENINPUTLAYOUTWINDOWJP_H

    20 #define C_PENINPUTLAYOUTWINDOWJP_H

    21 

    22 // System includes

    23 #include <peninputlayoutwindow.h>

    24 

    25 class CFepInputContextFieldJp;

    26 class CPeninputJapaneseView;

    27 class CPeninputJapaneseCandidateWnd;

    28 class CPeninputJapanesePredictiveWnd;

    29 

    30 /**

    31  *  Pen input Common layout for Japanese class

    32  *

    33  *  @lib peninputcommonctrlsjp.dll

    34  *  @since S60 v3.2

    35  */

    36 class CPeninputLayoutWindowJp : public CPeninputLayoutWindow

    37     {

    38 

    39 public:

    40 

    41     /**

    42      * Destructor

    43      *

    44      * @since S60 v3.2

    45      * @return None

    46      */

    47     IMPORT_C virtual ~CPeninputLayoutWindowJp();

    48 

    49     /**

    50      * From CPeninputLayoutWindow

    51      * Handle control event

    52      *

    53      * @since S60 v3.2

    54      * @param aEventType The event type

    55      * @param aCtrl The control who sends the event

    56      * @param aEventData The event data

    57      * @return None

    58      */

    59     IMPORT_C void HandleControlEvent( TInt aEventType,

    60                                      CFepUiBaseCtrl* aCtrl,

    61                                      const TDesC& aEventData );

    62 

    63     /**

    64      * Create VKB and HWR common controls

    65      *

    66      * @since S60 v3.2

    67      * @return None

    68      */

    69     IMPORT_C virtual void CreateAllControlsL();

    70 

    71     /**

    72      * Set control fonts for VKB and HWR common controls

    73      *

    74      * @since S60 v3.2

    75      * @return None

    76      */

    77     IMPORT_C virtual void SetControlsFont();

    78 

    79     /** 

    80      * From CPeninputLayoutWindow

    81      * ConstructFromResourceL load settings from resource.

    82      * Before calling this function, the resource id should be set

    83      *

    84      * @since S60 v3.2

    85      * @return None

    86      */

    87     IMPORT_C virtual void ConstructFromResourceL();

    88 

    89     /**

    90      * Handle pointer down event

    91      *

    92      * @since S60 V4.0

    93      * @param aPoint The point position relative the layout

    94      * @return The control which handles the event.

    95      */

    96     IMPORT_C virtual CFepUiBaseCtrl* HandlePointerDownEventL(const TPoint& aPoint);

    97 

    98     /**

    99      * Get id of prediction pane scroll up button

   100      *

   101      * @since S60 v3.2

   102      * @return The id of prediction pane scroll up button resource

   103      */

   104     IMPORT_C virtual TInt GetScrollUpBtnResId() = 0;

   105 

   106     /**

   107      * Get id of prediction pane scroll down button

   108      *

   109      * @since S60 v3.2

   110      * @return The id of prediction pane scroll down button resource

   111      */ 

   112     IMPORT_C virtual TInt GetScrollDownBtnResId() = 0;

   113 

   114     /**

   115      * Handle pointer up event

   116      *

   117      * @since S60 V4.0

   118      * @param aPoint The point position relative the layout

   119      * @return The control which handles the event.

   120      */

   121     IMPORT_C virtual CFepUiBaseCtrl* HandlePointerUpEventL(const TPoint& aPoint);

   122 

   123     /**

   124      * Handle pointer move event

   125      *

   126      * @since S60 V4.0

   127      * @param aPoint The point position relative the layout

   128      * @return The control which handles the event.

   129      */

   130     IMPORT_C virtual CFepUiBaseCtrl* HandlePointerMoveEventL(const TPoint& aPoint);

   131 

   132     /**

   133      * Get candidate window

   134      *

   135      * @since Series 60 3.2

   136      * @return candidate window

   137      */ 

   138     IMPORT_C CPeninputJapaneseCandidateWnd* CandidateWindow();

   139 

   140     /**

   141      * Get predictive window

   142      *

   143      * @since Series 60 3.2

   144      * @return predictive window

   145      */

   146     IMPORT_C CPeninputJapanesePredictiveWnd* PredictiveWindow();

   147 

   148     /**

   149      * Get CharacterRange window

   150      *

   151      * @since Series 60 3.2

   152      * @return CharacterRange window

   153      */ 

   154     IMPORT_C CPeninputJapaneseCandidateWnd* CharacterRangeWindow();

   155 

   156     /**

   157      * Get input context field

   158      *

   159      * @since S60 v3.2

   160      * @return The input context field

   161      */

   162     IMPORT_C CFepInputContextFieldJp* InputContextField();

   163 

   164     /**

   165      * Set layoutwindow opened

   166      *

   167      * @since S60 v3.2

   168      * @return None

   169      */

   170     IMPORT_C void Opened();

   171 

   172     /**

   173      * Set layoutwindow opened

   174      *

   175      * @since S60 v3.2

   176      * @return None

   177      */

   178     IMPORT_C void Closed();

   179 

   180     /**

   181      * DisableRegionUpdating on ICF

   182      *

   183      * @since S60 v5.0

   184      * @return None

   185      */

   186     IMPORT_C void ICFDisableRegionUpdating();

   187 

   188     /**

   189      * EnableRegionUpdating on ICF

   190      *

   191      * @since S60 v5.0

   192      * @return None

   193      */

   194     IMPORT_C void ICFEnableRegionUpdating();

   195 

   196 protected:

   197 

   198     /**

   199      * constructor

   200      *

   201      * @since S60 v3.2

   202      * @param aUiLayout The pointer to CFepUiLayout object

   203      * @param aLayoutContext The pointer to MPeninputLayoutContext

   204      * @return None

   205      */

   206     IMPORT_C CPeninputLayoutWindowJp( CFepUiLayout* aUiLayout, 

   207                                     MPeninputLayoutContext* aLayoutContext );

   208 

   209 private:

   210     /**

   211      * Add button to client area

   212      *

   213      * @since S60 v3.2

   214      * @param aControlId The control id

   215      * @param aEventId The control's event id

   216      * @param aResId The control's resource id

   217      * @param aUnicode The control's unicode

   218      * @param aIsRepeat The TBool indicating whether the

   219      *        control is repeated or not

   220      * @return The pointer to CAknFepCtrlEventButton object

   221      */

   222     CAknFepCtrlEventButton* AddButtonL( const TInt aControlId,

   223                                         const TInt aEventId,

   224                                         const TInt aResId,

   225                                         const TInt aUnicode = 0,

   226                                         const TBool aIsRepeat = EFalse );

   227 

   228     /**

   229      * Add Candidate window into the layout window

   230      *

   231      * @since Series 60 3.2

   232      * @return None

   233      */

   234     void AddCandidateWindowL();

   235 

   236     /**

   237      * Add Predictive window into the layout window

   238      *

   239      * @since Series 60 3.2

   240      * @return None

   241      */

   242     void AddPredictiveWindowL();

   243 

   244     /**

   245      * Add CharacterRange window into the layout window

   246      *

   247      * @since Series 60 3.2

   248      * @return None

   249      */

   250     void AddCharacterRangeWindowL();

   251 

   252 protected:  // data

   253 

   254     /**

   255      * The popup window

   256      * Own  (AddControlL())

   257      */

   258     CPeninputJapaneseCandidateWnd* iCandidateWnd;

   259 

   260     /**

   261      * The popup window

   262      * Own  (AddControlL())

   263      */

   264     CPeninputJapanesePredictiveWnd* iPredictiveWnd;

   265 

   266     /**

   267      * The popup window (Hwr)

   268      * Own  (AddControlL())

   269      */

   270     CPeninputJapaneseCandidateWnd* iCharacterRangeWnd;

   271 

   272     /**

   273      * parent of the popup window

   274      * Own

   275      */

   276     CPeninputJapaneseView* iViewCandidate;

   277 

   278     /**

   279      * parent of the popup window

   280      * Own

   281      */

   282     CPeninputJapaneseView* iViewPrediction;

   283 

   284     /**

   285      * parent of the popup window

   286      * Own

   287      */

   288     CPeninputJapaneseView* iViewCharacterRange;

   289 

   290     /**

   291      * lauoutwindow opend

   292      */

   293     TBool iOpened;

   294 

   295     };

   296 

   297 #endif // C_PENINPUTLAYOUTWINDOWJP_H