1 /*

     2 * Copyright (c) 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:  Main application class definitions.

    15 *

    16 */

    17 

    18 /*! \mainpage

    19 *

    20 * @section intro Introduction

    21 *

    22 * @subsection abstract Abstract

    23 *

    24 * Application provides FM radio functionality for

    25 * finding, saving and playing radio stations. 

    26 * 

    27 * @subsection architecture Basic architecture

    28 *

    29 * FMRadio constructs from the following program modules:

    30 * application UI, application engine, plugin extensions and interfaces to external components.

    31 ** 

    32 * @subsection containedcomponents Contained Components/Executables

    33 *

    34 * - fmradio.exe / UI application

    35 * - fmradioengine.dll / Application engine

    36 * - fmradioactiveidleengine200.dll / Active idle engine. Notify observers about P&S changes

    37 * - fmradioactionhandler.dll / Action handler plugin. Handles P&S commands

    38 * - fmradiomcpplugin100.dll / Content publisher plugin. Publishes radio data to other components

    39 *

    40 * @subsection providedapis Provided APIs

    41 *

    42 * - FM Radio command line parameters.

    43 * - Publish & Subscribe interface.

    44 * 

    45 * @section usecases Use cases

    46 *

    47 * \image html fmradio_use_case.png "Use cases"

    48 *

    49 

    50 *

    51 */

    52 

    53 #ifndef FMRADIOAPP_H

    54 #define FMRADIOAPP_H

    55 

    56 // INCLUDES

    57 #include <aknapp.h>

    58 

    59 // CONSTANTS

    60 

    61 // CLASS DECLARATION

    62 

    63 /**

    64 * CFMRadioApp application class.

    65 * This class is a part of the standard application framework. The application 

    66 * gets instantiated by this class. Provides a factory method for 

    67 * instantiating the document object.

    68 *

    69 * @since 2.6

    70 */

    71 class CFMRadioApp : public CAknApplication

    72     {

    73     

    74     private:

    75         /**

    76         * From CApaApplication, creates CFMRadioDocument document object.

    77         * @return A pointer to the created document object.

    78         */

    79         CApaDocument* CreateDocumentL();

    80         /**

    81         * From CApaApplication, returns application's UID (KUidFMRadio).

    82         * @return The value of KUidFMRadio.

    83         */

    84         TUid AppDllUid() const;

    85     };

    86 

    87 #endif

    88 

    89 // End of File

    90