1 /*

     2 * Copyright (c) 2006 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:   Sub-session for display

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef R_ALFDISPLAYSUBSESSION_H

    21 #define R_ALFDISPLAYSUBSESSION_H

    22 

    23 #include <e32std.h>

    24 #include "alfclient.h"

    25 #include "alf/alfdisplay.h"

    26 

    27 /**

    28  *  Sub-session for display

    29  *

    30  *  @lib alfclient.lib

    31  *  @since S60 v3.2

    32  */

    33 NONSHARABLE_CLASS( RAlfDisplaySubSession ): public RSubSessionBase 

    34     {

    35 

    36 public:

    37 

    38     /**

    39      * Open subsession for given session.

    40      *

    41      * @param aSession Used session.

    42      * @param aRect Display area.

    43      * @return Error code.

    44      */

    45     TInt Open( RAlfClient& aSession, const TRect& aRect, TInt aDisplayType, TUid aBufferUid );

    46     

    47     /**

    48      *  Closes the subsession.

    49      */

    50     void Close();

    51     

    52     /**

    53      * Set background clearing mode. 

    54      *

    55      * @param aClearBackground Mode. See CAlfDisplay::TClearMode.

    56      * @return Error code.

    57      */

    58     TInt SetClearBackground( TInt aClearBackground );

    59     

    60     /**

    61      * Set visible area. 

    62      *

    63      * @param aRect Visible area rect.

    64      * @return Error code.

    65      */

    66     TInt SetVisibleArea( const TRect& aRect, TBool aForce = EFalse );

    67     

    68     /**

    69      * Returns visible area. 

    70      *

    71      * @param aRect Visible area rect is set here (if returns KErrNone).

    72      * @return Error code.

    73      */

    74     TInt VisibleArea( TRect& aRect ) const;

    75     

    76     /**

    77      * Sets whole display as dirty. 

    78      *

    79      */

    80     void SetDirty();

    81     

    82     /**

    83      * Sets redering quality. 

    84      *

    85      */

    86     TInt SetQuality(TAlfQuality aRenderingQuality);

    87     

    88     /**

    89      * Gets redering quality. 

    90      *

    91      */

    92     TInt Quality(TAlfQuality& aRenderingQuality) const;

    93 

    94     /**

    95      * Sets depth test. 

    96      *

    97      */

    98     TInt SetUseDepth(TBool aUseDepth);

    99     

   100     /**

   101      * Sets intended usage of display. 

   102      *

   103      */

   104     TInt SetUsage(TUint aUsageHint);

   105     

   106     /**

   107      * Sets display background items. 

   108      *

   109      */

   110     TInt SetBackgroundItemsL(const RArray<TAlfDisplayBackgroundItem>& aItems);    

   111 

   112     /**

   113      * Forwards a pointer event to display.

   114      *

   115      */

   116     TInt HandlePointerEventL(const TPointerEvent& aPointerEvent);

   117 

   118     /**

   119      * Suppresses automatic fading.

   120      * @param aSuppress ETrue to suppress, EFalse to enable back.

   121      */

   122     TInt SuppressAutomaticFading( TBool aSuppress );

   123     

   124     /**

   125      * Set the client window where the visual or layout will be drawn to.

   126      * @param aWindowGroupId Window group id.

   127      * @param aClientWindowHandle Client side window handle.

   128      * @param aVisualHandle Visual handle.

   129      */

   130     void SetClientWindowForDrawingL(TInt aWindowGroupId, TInt aClientWindowHandle, TInt aVisualHandle);

   131 

   132     };

   133 

   134 

   135 #endif // R_ALFDISPLAYSUBSESSION_H