mpxplugins/viewplugins/views/inc/mpxplaybackviewlayoutinterface.h
changeset 0 ff3acec5bc43
equal deleted inserted replaced
-1:000000000000 0:ff3acec5bc43
       
     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:  An interface providing skin and layout data for common playback view.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef MMPXCOMMONPLAYBACKVIEWLAYOUT_H
       
    20 #define MMPXCOMMONPLAYBACKVIEWLAYOUT_H
       
    21 
       
    22 //  INCLUDES
       
    23 #include <e32base.h>
       
    24 #include <AknUtils.h>
       
    25 #include "mpxcommonplaybackviewdefs.h"
       
    26 
       
    27 // CLASS DECLARATION
       
    28 
       
    29 /**
       
    30 *  An interface providing skin and layout data for playback view.
       
    31 *
       
    32 *  @lib mpxplaybackview.dll
       
    33 *  @since S60 v3.0
       
    34 */
       
    35 NONSHARABLE_CLASS( MMPXPlaybackViewLayout )
       
    36     {
       
    37 public:
       
    38 
       
    39     /**
       
    40      * Get layout data for a button.
       
    41      *
       
    42      * @since 3.0
       
    43      * @param aParentRect Parent control's rect
       
    44      * @param aButton Enumeration value identifying the button
       
    45      * @return Layout data
       
    46      */
       
    47     virtual TRect ButtonLayout(
       
    48         const TRect& aParentRect )=0;
       
    49 
       
    50     /**
       
    51      * Get layout data for an graphical indicator.
       
    52      *
       
    53      * @since 3.0
       
    54      * @param aParentRect Parent control's rect
       
    55      * @param  aIndicator Enumeration value identifying the indicator
       
    56      * @return Layout data
       
    57      */
       
    58     virtual TRect IndicatorLayout(
       
    59         const TRect& aParentRect,
       
    60         TMPXPbvIndicator aIndicator )=0;
       
    61 
       
    62     /**
       
    63      * Set layout data for a text label.
       
    64      *
       
    65      * @since 3.0
       
    66      * @param aLabel      Label to set the layout to
       
    67      * @param aParentRect Parent rectangle for layout
       
    68      * @param aIndicator  Enumeration value identifying the indicator,
       
    69      * @param aOffsetx    Offset in x direction to apply to label
       
    70      * @param aOffsety    Offset in y direction to apply to label
       
    71      */
       
    72     virtual void LayoutLabel(
       
    73         CEikLabel* aLabel, 
       
    74         const TRect& aParentRect, 
       
    75         TMPXPbvTextIndicator aText,
       
    76         TInt aOffsetx=0,
       
    77         TInt aOffsety=0 )=0;
       
    78 
       
    79     /**
       
    80      * Get the bitmap and mask for a soft button in a given state.
       
    81      *
       
    82      * @since 3.0
       
    83      * @param  aButton      Enumeration value identifying the button.
       
    84      * @param  aButtonState State of the button
       
    85      * @param  aBitmap      Reference to a CFbsBitmap pointer to receive
       
    86      *                      the requested bitmap pointer. Ownership is
       
    87      *                      transferred to the caller.
       
    88      * @param  aMask        Reference to a CFbsBitmap pointer to receive
       
    89      *                      the mask of the requested bitmap. Ownership is
       
    90      *                      transferred to the caller.
       
    91      */
       
    92     virtual void GetButtonBitmapsL(
       
    93         TMPXPbvButton aButton,
       
    94         TInt aButtonState,
       
    95         CFbsBitmap*& aBitmap,
       
    96         CFbsBitmap*& aMask )=0;
       
    97 
       
    98     /**
       
    99      * Get the bitmap and mask for a given indicator.
       
   100      *
       
   101      * @since 3.0
       
   102      * @param  aIndicator   Enumeration value identifying the indicator
       
   103      * @return CGulIcon     Indicator graphic and mask. Ownership 
       
   104      *                      transferred to caller.
       
   105      */
       
   106     virtual CGulIcon* GetIndicatorIconMaskL(
       
   107         TMPXPbvIndicator aIndicator )=0;
       
   108         
       
   109     virtual TRect ButtonLayout(const TRect& aParentRect,
       
   110                                   TInt aButton)=0;
       
   111 
       
   112     };
       
   113 
       
   114 #endif  // C_CMPXCOMMONPLAYBACKVIEWLAYOUT_H
       
   115 
       
   116 // End of file