customization/UISettingsSrv/inc/UISettingsSrvClient.h
changeset 0 3ce708148e4d
equal deleted inserted replaced
-1:000000000000 0:3ce708148e4d
       
     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: Implementation of customization components
       
    15 *
       
    16 */
       
    17 
       
    18 #if !defined(__UISettingsSrvClient_H__)
       
    19 #define __UISettingsSrvClient_H__
       
    20 
       
    21 #if !defined(__E32BASE_H__)
       
    22 #include <e32base.h>
       
    23 #endif
       
    24 
       
    25 // #include "ScShortcutUids.h"
       
    26 
       
    27 //**********************************
       
    28 //RUISettingsSrv
       
    29 //**********************************
       
    30 // The client class. An RSessionBase sends messages to the server with the function 
       
    31 // RSessionBase::SendReceive(); specifying an opcode (TCountServRqst) and and array of argument pointers. 
       
    32 // Functions in derived classes, such as RUISettingsSrv::Increase(), are wrappers for different calls to 
       
    33 // SendReceive().
       
    34 // Most of the functions here return void because if they fail the server will panic the client.
       
    35 // If they return it can be assumed that there is no error.
       
    36 
       
    37 class RUISettingsSrv : public RSessionBase
       
    38 	{
       
    39 
       
    40 public:
       
    41 
       
    42 	IMPORT_C RUISettingsSrv();
       
    43 
       
    44 	IMPORT_C TInt Connect();
       
    45 	IMPORT_C TVersion Version() const;
       
    46 
       
    47 	IMPORT_C TInt SetStartupImage( const TDesC& aImagePath );
       
    48 	IMPORT_C TInt GetStartupImagePath( TDes& aImagePath );
       
    49 
       
    50 	IMPORT_C TInt   SetStartupText( const TDesC& aText );
       
    51 	IMPORT_C HBufC* GetStartupTextL( );
       
    52 
       
    53 	IMPORT_C TInt SetStartupNoteType( TInt aType );
       
    54 	IMPORT_C TInt GetStartupNoteType( TInt &aType );
       
    55 
       
    56 /*	IMPORT_C TInt UpdateShortcutTargetList();
       
    57 	IMPORT_C TInt GetShortcutTargetCount( TInt aRtMask, TInt &aCount );
       
    58 	IMPORT_C TInt GetShortcutTargetType( TInt aRtMask, TInt aIndex, TInt& aType );
       
    59     IMPORT_C TInt GetShortcutTargetCaption( TInt aRtMask, TInt aIndex, TDes& aCaption );
       
    60 	IMPORT_C TInt GetShortcutTargetAppUid( TInt aRtMask, TInt aIndex, TInt& aUid );
       
    61 	IMPORT_C TInt GetShortcutTargetIndex( TInt aRtMask, TScActionType aActionType, TInt& aUid );
       
    62 	IMPORT_C TInt GetShortcutTargetIndex( TInt aRtMask, TInt aIndex, TInt& aUid );
       
    63 	IMPORT_C TInt SetShortcutTargetAppIndex( TInt aActionType, TInt aRtType, TInt aIndex );
       
    64 
       
    65 	IMPORT_C TInt GetShortcutRtType( TInt aUid, TInt &aRtType );
       
    66 	IMPORT_C TInt SetShortcutTargetCaption( TInt aRtMask, TInt aIndex, const TDesC& aCaption);
       
    67 
       
    68 	IMPORT_C TInt SetShortcutTargetBitmap   ( TInt aRtMask, TInt aIndex,
       
    69 	                                          const TDesC& aFileName,
       
    70 	                                          const TDesC8& aMimeType );
       
    71 
       
    72 	IMPORT_C TInt SetShortcutTargetMask     ( TInt aRtMask, TInt aIndex,
       
    73 	                                          const TDesC& aFileName,
       
    74 	                                          const TDesC8& aMimeType );
       
    75 
       
    76 	IMPORT_C TInt GetShortcutTargetBitmap   ( TInt aRtMask, TInt aIndex,
       
    77 	                                          TDes& aFileName, TDes8& aMimeType );
       
    78 
       
    79 	IMPORT_C TInt GetShortcutTargetMask     ( TInt aRtMask, TInt aIndex,
       
    80 	                                          TDes& aFileName, TDes8& aMimeType );
       
    81 
       
    82 */
       
    83 	IMPORT_C TInt GetSoftkeyBitmap          ( TInt aSoftkeyId,
       
    84 	                                          TDes& aFileName, TDes8& aMimeType );
       
    85 
       
    86 	IMPORT_C TInt GetSoftkeyMask            ( TInt aSoftkeyId,
       
    87 	                                          TDes& aFileName, TDes8& aMimeType );
       
    88 
       
    89 	IMPORT_C TInt SetSoftkeyBitmap          ( TInt aSoftkeyId,
       
    90 	                                          const TDesC& aFileName,
       
    91 	                                          const TDesC8& aMimeType );
       
    92 
       
    93 	IMPORT_C TInt SetSoftkeyMask            ( TInt aSoftkeyId,
       
    94 	                                          const TDesC& aFileName,
       
    95 	                                          const TDesC8& aMimeType );
       
    96 
       
    97 private:
       
    98 		/**
       
    99 		* Starts UISettingsSrv.
       
   100 		* @param aServerExeName. The name of server.
       
   101 		* @return TInt. KErrNone or one of the system wide error codes.
       
   102 		*/
       
   103 		TInt LaunchServer( const TDesC& aServerName );
       
   104 
       
   105 	};
       
   106 
       
   107 
       
   108 #endif
       
   109