locationmanager/tagcreator/inc/ctagcreator.h
author hgs
Wed, 14 Jul 2010 07:57:22 +0300
changeset 38 5210ffae7137
permissions -rw-r--r--
201027
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
38
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  A class for creating country and city tags for media files.
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
#ifndef C_TAGCREATOR_H
hgs
parents:
diff changeset
    20
#define C_TAGCREATOR_H
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
#include "mdesession.h"
hgs
parents:
diff changeset
    23
#include "mdenamespacedef.h"
hgs
parents:
diff changeset
    24
#include <mdeconstants.h>
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
/**
hgs
parents:
diff changeset
    27
 *
hgs
parents:
diff changeset
    28
 *  @since S60 9.2
hgs
parents:
diff changeset
    29
 */
hgs
parents:
diff changeset
    30
class CTagCreator : public CBase
hgs
parents:
diff changeset
    31
    {
hgs
parents:
diff changeset
    32
public:  
hgs
parents:
diff changeset
    33
    /**
hgs
parents:
diff changeset
    34
     * 2-phased constructor.
hgs
parents:
diff changeset
    35
     */
hgs
parents:
diff changeset
    36
    IMPORT_C static CTagCreator* NewL( );
hgs
parents:
diff changeset
    37
hgs
parents:
diff changeset
    38
    /**
hgs
parents:
diff changeset
    39
     * C++ destructor.
hgs
parents:
diff changeset
    40
     */    
hgs
parents:
diff changeset
    41
    IMPORT_C virtual ~CTagCreator();
hgs
parents:
diff changeset
    42
    
hgs
parents:
diff changeset
    43
    /**
hgs
parents:
diff changeset
    44
     * Attach country and city tags to an image file/object.
hgs
parents:
diff changeset
    45
     * @param aObjectId, object Id for image/video to be tagged.
hgs
parents:
diff changeset
    46
     * @param aCountryTagId, a country tag Id.
hgs
parents:
diff changeset
    47
     * @param aCityTagId, a city tag Id.
hgs
parents:
diff changeset
    48
	   * @return None.
hgs
parents:
diff changeset
    49
     */
hgs
parents:
diff changeset
    50
   IMPORT_C void AttachTagsL( const TUint32 aObjectId, const TItemId aCountryTagId, 
hgs
parents:
diff changeset
    51
                              const TItemId aCityTagId );
hgs
parents:
diff changeset
    52
    /**
hgs
parents:
diff changeset
    53
     * Creates country and city tags.
hgs
parents:
diff changeset
    54
     * @param aCountry, a country name.
hgs
parents:
diff changeset
    55
     * @param aCountryTagId, reference to a country tag Id.
hgs
parents:
diff changeset
    56
     * @param aCity, a city name.
hgs
parents:
diff changeset
    57
     * @param aCityTagId, a reference to a city tag Id.
hgs
parents:
diff changeset
    58
	   * @return None.
hgs
parents:
diff changeset
    59
     */
hgs
parents:
diff changeset
    60
    IMPORT_C void CreateLocationTagsL( const TPtrC& aCountry, TItemId& aCountryTagId, 
hgs
parents:
diff changeset
    61
                                      const TPtrC& aCity, TItemId& aCityTagId );
hgs
parents:
diff changeset
    62
hgs
parents:
diff changeset
    63
	/**
hgs
parents:
diff changeset
    64
	  * Sets the CMdESession for tag creation
hgs
parents:
diff changeset
    65
	  * @param aSession  the CMdESession object
hgs
parents:
diff changeset
    66
	  */
hgs
parents:
diff changeset
    67
    IMPORT_C void SetSession( CMdESession* aSession );
hgs
parents:
diff changeset
    68
hgs
parents:
diff changeset
    69
public:
hgs
parents:
diff changeset
    70
hgs
parents:
diff changeset
    71
	/**
hgs
parents:
diff changeset
    72
	  * Creates a tag for the country
hgs
parents:
diff changeset
    73
	  * @param aCountry country name
hgs
parents:
diff changeset
    74
	  * @param aCity city name
hgs
parents:
diff changeset
    75
	  * @param aCountryTagId   The country tag Id
hgs
parents:
diff changeset
    76
	  */    
hgs
parents:
diff changeset
    77
    void CreateTagForCountryL( const TPtrC& aCountry, 
hgs
parents:
diff changeset
    78
                TItemId& aCountryTagId );
hgs
parents:
diff changeset
    79
hgs
parents:
diff changeset
    80
	/**
hgs
parents:
diff changeset
    81
	  * Creates a tag for the city
hgs
parents:
diff changeset
    82
	  * @param aCountry The country name
hgs
parents:
diff changeset
    83
	  * @param aCity   The city name
hgs
parents:
diff changeset
    84
	  *	@param aCityTagId  The city tag Id
hgs
parents:
diff changeset
    85
	  */		
hgs
parents:
diff changeset
    86
    void CreateTagForCityL( const TPtrC& aCountry, const TPtrC& aCity, TItemId& aCityTagId);
hgs
parents:
diff changeset
    87
    
hgs
parents:
diff changeset
    88
private:
hgs
parents:
diff changeset
    89
    /**
hgs
parents:
diff changeset
    90
     * C++ constructor.
hgs
parents:
diff changeset
    91
     */  
hgs
parents:
diff changeset
    92
    CTagCreator( );
hgs
parents:
diff changeset
    93
    
hgs
parents:
diff changeset
    94
    /**
hgs
parents:
diff changeset
    95
     * 2nd phase constructor.
hgs
parents:
diff changeset
    96
     */
hgs
parents:
diff changeset
    97
    void ConstructL();
hgs
parents:
diff changeset
    98
hgs
parents:
diff changeset
    99
	/**
hgs
parents:
diff changeset
   100
	  * Creates a tag object and adds it to the database
hgs
parents:
diff changeset
   101
	  * @param aTitle  The title associated with the tag
hgs
parents:
diff changeset
   102
	  * @param aUri  The uri associated with the tag
hgs
parents:
diff changeset
   103
	  * @return The itemId of the newly created tag in the database	
hgs
parents:
diff changeset
   104
	  */	
hgs
parents:
diff changeset
   105
    TUint32 CreateTagL( const TPtrC& aTitle, 
hgs
parents:
diff changeset
   106
        const TPtrC& aUri, 
hgs
parents:
diff changeset
   107
        MdeConstants::Tag::TTagType aTagType );
hgs
parents:
diff changeset
   108
	/**
hgs
parents:
diff changeset
   109
	  * Finds if a tag with the given uri exists
hgs
parents:
diff changeset
   110
	  * @param  aUri The uri by which the tag is to be searched
hgs
parents:
diff changeset
   111
	  * @return  The ItemId of the tag if it exists,0 otherwise
hgs
parents:
diff changeset
   112
	  */	
hgs
parents:
diff changeset
   113
    
hgs
parents:
diff changeset
   114
    TUint32 TagExistsL( const TPtrC& aUri  );
hgs
parents:
diff changeset
   115
    
hgs
parents:
diff changeset
   116
private:
hgs
parents:
diff changeset
   117
hgs
parents:
diff changeset
   118
	/**
hgs
parents:
diff changeset
   119
	  *  iMdeSession
hgs
parents:
diff changeset
   120
	  *  an instance of the CMdESession 
hgs
parents:
diff changeset
   121
	  */		
hgs
parents:
diff changeset
   122
    CMdESession* iMdeSession;
hgs
parents:
diff changeset
   123
    
hgs
parents:
diff changeset
   124
    };
hgs
parents:
diff changeset
   125
hgs
parents:
diff changeset
   126
#endif // C_TAGCREATOR_H
hgs
parents:
diff changeset
   127
hgs
parents:
diff changeset
   128
// End of file.