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:

    15  *

    16  */

    17 

    18 #ifndef UNIEDITORPLUGININTERFACE_H_

    19 #define UNIEDITORPLUGININTERFACE_H_

    20 

    21 #include <QtPlugin>

    22 #include <msvstd.h>

    23 #include <gsmuelem.h>

    24 #include "convergedmessage.h"

    25 

    26 

    27 class UniEditorPluginInterface

    28 {

    29 public:

    30     

    31     /**

    32      * Enum defining EditorOperation 

    33      * @attention This enum can have values from 0 to 2 only.

    34      */

    35     enum EditorOperation

    36     {

    37         Forward = 0,

    38         Reply,

    39         ReplyAll, 

    40         Default 

    41     };

    42 

    43     /**

    44      * Destructor

    45      */

    46     virtual ~UniEditorPluginInterface()

    47     {

    48     }

    49 

    50     /**

    51 	 * Type of the message (SMS/MMS etc..)

    52 	 * @return message type

    53 	 */

    54 	virtual ConvergedMessage::MessageType messageType()=0;

    55 

    56     /**

    57      * Converts message from message store into ConvergedMessage 

    58      * based on the operation

    59      * @param TMsvId id

    60      * @param aOperation operation type

    61      * @return ConvergedMessage object is returned in successfull cases and 

    62      *         NULL is returned in failure cases. The ownership of the object

    63      *         is transferred to the caller. 

    64      */

    65     virtual ConvergedMessage* convertFrom( TMsvId aId,

    66         UniEditorPluginInterface::EditorOperation aOperation

    67         =UniEditorPluginInterface::Default)=0;

    68 

    69     /**

    70      * delete entry from drafts folder

    71      * @param aId TMsvId of the message entry to be deleted

    72      */

    73     virtual void deleteDraftsEntry( TMsvId aId )=0;

    74 

    75     /**

    76      * convert convergedmessage type to messaging f/w message entry

    77      * @param aMessage convergedmessage

    78      * @return message entry id in message store

    79      */

    80     virtual TMsvId convertTo( ConvergedMessage *aMessage ) = 0;

    81 

    82     /**

    83      * send message

    84      * @param aId message entry id in message store

    85      * @return true if client-mtm send is successful else returns false

    86      */

    87     virtual bool send(TMsvId aId) = 0;

    88 

    89     /**

    90      * check if service is valid

    91      * @return true/false

    92      */

    93     virtual TBool isServiceValid() = 0;

    94 

    95     /**

    96      * validate service settings

    97      * @param aEmailOverSms true if email over sms is supported, else false

    98      * @return true/false

    99      */

   100     virtual TBool validateService( TBool aEmailOverSms = EFalse ) = 0;

   101     

   102     /*

   103      * Turkish SMS(PREQ2265) specific...

   104      */

   105     virtual void setEncodingSettings(TBool aUnicodeMode,

   106         TSmsEncoding aAlternativeEncodingType, TInt charSupportType)=0;

   107 

   108     /**

   109      * for deciding on reduced or full charset support

   110      */

   111     virtual bool getNumPDUs(QString& aBuf, TInt& aNumOfRemainingChars,

   112         TInt& aNumOfPDUs, TBool& aUnicodeMode,

   113         TSmsEncoding& aAlternativeEncodingType)=0;

   114 

   115 };

   116 

   117 Q_DECLARE_INTERFACE(UniEditorPluginInterface,

   118         "org.nokia.messaging.UniEditorPluginInterface/1.0")

   119 

   120 

   121 #endif //UNIEDITORPLUGININTERFACE_H_