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:  

    15 *

    16 */

    17 

    18 

    19 #ifndef M_AIPLUGINTOOL_H

    20 #define M_AIPLUGINTOOL_H

    21 

    22 #include <e32base.h>

    23 #include <aipropertyextension.h>

    24 

    25 class TAiPublisherInfo;

    26 class CAiContentPublisher;

    27 class MAiContentItemIterator;

    28 class MAiPropertyExtension;

    29 class MAiEventHandlerExtension;

    30 

    31 /**

    32 *  Plugin tool.

    33 *

    34 *  @since S60 3.2

    35 */

    36 class MAiPluginTool 

    37 	{

    38 	

    39 public:

    40 

    41     /**

    42      * Get the publisher info of the passed publisher.

    43      *

    44      * @since S60 3.2

    45      * @param reference to content publisher

    46      * @return pointer to publisher info 

    47      */

    48     virtual const TAiPublisherInfo* PublisherInfoL(

    49                                 CAiContentPublisher& aContentPublisher ) = 0;

    50 

    51     /**

    52      * Get the content item iterator for the passed publisher.

    53      *

    54      * @param reference to content publisher

    55      * @param content type indication

    56      * @return pointer to content iterator 

    57      */

    58     virtual MAiContentItemIterator* ContentItemIteratorL(

    59                                 CAiContentPublisher& aContentPublisher,

    60                                 TInt aContentType = EAiPublisherContent ) = 0;

    61 

    62 

    63     /**

    64      * Get the property extension for passed publisher.

    65      *

    66      * @param reference to content publisher

    67      * @return property extension pointer

    68      */

    69     virtual MAiPropertyExtension* PropertyExt(

    70                                 CAiContentPublisher& aContentPublisher ) = 0;

    71 

    72     /**

    73      * Get the event handler extension for passed publisher.

    74      *

    75      * @param reference to content publisher

    76      * @return event handler extension pointer

    77      */                                

    78     virtual MAiEventHandlerExtension* EventHandlerExt(

    79                                 CAiContentPublisher& aContentPublisher ) = 0;

    80 

    81     /**

    82      * Release the tool.

    83      */

    84     virtual void Release() = 0;

    85 	    

    86 protected:

    87 	    

    88 	MAiPluginTool() { }

    89     

    90     };

    91 

    92 inline void Release( MAiPluginTool* aSelf )

    93     {

    94     if ( aSelf )

    95         {

    96         aSelf->Release();

    97         }

    98     }

    99 

   100 #endif // M_AIPLUGINTOOL_H

   101 

   102 

   103 

   104 

   105