1 /*

     2 * Copyright (c) 2005-2009 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:  The declaration for Settings UI Info class of Location

    15 *                Settings UI Server

    16 *

    17 */

    18 

    19 

    20 #ifndef C_LOCSETTINGSUIINFO_H

    21 #define C_LOCSETTINGSUIINFO_H

    22 

    23 #include <e32cmn.h>

    24 #include <e32std.h>

    25 

    26 //Forward declarations

    27 class CSession2;

    28 

    29 /**

    30  *  The Info class which contains all information pertaining to

    31  *  the settings UI launch request.

    32  *

    33  *  @lib

    34  *  @since S60 v3.1

    35  */

    36 NONSHARABLE_CLASS(CLocSettingsUIInfo) : public CBase

    37     {

    38 public:

    39     /**

    40      * Symbian 2 Phase Constructor

    41      *

    42      * @since S60 v3.1

    43      * @param The request IPC Message sent by the client.

    44      * @param The Launch parameters with which the UI should be launched

    45      * @return A pointer to the created CLocSettingsUIInfo object

    46      */

    47     static CLocSettingsUIInfo* NewL( const RMessage2&   aMessage );

    48 

    49     /**

    50      * Symbian 2 Phase Constructor

    51      *

    52      * @since S60 v3.1

    53      * @param The request IPC Message sent by the client.

    54      * @param The Launch parameters with which the UI should be launched

    55      * @return A pointer to the created CLocSettingsUIInfo object

    56      */

    57     static CLocSettingsUIInfo* NewLC( const RMessage2&  aMessage );

    58 

    59     /**

    60      * Destructor

    61      */

    62     virtual ~CLocSettingsUIInfo();

    63 

    64 public:

    65     /**

    66      * Complete the Launch request with the Error Code

    67      *

    68      * @since S60 v3.1

    69      * @param aErrorCode The error code returned from the completion of the

    70      * launch request.

    71      * @return Pointer to the session object.

    72      */

    73     void Complete(TInt aErrorCode);

    74      

    75 public: //Accessor methods

    76 

    77     /**

    78      * Retrieve the IPC message

    79      * @return RMessage2&    The IPC message contained in the Info structure

    80      *

    81      */

    82     RMessage2&   IPCMessage();

    83     

    84     /**

    85      * Retrieve the offset of the TSglQueLink member.

    86      * This offset value is needed by the TSglQue to maintain and

    87      * manipulate the Linked List.

    88      *

    89      * @since S60 v3.1

    90      * @return Offset value of iNext member in this class.

    91      */

    92     static TInt QueLinkOffset();

    93     

    94     /**

    95      * Retrieve the session object through which this Request was sent.

    96      *

    97      * @since S60 v3.1

    98      * @return Pointer to the session object.

    99      */

   100     CSession2* Session() const;

   101 

   102     /**

   103      * Retrieve the Settings UI UID for which launch 

   104      * is requested.

   105      *

   106      * @since S60 v3.1

   107      * @return The UID value for the requested Settings UI.

   108      */

   109     TUid SettingsUID() const;

   110 

   111     /**

   112      * Retrieve the Settings UI Launch Parameters.

   113      *

   114      * @since S60 v9.2

   115      * @return The Int Launch parameters for the Settings UI

   116      */

   117     TInt SettingsUIIntParams();

   118 

   119     /**

   120      * Retrieve the Settings UI Launch String Parameters.

   121      *

   122      * @since S60 v9.2

   123      * @return The String Launch parameters for the Settings UI

   124      */

   125     TPtrC SettingsUIStringParamsL();

   126 

   127 private:

   128     /**

   129      * Constructor

   130      */

   131     CLocSettingsUIInfo(const RMessage2 &aMessage );

   132 

   133     /**

   134      * Symbian 2nd Phase Constructor

   135      * Leaves in case of Error.

   136      *

   137      * @since S60 v3.1

   138      * @return None

   139      */

   140     void ConstructL();

   141 

   142 private: // data

   143 

   144     /**

   145      * The data member contains the RMessage2 IPC message that was received

   146      * from the Client

   147      */

   148     RMessage2   iReqMsg;  

   149 

   150     /**

   151      * The Settings UI launch string parameters.

   152      */

   153     HBufC* iParamsString;

   154 

   155     /**

   156      * The Single Queue Link Object.

   157      */

   158     TSglQueLink iNext;

   159     };

   160 

   161 #endif // C_LOCSETTINGSUIINFO_H