javauis/coreui_akn/inc/coreuiavkonlcduisupport.h
branchRCL_3
changeset 19 04becd199f91
equal deleted inserted replaced
16:f5050f1da672 19:04becd199f91
       
     1 /*
       
     2 * Copyright (c) 2009 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: A support interface for the LCDUI.
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef COREUIAVKONLCDUISUPPORT_H
       
    19 #define COREUIAVKONLCDUISUPPORT_H
       
    20 
       
    21 #include <e32base.h>
       
    22 class RLcdui;
       
    23 
       
    24 namespace java // codescanner::namespace
       
    25 {
       
    26 namespace ui // codescanner::namespace
       
    27 {
       
    28 
       
    29 /**
       
    30  * CoreUiAvkonLcduiSupport is a class for LCDUI for storing and doing
       
    31  * LCDUI specific operations. The CoreUi stores a singleton instance of
       
    32  * this class that can be get by calling
       
    33  * CoreUiAvkonLcdui::getInstance().getLcduiSupport() method.
       
    34  */
       
    35 NONSHARABLE_CLASS(CoreUiAvkonLcduiSupport)
       
    36 {
       
    37 public:
       
    38     /**
       
    39      * CoreUiAvkonLcduiSupport default constructor.
       
    40      */
       
    41     CoreUiAvkonLcduiSupport() {}
       
    42 
       
    43     /**
       
    44      * CoreUiAvkonLcduiSupport destructor.
       
    45      */
       
    46     virtual ~CoreUiAvkonLcduiSupport() {}
       
    47 
       
    48     /**
       
    49      * Gets the RLcdui object. Should never
       
    50      * be null.
       
    51      */
       
    52     virtual RLcdui* getRlcdUi() = 0;
       
    53 
       
    54     /**
       
    55      * Gets the handle to event server handle. This handle is a pointer to
       
    56      * LCDUI event server object. The handle is is actually a pointer that
       
    57      * has been shifted two bits to right (using JavaMakeHandle from jutils.h).
       
    58      * When the user wants get the real pointer the result of this method call
       
    59      * must be converted by using method JavaUnhand (from jutils.h).
       
    60      */
       
    61     virtual int getEventServerHandle() = 0;
       
    62 };
       
    63 
       
    64 } // end namespace ui
       
    65 } // end namespace java
       
    66 
       
    67 #endif // COREUIAVKONLCDUISUPPORT_H