contentstorage/cautils/inc/calocalizationentry.h
author hgs
Fri, 28 May 2010 16:17:03 +0300
changeset 96 5d243a69bdda
parent 94 dbb8300717f7
permissions -rw-r--r--
201021
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
85
7feec50967db 201003_02
hgs
parents:
diff changeset
     1
/*
7feec50967db 201003_02
hgs
parents:
diff changeset
     2
 * Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
7feec50967db 201003_02
hgs
parents:
diff changeset
     3
 * All rights reserved.
7feec50967db 201003_02
hgs
parents:
diff changeset
     4
 * This component and the accompanying materials are made available
7feec50967db 201003_02
hgs
parents:
diff changeset
     5
 * under the terms of "Eclipse Public License v1.0"
7feec50967db 201003_02
hgs
parents:
diff changeset
     6
 * which accompanies this distribution, and is available
7feec50967db 201003_02
hgs
parents:
diff changeset
     7
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
7feec50967db 201003_02
hgs
parents:
diff changeset
     8
 *
7feec50967db 201003_02
hgs
parents:
diff changeset
     9
 * Initial Contributors:
7feec50967db 201003_02
hgs
parents:
diff changeset
    10
 * Nokia Corporation - initial contribution.
7feec50967db 201003_02
hgs
parents:
diff changeset
    11
 *
7feec50967db 201003_02
hgs
parents:
diff changeset
    12
 * Contributors:
7feec50967db 201003_02
hgs
parents:
diff changeset
    13
 *
7feec50967db 201003_02
hgs
parents:
diff changeset
    14
 * Description:  ?Description
7feec50967db 201003_02
hgs
parents:
diff changeset
    15
 *
7feec50967db 201003_02
hgs
parents:
diff changeset
    16
 */
7feec50967db 201003_02
hgs
parents:
diff changeset
    17
7feec50967db 201003_02
hgs
parents:
diff changeset
    18
#ifndef __CAINNERLOCALIZATION_H__
7feec50967db 201003_02
hgs
parents:
diff changeset
    19
#define __CAINNERLOCALIZATION_H__
7feec50967db 201003_02
hgs
parents:
diff changeset
    20
7feec50967db 201003_02
hgs
parents:
diff changeset
    21
#include <e32base.h>
7feec50967db 201003_02
hgs
parents:
diff changeset
    22
7feec50967db 201003_02
hgs
parents:
diff changeset
    23
/**
7feec50967db 201003_02
hgs
parents:
diff changeset
    24
 * Class represents Content Arsenal entry
7feec50967db 201003_02
hgs
parents:
diff changeset
    25
 */
7feec50967db 201003_02
hgs
parents:
diff changeset
    26
NONSHARABLE_CLASS( CCaLocalizationEntry ): public CBase
7feec50967db 201003_02
hgs
parents:
diff changeset
    27
    {
7feec50967db 201003_02
hgs
parents:
diff changeset
    28
7feec50967db 201003_02
hgs
parents:
diff changeset
    29
public:
7feec50967db 201003_02
hgs
parents:
diff changeset
    30
7feec50967db 201003_02
hgs
parents:
diff changeset
    31
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    32
     * Destructor.
7feec50967db 201003_02
hgs
parents:
diff changeset
    33
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    34
    virtual ~CCaLocalizationEntry( );
7feec50967db 201003_02
hgs
parents:
diff changeset
    35
7feec50967db 201003_02
hgs
parents:
diff changeset
    36
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    37
     * Two-phased constructor.
7feec50967db 201003_02
hgs
parents:
diff changeset
    38
     * @return The created object.
7feec50967db 201003_02
hgs
parents:
diff changeset
    39
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    40
    IMPORT_C static CCaLocalizationEntry* NewL( );
7feec50967db 201003_02
hgs
parents:
diff changeset
    41
7feec50967db 201003_02
hgs
parents:
diff changeset
    42
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    43
     * Two-phased constructor.
7feec50967db 201003_02
hgs
parents:
diff changeset
    44
     * @return The created object.
7feec50967db 201003_02
hgs
parents:
diff changeset
    45
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    46
    IMPORT_C static CCaLocalizationEntry* NewLC( );
7feec50967db 201003_02
hgs
parents:
diff changeset
    47
7feec50967db 201003_02
hgs
parents:
diff changeset
    48
    //    GETTERS
7feec50967db 201003_02
hgs
parents:
diff changeset
    49
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    50
     * Gets entry id.
7feec50967db 201003_02
hgs
parents:
diff changeset
    51
     * @return Entry id.
7feec50967db 201003_02
hgs
parents:
diff changeset
    52
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    53
    IMPORT_C TInt GetRowId( ) const;
7feec50967db 201003_02
hgs
parents:
diff changeset
    54
7feec50967db 201003_02
hgs
parents:
diff changeset
    55
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    56
     * Gets entry id.
7feec50967db 201003_02
hgs
parents:
diff changeset
    57
     * @return Entry id.
7feec50967db 201003_02
hgs
parents:
diff changeset
    58
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    59
    IMPORT_C TInt GetTextId( ) const;
7feec50967db 201003_02
hgs
parents:
diff changeset
    60
7feec50967db 201003_02
hgs
parents:
diff changeset
    61
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    62
     * Gets entry text.
7feec50967db 201003_02
hgs
parents:
diff changeset
    63
     * @return Entry text.
7feec50967db 201003_02
hgs
parents:
diff changeset
    64
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    65
    IMPORT_C const RBuf& GetAttributeName( ) const;
7feec50967db 201003_02
hgs
parents:
diff changeset
    66
7feec50967db 201003_02
hgs
parents:
diff changeset
    67
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    68
     * Gets entry text.
7feec50967db 201003_02
hgs
parents:
diff changeset
    69
     * @return Entry text.
7feec50967db 201003_02
hgs
parents:
diff changeset
    70
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    71
    IMPORT_C const RBuf& GetStringId( ) const;
7feec50967db 201003_02
hgs
parents:
diff changeset
    72
    
7feec50967db 201003_02
hgs
parents:
diff changeset
    73
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    74
     * Gets entry text.
7feec50967db 201003_02
hgs
parents:
diff changeset
    75
     * @return Entry text.
7feec50967db 201003_02
hgs
parents:
diff changeset
    76
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    77
    IMPORT_C const RBuf& GetTableName( ) const;  
7feec50967db 201003_02
hgs
parents:
diff changeset
    78
    
7feec50967db 201003_02
hgs
parents:
diff changeset
    79
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    80
     * Gets LocalizedString
7feec50967db 201003_02
hgs
parents:
diff changeset
    81
     * @return LocalizedString
7feec50967db 201003_02
hgs
parents:
diff changeset
    82
     */
94
hgs
parents: 85
diff changeset
    83
    IMPORT_C const RBuf& GetLocalizedString() const;
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    84
    
94
hgs
parents: 85
diff changeset
    85
    /**
hgs
parents: 85
diff changeset
    86
     * Gets GetQmFilename
hgs
parents: 85
diff changeset
    87
     * @return GetQmFilename
hgs
parents: 85
diff changeset
    88
     */
hgs
parents: 85
diff changeset
    89
    IMPORT_C const RBuf& GetQmFilename() const;
hgs
parents: 85
diff changeset
    90
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    91
    // SETTERS
94
hgs
parents: 85
diff changeset
    92
hgs
parents: 85
diff changeset
    93
    /**
hgs
parents: 85
diff changeset
    94
    */
hgs
parents: 85
diff changeset
    95
    IMPORT_C void SetQmFilenameL( const TDesC& aQmFilename );
hgs
parents: 85
diff changeset
    96
    
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    97
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    98
7feec50967db 201003_02
hgs
parents:
diff changeset
    99
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   100
    IMPORT_C void SetRowId( TUint aRowId );
7feec50967db 201003_02
hgs
parents:
diff changeset
   101
    
7feec50967db 201003_02
hgs
parents:
diff changeset
   102
    /**
96
hgs
parents: 94
diff changeset
   103
      Sets localization id
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   104
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   105
    IMPORT_C void SetTextId( TUint aId );
7feec50967db 201003_02
hgs
parents:
diff changeset
   106
    
7feec50967db 201003_02
hgs
parents:
diff changeset
   107
7feec50967db 201003_02
hgs
parents:
diff changeset
   108
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   109
     * Sets the entry text.
7feec50967db 201003_02
hgs
parents:
diff changeset
   110
     * @param aText Entry text.
7feec50967db 201003_02
hgs
parents:
diff changeset
   111
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   112
    IMPORT_C void SetAttributeNameL( const TDesC& aAttribName );
7feec50967db 201003_02
hgs
parents:
diff changeset
   113
7feec50967db 201003_02
hgs
parents:
diff changeset
   114
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   115
     * Sets the entry text.
7feec50967db 201003_02
hgs
parents:
diff changeset
   116
     * @param aText Entry text.
7feec50967db 201003_02
hgs
parents:
diff changeset
   117
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   118
    IMPORT_C void SetStringIdL( const TDesC& aStringId );
7feec50967db 201003_02
hgs
parents:
diff changeset
   119
    
7feec50967db 201003_02
hgs
parents:
diff changeset
   120
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   121
     * Sets the entry text.
7feec50967db 201003_02
hgs
parents:
diff changeset
   122
     * @param aText Entry text.
7feec50967db 201003_02
hgs
parents:
diff changeset
   123
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   124
    IMPORT_C void SetTableNameL( const TDesC& aTableName );
7feec50967db 201003_02
hgs
parents:
diff changeset
   125
7feec50967db 201003_02
hgs
parents:
diff changeset
   126
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   127
     * Sets the Localized String 
7feec50967db 201003_02
hgs
parents:
diff changeset
   128
     * @param aLocalName LocalizedString
7feec50967db 201003_02
hgs
parents:
diff changeset
   129
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   130
    IMPORT_C void SetLocalizedStringL( const TDesC& aLocalName );
7feec50967db 201003_02
hgs
parents:
diff changeset
   131
    
7feec50967db 201003_02
hgs
parents:
diff changeset
   132
    
94
hgs
parents: 85
diff changeset
   133
    
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   134
/*    *
7feec50967db 201003_02
hgs
parents:
diff changeset
   135
     * Externalizes object to the stream
7feec50967db 201003_02
hgs
parents:
diff changeset
   136
     * @param aStream a write stream
7feec50967db 201003_02
hgs
parents:
diff changeset
   137
     
7feec50967db 201003_02
hgs
parents:
diff changeset
   138
    IMPORT_C void ExternalizeL( RWriteStream& aStream ) const;
7feec50967db 201003_02
hgs
parents:
diff changeset
   139
7feec50967db 201003_02
hgs
parents:
diff changeset
   140
    *
7feec50967db 201003_02
hgs
parents:
diff changeset
   141
     * Internalizes stream to the object
7feec50967db 201003_02
hgs
parents:
diff changeset
   142
     * @param aStream a read stream
7feec50967db 201003_02
hgs
parents:
diff changeset
   143
     
7feec50967db 201003_02
hgs
parents:
diff changeset
   144
    IMPORT_C void InternalizeL( RReadStream& aStream );*/
7feec50967db 201003_02
hgs
parents:
diff changeset
   145
7feec50967db 201003_02
hgs
parents:
diff changeset
   146
private:
7feec50967db 201003_02
hgs
parents:
diff changeset
   147
7feec50967db 201003_02
hgs
parents:
diff changeset
   148
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   149
     * Second phased constructor.
7feec50967db 201003_02
hgs
parents:
diff changeset
   150
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   151
    void ConstructL( );
7feec50967db 201003_02
hgs
parents:
diff changeset
   152
7feec50967db 201003_02
hgs
parents:
diff changeset
   153
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   154
     * Constructor
7feec50967db 201003_02
hgs
parents:
diff changeset
   155
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   156
    CCaLocalizationEntry( );
7feec50967db 201003_02
hgs
parents:
diff changeset
   157
7feec50967db 201003_02
hgs
parents:
diff changeset
   158
private:
7feec50967db 201003_02
hgs
parents:
diff changeset
   159
    // data
7feec50967db 201003_02
hgs
parents:
diff changeset
   160
	/*,                                                    
7feec50967db 201003_02
hgs
parents:
diff changeset
   161
	                                      
7feec50967db 201003_02
hgs
parents:
diff changeset
   162
	  				
7feec50967db 201003_02
hgs
parents:
diff changeset
   163
	                                  
7feec50967db 201003_02
hgs
parents:
diff changeset
   164
	
7feec50967db 201003_02
hgs
parents:
diff changeset
   165
    /*
7feec50967db 201003_02
hgs
parents:
diff changeset
   166
     * Unique identifier of the localization entry.
7feec50967db 201003_02
hgs
parents:
diff changeset
   167
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   168
    TInt iId;
7feec50967db 201003_02
hgs
parents:
diff changeset
   169
    
7feec50967db 201003_02
hgs
parents:
diff changeset
   170
    /*
7feec50967db 201003_02
hgs
parents:
diff changeset
   171
     * Unique identifier of the entry to update.
7feec50967db 201003_02
hgs
parents:
diff changeset
   172
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   173
    TInt iRowId;
7feec50967db 201003_02
hgs
parents:
diff changeset
   174
7feec50967db 201003_02
hgs
parents:
diff changeset
   175
    /*
7feec50967db 201003_02
hgs
parents:
diff changeset
   176
     * Name of table to update.
7feec50967db 201003_02
hgs
parents:
diff changeset
   177
     * Own.
7feec50967db 201003_02
hgs
parents:
diff changeset
   178
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   179
    RBuf iTableName;
7feec50967db 201003_02
hgs
parents:
diff changeset
   180
    
7feec50967db 201003_02
hgs
parents:
diff changeset
   181
    /*
7feec50967db 201003_02
hgs
parents:
diff changeset
   182
     * Name of attribute (column) to update.
7feec50967db 201003_02
hgs
parents:
diff changeset
   183
     * Own.
7feec50967db 201003_02
hgs
parents:
diff changeset
   184
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   185
    RBuf iAttribName;
7feec50967db 201003_02
hgs
parents:
diff changeset
   186
    
7feec50967db 201003_02
hgs
parents:
diff changeset
   187
    /*
7feec50967db 201003_02
hgs
parents:
diff changeset
   188
     * String it to translate.
7feec50967db 201003_02
hgs
parents:
diff changeset
   189
     * Own.
7feec50967db 201003_02
hgs
parents:
diff changeset
   190
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   191
    RBuf iStringId;
7feec50967db 201003_02
hgs
parents:
diff changeset
   192
7feec50967db 201003_02
hgs
parents:
diff changeset
   193
    /*
7feec50967db 201003_02
hgs
parents:
diff changeset
   194
     * Translated string.
7feec50967db 201003_02
hgs
parents:
diff changeset
   195
     * Own.
7feec50967db 201003_02
hgs
parents:
diff changeset
   196
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   197
    RBuf iLocalName;
94
hgs
parents: 85
diff changeset
   198
    
hgs
parents: 85
diff changeset
   199
    /*
96
hgs
parents: 94
diff changeset
   200
     * Qm filename.
94
hgs
parents: 85
diff changeset
   201
     * Own.
hgs
parents: 85
diff changeset
   202
     */
hgs
parents: 85
diff changeset
   203
    RBuf iQmFilename;
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   204
7feec50967db 201003_02
hgs
parents:
diff changeset
   205
     };
7feec50967db 201003_02
hgs
parents:
diff changeset
   206
7feec50967db 201003_02
hgs
parents:
diff changeset
   207
#endif // __CAINNERLOCALIZATION_H__