homescreensrv_plat/ai_utilities_api/inc/aiplugintool.h
branchRCL_3
changeset 9 d0529222e3f0
parent 0 79c6a41cd166
equal deleted inserted replaced
4:1a2a00e78665 9:d0529222e3f0
    17 
    17 
    18 
    18 
    19 #ifndef M_AIPLUGINTOOL_H
    19 #ifndef M_AIPLUGINTOOL_H
    20 #define M_AIPLUGINTOOL_H
    20 #define M_AIPLUGINTOOL_H
    21 
    21 
       
    22 // System includes
    22 #include <e32base.h>
    23 #include <e32base.h>
    23 #include <aipropertyextension.h>
       
    24 
    24 
    25 class TAiPublisherInfo;
    25 // User incldues
    26 class CAiContentPublisher;
    26 #include <hscontentpublisher.h>
       
    27 
       
    28 // Forward declarations
       
    29 class THsPublisherInfo;
    27 class MAiContentItemIterator;
    30 class MAiContentItemIterator;
    28 class MAiPropertyExtension;
       
    29 class MAiEventHandlerExtension;
       
    30 
    31 
    31 /**
    32 /**
    32 *  Plugin tool.
    33 *  Plugin tool.
    33 *
    34 *
    34 *  @since S60 3.2
    35 *  @since S60 3.2
    37 	{
    38 	{
    38 	
    39 	
    39 public:
    40 public:
    40 
    41 
    41     /**
    42     /**
    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.
    43      * Get the content item iterator for the passed publisher.
    53      *
    44      *
    54      * @param reference to content publisher
    45      * @param reference to content publisher
    55      * @param content type indication
    46      * @param content type indication
    56      * @return pointer to content iterator 
    47      * @return pointer to content iterator 
    57      */
    48      */
    58     virtual MAiContentItemIterator* ContentItemIteratorL(
    49     virtual MAiContentItemIterator* ContentItemIterator(
    59                                 CAiContentPublisher& aContentPublisher,
    50         CHsContentPublisher& aContentPublisher,
    60                                 TInt aContentType = EAiPublisherContent ) = 0;
    51         CHsContentPublisher::TProperty aType = CHsContentPublisher::EPublisherContent ) = 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 
    52 
    81     /**
    53     /**
    82      * Release the tool.
    54      * Release the tool.
    83      */
    55      */
    84     virtual void Release() = 0;
    56     virtual void Release() = 0;
    85 	    
    57 	    
    86 protected:
    58 protected:
    87 	    
    59 	    
    88 	MAiPluginTool() { }
    60 	MAiPluginTool() { }    
    89     
       
    90     };
    61     };
    91 
    62 
    92 inline void Release( MAiPluginTool* aSelf )
    63 inline void Release( MAiPluginTool* aSelf )
    93     {
    64     {
    94     if ( aSelf )
    65     if ( aSelf )