1 /*

     2 * Copyright (c) 2004, 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: 

    15 *

    16 */

    17 

    18 

    19 #ifndef __EIKONENVIRONMENT_H__

    20 #define __EIKONENVIRONMENT_H__

    21 

    22 // INCLUDES

    23 #include <e32base.h>

    24 

    25 // FORWARD DECLARATIONS

    26 class CEikAppUi;

    27 class CEikonEnv;

    28 class CEikDocument;

    29 class CCoeControl;

    30 class RFs;

    31 

    32 // CLASS DECLARATION

    33 /**

    34 * NEikonEnvironment

    35 * Useful functions based around the Eikon environment

    36 */

    37 namespace NEikonEnvironment

    38     {

    39         /**

    40         * EikAppUi()

    41         * the appui

    42         * @return a reference to the CEikAppUi

    43         */

    44         CEikAppUi& EikAppUi();

    45 

    46         /**

    47         * EikEnv()

    48         * the eikon environment

    49         * @return a reference to the CEikonEnv

    50         */

    51         CEikonEnv& EikEnv();

    52 

    53         /**

    54         * EikDocument()

    55         * the document

    56         * @return a reference to CEikDocument

    57         */

    58         CEikDocument& EikDocument();

    59 

    60         /**

    61         * AddToStackL()

    62         * add a control to the control stack

    63         * @param aControl the control to add

    64         */

    65         void AddToStackL( CCoeControl& aControl );

    66 

    67         /**

    68         * AddToStackL()

    69         * add a control to the control stack given a priority and flags

    70         * @param aControl the control to add

    71         * @param aPriority the priority

    72         * @param aStackingFlags the flags

    73         */

    74         void AddToStackL( CCoeControl& aControl,

    75                           TInt aPriority,

    76                           TInt aStackingFlags );

    77 

    78         /**

    79         * RemoveFromStack()

    80         * remove a control from the control stack

    81         * @param aControl the control to remove

    82         */

    83         void RemoveFromStack( CCoeControl& aControl );

    84 

    85         /**

    86         * AppFullName()

    87         * the full name of the application

    88         * @return the name

    89         */

    90         TFileName AppFullName();

    91 

    92         /**

    93         * ApplicationDriveAndPath()

    94         * the drive and path of the application

    95         * @return the drive and path

    96         */

    97         TFileName ApplicationDriveAndPath();

    98 

    99         /**

   100         * AddPath()

   101         * convert a filename to a filename with the drive and

   102         * path of the application added

   103         * @return the drive, path and filename

   104         * @param aFileName the file name to convert

   105         */

   106         TFileName AddPath( const TDesC& aFileName );

   107 

   108         /**

   109         * MessageBox()

   110         * Display a message box

   111         * @param the message to display

   112         */

   113         void MessageBox( const TDesC&  aMessage );

   114 

   115         /**

   116         * FlushWindowServer()

   117         * flush the windows server to ensure all changes to the

   118         * display are reflected on the screen

   119         */

   120         void FlushWindowServer();

   121 

   122         /**

   123         * TheRFs()

   124         * the eikon frameworks file server connection

   125         * @return a reference to the RFs

   126         */

   127         RFs& TheRFs();

   128 

   129     }

   130 

   131 

   132 #endif //__EIKONENVIRONMENT_H__

   133 

   134 // End of File