contentstorage/caclient/s60/inc/caobjectadapter.h
author hgs
Fri, 14 May 2010 17:24:44 +0300
changeset 94 dbb8300717f7
parent 92 782e3408c2ab
permissions -rw-r--r--
201019
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>
92
hgs
parents: 89
diff changeset
    25
#include <QSharedPointer>
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    26
7feec50967db 201003_02
hgs
parents:
diff changeset
    27
#include <cadefs.h>
7feec50967db 201003_02
hgs
parents:
diff changeset
    28
7feec50967db 201003_02
hgs
parents:
diff changeset
    29
#include "cainnernotifierfilter.h"
7feec50967db 201003_02
hgs
parents:
diff changeset
    30
#include "canotifier.h"
7feec50967db 201003_02
hgs
parents:
diff changeset
    31
#include "canotifier_p.h"
7feec50967db 201003_02
hgs
parents:
diff changeset
    32
#include "cainnerquery.h"
7feec50967db 201003_02
hgs
parents:
diff changeset
    33
7feec50967db 201003_02
hgs
parents:
diff changeset
    34
class CaEntry;
7feec50967db 201003_02
hgs
parents:
diff changeset
    35
class CaQuery;
7feec50967db 201003_02
hgs
parents:
diff changeset
    36
class CaNotifierFilter;
7feec50967db 201003_02
hgs
parents:
diff changeset
    37
class CCaInnerEntry;
7feec50967db 201003_02
hgs
parents:
diff changeset
    38
class CCaInnerNotifierFilter;
86
hgs
parents: 85
diff changeset
    39
class HbIcon;
hgs
parents: 85
diff changeset
    40
class CFbsBitmap;
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    41
89
hgs
parents: 88
diff changeset
    42
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    43
/**
7feec50967db 201003_02
hgs
parents:
diff changeset
    44
 *  CaObjectAdapter
7feec50967db 201003_02
hgs
parents:
diff changeset
    45
 *
7feec50967db 201003_02
hgs
parents:
diff changeset
    46
 */
7feec50967db 201003_02
hgs
parents:
diff changeset
    47
class CaObjectAdapter
7feec50967db 201003_02
hgs
parents:
diff changeset
    48
{
7feec50967db 201003_02
hgs
parents:
diff changeset
    49
public:
7feec50967db 201003_02
hgs
parents:
diff changeset
    50
7feec50967db 201003_02
hgs
parents:
diff changeset
    51
    //Static convertion methods between Symbian and Qt objects
7feec50967db 201003_02
hgs
parents:
diff changeset
    52
7feec50967db 201003_02
hgs
parents:
diff changeset
    53
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    54
     * Converts entry to inner entry.
7feec50967db 201003_02
hgs
parents:
diff changeset
    55
     * @param fromEntry entry to be converted
7feec50967db 201003_02
hgs
parents:
diff changeset
    56
     * @param toEntry inner entry resulting from conversion
7feec50967db 201003_02
hgs
parents:
diff changeset
    57
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    58
    static void convertL(
87
hgs
parents: 86
diff changeset
    59
        const CaEntry &fromEntry,
hgs
parents: 86
diff changeset
    60
        CCaInnerEntry &toEntry);
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    61
7feec50967db 201003_02
hgs
parents:
diff changeset
    62
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    63
     * Converts inner entry to entry.
7feec50967db 201003_02
hgs
parents:
diff changeset
    64
     * @param fromEntry inner entry to be converted
7feec50967db 201003_02
hgs
parents:
diff changeset
    65
     * @param toEntry entry resulting from conversino
7feec50967db 201003_02
hgs
parents:
diff changeset
    66
     */
87
hgs
parents: 86
diff changeset
    67
    static void convert(const CCaInnerEntry &fromEntry,
hgs
parents: 86
diff changeset
    68
                        CaEntry &toEntry);
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    69
7feec50967db 201003_02
hgs
parents:
diff changeset
    70
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    71
     * Converts query to inner query.
7feec50967db 201003_02
hgs
parents:
diff changeset
    72
     * @param fromQuery query to be converted
7feec50967db 201003_02
hgs
parents:
diff changeset
    73
     * @param toQuery inner query resutling from conversion
7feec50967db 201003_02
hgs
parents:
diff changeset
    74
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    75
    static void convertL(
87
hgs
parents: 86
diff changeset
    76
        const CaQuery &fromQuery,
hgs
parents: 86
diff changeset
    77
        CCaInnerQuery &toQuery);
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    78
7feec50967db 201003_02
hgs
parents:
diff changeset
    79
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    80
     * Converts inner entry table to QList of pointers to entries.
7feec50967db 201003_02
hgs
parents:
diff changeset
    81
     * @param fromEntriesArray an array containing inner entries
7feec50967db 201003_02
hgs
parents:
diff changeset
    82
     * for conversion.
7feec50967db 201003_02
hgs
parents:
diff changeset
    83
     * @param toEntriesArray list of converted entries.
7feec50967db 201003_02
hgs
parents:
diff changeset
    84
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    85
    static void convertL(
7feec50967db 201003_02
hgs
parents:
diff changeset
    86
        const RPointerArray<CCaInnerEntry>& fromEntriesArray,
92
hgs
parents: 89
diff changeset
    87
        QList< QSharedPointer<CaEntry> > & toEntriesArray);
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    88
7feec50967db 201003_02
hgs
parents:
diff changeset
    89
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    90
     * Converts QList of ids to RArray of TInts.
7feec50967db 201003_02
hgs
parents:
diff changeset
    91
     * @param fromEntryIdList list of entry id
7feec50967db 201003_02
hgs
parents:
diff changeset
    92
     * @param toEntryIdArray array of entry ids
7feec50967db 201003_02
hgs
parents:
diff changeset
    93
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    94
    static void convertL(const QList<int> &fromEntryIdList,
87
hgs
parents: 86
diff changeset
    95
                         RArray<TInt>& toEntryIdArray);
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    96
7feec50967db 201003_02
hgs
parents:
diff changeset
    97
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    98
     * Converts RArray of TInts to QList of ids.
7feec50967db 201003_02
hgs
parents:
diff changeset
    99
     * @param fromEntryIdList an array of entry ids.
7feec50967db 201003_02
hgs
parents:
diff changeset
   100
     * @param toEntryIdList resulgin list of entry ids.
7feec50967db 201003_02
hgs
parents:
diff changeset
   101
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   102
    static void convertL(const RArray<TInt>& fromEntryIdList,
87
hgs
parents: 86
diff changeset
   103
                         QList<int>& toEntryIdList);
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   104
7feec50967db 201003_02
hgs
parents:
diff changeset
   105
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   106
     * Converts symbian error code to error code (used in QT code).
7feec50967db 201003_02
hgs
parents:
diff changeset
   107
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   108
    static ErrorCode convertErrorCode(
7feec50967db 201003_02
hgs
parents:
diff changeset
   109
        TInt internalErrorCode);
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 notifier type to inner notifier type.
7feec50967db 201003_02
hgs
parents:
diff changeset
   113
     * @param from notifier type.
7feec50967db 201003_02
hgs
parents:
diff changeset
   114
     * @param to resulting inner notifier type.
7feec50967db 201003_02
hgs
parents:
diff changeset
   115
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   116
    static void convert(
7feec50967db 201003_02
hgs
parents:
diff changeset
   117
        CaNotifierPrivate::NotifierType from,
87
hgs
parents: 86
diff changeset
   118
        CCaInnerNotifierFilter::TNotifierType &to);
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   119
7feec50967db 201003_02
hgs
parents:
diff changeset
   120
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   121
     * Converts inner change type to change type.
7feec50967db 201003_02
hgs
parents:
diff changeset
   122
     * @param from inner change type.
7feec50967db 201003_02
hgs
parents:
diff changeset
   123
     * @param to resulting change type.
7feec50967db 201003_02
hgs
parents:
diff changeset
   124
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   125
    static void convert(
87
hgs
parents: 86
diff changeset
   126
        TChangeType src, ChangeType &dest);
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   127
7feec50967db 201003_02
hgs
parents:
diff changeset
   128
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   129
     * Converts filter to inner filter.
7feec50967db 201003_02
hgs
parents:
diff changeset
   130
     * @param from notifier filter.
7feec50967db 201003_02
hgs
parents:
diff changeset
   131
     * @param to resulting notifier filter.
7feec50967db 201003_02
hgs
parents:
diff changeset
   132
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   133
    static void convertL(
7feec50967db 201003_02
hgs
parents:
diff changeset
   134
        const CaNotifierFilter &from,
7feec50967db 201003_02
hgs
parents:
diff changeset
   135
        CCaInnerNotifierFilter &to);
7feec50967db 201003_02
hgs
parents:
diff changeset
   136
7feec50967db 201003_02
hgs
parents:
diff changeset
   137
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   138
     * Set entry id.
7feec50967db 201003_02
hgs
parents:
diff changeset
   139
     * @param entry entry.
7feec50967db 201003_02
hgs
parents:
diff changeset
   140
     * @param id entry id.
7feec50967db 201003_02
hgs
parents:
diff changeset
   141
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   142
    static void setId(CaEntry &entry,
87
hgs
parents: 86
diff changeset
   143
                      int id);
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   144
7feec50967db 201003_02
hgs
parents:
diff changeset
   145
private:
7feec50967db 201003_02
hgs
parents:
diff changeset
   146
7feec50967db 201003_02
hgs
parents:
diff changeset
   147
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   148
     * Maps a given sort subject and the order to be applied
7feec50967db 201003_02
hgs
parents:
diff changeset
   149
     * into a sort code used
7feec50967db 201003_02
hgs
parents:
diff changeset
   150
     * @param sortAttribute - what is to be sorted
7feec50967db 201003_02
hgs
parents:
diff changeset
   151
     * @param sortOrder - how it is to be sorted
7feec50967db 201003_02
hgs
parents:
diff changeset
   152
     * @return sort code corresponding to input parameters
7feec50967db 201003_02
hgs
parents:
diff changeset
   153
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   154
    static CCaInnerQuery::TSortAttribute getSortCode(
7feec50967db 201003_02
hgs
parents:
diff changeset
   155
        SortAttribute sortAttribute,
7feec50967db 201003_02
hgs
parents:
diff changeset
   156
        Qt::SortOrder sortOrder);
7feec50967db 201003_02
hgs
parents:
diff changeset
   157
7feec50967db 201003_02
hgs
parents:
diff changeset
   158
};
7feec50967db 201003_02
hgs
parents:
diff changeset
   159
7feec50967db 201003_02
hgs
parents:
diff changeset
   160
#endif // OBJECTADAPTER_H