vtuis/videotelui/inc/VtUiLayout.h
changeset 0 ed9695c8bcbe
child 3 b1602a5ab0a3
equal deleted inserted replaced
-1:000000000000 0:ed9695c8bcbe
       
     1 /*
       
     2 * Copyright (c) 2004, 2005 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:  Layout related accessory methods for Video Telephone
       
    15 *                application.
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 
       
    21 #ifndef VTUILAYOUT_H
       
    22 #define VTUILAYOUT_H
       
    23 
       
    24 //  INCLUDES
       
    25 #include    "videotelui.hrh"
       
    26 #include    <e32base.h>
       
    27 #include    <aknutils.h>
       
    28 
       
    29 // FORWARD DECLARATIONS
       
    30 class TAknsItemID;
       
    31 
       
    32 // CLASS DECLARATION
       
    33 
       
    34 /**
       
    35 *  Layout related accessory methods for Video Telephone application.
       
    36 *
       
    37 *  @since Series 60 2.6
       
    38 */
       
    39 class VtUiLayout
       
    40     {
       
    41     public: // New functions
       
    42 
       
    43         /**
       
    44         * Returns application window rectangle.
       
    45         * @param aRect rectangle to be filled.
       
    46         */
       
    47         static void GetApplicationParentRect(
       
    48             TRect& aRect );
       
    49 
       
    50         // ELEMENTS RELATIVE TO APPLICATION WINDOW:
       
    51 
       
    52         /**
       
    53         * Returns main pane layout.
       
    54         * @param aLayout main pane layout.
       
    55         */
       
    56         static void GetMainPaneLayout(
       
    57             TAknWindowLineLayout& aLayout );
       
    58 
       
    59         // ELEMENTS RELATIVE TO APPLICATION WINDOW:
       
    60 
       
    61         /**
       
    62         * Returns layout for uplink video stream background.
       
    63         * @param aLayout layout of qgn_graf_call_video_out_bg.
       
    64         */
       
    65         static void GetFirstWindowBackgroundLayout(
       
    66             TAknWindowLineLayout& aLayout );
       
    67 
       
    68         /**
       
    69         * Returns layout for uplink video stream.
       
    70         * @param aLayout layout of uplink video stream relative.
       
    71         */
       
    72         static void GetFirstWindowStreamLayout(
       
    73             TAknWindowLineLayout& aLayout );
       
    74 
       
    75         /**
       
    76         * Returns layout of uplink video disabled icon.
       
    77         * @param aLayout layout of qgn_indi_call_video_blind_out.
       
    78         */
       
    79         static void GetFirstWindowStreamDisabledIconLayout(
       
    80             TAknWindowLineLayout& aLayout );
       
    81 
       
    82         // ELEMENTS RELATIVE TO MAIN PANE:
       
    83 
       
    84         /**
       
    85         * Returns layout of background rectangle.
       
    86         * @param aLayout layout of background rectangle.
       
    87         */
       
    88         static void GetSecondWindowBackgroundLayout(
       
    89             TAknWindowLineLayout& aLayout );
       
    90 
       
    91         /**
       
    92         * Returns layout of downlink video stream.
       
    93         * @param aLayout layout of downlink video stream.
       
    94         * @param aUseSQCif ETrue if SQCIF layout is to be used.
       
    95         */
       
    96         static void GetSecondWindowStreamLayout(
       
    97             TAknWindowLineLayout& aLayout,
       
    98             TBool aIsToolbar,
       
    99             TBool aIsSubQCIF = EFalse );
       
   100 
       
   101         /**
       
   102         * Returns layout of downlink video stream (the whole picture).
       
   103         * @param aLayout layout of downlink video stream.
       
   104         * @param aUseSQCif ETrue if SQCIF layout is to be used.
       
   105         */
       
   106         static void GetSecondWindowStreamWholeLayout(
       
   107             TAknWindowLineLayout& aLayout,
       
   108             TBool aIsToolbaraIsToolbar,
       
   109             TBool aIsSubQCIF = EFalse );
       
   110 
       
   111         /**
       
   112         * Returns layout of downlink video disabled icon.
       
   113         * @param aLayout layout of qgn_indi_call_video_blind_in.
       
   114         */
       
   115         static void GetSecondWindowDisabledIconLayout(
       
   116             TAknWindowLineLayout& aLayout );
       
   117 
       
   118         /**
       
   119         * Returns layout of waiting text.
       
   120         * @param aLayout layout.
       
   121         * @param aFirstLine ETrue if first line, EFalse if second.
       
   122         */
       
   123         static void GetSecondWindowWaitingTextLayout(
       
   124             TAknTextLineLayout& aLayout,
       
   125             const TBool aFirstLine );
       
   126 
       
   127         /**
       
   128         * Returns number entry area layout.
       
   129         * @param aLayout layout.
       
   130         */
       
   131         static void GetNumberEntryAreaLayout(
       
   132             TAknWindowLineLayout& aLayout );
       
   133 
       
   134         // ELEMENTS RELATIVE TO NAVI PANE:
       
   135 
       
   136         /**
       
   137         * Returns layout of audio routing indicator.
       
   138         * @param aLayoutlayout of qgn_indi_<ref>_[muted].
       
   139         */
       
   140         static void GetAudioRoutingIconLayout(
       
   141             TAknWindowLineLayout& aLayout );
       
   142 
       
   143         /**
       
   144         * Returns layout of call duration text.
       
   145         * @param aLayout layout of call duration text.
       
   146         */
       
   147         static void GetCallDurationTextLayout(
       
   148             TAknTextLineLayout& aLayout );
       
   149 
       
   150         /**
       
   151         * Returns layout of muted text.
       
   152         * @param aLayout layout of muted text.
       
   153         */
       
   154         static void GetMutedTextLayout(
       
   155             TAknTextLineLayout& aLayout );
       
   156 
       
   157         /**
       
   158         * Gets zooming pane layout.
       
   159         * @param aLayout layout of zooming pane.
       
   160         */
       
   161         static void GetZoomPaneLayout(
       
   162             TAknWindowLineLayout& aLayout );
       
   163 
       
   164         // ELEMENTS RELATIVE TO ZOOMING PANE:
       
   165 
       
   166         /**
       
   167         * Gets zoom direction icon layout.
       
   168         * @param aLayout layout of zoom direction icon.
       
   169         */
       
   170         static void GetZoomDirLayout(
       
   171             TAknWindowLineLayout& aLayout );
       
   172 
       
   173         /**
       
   174         * Gets zoom area layout.
       
   175         * @param aLayout layout of zoom area.
       
   176         */
       
   177         static void GetZoomAreaLayout(
       
   178             TAknWindowLineLayout& aLayout );
       
   179 
       
   180         /**
       
   181         * Gets zoom step layout.
       
   182         * @param aLayout layout of a zoom step.
       
   183         * @param aZoomStep zoom step, 1 .. 11.
       
   184         */
       
   185         static void GetZoomStepLayout(
       
   186             TAknWindowLineLayout& aLayout,
       
   187             TInt aZoomStep );
       
   188 
       
   189         // OTHER UTILITY METHODS
       
   190 
       
   191         /**
       
   192         * Returns skin identifier corresponding to the bitmap.
       
   193         *
       
   194         * @param aId identifier of the bitmap.
       
   195         * @return skin identifier or KAknsIIDNone if no skin for this bitmap.
       
   196         */
       
   197         static TAknsItemID MapBitmapToSkinId( TVtUiBitmapId aId );
       
   198 
       
   199         /**
       
   200         * Determines color skin identifier corresponding to the bitmap.
       
   201         *
       
   202         * @param aId bitmap identifier.
       
   203         * @param aColorId it will contain color skin id.
       
   204         * @param aColorIndex it will contain color index.
       
   205         * @return ETrue if bitmap has color skin, EFalse otherwise.
       
   206         */
       
   207         static TBool MapBitmapToColorId(
       
   208             TVtUiBitmapId aId,
       
   209             TAknsItemID& aColorId,
       
   210             TInt& aColorIndex );
       
   211 
       
   212         /**
       
   213         * Resolves file name and index from bitmap identifier.
       
   214         * @param aId bitmap identifier.
       
   215         * @param aFileName it will contain the name of the file.
       
   216         * @param aIndex it will contain the index.
       
   217         */
       
   218         static void Resolve(
       
   219             TVtUiBitmapId aId,
       
   220             TFileName& aFileName,
       
   221             TInt& aIndex );
       
   222 
       
   223         /**
       
   224         * Can be used for checking current orientation.
       
   225         * @return ETrue if current application orientation is landscape,
       
   226         * EFalse otherwise.
       
   227         */
       
   228         static TBool IsLandscapeOrientation();
       
   229 
       
   230     };
       
   231 
       
   232 #endif      // VTUILAYOUT_H
       
   233 
       
   234 // End of File