1 /*

     2 * Copyright (c) 2005-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:  AI Shortcut xSP Extension API

    15 *

    16 */

    17 

    18 

    19 #ifndef RAISCUTEXTSERV_H

    20 #define RAISCUTEXTSERV_H

    21 

    22 #include <e32std.h>

    23 #include <bamdesca.h>

    24 

    25 class CGulIcon;

    26 

    27 /**

    28  *  Active Idle Shortcut Plugin extension client side API.

    29  *  @since S60 v3.2

    30  */

    31 class RAiScutExtServ : public RSessionBase

    32 {

    33     public:

    34         /**

    35          * Connects a client to the AiScut extension server.

    36          * Target definition is generated automatically from process' uid 3.

    37          * @return KErrNone, if successful, otherwise one of the other

    38          * system-wide error codes.

    39          */

    40         IMPORT_C TInt Connect();

    41 

    42         /**

    43          * Connects a client to the AiScut extension server.

    44          * @param aTargetDefinition Target definition string.

    45          * @return KErrNone, if successful, otherwise one of the other

    46          * system-wide error codes.

    47          */

    48         IMPORT_C TInt Connect( const TDesC& aTargetDefinition );

    49 

    50         /**

    51          * @return The client side version number.

    52          */

    53         IMPORT_C TVersion Version() const;

    54 

    55         /**

    56          * Updates a pop-up text box.

    57          * @param aPopupTextLines Array of lines displayed in pop-up text box.

    58          * @return KErrNone, if successful, otherwise one of the other system-wide error codes.

    59          */

    60         IMPORT_C TInt UpdatePopupTextL( const MDesCArray& aPopupTextLines );

    61 

    62         /**

    63          * Resets a pop-up text box.

    64          * @return KErrNone, if successful, otherwise one of the other system-wide error codes.

    65          */

    66         IMPORT_C TInt ResetPopupText();

    67 

    68         /**

    69          * Updates a shortcut icon.

    70          * @param aIcon Icon to be shown in shortcut.

    71          * @return KErrNone, if successful, otherwise one of the other system-wide error codes.

    72          */

    73         IMPORT_C TInt UpdateIconL( const CGulIcon& aIcon );

    74 

    75         /**

    76          * Resets a shortcut icon. Default icon will be shown.

    77          * @return KErrNone, if successful, otherwise one of the other system-wide error codes.

    78          */

    79         IMPORT_C TInt ResetIcon();

    80 

    81         /**

    82          * @return ETrue if the shortcut is in shortcuts bar.

    83          * @return KErrNone, if successful, otherwise one of the other system-wide error codes.

    84          */

    85         IMPORT_C TInt IsInShortcuts( TBool& aIsInShortcuts ) const;

    86 

    87         /**

    88          * Launches AiScutPlugin General Settings view.

    89          * @return KErrNone, if successful, otherwise one of the other system-wide error codes.

    90          */

    91         IMPORT_C TInt IssuePutInShortcuts();

    92 };

    93 

    94 #endif // RAISCUTEXTSERV_H

    95 

    96 // End of File.