mmsharinguis_plat/live_comms_plugin_api/inc/lcwindow.h
branchRCL_3
changeset 33 bc78a40cd63c
parent 32 73a1feb507fb
child 35 6c57ef9392d2
equal deleted inserted replaced
32:73a1feb507fb 33:bc78a40cd63c
     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: 
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef MLCWINDOW_H
       
    19 #define MLCWINDOW_H
       
    20 
       
    21 // INCLUDES
       
    22 #include <e32std.h>
       
    23 
       
    24 // CLASS DECLARATION
       
    25 /**
       
    26 * Class representing a window for a video player.
       
    27 */
       
    28 class MLcWindow
       
    29     {
       
    30     public:
       
    31 
       
    32         /**
       
    33         * The possible window orientations.
       
    34         */
       
    35         enum TLcWindowOrientation
       
    36             {
       
    37             EPortrait, // Normal
       
    38             ELandscape // 90 degree's clockwise rotation
       
    39             };
       
    40 
       
    41         /**
       
    42         * Enables / disables the window into use 
       
    43         * and start / stops to show the video in it.
       
    44         * @param aEnabled ETrue enables the window, EFalse disables it.
       
    45         */
       
    46         virtual void EnableLcWindowL( TBool aEnable ) = 0;
       
    47         
       
    48         /**
       
    49         * Checks whether the window has been enabled.
       
    50         * @return ETrue if the window has been enabled, otherwise EFalse.
       
    51         */
       
    52         virtual TBool IsLcWindowEnabled() = 0;
       
    53         
       
    54         /**
       
    55         * Sets the rectangle for the window.
       
    56         * @param aRect the rectangle for the window
       
    57         */
       
    58         virtual void SetLcWindowRectL( TRect aRect ) = 0;
       
    59         
       
    60         /**
       
    61         * Returns the current rectangle for the window.
       
    62         * @return the current rectangle for the window
       
    63         */
       
    64         virtual TRect LcWindowRect() = 0;
       
    65         
       
    66         /**
       
    67         * Sets the window orientation.
       
    68         * @param aOrientation the current window orientation
       
    69         */
       
    70         virtual void SetLcWindowOrientationL( 
       
    71             TLcWindowOrientation aOrientation ) = 0;
       
    72         
       
    73         /**
       
    74         * Returns the current window orientation.
       
    75         * @return the current window orientation
       
    76         */
       
    77         virtual TLcWindowOrientation LcWindowOrientationL() = 0;
       
    78     };
       
    79 
       
    80 #endif // MLCWINDOW_H
       
    81 
       
    82 // end of file