1.1 --- a/epoc32/include/mw/contentlistingfactory.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/contentlistingfactory.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,106 @@
     1.4 -contentlistingfactory.h
     1.5 +/*
     1.6 +* Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies). 
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description: 
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +#ifndef CONTENTLISTINGFACTORY_H
    1.24 +#define CONTENTLISTINGFACTORY_H
    1.25 +
    1.26 +//  INCLUDES
    1.27 +#include <e32def.h>
    1.28 +
    1.29 +// FORWARD DECLARATIONS
    1.30 +class MCLFContentListingEngine;
    1.31 +class MCLFModifiableItem;
    1.32 +class MCLFSortingStyle;
    1.33 +class TResourceReader;
    1.34 +
    1.35 +// CLASS DECLARATION
    1.36 +
    1.37 +/**
    1.38 +*  Factory for Content Listing Framework.
    1.39 +*  You can create new instances of Content Listing Engines, Modifiable items
    1.40 +*  and Sorting Styles by using this factory.<br><br>
    1.41 +*  Example:
    1.42 +*  @code
    1.43 +*  // Create a new instance of Content Listing Engine
    1.44 +*  MCLFContentListingEngine* engine =
    1.45 +*      ContentListingFactory::NewContentListingEngineLC();
    1.46 +*
    1.47 +*  // Create a new instance of Sorting style
    1.48 +*  MCLFSortingStyle* sortingStyle =
    1.49 +*      ContentListingFactory::NewSortingStyleLC();
    1.50 +*
    1.51 +*  // Create a new instance of Modifiable item
    1.52 +*  MCLFModifiableItem* modItem =
    1.53 +*      ContentListingFactory::NewModifiableItemLC();
    1.54 +*  @endcode
    1.55 +*
    1.56 +*  @lib ContentListingFramework.lib
    1.57 +*  @since S60 3.1
    1.58 +*/
    1.59 +class ContentListingFactory
    1.60 +    {
    1.61 +    public: // New functions
    1.62 +
    1.63 +        /**
    1.64 +        * Create new instance of Content Listing Engine.
    1.65 +        * @since S60 3.1
    1.66 +        * @return New instance of Content Listing Engine.
    1.67 +        *         Ownership is transferred to the client application.
    1.68 +        */
    1.69 +        IMPORT_C static MCLFContentListingEngine* NewContentListingEngineLC();
    1.70 +
    1.71 +        /**
    1.72 +        * Create new instance of Modifiable Item.
    1.73 +        * @since S60 3.1
    1.74 +        * @return New instance of Modifiable Item.
    1.75 +        *         Ownership is transferred to the client application.
    1.76 +        */
    1.77 +        IMPORT_C static MCLFModifiableItem* NewModifiableItemLC();
    1.78 +
    1.79 +        /**
    1.80 +        * Create new instance of Sorting Style.
    1.81 +        * @since S60 3.1
    1.82 +        * @return New instance of the Sorting Style.
    1.83 +        *         Ownership is transferred to the client application.
    1.84 +        */
    1.85 +        IMPORT_C static MCLFSortingStyle* NewSortingStyleLC();
    1.86 +
    1.87 +        /**
    1.88 +        * Create new instance of Sorting Style from resource of the
    1.89 +        * application by using TResourceReader.
    1.90 +        * @since S60 3.1
    1.91 +        * @param aResource Resource reader to sorting style resource.
    1.92 +        *                  Use resource struct CLF_SORTING_STYLE. See
    1.93 +        *                  CLFContentListing.rh
    1.94 +        * @return New instance of the Sorting Style.
    1.95 +        *         Ownership is transferred to the client application.
    1.96 +        */
    1.97 +        IMPORT_C static MCLFSortingStyle* NewSortingStyleLC(
    1.98 +                                                TResourceReader& aResource );
    1.99 +
   1.100 +    private:
   1.101 +        // Prohibit C++ default constructor.
   1.102 +        ContentListingFactory();
   1.103 +        // Prohibit Destructor.
   1.104 +        ~ContentListingFactory();
   1.105 +
   1.106 +    };
   1.107 +
   1.108 +#endif      // CONTENTLISTINGFACTORY_H
   1.109 +
   1.110 +// End of File