1 /*

     2 * Copyright (c) 2009-2010 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 the License "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 * appreginfo.h

    16 *

    17 */

    18 

    19 /**

    20  @file

    21  @publishedAll

    22  @prototype 

    23 */

    24 

    25 #ifndef __APPREGINFO_H__

    26 #define __APPREGINFO_H__

    27 

    28 #include <e32base.h>

    29 	

    30 class RReadStream;

    31 class RWriteStream;

    32 

    33 namespace Usif

    34     {

    35 // Defines a modifiable buffer descriptor to contain the caption or the short caption for an application.

    36 const TInt KMaxAppCaption=0x100;

    37 typedef TBuf<KMaxAppCaption> TAppCaption;

    38 

    39 /** Basic application information. An object of this type contains four pieces of information:

    40  - The application specific Uid

    41  - The full path name of the application exe

    42  - The application's caption

    43  - A short caption

    44 */

    45 NONSHARABLE_CLASS (TAppRegInfo)

    46 	{

    47     friend class CScrRequestImpl;

    48 public:

    49 

    50     IMPORT_C TAppRegInfo();

    51     

    52     /** 

    53     Constructs an application information object from the specified full application path 

    54     name, UID and caption.

    55 

    56     @param aAppUid The application specific UID. 

    57     @param aAppName The full path name of the application. 

    58     @param aCaption The application caption. 

    59     */

    60     IMPORT_C TAppRegInfo(TUid aAppUid, const TFileName& aAppName, const TAppCaption& aCaption);

    61 

    62     /** 

    63     Constructs an application information object from the specified full application path 

    64     name, UID, short caption and caption.

    65 

    66     @param aAppUid The application specific UID. 

    67     @param aAppName The full path name of the application. 

    68     @param aCaption The application caption. 

    69     @param aShortCaption The application short caption.

    70     */    

    71     IMPORT_C TAppRegInfo(TUid aAppUid, const TFileName& aAppName, const TAppCaption& aCaption, const TAppCaption& aShortCaption);

    72     

    73     IMPORT_C void ExternalizeL(RWriteStream& aStream)const;

    74     

    75     IMPORT_C void InternalizeL(RReadStream& aStream);

    76     

    77     /**    

    78      @return The application specific UID.

    79      */

    80     IMPORT_C TUid Uid() const;

    81     

    82     /**   

    83      @return The full path name of the application executable.

    84      */    

    85     IMPORT_C TFileName FullName() const;

    86     

    87     /**   

    88      @return The caption for the application.

    89      */       

    90     IMPORT_C TAppCaption Caption() const;

    91     

    92     /**   

    93      @return The short caption for the application.

    94      */       

    95     IMPORT_C TAppCaption ShortCaption() const;

    96     

    97 private:

    98 	/** The application specific UID. */

    99 	TUid iUid;

   100 	/** The full path name of the application. */

   101 	TFileName iFullName;

   102 	/** The caption for the application. */

   103 	TAppCaption iCaption;

   104 	/** The short caption for the application. */

   105 	TAppCaption iShortCaption;

   106 	};

   107 }

   108 #endif

   109