javauis/mmapi_qt/baseline/inc/mmmaguiplayer.h
branchRCL_3
changeset 24 0fd27995241b
equal deleted inserted replaced
20:f9bb0fca356a 24:0fd27995241b
       
     1 /*
       
     2 * Copyright (c) 2002 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:  Interface for players which shows picture.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef MMMAGUIPLAYER_H
       
    20 #define MMMAGUIPLAYER_H
       
    21 
       
    22 #include "cmmaplayerevent.h"
       
    23 
       
    24 //  FORWARD DECLARATIONS
       
    25 class MMMADisplay;
       
    26 class CFbsBitmap;
       
    27 class MMMASnapshot;
       
    28 class MMAFunctionServer;
       
    29 class CMIDToolkit;
       
    30 
       
    31 //  CLASS DEFINITION
       
    32 /**
       
    33     Interface for players which shows picture. Player will be notified
       
    34     throw this interface when display state is changed.
       
    35 */
       
    36 NONSHARABLE_CLASS(MMMAGuiPlayer)
       
    37 {
       
    38 protected:  // Constructors and destructors
       
    39     /**
       
    40      * Do not allow delete through this interface
       
    41      */
       
    42     virtual ~MMMAGuiPlayer() {};
       
    43 
       
    44 public:     // Abstract methods
       
    45     /**
       
    46      * Sets display to the player. Player must likely will create window
       
    47      * for the display. Called when display is available for the player.
       
    48      *
       
    49      * @param aDisplay Display which can be used.
       
    50      */
       
    51     virtual void SetDisplayL(MMMADisplay* aDisplay) = 0;
       
    52 
       
    53     /**
       
    54      * Returns size of the content. Content size may not available
       
    55      * before player is initialized.
       
    56      *
       
    57      * @return Size of the source content.
       
    58      */
       
    59     virtual TSize SourceSize() = 0;
       
    60 
       
    61     /**
       
    62      * Returns inferface that is used for taking snapshots from the player.
       
    63      * Method can leave if player creates a snapshoter object when this
       
    64      * method is called.
       
    65      *
       
    66      * @return Interface for taking snaphots.
       
    67      */
       
    68     virtual MMMASnapshot* SnapshoterL() = 0;
       
    69 
       
    70     /**
       
    71      * Method sends event to the Java. This can be used to notify errors
       
    72      * to the Java side.
       
    73      *
       
    74      * @param aEventType Type of the event.
       
    75      * @param aStringEventData Data of the event.
       
    76      */
       
    77     virtual void NotifyWithStringEvent(CMMAPlayerEvent::TEventType aEventType,
       
    78                                        const TDesC& aStringEventData) = 0;
       
    79 
       
    80     // No data in MClass!!
       
    81 
       
    82 };
       
    83 
       
    84 #endif // MMMAGUIPLAYER_H