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:  Shortcut plug-in extension data model

    15 *

    16 */

    17 

    18 

    19 #ifndef CAISCUTEXTDATAMODEL_H

    20 #define CAISCUTEXTDATAMODEL_H

    21 

    22 #include <e32base.h>

    23 #include <badesca.h>

    24 

    25 class CGulIcon;

    26 class CAiScutExtData;

    27 

    28 /**

    29  *  This class owns an array of CAiScutExtData items and provides an API to

    30  *  update popup line array and icon data for different targets.

    31  *  @since S60 v3.2

    32  */

    33 class CAiScutExtDataModel : public CBase

    34     {

    35     private:

    36         friend class T_CAiScutExtDataModel;

    37 

    38     public:

    39         /**

    40          * Factory function

    41          * @since S60 v3.2

    42          */

    43         static CAiScutExtDataModel* NewL();

    44 

    45 

    46         /**

    47          * Factory function

    48          * @since S60 v3.2

    49          */

    50         static CAiScutExtDataModel* NewLC();

    51 

    52         /**

    53          * Destructor

    54          * @since S60 v3.2

    55          */

    56         ~CAiScutExtDataModel();

    57         

    58     private:

    59         /**

    60          * Constructor

    61          * @see CAiScutEngine

    62          * @since S60 v3.2

    63          */

    64         CAiScutExtDataModel();

    65 

    66         void ConstructL();

    67 

    68     public:  // New functions    

    69         /**

    70          * Sets the new popup line array for target. The old one is deleted. If

    71          * matching target definition is not found new CAiScutExtData object is

    72          * created.

    73          * @param aDefinition Target definition string

    74          * @param aLineArray Pointer to line array. Ownership is transferred

    75          * @return Pointer to new or existing CAiScutExtData object

    76          * @since S60 v3.2

    77          */

    78         CAiScutExtData* SetPopupLineArrayL( const TDesC& aDefinition, CDesCArray* aLineArray );

    79 

    80         /**

    81          * Resets popup line array. If also the icon is not set the CAiScutExtData

    82          * item is deleted and removed from the array.

    83          * @param aDefinition Target definition string

    84          * @since S60 v3.2

    85          */

    86         CAiScutExtData* ResetPopupLineArray( const TDesC& aDefinition );

    87 

    88         /**

    89          * Sets the new icon for target. The old one is deleted. If

    90          * matching target definition is not found new CAiScutExtData object is

    91          * created.

    92          * @param aDefinition Target definition string

    93          * @param aIcon Pointer to icon. Ownership is transferred

    94          * @return Pointer to new or existing CAiScutExtData object

    95          * @since S60 v3.2

    96          */

    97         CAiScutExtData* SetIconL( const TDesC& aDefinition, CGulIcon* aIcon );

    98 

    99         /**

   100          * Resets icon. If also the popup line array is not set the CAiScutExtData

   101          * item is deleted and removed from the array.

   102          * @param aDefinition Target definition string

   103          * @since S60 v3.2

   104          */

   105         CAiScutExtData* ResetIcon( const TDesC& aDefinition );

   106 

   107         /**

   108          * @return Array of CAiScutExtData objects

   109          * @since S60 v3.2

   110          */

   111         TArray<CAiScutExtData*> AiScutExtDataArray() const;

   112 

   113         /**

   114          * Deletes CAiScutExtData object and removes it from the array.

   115          * @param aDefinition Target definition string

   116          * @since S60 v3.2

   117          */

   118         void RemoveAiScutExtData( const TDesC& aDefinition );

   119         

   120     private: // New functions

   121         TInt FindAiScutExtData( const TDesC& aDefinition ) const;

   122         CAiScutExtData* CreateAiScutExtDataL( const TDesC& aDefinition );

   123         

   124     private: // data

   125         /**

   126          * Shortcut extension data items

   127          * Own.

   128          */

   129          RPointerArray<CAiScutExtData> iAiScutExtDataArray;

   130     };

   131 

   132 #endif // CAISCUTEXTDATAMODEL_H

   133 

   134 // End of File.