imservices/xmppsettingsapi/inc/xmppsettingscolumn.h
author hgs
Wed, 03 Nov 2010 22:25:05 +0530
changeset 52 3d676fce9a4e
parent 51 61fad867f68e
permissions -rw-r--r--
201044_02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
51
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2007 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:  This class handles columns.
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
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
#ifndef C_XMPPSETTINGSCOLUMN_H
hgs
parents:
diff changeset
    22
#define C_XMPPSETTINGSCOLUMN_H
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
#include <e32base.h>
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
class CRepository;
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
/**
hgs
parents:
diff changeset
    29
 *  This class handles columns.
hgs
parents:
diff changeset
    30
 *
hgs
parents:
diff changeset
    31
 *  This class contains all methods needed to read and write columns table.
hgs
parents:
diff changeset
    32
 *
hgs
parents:
diff changeset
    33
 *
hgs
parents:
diff changeset
    34
 *  @lib jabbersettings.lib
hgs
parents:
diff changeset
    35
 *  @since S60 5.0
hgs
parents:
diff changeset
    36
 */
hgs
parents:
diff changeset
    37
class CXmppSettingsColumn: public CBase
hgs
parents:
diff changeset
    38
    {
hgs
parents:
diff changeset
    39
hgs
parents:
diff changeset
    40
public:
hgs
parents:
diff changeset
    41
	
hgs
parents:
diff changeset
    42
		/**
hgs
parents:
diff changeset
    43
     * Two-phased constructor.         
hgs
parents:
diff changeset
    44
     * @return Instance of this class
hgs
parents:
diff changeset
    45
     */ 
hgs
parents:
diff changeset
    46
    static CXmppSettingsColumn* NewL( CRepository& aRepository );
hgs
parents:
diff changeset
    47
hgs
parents:
diff changeset
    48
    static CXmppSettingsColumn* NewLC( CRepository& aRepository );
hgs
parents:
diff changeset
    49
hgs
parents:
diff changeset
    50
	  /**
hgs
parents:
diff changeset
    51
	   * Destructor
hgs
parents:
diff changeset
    52
	   */
hgs
parents:
diff changeset
    53
    virtual ~CXmppSettingsColumn();
hgs
parents:
diff changeset
    54
hgs
parents:
diff changeset
    55
    /**
hgs
parents:
diff changeset
    56
     * This method checks that does this column exist. If it does not, it
hgs
parents:
diff changeset
    57
     * creates it (if requested. Otherwise it leaves.
hgs
parents:
diff changeset
    58
     *
hgs
parents:
diff changeset
    59
     * @since S60 5.0
hgs
parents:
diff changeset
    60
     * @param aAttrName Column name.
hgs
parents:
diff changeset
    61
     * @param aCreateColumnIfNotExist Should new column be created if it is
hgs
parents:
diff changeset
    62
     *                         not found.
hgs
parents:
diff changeset
    63
     * @param aColKey onn return contains the key of the column.
hgs
parents:
diff changeset
    64
     */
hgs
parents:
diff changeset
    65
    void GetColumnKeyL( const TDesC& aAttrName,
hgs
parents:
diff changeset
    66
                        TBool aCreateColumnIfNotExist,
hgs
parents:
diff changeset
    67
                        TUint32& aColKey );
hgs
parents:
diff changeset
    68
hgs
parents:
diff changeset
    69
    /**
hgs
parents:
diff changeset
    70
     * Tries to find columns key by it is name (value).
hgs
parents:
diff changeset
    71
     *
hgs
parents:
diff changeset
    72
     * @since S60 5.0
hgs
parents:
diff changeset
    73
     * @param aColumnName Name of the column.
hgs
parents:
diff changeset
    74
     * @param aColumnKey on return contains the columns key.
hgs
parents:
diff changeset
    75
     */
hgs
parents:
diff changeset
    76
    void FindByNameL( const TDesC& aColumnName,
hgs
parents:
diff changeset
    77
                      TUint32& aColumnKey );
hgs
parents:
diff changeset
    78
hgs
parents:
diff changeset
    79
private:
hgs
parents:
diff changeset
    80
		
hgs
parents:
diff changeset
    81
		/**
hgs
parents:
diff changeset
    82
		 * Default Contructor
hgs
parents:
diff changeset
    83
		 */
hgs
parents:
diff changeset
    84
    CXmppSettingsColumn( CRepository& aRepository );
hgs
parents:
diff changeset
    85
		
hgs
parents:
diff changeset
    86
    void ConstructL();
hgs
parents:
diff changeset
    87
hgs
parents:
diff changeset
    88
    /**
hgs
parents:
diff changeset
    89
     * This method resolves next free key to be used as column key.
hgs
parents:
diff changeset
    90
     *
hgs
parents:
diff changeset
    91
     * @since S60 5.0
hgs
parents:
diff changeset
    92
     * @param aColKey On return contains next free column key.
hgs
parents:
diff changeset
    93
     */
hgs
parents:
diff changeset
    94
    void NextFreeSlotL( TUint32& aColKey );
hgs
parents:
diff changeset
    95
hgs
parents:
diff changeset
    96
private: // data
hgs
parents:
diff changeset
    97
hgs
parents:
diff changeset
    98
    /**
hgs
parents:
diff changeset
    99
     * Handle to the Central Repository. Doesnt Own.
hgs
parents:
diff changeset
   100
     */
hgs
parents:
diff changeset
   101
    CRepository& iRepository;
hgs
parents:
diff changeset
   102
hgs
parents:
diff changeset
   103
    };
hgs
parents:
diff changeset
   104
hgs
parents:
diff changeset
   105
hgs
parents:
diff changeset
   106
#endif // C_XMPPSETTINGSCOLUMN_H