videoplayerapp/lwplayer/inc/lwplayerappui.h
author hgs
Thu, 04 Nov 2010 11:16:56 +0200
changeset 71 60b4b6493d7b
permissions -rw-r--r--
201044
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
71
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  Declares UI class for LWPlayer application.
hgs
parents:
diff changeset
    15
 *
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
// Version : %version: 5 %
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
#ifndef _LWPLAYERAPPUI_H_
hgs
parents:
diff changeset
    23
#define _LWPLAYERAPPUI_H_
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
#include <aknViewAppUi.h>
hgs
parents:
diff changeset
    26
#include <AknServerApp.h>
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
//
hgs
parents:
diff changeset
    29
//  FORWARD DECLARATIONS
hgs
parents:
diff changeset
    30
//
hgs
parents:
diff changeset
    31
class CDocumentHandler;
hgs
parents:
diff changeset
    32
class CAiwGenericParamList;
hgs
parents:
diff changeset
    33
hgs
parents:
diff changeset
    34
/*
hgs
parents:
diff changeset
    35
 * Application UI class.
hgs
parents:
diff changeset
    36
 * Provides support for the following features:
hgs
parents:
diff changeset
    37
 * - EIKON control architecture
hgs
parents:
diff changeset
    38
 */
hgs
parents:
diff changeset
    39
hgs
parents:
diff changeset
    40
class CLWPlayerAppUi : public CAknViewAppUi,
hgs
parents:
diff changeset
    41
                       public MAknServerAppExitObserver
hgs
parents:
diff changeset
    42
{
hgs
parents:
diff changeset
    43
    public:
hgs
parents:
diff changeset
    44
        /*
hgs
parents:
diff changeset
    45
         * EPOC default constructor.
hgs
parents:
diff changeset
    46
         */
hgs
parents:
diff changeset
    47
        void ConstructL();
hgs
parents:
diff changeset
    48
hgs
parents:
diff changeset
    49
        /*
hgs
parents:
diff changeset
    50
         * Destructor.
hgs
parents:
diff changeset
    51
         */
hgs
parents:
diff changeset
    52
        virtual ~CLWPlayerAppUi();
hgs
parents:
diff changeset
    53
hgs
parents:
diff changeset
    54
        // ----------------------------------------------------
hgs
parents:
diff changeset
    55
        //  New Methods added for Progressive Download
hgs
parents:
diff changeset
    56
        // ----------------------------------------------------
hgs
parents:
diff changeset
    57
hgs
parents:
diff changeset
    58
        /*
hgs
parents:
diff changeset
    59
         * Process Commandline Parameters
hgs
parents:
diff changeset
    60
         */
hgs
parents:
diff changeset
    61
        TBool ProcessCommandParametersL( CApaCommandLine& aCommandLine );
hgs
parents:
diff changeset
    62
hgs
parents:
diff changeset
    63
        /*
hgs
parents:
diff changeset
    64
         * Extract Generic Parameters
hgs
parents:
diff changeset
    65
         */
hgs
parents:
diff changeset
    66
        void ExtractGenericParamsL( const TDesC8& aParams );
hgs
parents:
diff changeset
    67
hgs
parents:
diff changeset
    68
        /*
hgs
parents:
diff changeset
    69
         * Handle DlMgr Message
hgs
parents:
diff changeset
    70
         */
hgs
parents:
diff changeset
    71
        MCoeMessageObserver::TMessageResponse HandleMessageL(
hgs
parents:
diff changeset
    72
                TUint32 aClientHandleOfTWG,
hgs
parents:
diff changeset
    73
                TUid aMessageUid,
hgs
parents:
diff changeset
    74
                const TDesC8& aMessageParameters);
hgs
parents:
diff changeset
    75
hgs
parents:
diff changeset
    76
        /*
hgs
parents:
diff changeset
    77
         * From MAknServerAppExitObserver.
hgs
parents:
diff changeset
    78
         */
hgs
parents:
diff changeset
    79
        void HandleServerAppExit(TInt aReason);
hgs
parents:
diff changeset
    80
hgs
parents:
diff changeset
    81
    private:
hgs
parents:
diff changeset
    82
        /*
hgs
parents:
diff changeset
    83
         * From CEikAppUi, takes care of command handling.
hgs
parents:
diff changeset
    84
         * @param aCommand command to be handled
hgs
parents:
diff changeset
    85
         */
hgs
parents:
diff changeset
    86
        void HandleCommandL( TInt aCommand );
hgs
parents:
diff changeset
    87
hgs
parents:
diff changeset
    88
        /*
hgs
parents:
diff changeset
    89
         * From CEikAppUi, takes care of error handling.
hgs
parents:
diff changeset
    90
         * @param aCommand command to be handled
hgs
parents:
diff changeset
    91
         */
hgs
parents:
diff changeset
    92
        void HandleErrorL( TInt aError );
hgs
parents:
diff changeset
    93
hgs
parents:
diff changeset
    94
        /*
hgs
parents:
diff changeset
    95
         *  LaunchMediaPlayerL
hgs
parents:
diff changeset
    96
         *
hgs
parents:
diff changeset
    97
         *  Uses the document handler framework to open a file
hgs
parents:
diff changeset
    98
         *  Used to create the embedded media player
hgs
parents:
diff changeset
    99
         *
hgs
parents:
diff changeset
   100
         *  @since S60 3.2
hgs
parents:
diff changeset
   101
         *  @param afilename   filename of clip to be opened
hgs
parents:
diff changeset
   102
         *  @param aparamList  list of parameters for progressive download
hgs
parents:
diff changeset
   103
         *  @return error code
hgs
parents:
diff changeset
   104
         */
hgs
parents:
diff changeset
   105
        TInt LaunchMediaPlayerL( const TDesC& afilename,
hgs
parents:
diff changeset
   106
                                 const CAiwGenericParamList* aparamList );
hgs
parents:
diff changeset
   107
hgs
parents:
diff changeset
   108
hgs
parents:
diff changeset
   109
        /*
hgs
parents:
diff changeset
   110
         *  SendMessageL
hgs
parents:
diff changeset
   111
         *
hgs
parents:
diff changeset
   112
         *  Finds the embedded media player and forwards the message
hgs
parents:
diff changeset
   113
         *  from the browser to the embedded Media Player
hgs
parents:
diff changeset
   114
         *
hgs
parents:
diff changeset
   115
         *  @since S60 3.2
hgs
parents:
diff changeset
   116
         *  @param aMessageParameters   list of parameters for prog. download
hgs
parents:
diff changeset
   117
         *  @return error code
hgs
parents:
diff changeset
   118
         */
hgs
parents:
diff changeset
   119
        TInt SendMessageL(const TDesC8& aMessageParameters);
hgs
parents:
diff changeset
   120
hgs
parents:
diff changeset
   121
        /*
hgs
parents:
diff changeset
   122
         *  DocumentHandlerL
hgs
parents:
diff changeset
   123
         *
hgs
parents:
diff changeset
   124
         *  Returns a reference to the Document Handler.
hgs
parents:
diff changeset
   125
         *  Sets this class as an exit observer
hgs
parents:
diff changeset
   126
         *
hgs
parents:
diff changeset
   127
         *  @since S60 3.2
hgs
parents:
diff changeset
   128
         *  @return reference to the document handler
hgs
parents:
diff changeset
   129
         */
hgs
parents:
diff changeset
   130
        CDocumentHandler& DocumentHandlerL();
hgs
parents:
diff changeset
   131
hgs
parents:
diff changeset
   132
        /*
hgs
parents:
diff changeset
   133
         *  ActivateClosePlayerActiveObject
hgs
parents:
diff changeset
   134
         *
hgs
parents:
diff changeset
   135
         *  Starts an active object to close the LWPlayer.
hgs
parents:
diff changeset
   136
         *
hgs
parents:
diff changeset
   137
         *  @since S60 9.2
hgs
parents:
diff changeset
   138
         */
hgs
parents:
diff changeset
   139
        void ActivateClosePlayerActiveObject();
hgs
parents:
diff changeset
   140
hgs
parents:
diff changeset
   141
        /*
hgs
parents:
diff changeset
   142
         *  Called to stop and exit the LWPlayer
hgs
parents:
diff changeset
   143
         *  @since 3.2
hgs
parents:
diff changeset
   144
         *  @return void
hgs
parents:
diff changeset
   145
         */
hgs
parents:
diff changeset
   146
        virtual void DoCloseLWPlayerL();
hgs
parents:
diff changeset
   147
hgs
parents:
diff changeset
   148
        /*
hgs
parents:
diff changeset
   149
         *  Provides the static function for the callback to close the LWPlayer
hgs
parents:
diff changeset
   150
         *  Called by CIdle iIdle
hgs
parents:
diff changeset
   151
         *  @since 3.2
hgs
parents:
diff changeset
   152
         *  @param aPtr Pointer to callback class
hgs
parents:
diff changeset
   153
         *  @return KErrNone
hgs
parents:
diff changeset
   154
         */
hgs
parents:
diff changeset
   155
        static TInt CloseLWPlayerL( TAny* aPtr );
hgs
parents:
diff changeset
   156
hgs
parents:
diff changeset
   157
        /*
hgs
parents:
diff changeset
   158
         *  Handles the Block Events Timer Timout
hgs
parents:
diff changeset
   159
         *  @since 9.2
hgs
parents:
diff changeset
   160
         *  @param aPtr Pointer to callback class
hgs
parents:
diff changeset
   161
         *  @return KErrNone
hgs
parents:
diff changeset
   162
         */
hgs
parents:
diff changeset
   163
        static TInt HandleBlockEventsTimeout( TAny* aPtr );
hgs
parents:
diff changeset
   164
hgs
parents:
diff changeset
   165
        /*
hgs
parents:
diff changeset
   166
         *  Called to unblock events
hgs
parents:
diff changeset
   167
         *  @since 9.2
hgs
parents:
diff changeset
   168
         *  @return void
hgs
parents:
diff changeset
   169
         */
hgs
parents:
diff changeset
   170
        void UnblockEvents();
hgs
parents:
diff changeset
   171
hgs
parents:
diff changeset
   172
        /*
hgs
parents:
diff changeset
   173
         *  Called to block events
hgs
parents:
diff changeset
   174
         *  @since 9.2
hgs
parents:
diff changeset
   175
         *  @return void
hgs
parents:
diff changeset
   176
         */
hgs
parents:
diff changeset
   177
        void BlockEvents();
hgs
parents:
diff changeset
   178
hgs
parents:
diff changeset
   179
        //
hgs
parents:
diff changeset
   180
        //  Member Variables
hgs
parents:
diff changeset
   181
        //
hgs
parents:
diff changeset
   182
        CDocumentHandler*      iDocHandler;
hgs
parents:
diff changeset
   183
        TBool                  iEmbeddedMPCreated;
hgs
parents:
diff changeset
   184
        TBool                  iAllowEvents;
hgs
parents:
diff changeset
   185
        CIdle*                 iCloseAO;
hgs
parents:
diff changeset
   186
        CPeriodic*             iBlockEventsTimer;
hgs
parents:
diff changeset
   187
};
hgs
parents:
diff changeset
   188
hgs
parents:
diff changeset
   189
#endif
hgs
parents:
diff changeset
   190
hgs
parents:
diff changeset
   191
// End of File