messagingapp/msgui/unifiededitor/inc/msgunieditormonitor.h
author hgs
Tue, 19 Oct 2010 11:30:16 +0530
changeset 76 60a8a215b0ec
parent 37 518b245aa84c
permissions -rw-r--r--
201041
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
37
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
 * Copyright (c) 2009 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: Helper class to monitor msg construction in unified editor
hgs
parents:
diff changeset
    15
 *
hgs
parents:
diff changeset
    16
 */
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef MSG_UNIFIED_EDITOR_MONITOR_H
hgs
parents:
diff changeset
    19
#define MSG_UNIFIED_EDITOR_MONITOR_H
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
#include <QObject>
hgs
parents:
diff changeset
    22
#include "convergedmessage.h"
76
hgs
parents: 37
diff changeset
    23
37
hgs
parents:
diff changeset
    24
class MsgUnifiedEditorView;
hgs
parents:
diff changeset
    25
class HbWidget;
hgs
parents:
diff changeset
    26
class UniEditorGenUtils;
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
/**
hgs
parents:
diff changeset
    29
 * Helper class to monitor message's contruction in unified editor.
hgs
parents:
diff changeset
    30
 * This class is for only reading editor's content to run its logic.
hgs
parents:
diff changeset
    31
 * This class is NOT a place for content editing inside editor.
hgs
parents:
diff changeset
    32
 */
hgs
parents:
diff changeset
    33
class MsgUnifiedEditorMonitor : public QObject
hgs
parents:
diff changeset
    34
    {
hgs
parents:
diff changeset
    35
    Q_OBJECT
hgs
parents:
diff changeset
    36
hgs
parents:
diff changeset
    37
public:
hgs
parents:
diff changeset
    38
    /**
hgs
parents:
diff changeset
    39
     * Constructor
hgs
parents:
diff changeset
    40
     */
hgs
parents:
diff changeset
    41
    MsgUnifiedEditorMonitor(QObject* parent=0);
hgs
parents:
diff changeset
    42
hgs
parents:
diff changeset
    43
    /**
hgs
parents:
diff changeset
    44
     * Destructor
hgs
parents:
diff changeset
    45
     */
hgs
parents:
diff changeset
    46
    ~MsgUnifiedEditorMonitor();
hgs
parents:
diff changeset
    47
hgs
parents:
diff changeset
    48
    /**
hgs
parents:
diff changeset
    49
     * Set to skip showing note for first time
hgs
parents:
diff changeset
    50
     * @param skip true/false
hgs
parents:
diff changeset
    51
     */
76
hgs
parents: 37
diff changeset
    52
    inline void setSkipNote(bool skip = true)
hgs
parents: 37
diff changeset
    53
    {
hgs
parents: 37
diff changeset
    54
        mSkipNote = skip;
hgs
parents: 37
diff changeset
    55
    }
37
hgs
parents:
diff changeset
    56
    
hgs
parents:
diff changeset
    57
    /**
hgs
parents:
diff changeset
    58
     * Seeker method to access current message type
hgs
parents:
diff changeset
    59
     */
76
hgs
parents: 37
diff changeset
    60
    static inline ConvergedMessage::MessageType messageType()
hgs
parents: 37
diff changeset
    61
    {
hgs
parents: 37
diff changeset
    62
        return mMessageType;
hgs
parents: 37
diff changeset
    63
    }
37
hgs
parents:
diff changeset
    64
hgs
parents:
diff changeset
    65
    /**
hgs
parents:
diff changeset
    66
     * seeker function to get current msg size in bytes
hgs
parents:
diff changeset
    67
     */
76
hgs
parents: 37
diff changeset
    68
    static inline int messageSize()
hgs
parents: 37
diff changeset
    69
    {
hgs
parents: 37
diff changeset
    70
        return mBodyContentSize + mContainerSize + mSubjectSize;
hgs
parents: 37
diff changeset
    71
    }
37
hgs
parents:
diff changeset
    72
hgs
parents:
diff changeset
    73
    /**
hgs
parents:
diff changeset
    74
     * seeker function to get current msg's body size 
hgs
parents:
diff changeset
    75
     * in bytes
hgs
parents:
diff changeset
    76
     */
76
hgs
parents: 37
diff changeset
    77
    static inline int bodySize()
hgs
parents: 37
diff changeset
    78
    {
hgs
parents: 37
diff changeset
    79
        return mBodyContentSize;
hgs
parents: 37
diff changeset
    80
    }
37
hgs
parents:
diff changeset
    81
hgs
parents:
diff changeset
    82
    /**
hgs
parents:
diff changeset
    83
     * seeker function to get current msg's attachment
hgs
parents:
diff changeset
    84
     * container size in bytes
hgs
parents:
diff changeset
    85
     */
76
hgs
parents: 37
diff changeset
    86
    static inline int containerSize()
hgs
parents: 37
diff changeset
    87
    {
hgs
parents: 37
diff changeset
    88
        return mContainerSize;
hgs
parents: 37
diff changeset
    89
    }
37
hgs
parents:
diff changeset
    90
hgs
parents:
diff changeset
    91
    /**
hgs
parents:
diff changeset
    92
     * seeker function to get current msg's subject
hgs
parents:
diff changeset
    93
     * size in bytes
hgs
parents:
diff changeset
    94
     */
76
hgs
parents: 37
diff changeset
    95
    static inline int subjectSize()
hgs
parents: 37
diff changeset
    96
    {
hgs
parents: 37
diff changeset
    97
        return mSubjectSize;
hgs
parents: 37
diff changeset
    98
    }
37
hgs
parents:
diff changeset
    99
hgs
parents:
diff changeset
   100
    /**
hgs
parents:
diff changeset
   101
     * seeker function to get max possible mms size
hgs
parents:
diff changeset
   102
     * in bytes
hgs
parents:
diff changeset
   103
     */
76
hgs
parents: 37
diff changeset
   104
    static inline int maxMmsSize()
hgs
parents: 37
diff changeset
   105
    {
hgs
parents: 37
diff changeset
   106
        return mMaxMmsSize;
hgs
parents: 37
diff changeset
   107
    }
37
hgs
parents:
diff changeset
   108
    
hgs
parents:
diff changeset
   109
    /**
hgs
parents:
diff changeset
   110
     * seeker funtion to get max recipient count for sms
hgs
parents:
diff changeset
   111
     */
76
hgs
parents: 37
diff changeset
   112
    static inline int maxSmsRecipients()
hgs
parents: 37
diff changeset
   113
    {
hgs
parents: 37
diff changeset
   114
        return mMaxSmsRecipients;
hgs
parents: 37
diff changeset
   115
    }
37
hgs
parents:
diff changeset
   116
hgs
parents:
diff changeset
   117
    /**
hgs
parents:
diff changeset
   118
     * seeker funtion to get max recipient count for mms
hgs
parents:
diff changeset
   119
     */
76
hgs
parents: 37
diff changeset
   120
    static inline int maxMmsRecipients()
hgs
parents: 37
diff changeset
   121
    {
hgs
parents: 37
diff changeset
   122
        return mMaxMmsRecipients;
hgs
parents: 37
diff changeset
   123
    }
37
hgs
parents:
diff changeset
   124
    
hgs
parents:
diff changeset
   125
    /**
hgs
parents:
diff changeset
   126
     * get total address count in To, Cc & Bcc fields
hgs
parents:
diff changeset
   127
     */
76
hgs
parents: 37
diff changeset
   128
    static inline int msgAddressCount()
hgs
parents: 37
diff changeset
   129
    {
hgs
parents: 37
diff changeset
   130
        return  mToAddressCount + mCcAddressCount + mBccAddressCount;
hgs
parents: 37
diff changeset
   131
    }
hgs
parents: 37
diff changeset
   132
    
hgs
parents: 37
diff changeset
   133
    /**
hgs
parents: 37
diff changeset
   134
     * tells if message is ready for send.
hgs
parents: 37
diff changeset
   135
     */
hgs
parents: 37
diff changeset
   136
    static inline bool readyForSend()
hgs
parents: 37
diff changeset
   137
    {
hgs
parents: 37
diff changeset
   138
        return mReadyForSend;
hgs
parents: 37
diff changeset
   139
    }
37
hgs
parents:
diff changeset
   140
hgs
parents:
diff changeset
   141
public slots:
hgs
parents:
diff changeset
   142
    /**
hgs
parents:
diff changeset
   143
     * slot to handle content change in any editor component
hgs
parents:
diff changeset
   144
     */
76
hgs
parents: 37
diff changeset
   145
    void handleContentsChanged(const QVariant& data);
37
hgs
parents:
diff changeset
   146
hgs
parents:
diff changeset
   147
signals:
hgs
parents:
diff changeset
   148
    /**
hgs
parents:
diff changeset
   149
     * Emitted when composed message can be sent.
hgs
parents:
diff changeset
   150
     * @param enable true if send is possible else false.
hgs
parents:
diff changeset
   151
     */
hgs
parents:
diff changeset
   152
    void enableSend(bool enable);
76
hgs
parents: 37
diff changeset
   153
    
hgs
parents: 37
diff changeset
   154
    /**
hgs
parents: 37
diff changeset
   155
     * Emitte when contents are changed, to set drafts flag.
hgs
parents: 37
diff changeset
   156
     */
hgs
parents: 37
diff changeset
   157
    void contentsChanged();
37
hgs
parents:
diff changeset
   158
hgs
parents:
diff changeset
   159
private:
hgs
parents:
diff changeset
   160
    /**
hgs
parents:
diff changeset
   161
     * setter method to initialize content
hgs
parents:
diff changeset
   162
     */
hgs
parents:
diff changeset
   163
    void init();
hgs
parents:
diff changeset
   164
hgs
parents:
diff changeset
   165
    /**
hgs
parents:
diff changeset
   166
     * Determine the projected msg type due to change in editor content
hgs
parents:
diff changeset
   167
     */
hgs
parents:
diff changeset
   168
    ConvergedMessage::MessageType projectedMsgType();
hgs
parents:
diff changeset
   169
hgs
parents:
diff changeset
   170
    /**
hgs
parents:
diff changeset
   171
     * show type change discreet note
hgs
parents:
diff changeset
   172
     */
hgs
parents:
diff changeset
   173
    void showPopup(const QString& text);
hgs
parents:
diff changeset
   174
    
76
hgs
parents: 37
diff changeset
   175
  
37
hgs
parents:
diff changeset
   176
    /**
hgs
parents:
diff changeset
   177
     * check editor body for MMS content
hgs
parents:
diff changeset
   178
     * @return true if MMS content is present
hgs
parents:
diff changeset
   179
     */
hgs
parents:
diff changeset
   180
    bool bodyHasMMSContent();
hgs
parents:
diff changeset
   181
    
hgs
parents:
diff changeset
   182
    /**
hgs
parents:
diff changeset
   183
     * check editor subject for MMS content
hgs
parents:
diff changeset
   184
     * @return true if MMS content is present
hgs
parents:
diff changeset
   185
     */
hgs
parents:
diff changeset
   186
    bool subjectHasMMSContent();
hgs
parents:
diff changeset
   187
    
hgs
parents:
diff changeset
   188
    /**
hgs
parents:
diff changeset
   189
     * check editor attachment container for MMS content
hgs
parents:
diff changeset
   190
     * @return true if MMS content is present
hgs
parents:
diff changeset
   191
     */
hgs
parents:
diff changeset
   192
    bool containerHasMMSContent();
hgs
parents:
diff changeset
   193
    
hgs
parents:
diff changeset
   194
    /**
hgs
parents:
diff changeset
   195
     * check for other MMS content criteria
hgs
parents:
diff changeset
   196
     * @return true if MMS criteria is met
hgs
parents:
diff changeset
   197
     */
hgs
parents:
diff changeset
   198
    bool otherMMSCriteriaMet();
hgs
parents:
diff changeset
   199
hgs
parents:
diff changeset
   200
    /**
hgs
parents:
diff changeset
   201
     * Checks if composed message can be sent and emits a signal.
hgs
parents:
diff changeset
   202
     */
hgs
parents:
diff changeset
   203
    void updateSend();
76
hgs
parents: 37
diff changeset
   204
    
hgs
parents: 37
diff changeset
   205
    /**
hgs
parents: 37
diff changeset
   206
     * Updates body content size.
hgs
parents: 37
diff changeset
   207
     */
hgs
parents: 37
diff changeset
   208
    void updateBodyContentSize();
hgs
parents: 37
diff changeset
   209
    
hgs
parents: 37
diff changeset
   210
    /**
hgs
parents: 37
diff changeset
   211
     * resets value of static member variables.
hgs
parents: 37
diff changeset
   212
     */
hgs
parents: 37
diff changeset
   213
    void reset();
37
hgs
parents:
diff changeset
   214
hgs
parents:
diff changeset
   215
private:
hgs
parents:
diff changeset
   216
hgs
parents:
diff changeset
   217
    /**
hgs
parents:
diff changeset
   218
     * Flag to skip showing the type change popup.
hgs
parents:
diff changeset
   219
     * Note need to be skipped when an mms is opened from draft.
hgs
parents:
diff changeset
   220
     */
hgs
parents:
diff changeset
   221
    bool mSkipNote;
76
hgs
parents: 37
diff changeset
   222
    
hgs
parents: 37
diff changeset
   223
    /**
hgs
parents: 37
diff changeset
   224
     * Flag to keep information, if attachment container has mms content.
hgs
parents: 37
diff changeset
   225
     */
hgs
parents: 37
diff changeset
   226
    bool mContainerHasMmsContent;
hgs
parents: 37
diff changeset
   227
    
hgs
parents: 37
diff changeset
   228
    /**
hgs
parents: 37
diff changeset
   229
     * Priority.
hgs
parents: 37
diff changeset
   230
     */
hgs
parents: 37
diff changeset
   231
    ConvergedMessage::Priority mPriority;
hgs
parents: 37
diff changeset
   232
    
hgs
parents: 37
diff changeset
   233
    /**
hgs
parents: 37
diff changeset
   234
     * Email id is present in to field or not.
hgs
parents: 37
diff changeset
   235
     */
hgs
parents: 37
diff changeset
   236
    bool mEmailPresent;
hgs
parents: 37
diff changeset
   237
    
hgs
parents: 37
diff changeset
   238
    /**
hgs
parents: 37
diff changeset
   239
     * Body text has uni code char(s).
hgs
parents: 37
diff changeset
   240
     */
hgs
parents: 37
diff changeset
   241
    bool mUniCode;
hgs
parents: 37
diff changeset
   242
    
hgs
parents: 37
diff changeset
   243
    /**
hgs
parents: 37
diff changeset
   244
     * Flag to hold state of image resizing
hgs
parents: 37
diff changeset
   245
     */
hgs
parents: 37
diff changeset
   246
    bool mImageResizing;
37
hgs
parents:
diff changeset
   247
hgs
parents:
diff changeset
   248
    /**
hgs
parents:
diff changeset
   249
     * Type of msg under composition in the editor 
hgs
parents:
diff changeset
   250
     */
hgs
parents:
diff changeset
   251
    static ConvergedMessage::MessageType mMessageType;
hgs
parents:
diff changeset
   252
    
hgs
parents:
diff changeset
   253
    /**
hgs
parents:
diff changeset
   254
     * msg body size in bytes
hgs
parents:
diff changeset
   255
     */
hgs
parents:
diff changeset
   256
    static int mBodySize;
hgs
parents:
diff changeset
   257
    
hgs
parents:
diff changeset
   258
    /**
76
hgs
parents: 37
diff changeset
   259
     * msg body text size in bytes
hgs
parents: 37
diff changeset
   260
     */
hgs
parents: 37
diff changeset
   261
    static int mBodyTextSize;
hgs
parents: 37
diff changeset
   262
    
hgs
parents: 37
diff changeset
   263
    /**
hgs
parents: 37
diff changeset
   264
     * msg body content (mBodySize + mBodyTextSize + mime headers) size in bytes.
hgs
parents: 37
diff changeset
   265
     */
hgs
parents: 37
diff changeset
   266
    static int mBodyContentSize;
hgs
parents: 37
diff changeset
   267
    
hgs
parents: 37
diff changeset
   268
    /**
37
hgs
parents:
diff changeset
   269
     * msg container size in bytes
hgs
parents:
diff changeset
   270
     */
hgs
parents:
diff changeset
   271
    static int mContainerSize;
hgs
parents:
diff changeset
   272
    
hgs
parents:
diff changeset
   273
    /**
hgs
parents:
diff changeset
   274
     * msg subject size in bytes
hgs
parents:
diff changeset
   275
     */
hgs
parents:
diff changeset
   276
    static int mSubjectSize;
hgs
parents:
diff changeset
   277
hgs
parents:
diff changeset
   278
    /**
hgs
parents:
diff changeset
   279
     * max mms size in bytes
hgs
parents:
diff changeset
   280
     */
hgs
parents:
diff changeset
   281
    static int mMaxMmsSize;
hgs
parents:
diff changeset
   282
    
hgs
parents:
diff changeset
   283
    /**
hgs
parents:
diff changeset
   284
     * max recipient count in an sms
hgs
parents:
diff changeset
   285
     */
hgs
parents:
diff changeset
   286
    static int mMaxSmsRecipients;
hgs
parents:
diff changeset
   287
hgs
parents:
diff changeset
   288
    /**
hgs
parents:
diff changeset
   289
     * max recipient count in an sms
hgs
parents:
diff changeset
   290
     */
hgs
parents:
diff changeset
   291
    static int mMaxMmsRecipients;
hgs
parents:
diff changeset
   292
    
hgs
parents:
diff changeset
   293
    /**
76
hgs
parents: 37
diff changeset
   294
     * Address count in various fields.
37
hgs
parents:
diff changeset
   295
     */
76
hgs
parents: 37
diff changeset
   296
    static int mToAddressCount;
hgs
parents: 37
diff changeset
   297
    static int mCcAddressCount;
hgs
parents: 37
diff changeset
   298
    static int mBccAddressCount;
hgs
parents: 37
diff changeset
   299
    
hgs
parents: 37
diff changeset
   300
    /**
hgs
parents: 37
diff changeset
   301
     * flag to check if message is ready for send.
hgs
parents: 37
diff changeset
   302
     */
hgs
parents: 37
diff changeset
   303
    static bool mReadyForSend;
37
hgs
parents:
diff changeset
   304
hgs
parents:
diff changeset
   305
    /**
hgs
parents:
diff changeset
   306
     * UniEditorGenUtils object
hgs
parents:
diff changeset
   307
     * Owned
hgs
parents:
diff changeset
   308
     */
hgs
parents:
diff changeset
   309
    UniEditorGenUtils* mUniEditorGenUtils;
76
hgs
parents: 37
diff changeset
   310
#ifdef UNIEDITOR_UNIT_TEST
hgs
parents: 37
diff changeset
   311
    /**
hgs
parents: 37
diff changeset
   312
     * Unit Testing
hgs
parents: 37
diff changeset
   313
     */
hgs
parents: 37
diff changeset
   314
    friend class TestMsgUnifiedEditorView;
hgs
parents: 37
diff changeset
   315
    friend class TestMsgUnifiedEditorMonitor;
hgs
parents: 37
diff changeset
   316
#endif
37
hgs
parents:
diff changeset
   317
    };
hgs
parents:
diff changeset
   318
hgs
parents:
diff changeset
   319
#endif //MSG_UNIFIED_EDITOR_MONITOR_H