contentstorage/caclient/stub/inc/caclientnotifierproxy.h
author hgs
Tue, 23 Mar 2010 23:42:03 +0200
changeset 87 9d806967057c
parent 85 7feec50967db
child 93 82b66994846c
permissions -rw-r--r--
201007
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 CACLIENTNOTIFIERPROXY_H
7feec50967db 201003_02
hgs
parents:
diff changeset
    19
#define CACLIENTNOTIFIERPROXY_H
7feec50967db 201003_02
hgs
parents:
diff changeset
    20
7feec50967db 201003_02
hgs
parents:
diff changeset
    21
#include <QObject>
7feec50967db 201003_02
hgs
parents:
diff changeset
    22
#include <QMutex>
7feec50967db 201003_02
hgs
parents:
diff changeset
    23
7feec50967db 201003_02
hgs
parents:
diff changeset
    24
#include "caclient_global.h"
7feec50967db 201003_02
hgs
parents:
diff changeset
    25
#include "cadefs.h"
7feec50967db 201003_02
hgs
parents:
diff changeset
    26
#include "canotifier_p.h"
7feec50967db 201003_02
hgs
parents:
diff changeset
    27
7feec50967db 201003_02
hgs
parents:
diff changeset
    28
class CaEntry;
7feec50967db 201003_02
hgs
parents:
diff changeset
    29
class CaNotifierFilter;
7feec50967db 201003_02
hgs
parents:
diff changeset
    30
7feec50967db 201003_02
hgs
parents:
diff changeset
    31
/**
7feec50967db 201003_02
hgs
parents:
diff changeset
    32
 *  IDataObserver
7feec50967db 201003_02
hgs
parents:
diff changeset
    33
 *
7feec50967db 201003_02
hgs
parents:
diff changeset
    34
 */
7feec50967db 201003_02
hgs
parents:
diff changeset
    35
class IDataObserver
7feec50967db 201003_02
hgs
parents:
diff changeset
    36
{
7feec50967db 201003_02
hgs
parents:
diff changeset
    37
public:
7feec50967db 201003_02
hgs
parents:
diff changeset
    38
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    39
     * Method invoked when entry is changed.
7feec50967db 201003_02
hgs
parents:
diff changeset
    40
     * @param entryId entry id.
7feec50967db 201003_02
hgs
parents:
diff changeset
    41
     * @param changeType change type.
7feec50967db 201003_02
hgs
parents:
diff changeset
    42
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    43
    virtual void entryChanged(int entryId,
87
hgs
parents: 85
diff changeset
    44
                              ChangeType changeType) const = 0;
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    45
7feec50967db 201003_02
hgs
parents:
diff changeset
    46
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    47
     * Method invoked when entry is changed.
7feec50967db 201003_02
hgs
parents:
diff changeset
    48
     * @param entry entry.
7feec50967db 201003_02
hgs
parents:
diff changeset
    49
     * @param changeType change type.
7feec50967db 201003_02
hgs
parents:
diff changeset
    50
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    51
    virtual void entryChanged(const CaEntry &entry,
87
hgs
parents: 85
diff changeset
    52
                              ChangeType changeType) const = 0;
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    53
7feec50967db 201003_02
hgs
parents:
diff changeset
    54
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    55
     * Method invoked when entry was changed.
7feec50967db 201003_02
hgs
parents:
diff changeset
    56
     * @param entryId entry id.
7feec50967db 201003_02
hgs
parents:
diff changeset
    57
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    58
    virtual void entryTouched(int id) const = 0;
7feec50967db 201003_02
hgs
parents:
diff changeset
    59
7feec50967db 201003_02
hgs
parents:
diff changeset
    60
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    61
     * Method invoked when entry was changed.
7feec50967db 201003_02
hgs
parents:
diff changeset
    62
     * @param groupId group id.
7feec50967db 201003_02
hgs
parents:
diff changeset
    63
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    64
    virtual void groupContentChanged(int groupId) const = 0;
7feec50967db 201003_02
hgs
parents:
diff changeset
    65
};
7feec50967db 201003_02
hgs
parents:
diff changeset
    66
7feec50967db 201003_02
hgs
parents:
diff changeset
    67
7feec50967db 201003_02
hgs
parents:
diff changeset
    68
class CACLIENT_EXPORT CaClientNotifierProxy: public QObject
7feec50967db 201003_02
hgs
parents:
diff changeset
    69
{
87
hgs
parents: 85
diff changeset
    70
    Q_OBJECT
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    71
7feec50967db 201003_02
hgs
parents:
diff changeset
    72
public:
7feec50967db 201003_02
hgs
parents:
diff changeset
    73
7feec50967db 201003_02
hgs
parents:
diff changeset
    74
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    75
     * Constructor.
7feec50967db 201003_02
hgs
parents:
diff changeset
    76
     * @param parent pointer to parent. Defaults to NULL.
7feec50967db 201003_02
hgs
parents:
diff changeset
    77
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    78
    explicit CaClientNotifierProxy(QObject *parent = 0);
7feec50967db 201003_02
hgs
parents:
diff changeset
    79
7feec50967db 201003_02
hgs
parents:
diff changeset
    80
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    81
     * Destructor.
7feec50967db 201003_02
hgs
parents:
diff changeset
    82
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    83
    ~CaClientNotifierProxy();
7feec50967db 201003_02
hgs
parents:
diff changeset
    84
7feec50967db 201003_02
hgs
parents:
diff changeset
    85
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    86
     * Method invoked when entry is changed.
7feec50967db 201003_02
hgs
parents:
diff changeset
    87
     * @param entryId entry id.
7feec50967db 201003_02
hgs
parents:
diff changeset
    88
     * @param changeType change type.
7feec50967db 201003_02
hgs
parents:
diff changeset
    89
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    90
    virtual void entryChanged(int entryId, ChangeType changeType) const;
7feec50967db 201003_02
hgs
parents:
diff changeset
    91
7feec50967db 201003_02
hgs
parents:
diff changeset
    92
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    93
     * Method invoked when entry is changed.
7feec50967db 201003_02
hgs
parents:
diff changeset
    94
     * @param entry entry.
7feec50967db 201003_02
hgs
parents:
diff changeset
    95
     * @param changeType change type.
7feec50967db 201003_02
hgs
parents:
diff changeset
    96
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    97
    virtual void entryChanged(const CaEntry &entry,
87
hgs
parents: 85
diff changeset
    98
                              ChangeType changeType) const;
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    99
7feec50967db 201003_02
hgs
parents:
diff changeset
   100
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   101
     * Method invoked when entry was changed.
7feec50967db 201003_02
hgs
parents:
diff changeset
   102
     * @param entryId entry id.
7feec50967db 201003_02
hgs
parents:
diff changeset
   103
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   104
    virtual void entryTouched(int id) const;
7feec50967db 201003_02
hgs
parents:
diff changeset
   105
7feec50967db 201003_02
hgs
parents:
diff changeset
   106
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   107
     * Method invoked when entry was changed.
7feec50967db 201003_02
hgs
parents:
diff changeset
   108
     * @param groupId group id.
7feec50967db 201003_02
hgs
parents:
diff changeset
   109
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   110
    virtual void groupContentChanged(int groupId) const;
7feec50967db 201003_02
hgs
parents:
diff changeset
   111
7feec50967db 201003_02
hgs
parents:
diff changeset
   112
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   113
     * Method for registering notifier
7feec50967db 201003_02
hgs
parents:
diff changeset
   114
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
   115
     * @param notifierFilter notifierFilter used to register notifier.
7feec50967db 201003_02
hgs
parents:
diff changeset
   116
     * @param notifierType type of notifier
7feec50967db 201003_02
hgs
parents:
diff changeset
   117
     * @return error code
7feec50967db 201003_02
hgs
parents:
diff changeset
   118
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   119
    int registerNotifier(
7feec50967db 201003_02
hgs
parents:
diff changeset
   120
        const CaNotifierFilter *notifierFilter,
7feec50967db 201003_02
hgs
parents:
diff changeset
   121
        CaNotifierPrivate::NotifierType notifierType,
7feec50967db 201003_02
hgs
parents:
diff changeset
   122
        const CaClientNotifierProxy *notifierProxy);
7feec50967db 201003_02
hgs
parents:
diff changeset
   123
7feec50967db 201003_02
hgs
parents:
diff changeset
   124
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   125
     * Method for unregistering notifier.
7feec50967db 201003_02
hgs
parents:
diff changeset
   126
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
   127
     * @param notifierFilter notifierFilter used to unregister notifier.
7feec50967db 201003_02
hgs
parents:
diff changeset
   128
     * @param notifierType type of notifier
7feec50967db 201003_02
hgs
parents:
diff changeset
   129
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   130
    void unregisterNotifier(
7feec50967db 201003_02
hgs
parents:
diff changeset
   131
        const CaNotifierFilter &notifierFilter,
7feec50967db 201003_02
hgs
parents:
diff changeset
   132
        CaNotifierPrivate::NotifierType notifierType);
7feec50967db 201003_02
hgs
parents:
diff changeset
   133
7feec50967db 201003_02
hgs
parents:
diff changeset
   134
signals:
7feec50967db 201003_02
hgs
parents:
diff changeset
   135
7feec50967db 201003_02
hgs
parents:
diff changeset
   136
    void signalEntryChanged(int entryId, ChangeType changeType) const;
7feec50967db 201003_02
hgs
parents:
diff changeset
   137
    void signalEntryChanged(const CaEntry &entry,
87
hgs
parents: 85
diff changeset
   138
                            ChangeType changeType) const;
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   139
    void signalEntryTouched(int id) const;
7feec50967db 201003_02
hgs
parents:
diff changeset
   140
    void signalGroupContentChanged(int groupId) const;
7feec50967db 201003_02
hgs
parents:
diff changeset
   141
7feec50967db 201003_02
hgs
parents:
diff changeset
   142
private:
7feec50967db 201003_02
hgs
parents:
diff changeset
   143
7feec50967db 201003_02
hgs
parents:
diff changeset
   144
    // Mutex to serialize registering/unregistering for notifications.
7feec50967db 201003_02
hgs
parents:
diff changeset
   145
    QMutex mMutex;
7feec50967db 201003_02
hgs
parents:
diff changeset
   146
7feec50967db 201003_02
hgs
parents:
diff changeset
   147
    Q_DISABLE_COPY(CaClientNotifierProxy)
7feec50967db 201003_02
hgs
parents:
diff changeset
   148
};
7feec50967db 201003_02
hgs
parents:
diff changeset
   149
7feec50967db 201003_02
hgs
parents:
diff changeset
   150
#endif //_CACLIENTNOTIFIERPROXY_H