contacts_plat/logs_engine_api/inc/logsabstractmodel.h
changeset 24 0ba2181d7c28
equal deleted inserted replaced
0:e686773b3f54 24:0ba2181d7c28
       
     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 LOGSABSTRACTMODEL_H
       
    19 #define LOGSABSTRACTMODEL_H
       
    20 
       
    21 #include <QAbstractListModel>
       
    22 #include <logsexport.h>
       
    23 
       
    24 class LogsEvent;
       
    25 class LogsDbConnector;
       
    26 class LogsModelItemContainer;
       
    27 class HbIcon;
       
    28 
       
    29 /**
       
    30  * Abstract logs model.
       
    31  *
       
    32  */
       
    33 class LogsAbstractModel : public QAbstractListModel 
       
    34 {
       
    35     Q_OBJECT
       
    36     
       
    37 public:
       
    38     
       
    39     /**
       
    40      * Additional data role types.
       
    41      */
       
    42     enum LogsModelRole {
       
    43            RoleFullEvent = Qt::UserRole + 1, // LogsEvent
       
    44            RoleCall,                         // LogsCall
       
    45            RoleMessage,                      // LogsMessage
       
    46            RoleContact,                      // LogsContact
       
    47            RoleDetailsModel,                 // LogsDetailsModel
       
    48            RoleBaseLast                      // Child classes may define roles above this val
       
    49     };
       
    50 
       
    51 public:
       
    52     
       
    53     ~LogsAbstractModel();
       
    54     
       
    55 public:
       
    56     
       
    57     static QString directionIconName(const LogsEvent& event);
       
    58     static QString typeIconName(const LogsEvent& event);
       
    59         
       
    60     /**
       
    61      * Fills iconList based on the event.
       
    62      * @param event, 
       
    63      * @param iconList, on return contains list of icons 
       
    64      */
       
    65     void getDecorationData(const LogsEvent& event, QList<QVariant>& iconList) const;
       
    66     
       
    67     LogsDbConnector* dbConnector();
       
    68     
       
    69 protected:
       
    70 
       
    71     QVariant doGetData(int role, const LogsModelItemContainer& item) const;
       
    72     
       
    73     virtual QVariant createCall(const LogsModelItemContainer& item) const;
       
    74     virtual QVariant createMessage(const LogsModelItemContainer& item) const;
       
    75     virtual QVariant createContact(const LogsModelItemContainer& item) const;
       
    76       
       
    77     explicit LogsAbstractModel();
       
    78     
       
    79 protected: //data 
       
    80     
       
    81     LogsDbConnector* mDbConnector;
       
    82     QMap<QString, HbIcon*> mIcons;
       
    83     
       
    84 private:  // Testing related friend definitions
       
    85     
       
    86     friend class UT_LogsModel;
       
    87     friend class UT_LogsDetailsModel;
       
    88     friend class UT_LogsFilter;
       
    89     friend class UT_LogsCustomFilter;
       
    90     
       
    91 };
       
    92 
       
    93 
       
    94 /**
       
    95  * Specialized model may contain other model items than log events.
       
    96  */
       
    97 class LogsModelItemContainer {
       
    98 public:
       
    99     LogsModelItemContainer(LogsEvent* event = 0);
       
   100     virtual ~LogsModelItemContainer();
       
   101     LogsEvent* event() const;
       
   102 
       
   103 protected:
       
   104     LogsEvent* mEvent; // not owned
       
   105 };
       
   106 
       
   107 #endif //LOGSABSTRACTMODEL_H