email_plat/nmail_client_api/inc/nmapifolder.h
changeset 76 38bf5461e270
parent 74 6c59112cfd31
equal deleted inserted replaced
74:6c59112cfd31 76:38bf5461e270
    21 #include <QExplicitlySharedDataPointer>
    21 #include <QExplicitlySharedDataPointer>
    22 #include <QList>
    22 #include <QList>
    23 #include <nmapidef.h>
    23 #include <nmapidef.h>
    24 #include <nmapicommon.h>
    24 #include <nmapicommon.h>
    25 
    25 
    26 /*!
       
    27    Mailbox metadata class
       
    28  */
       
    29 namespace EmailClientApi
    26 namespace EmailClientApi
    30 {
    27 {
    31 
    28 
    32 class NmApiFolderPrivate;
    29 class NmApiFolderPrivate;
    33 
    30 
    34 class NMAPI_EXPORT NmApiFolder
    31 class NMAPI_EXPORT NmApiFolder
    35 {
    32 {
    36 public:
    33 public:
    37     /*!
    34 
    38        constructor for NmApiFolder class
       
    39      */
       
    40     NmApiFolder();
    35     NmApiFolder();
    41     
       
    42     /*!
       
    43         Copy constructor for NmApiFolder 
       
    44      */
       
    45     NmApiFolder(const NmApiFolder &nmApiFolder);
    36     NmApiFolder(const NmApiFolder &nmApiFolder);
    46     
       
    47     /*!
       
    48        destructor for NmApiFolder class
       
    49      */
       
    50     virtual ~NmApiFolder();
    37     virtual ~NmApiFolder();
    51 
       
    52     /*!
       
    53        Assigns data from \a folder
       
    54      */
       
    55     NmApiFolder &operator=(const NmApiFolder &folder);
    38     NmApiFolder &operator=(const NmApiFolder &folder);
    56     
       
    57     /*!
       
    58        Compares data from \a folder
       
    59      */
       
    60     bool operator==(const NmApiFolder &folder);
    39     bool operator==(const NmApiFolder &folder);
    61     
       
    62     /*!
       
    63        getter for id
       
    64      */
       
    65     quint64 id() const;
    40     quint64 id() const;
    66 
       
    67     /*!
       
    68        getter for name 
       
    69      */
       
    70     QString name() const;
    41     QString name() const;
    71 
       
    72     /*!
       
    73        getter for foldertype
       
    74      */
       
    75     EmailClientApi::NmApiEmailFolderType folderType() const;
    42     EmailClientApi::NmApiEmailFolderType folderType() const;
    76 
       
    77     /*!
       
    78        setter for id
       
    79      */
       
    80     void setId(quint64 id);
    43     void setId(quint64 id);
    81 
       
    82     /*!
       
    83        setter for name
       
    84      */
       
    85     void setName(const QString &name);
    44     void setName(const QString &name);
    86 
       
    87     /*!
       
    88        setter for foldertype
       
    89      */
       
    90     void setFolderType(EmailClientApi::NmApiEmailFolderType folderType);
    45     void setFolderType(EmailClientApi::NmApiEmailFolderType folderType);
    91 
       
    92     /*!
       
    93        setter for childfolder ids
       
    94      */
       
    95     void setChildFolderIds(QList<quint64> &childFolderIds);
    46     void setChildFolderIds(QList<quint64> &childFolderIds);
    96 
       
    97     /*!
       
    98        setter for childfolder ids
       
    99      */
       
   100     void setParentFolderId(quint64 parentId);
    47     void setParentFolderId(quint64 parentId);
   101 
       
   102     /*!
       
   103        returns child folder ids.
       
   104        to be implemented later when nmail functionality is available
       
   105      */
       
   106     void getChildFolderIds(QList<quint64> &childFolderIds);
    48     void getChildFolderIds(QList<quint64> &childFolderIds);
   107 
       
   108     /*!
       
   109        returns parent folder id.
       
   110        
       
   111      */
       
   112     quint64 parentFolderId() const;
    49     quint64 parentFolderId() const;
   113 
    50 
   114 private:
    51 private:
   115     QExplicitlySharedDataPointer<NmApiFolderPrivate> d;
    52     QExplicitlySharedDataPointer<NmApiFolderPrivate> d;
   116 };
    53 };