messagingapp/msgsettings/settingsview/inc/msgsettingengine.h
branchRCL_3
changeset 26 ebe688cedc25
equal deleted inserted replaced
25:fa1df4b99609 26:ebe688cedc25
       
     1 /*
       
     2  * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     3  * All rights reserved.
       
     4  * This component and the accompanying materials are made available
       
     5  * under the terms of "Eclipse Public License v1.0"
       
     6  * which accompanies this distribution, and is available
       
     7  * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8  *
       
     9  * Initial Contributors:
       
    10  * Nokia Corporation - initial contribution.
       
    11  *
       
    12  * Contributors:
       
    13  *
       
    14  * Description:This class provides API m/w for msg settings plugin
       
    15  *
       
    16  */
       
    17 
       
    18 #ifndef MSGSETTINGENGINE_H_
       
    19 #define MSGSETTINGENGINE_H_
       
    20 
       
    21 #include <qobject.h>
       
    22 
       
    23 //FORWARD DECLARATION
       
    24 class SmsSettingsPrivate;
       
    25 class MmsSettingsPrivate;
       
    26 
       
    27 /**
       
    28  * This class defines interfaces wrapper b/w MsgSettings UI
       
    29  * and m/w. 
       
    30  */
       
    31 class MsgSettingEngine : public QObject
       
    32 {
       
    33 Q_OBJECT
       
    34 
       
    35 public:
       
    36     /*
       
    37      * Enum defining Character Encoding
       
    38      */
       
    39     enum CharacterEncoding
       
    40     {
       
    41         ReducedSupport, FullSupport
       
    42     };
       
    43 
       
    44     /**
       
    45      * Enum defining MmsRetrieval mode
       
    46      */
       
    47     enum MmsRetrieval
       
    48     {
       
    49         AlwaysAutomatic, AutomInHomeNetwork, Manual, Off, No
       
    50     };
       
    51     
       
    52 public:
       
    53 
       
    54     /**
       
    55      * Constructor
       
    56      */
       
    57     MsgSettingEngine();
       
    58 
       
    59     /**
       
    60      * Destructor
       
    61      */
       
    62     ~MsgSettingEngine();
       
    63 
       
    64     /**
       
    65      * set the character encoding
       
    66      * @param encoding specifying encoding type
       
    67      */
       
    68     void setCharacterEncoding(MsgSettingEngine::CharacterEncoding encoding);
       
    69 
       
    70     /**
       
    71      * returns settings delivery report status
       
    72      * and character encoding
       
    73      * @param encoding for char encoding
       
    74      */
       
    75     void settingsCharEncoding( 
       
    76             MsgSettingEngine::CharacterEncoding& encoding);
       
    77     
       
    78     /**
       
    79      * set the mms retrieval mode
       
    80      * @param retrieval specifying mode
       
    81      */
       
    82     void setMMSRetrieval(MsgSettingEngine::MmsRetrieval);
       
    83 
       
    84     /**
       
    85      * set the anonymous message
       
    86      * @param status true or false
       
    87      */
       
    88     void setAnonymousMessages(bool status);
       
    89 
       
    90     /**
       
    91      * set for receiving MMS Adverts
       
    92      * @param status for true or false
       
    93      */
       
    94     void setReceiveMMSAdverts(bool status);
       
    95 
       
    96     /**
       
    97      * for view 2 mms advance settings\
       
    98      * get all the fields of mms advance setting
       
    99      * @param retrieval return for mms retrieval
       
   100      * @param anonymous return status true or false
       
   101      * @param mmsadverts return status true or false
       
   102      */
       
   103     void advanceMmsSettings(MsgSettingEngine::MmsRetrieval& retrieval,
       
   104                             bool& anonymousStatus, bool& mmsAdvertsStatus);
       
   105 
       
   106     /**
       
   107      * get all the MMs access points
       
   108      * @param returns all the access point names
       
   109      * @attention to be displayed as per the index o to total count
       
   110      * @param defaultIndex returns default selected
       
   111      */
       
   112     void allMMsAcessPoints(QStringList& nameList, int& defaultIndex);
       
   113 
       
   114     /**
       
   115      * set the default access point
       
   116      * @param index specifying the index
       
   117      */
       
   118     void setMMSAccesspoint(int index);
       
   119 
       
   120     /**
       
   121      * get the list of all SMS Message Centres
       
   122      * @param list of all names QString
       
   123      * @param defaultIndex returns default selected
       
   124      */
       
   125     void allSMSMessageCenter(QStringList& nameList, int& defaultIndex);
       
   126 
       
   127     /**
       
   128      * set the default SMS message centre
       
   129      * @param index specifying default index
       
   130      */
       
   131     void setSMSMessageCenter(int index);
       
   132 
       
   133     /**
       
   134      * for editing the SMS messafe Centre
       
   135      * @param name specifying center name
       
   136      * @param number specifying center number
       
   137      * @param index specying index of message list
       
   138      */
       
   139     void editSmsMessageCenter(QString& centreName, QString& centreNumber,
       
   140                               int index);
       
   141 
       
   142     /**
       
   143      * for add new sms message centre
       
   144      * @param name specifying center name
       
   145      * @param number specifying center number
       
   146      */
       
   147     void addSmsMessageCenter(QString& centreName, QString& centreNumber);
       
   148 
       
   149     /**
       
   150      * for delete new sms message centre
       
   151      * @param deleteIndex specifying index to delete
       
   152      */
       
   153     void deleteSmsMessageCenter(int deleteIndex);
       
   154     
       
   155     /**
       
   156      * get the sms message centre namd and number
       
   157      * @index for which center needs
       
   158      * @param return name specifying center name
       
   159      * @param return number specifying center number
       
   160      */
       
   161     void smsCenterNameAndNumber(int index, QString& centreName,
       
   162                                 QString& centreNumber);    
       
   163     
       
   164 private:
       
   165     SmsSettingsPrivate* dptr_smsSettings;
       
   166     MmsSettingsPrivate* dptr_mmsSettings;
       
   167 };
       
   168 
       
   169 #endif /* MSGSETTINGENGINE_H_ */