contentstorage/caclient/s60/inc/caobjectadapter.h
author hgs
Tue, 23 Mar 2010 23:28:12 +0200
changeset 86 e492551a0d54
parent 85 7feec50967db
child 87 9d806967057c
permissions -rw-r--r--
201005
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) 2009 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:
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 OBJECTADAPTER_H
7feec50967db 201003_02
hgs
parents:
diff changeset
    19
#define OBJECTADAPTER_H
7feec50967db 201003_02
hgs
parents:
diff changeset
    20
7feec50967db 201003_02
hgs
parents:
diff changeset
    21
// INCLUDES
7feec50967db 201003_02
hgs
parents:
diff changeset
    22
7feec50967db 201003_02
hgs
parents:
diff changeset
    23
// CLASS DECLARATION
7feec50967db 201003_02
hgs
parents:
diff changeset
    24
#include <QList>
7feec50967db 201003_02
hgs
parents:
diff changeset
    25
7feec50967db 201003_02
hgs
parents:
diff changeset
    26
#include <cadefs.h>
7feec50967db 201003_02
hgs
parents:
diff changeset
    27
7feec50967db 201003_02
hgs
parents:
diff changeset
    28
#include "cainnernotifierfilter.h"
7feec50967db 201003_02
hgs
parents:
diff changeset
    29
#include "canotifier.h"
7feec50967db 201003_02
hgs
parents:
diff changeset
    30
#include "canotifier_p.h"
7feec50967db 201003_02
hgs
parents:
diff changeset
    31
#include "cainnerquery.h"
7feec50967db 201003_02
hgs
parents:
diff changeset
    32
7feec50967db 201003_02
hgs
parents:
diff changeset
    33
class CaEntry;
7feec50967db 201003_02
hgs
parents:
diff changeset
    34
class CaQuery;
7feec50967db 201003_02
hgs
parents:
diff changeset
    35
class CaNotifierFilter;
7feec50967db 201003_02
hgs
parents:
diff changeset
    36
class CCaInnerEntry;
7feec50967db 201003_02
hgs
parents:
diff changeset
    37
class CCaInnerNotifierFilter;
86
hgs
parents: 85
diff changeset
    38
class HbIcon;
hgs
parents: 85
diff changeset
    39
class CFbsBitmap;
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    40
7feec50967db 201003_02
hgs
parents:
diff changeset
    41
/**
7feec50967db 201003_02
hgs
parents:
diff changeset
    42
 *  CaObjectAdapter
7feec50967db 201003_02
hgs
parents:
diff changeset
    43
 *
7feec50967db 201003_02
hgs
parents:
diff changeset
    44
 */
7feec50967db 201003_02
hgs
parents:
diff changeset
    45
class CaObjectAdapter
7feec50967db 201003_02
hgs
parents:
diff changeset
    46
{
7feec50967db 201003_02
hgs
parents:
diff changeset
    47
public:
7feec50967db 201003_02
hgs
parents:
diff changeset
    48
7feec50967db 201003_02
hgs
parents:
diff changeset
    49
    //Static convertion methods between Symbian and Qt objects
7feec50967db 201003_02
hgs
parents:
diff changeset
    50
7feec50967db 201003_02
hgs
parents:
diff changeset
    51
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    52
     * Converts entry to inner entry.
7feec50967db 201003_02
hgs
parents:
diff changeset
    53
     * @param fromEntry entry to be converted
7feec50967db 201003_02
hgs
parents:
diff changeset
    54
     * @param toEntry inner entry resulting from conversion
7feec50967db 201003_02
hgs
parents:
diff changeset
    55
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    56
    static void convertL(
7feec50967db 201003_02
hgs
parents:
diff changeset
    57
        const CaEntry& fromEntry,
7feec50967db 201003_02
hgs
parents:
diff changeset
    58
        CCaInnerEntry& toEntry);
7feec50967db 201003_02
hgs
parents:
diff changeset
    59
7feec50967db 201003_02
hgs
parents:
diff changeset
    60
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    61
     * Converts inner entry to entry.
7feec50967db 201003_02
hgs
parents:
diff changeset
    62
     * @param fromEntry inner entry to be converted
7feec50967db 201003_02
hgs
parents:
diff changeset
    63
     * @param toEntry entry resulting from conversino
7feec50967db 201003_02
hgs
parents:
diff changeset
    64
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    65
    static void convert(const CCaInnerEntry& fromEntry,
7feec50967db 201003_02
hgs
parents:
diff changeset
    66
        CaEntry& toEntry);
7feec50967db 201003_02
hgs
parents:
diff changeset
    67
7feec50967db 201003_02
hgs
parents:
diff changeset
    68
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    69
     * Converts query to inner query.
7feec50967db 201003_02
hgs
parents:
diff changeset
    70
     * @param fromQuery query to be converted
7feec50967db 201003_02
hgs
parents:
diff changeset
    71
     * @param toQuery inner query resutling from conversion
7feec50967db 201003_02
hgs
parents:
diff changeset
    72
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    73
    static void convertL(
7feec50967db 201003_02
hgs
parents:
diff changeset
    74
        const CaQuery& fromQuery,
7feec50967db 201003_02
hgs
parents:
diff changeset
    75
        CCaInnerQuery& toQuery);
7feec50967db 201003_02
hgs
parents:
diff changeset
    76
7feec50967db 201003_02
hgs
parents:
diff changeset
    77
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    78
     * Wraps a QString internal buffer into TPtrC object.
7feec50967db 201003_02
hgs
parents:
diff changeset
    79
     * The returned object is valid until QString internal buffer changes
7feec50967db 201003_02
hgs
parents:
diff changeset
    80
     * or the object is destroyed.
7feec50967db 201003_02
hgs
parents:
diff changeset
    81
     * @param string QString.
7feec50967db 201003_02
hgs
parents:
diff changeset
    82
     * @return descriptor.
7feec50967db 201003_02
hgs
parents:
diff changeset
    83
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    84
    static const TPtrC convertToDescriptor(const QString& string);
7feec50967db 201003_02
hgs
parents:
diff changeset
    85
7feec50967db 201003_02
hgs
parents:
diff changeset
    86
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    87
     * Converts descriptor to QString.
7feec50967db 201003_02
hgs
parents:
diff changeset
    88
     * @param des descriptor.
7feec50967db 201003_02
hgs
parents:
diff changeset
    89
     * @return QString.
7feec50967db 201003_02
hgs
parents:
diff changeset
    90
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    91
    static QString convertToString(const TDesC& des);
7feec50967db 201003_02
hgs
parents:
diff changeset
    92
7feec50967db 201003_02
hgs
parents:
diff changeset
    93
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    94
     * Converts inner entry table to QList of pointers to entries.
7feec50967db 201003_02
hgs
parents:
diff changeset
    95
     * @param fromEntriesArray an array containing inner entries
7feec50967db 201003_02
hgs
parents:
diff changeset
    96
     * for conversion.
7feec50967db 201003_02
hgs
parents:
diff changeset
    97
     * @param toEntriesArray list of converted entries.
7feec50967db 201003_02
hgs
parents:
diff changeset
    98
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    99
    static void convertL(
7feec50967db 201003_02
hgs
parents:
diff changeset
   100
        const RPointerArray<CCaInnerEntry>& fromEntriesArray,
7feec50967db 201003_02
hgs
parents:
diff changeset
   101
        QList<CaEntry*>& toEntriesArray);
7feec50967db 201003_02
hgs
parents:
diff changeset
   102
7feec50967db 201003_02
hgs
parents:
diff changeset
   103
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   104
     * Converts QList of ids to RArray of TInts.
7feec50967db 201003_02
hgs
parents:
diff changeset
   105
     * @param fromEntryIdList list of entry id
7feec50967db 201003_02
hgs
parents:
diff changeset
   106
     * @param toEntryIdArray array of entry ids
7feec50967db 201003_02
hgs
parents:
diff changeset
   107
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   108
    static void convertL(const QList<int> &fromEntryIdList,
7feec50967db 201003_02
hgs
parents:
diff changeset
   109
        RArray<TInt>& toEntryIdArray);
7feec50967db 201003_02
hgs
parents:
diff changeset
   110
7feec50967db 201003_02
hgs
parents:
diff changeset
   111
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   112
     * Converts RArray of TInts to QList of ids.
7feec50967db 201003_02
hgs
parents:
diff changeset
   113
     * @param fromEntryIdList an array of entry ids.
7feec50967db 201003_02
hgs
parents:
diff changeset
   114
     * @param toEntryIdList resulgin list of entry ids.
7feec50967db 201003_02
hgs
parents:
diff changeset
   115
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   116
    static void convertL(const RArray<TInt>& fromEntryIdList,
7feec50967db 201003_02
hgs
parents:
diff changeset
   117
        QList<int>& toEntryIdList);
7feec50967db 201003_02
hgs
parents:
diff changeset
   118
7feec50967db 201003_02
hgs
parents:
diff changeset
   119
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   120
     * Converts symbian error code to error code (used in QT code).
7feec50967db 201003_02
hgs
parents:
diff changeset
   121
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   122
    static ErrorCode convertErrorCode(
7feec50967db 201003_02
hgs
parents:
diff changeset
   123
        TInt internalErrorCode);
7feec50967db 201003_02
hgs
parents:
diff changeset
   124
7feec50967db 201003_02
hgs
parents:
diff changeset
   125
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   126
     * Creates icon.
7feec50967db 201003_02
hgs
parents:
diff changeset
   127
     * @param entry entry.
86
hgs
parents: 85
diff changeset
   128
     * @return HbIcon.
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   129
     */
86
hgs
parents: 85
diff changeset
   130
    static HbIcon makeIcon(const CaEntry& entry, const QSize &size);
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   131
7feec50967db 201003_02
hgs
parents:
diff changeset
   132
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   133
     * Converts notifier type to inner notifier type.
7feec50967db 201003_02
hgs
parents:
diff changeset
   134
     * @param from notifier type.
7feec50967db 201003_02
hgs
parents:
diff changeset
   135
     * @param to resulting inner notifier type.
7feec50967db 201003_02
hgs
parents:
diff changeset
   136
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   137
    static void convert(
7feec50967db 201003_02
hgs
parents:
diff changeset
   138
        CaNotifierPrivate::NotifierType from,
7feec50967db 201003_02
hgs
parents:
diff changeset
   139
        CCaInnerNotifierFilter::TNotifierType& to);
7feec50967db 201003_02
hgs
parents:
diff changeset
   140
7feec50967db 201003_02
hgs
parents:
diff changeset
   141
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   142
     * Converts inner change type to change type.
7feec50967db 201003_02
hgs
parents:
diff changeset
   143
     * @param from inner change type.
7feec50967db 201003_02
hgs
parents:
diff changeset
   144
     * @param to resulting change type.
7feec50967db 201003_02
hgs
parents:
diff changeset
   145
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   146
    static void convert(
7feec50967db 201003_02
hgs
parents:
diff changeset
   147
            TChangeType src, ChangeType& dest);
7feec50967db 201003_02
hgs
parents:
diff changeset
   148
7feec50967db 201003_02
hgs
parents:
diff changeset
   149
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   150
     * Converts filter to inner filter.
7feec50967db 201003_02
hgs
parents:
diff changeset
   151
     * @param from notifier filter.
7feec50967db 201003_02
hgs
parents:
diff changeset
   152
     * @param to resulting notifier filter.
7feec50967db 201003_02
hgs
parents:
diff changeset
   153
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   154
    static void convertL(
7feec50967db 201003_02
hgs
parents:
diff changeset
   155
        const CaNotifierFilter &from,
7feec50967db 201003_02
hgs
parents:
diff changeset
   156
        CCaInnerNotifierFilter &to);
7feec50967db 201003_02
hgs
parents:
diff changeset
   157
7feec50967db 201003_02
hgs
parents:
diff changeset
   158
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   159
     * @return  uid attribute name
7feec50967db 201003_02
hgs
parents:
diff changeset
   160
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   161
    static const QString& applicationUidAttributeName();
7feec50967db 201003_02
hgs
parents:
diff changeset
   162
7feec50967db 201003_02
hgs
parents:
diff changeset
   163
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   164
     * @return  attribute type name
7feec50967db 201003_02
hgs
parents:
diff changeset
   165
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   166
    static const QString& applicationEntryName();
7feec50967db 201003_02
hgs
parents:
diff changeset
   167
    
7feec50967db 201003_02
hgs
parents:
diff changeset
   168
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   169
     * @return  widget type name
7feec50967db 201003_02
hgs
parents:
diff changeset
   170
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   171
    static const QString& widgetEntryName();
7feec50967db 201003_02
hgs
parents:
diff changeset
   172
7feec50967db 201003_02
hgs
parents:
diff changeset
   173
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   174
     * Set entry id.
7feec50967db 201003_02
hgs
parents:
diff changeset
   175
     * @param entry entry.
7feec50967db 201003_02
hgs
parents:
diff changeset
   176
     * @param id entry id.
7feec50967db 201003_02
hgs
parents:
diff changeset
   177
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   178
    static void setId(CaEntry &entry,
7feec50967db 201003_02
hgs
parents:
diff changeset
   179
        int id);
7feec50967db 201003_02
hgs
parents:
diff changeset
   180
7feec50967db 201003_02
hgs
parents:
diff changeset
   181
private:
7feec50967db 201003_02
hgs
parents:
diff changeset
   182
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   183
     * Creates icon. Leaving version.
7feec50967db 201003_02
hgs
parents:
diff changeset
   184
     * @param entry entry.
86
hgs
parents: 85
diff changeset
   185
     * @return HbIcon.
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   186
     */
86
hgs
parents: 85
diff changeset
   187
    static HbIcon makeIconL(const CaEntry& entry, const QSize &size);
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   188
7feec50967db 201003_02
hgs
parents:
diff changeset
   189
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   190
     * Make bitmap copy, used to get rid of compression for extended bitmap
7feec50967db 201003_02
hgs
parents:
diff changeset
   191
     * @param input input bitmap.
7feec50967db 201003_02
hgs
parents:
diff changeset
   192
     * @return copied bitmap.
7feec50967db 201003_02
hgs
parents:
diff changeset
   193
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   194
    static CFbsBitmap* copyBitmapLC(CFbsBitmap* input);
7feec50967db 201003_02
hgs
parents:
diff changeset
   195
7feec50967db 201003_02
hgs
parents:
diff changeset
   196
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   197
     * Maps a given sort subject and the order to be applied
7feec50967db 201003_02
hgs
parents:
diff changeset
   198
     * into a sort code used
7feec50967db 201003_02
hgs
parents:
diff changeset
   199
     * @param sortAttribute - what is to be sorted
7feec50967db 201003_02
hgs
parents:
diff changeset
   200
     * @param sortOrder - how it is to be sorted
7feec50967db 201003_02
hgs
parents:
diff changeset
   201
     * @return sort code corresponding to input parameters
7feec50967db 201003_02
hgs
parents:
diff changeset
   202
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   203
    static CCaInnerQuery::TSortAttribute getSortCode(
7feec50967db 201003_02
hgs
parents:
diff changeset
   204
        SortAttribute sortAttribute,
7feec50967db 201003_02
hgs
parents:
diff changeset
   205
        Qt::SortOrder sortOrder);
7feec50967db 201003_02
hgs
parents:
diff changeset
   206
7feec50967db 201003_02
hgs
parents:
diff changeset
   207
};
7feec50967db 201003_02
hgs
parents:
diff changeset
   208
7feec50967db 201003_02
hgs
parents:
diff changeset
   209
#endif // OBJECTADAPTER_H