--- a/email_plat/nmail_client_api/inc/nmapimailboxlisting.h Thu Sep 30 11:43:07 2010 +0300
+++ b/email_plat/nmail_client_api/inc/nmapimailboxlisting.h Thu Oct 14 17:33:43 2010 +0300
@@ -36,72 +36,21 @@
{
Q_OBJECT
public:
- /*!
- Constructor of class. It set start values.
- */
+
NmApiMailboxListing(QObject *parent);
- /*!
- Destructor of class. It release engine to be safe if manual releasing won't work.
- */
- ~NmApiMailboxListing();
+ virtual ~NmApiMailboxListing();
+ bool getMailboxes(QList<EmailClientApi::NmApiMailbox> &mailboxes);
+ bool isRunning() const;
+
enum {MailboxListingFailed = -1};
- /*!
- \brief Returns results after mailboxesListed signal is received.
-
- Caller gets ownership of mailboxes. Returns true if results were available.
- Before calling this method, cancel and start should be called,
- because after second call it returns empty list.
- At start it clear inputlist of mailboxes.
-
- \return Return true if results were avaible
- \param mailboxes List of mailboxes to filled. On start is cleared.
- */
- bool getMailboxes(QList<EmailClientApi::NmApiMailbox> &mailboxes);
+signals:
- /*!
- \brief Return info if listing is running
-
- \return Return true if listing is running
- */
- bool isRunning() const;
-
- signals:
- /*!
-
- emitted when listing is available, count is number of mailboxes found
- or MailboxListingFailed if listing failed
-
- \param count Count of mailboxes inside class.
- */
void mailboxesListed(qint32 count);
public slots:
- /*!
- \brief Starts gathering mailbox list.
-
- In first turn it will get whole mailboxlist.
- Then it initialize core arguments and emits signal when ready.
-
- To asynchronous operation can be used \sa QTimer::singleShot on this method.
- Example:
- <code>
- QTimer::singleShot(0,nmMailboxListing,SLOT(start());
- </code>
-
- \return Return true if everything go good and core of listing works good.
-
- */
bool start();
-
- /*!
- \brief Stop gathering mailbox list.
-
- In first it change state of listing.
- Then it release engine.
- On end it clears list of mailboxes and emits \sa NmApiMessageTask::canceled() signal.
- */
void cancel();
private: