diff --git a/include/QCefDownloadItem.h b/include/QCefDownloadItem.h index 14861085..16f3b88d 100644 --- a/include/QCefDownloadItem.h +++ b/include/QCefDownloadItem.h @@ -30,113 +30,127 @@ class QCEFVIEW_EXPORT QCefDownloadItem : public QEnableSharedFromThis - /// Destructs the event instance + /// Destructs the download item instance /// ~QCefDownloadItem(); /// - /// + /// Starts the download /// void start(const QString& path, bool useDefaultDialog = true); /// - /// + /// Pauses the download /// void pause() const; /// - /// + /// Resume the download /// void resume() const; /// - /// + /// Cancels the download /// void cancel() const; /// - // Returns true if the download is in progress. + /// Gets whether the download is in progress /// - /// + /// True if the download is in progress; otherwise false bool isInProgress() const; /// - // Returns true if the download is complete. + /// Gets whether the download is complete /// + /// True if the download is complete; otherwise false bool isComplete() const; /// - // Returns true if the download has been canceled or interrupted. + /// Gets whether the download has been canceled or interrupted /// + /// True if the download has been canceled or interrupted; otherwise false bool isCanceled() const; /// - // Returns a simple speed estimate in bytes/s. + /// Gets current download speed /// + /// A simple speed estimate in bytes/s qint64 currentSpeed() const; /// - // Returns the rough percent complete or -1 if the receive total size is - // unknown. + /// Gets the completion percentage /// + /// The rough percent complete or -1 if the receive total size is unknown int percentComplete() const; /// - // Returns the total number of bytes. + /// Gets total number of bytes /// + /// The total number of bytes qint64 totalBytes() const; /// - // Returns the number of received bytes. + /// Gets number of received bytes /// + /// The number of received bytes qint64 receivedBytes() const; /// - // Returns the time that the download started. + /// Gets the time that the download started /// + /// The time that the download started QDateTime startTime() const; /// - // Returns the time that the download ended. + /// Gets the time that the download ended /// + /// The time that the download ended QDateTime endTime() const; /// - // Returns the full path to the downloaded or downloading file. + /// Gets the full path to the downloaded or downloading file /// + /// The full path to the downloaded or downloading file QString fullPath() const; /// - // Returns the unique identifier for this download. + /// Gets the unique identifier for this download /// + /// The unique identifier for this download quint32 id() const; /// - // Returns the URL. + /// Gets the URL /// + /// The the URL QString url() const; /// - // Returns the original URL before any redirections. + /// Gets the original URL before any redirections /// + /// The original URL before any redirections QString originalUrl() const; /// - // Returns the suggested file name. + /// Gets the suggested file name /// + /// The suggested file name QString suggestedFileName() const; /// - // Returns the content disposition. + /// Gets the content disposition /// + /// The the content disposition QString contentDisposition() const; /// - // Returns the mime type. + /// Gets the mime type /// + /// The mime type QString mimeType() const; }; typedef QSharedPointer QCefDownloadItemPointer; -#endif // QCEFDOWNLOADITEM_H +#endif /// QCEFDOWNLOADITEM_H diff --git a/include/QCefView.h b/include/QCefView.h index 61f268ce..067c7654 100644 --- a/include/QCefView.h +++ b/include/QCefView.h @@ -352,13 +352,16 @@ class QCEFVIEW_EXPORT QCefView : public QWidget void reportJavascriptResult(int browserId, qint64 frameId, qint64 context, const QVariant& result); /// - /// Gets called on new download item. + /// Gets called on new download item was required. Keep reference to the download item + /// and call method to allow and start the download, then get the updated + /// information on method. Ignore the download item to disallow the download /// /// The new download item void newDownloadItem(QCefDownloadItemPointer item); /// - /// Gets called on download item updated + /// Gets called on download item updated. To get this method called method must + /// be called in method /// /// The download item void updateDownloadItem(QCefDownloadItemPointer item);