webengine/wrtharvester/inc/wrtharvesterregistryaccess.h
changeset 10 a359256acfc6
parent 0 dd21522fd290
child 25 0ed94ceaa377
equal deleted inserted replaced
5:10e98eab6f85 10:a359256acfc6
    58                 delete ( *ptr )[ i ];
    58                 delete ( *ptr )[ i ];
    59                 }
    59                 }
    60             ptr->Close();
    60             ptr->Close();
    61             }
    61             }
    62     };
    62     };
    63     
    63 
       
    64 class CWrtInfo : public CBase
       
    65     {
       
    66     public:
       
    67         /**
       
    68         * Constructor
       
    69         */
       
    70         inline CWrtInfo()
       
    71             {
       
    72             iUid = TUid::Uid(0);
       
    73             iDisplayName = NULL;
       
    74             iBundleId = NULL;
       
    75             }
       
    76 
       
    77         /**
       
    78         * Destructor.
       
    79         */
       
    80         inline virtual ~CWrtInfo()
       
    81             {
       
    82             delete iDisplayName;
       
    83             delete iBundleId;
       
    84             }
       
    85 
       
    86     public:
       
    87         TUid        iUid;
       
    88         HBufC*      iDisplayName;// widget display name
       
    89         HBufC*      iBundleId; //  widget bundle identifier
       
    90     };
       
    91 
    64 // CLASS DECLARATION
    92 // CLASS DECLARATION
    65 
    93 
    66 /**
    94 /**
    67  *  Widget Register accessor.
    95  *  Widget Registry interface.
    68  *
    96  *
    69  *  Handles communication & widget bookkeeping of miniview-capable widgets.
    97  *  Handles communication & widget bookkeeping of miniview-capable widgets.
    70  *
    98  *
    71  *  @lib wrtharvester.dll
    99  *  @lib wrtharvester.dll
    72  *  @since S60 S60 v5.0
   100  *  @since S60 S60 v5.0
    83         * Destructor.
   111         * Destructor.
    84         */
   112         */
    85         ~WrtHarvesterRegistryAccess();
   113         ~WrtHarvesterRegistryAccess();
    86         
   114         
    87         /**
   115         /**
    88 	    * Get widget bundle names for widgets supporting miniviews.
   116 	    * Get widget bundle ids for widgets supporting miniviews.
    89 	    *
   117 	    *
    90 	    * NOTE: Ownership of pointers in the array is not transferred!
   118 	    * NOTE: Ownership of pointers in the array is not transferred!
    91 	    * Caller must not delete them.
   119 	    * Caller must not delete them.
    92 	    * 
   120 	    * 
    93 	    * @param aArray Array where the descriptor pointers are to be stored.
   121 	    * @param aArray Array where the descriptor pointers are to be stored.
    94 	    */
   122 	    */
    95 	    void WidgetBundleNamesL( RPointerArray< HBufC >& aArray );
   123 	    void WidgetInfosL( RWrtArray< CWrtInfo >& aWidgetInfoArray );
    96 	    
       
    97         /**
       
    98 	    * Get widget uid.
       
    99 	    *
       
   100 	    * @param aBundleName Name of the widget
       
   101 	    * @return TUid of the widget.
       
   102 	    */
       
   103 	    TUid WidgetUid( TPtrC aBundleName );
       
   104 	    
   124 	    
   105 	private:
   125 	private:
   106         /**
   126         /**
   107         * Check if the widget support miniview.
   127         * Check if the widget support miniview.
   108         * 
   128         * 
   111         * @return Yes or no.
   131         * @return Yes or no.
   112         */
   132         */
   113         TBool SupportsMiniviewL( RWidgetRegistryClientSession& aSession, const TUid& aUid );
   133         TBool SupportsMiniviewL( RWidgetRegistryClientSession& aSession, const TUid& aUid );
   114         
   134         
   115         /**
   135         /**
   116         * Returns the Bundle identifier for the given widget. Ownership transfered.
   136         * Returns the property value for the widget as a string. Ownership transferred.
   117         * 
   137         * 
   118         * @param aSession Widget registry session
   138         * @param aSession Widget registry session
   119         * @param aUid UID of widget.
   139         * @param aUid UID of widget.
       
   140         * aPropertyId Id of the property.
   120         * @return Identifier in a descriptor.
   141         * @return Identifier in a descriptor.
   121         */
   142         */
   122         HBufC* ConstructWidgetNameL( RWidgetRegistryClientSession& aSession, CWidgetInfo& aInfo );
   143         HBufC* WidgetPropertyL( RWidgetRegistryClientSession& aSession, const TUid& aUid, TWidgetPropertyId aPropertyId  );
   123         
   144         
   124 	private: // data
   145 
   125 	    /**
   146 
   126 	    *
       
   127 	    */
       
   128 	    RWrtArray< CWidgetInfo >     iWidgetInfoArray;
       
   129     };
   147     };
   130 
   148 
   131 #endif // WRHARVESTERREGISTRYACCESS_H 
   149 #endif // WRHARVESTERREGISTRYACCESS_H