From 6b452ea0757414965fa00bfb7285f7d687c9c8d0 Mon Sep 17 00:00:00 2001 From: mread Date: Tue, 9 Nov 2010 13:02:56 +0000 Subject: documentation for QFileOpenEvent::openFile Task-number: QTBUG-15015 Reviewed-by: Shane Kearns --- src/gui/kernel/qevent.cpp | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/gui/kernel/qevent.cpp b/src/gui/kernel/qevent.cpp index 8a67b91..8f2e6cb 100644 --- a/src/gui/kernel/qevent.cpp +++ b/src/gui/kernel/qevent.cpp @@ -3098,6 +3098,17 @@ QUrl QFileOpenEvent::url() const return reinterpret_cast(d)->url; } +/*! + \fn void openFile(QFile &file, QIODevice::OpenMode flags) const + + Opens a QFile on the file referenced by this event. + This is necessary as some files cannot be opened with the filename alone, but require specific + information stored in this event. + For example, if this QFileOpenEvent contains a request to open a Symbian data caged file, + this function must be used to open a QFile on it. + + \since 4.8 +*/ void QFileOpenEvent::openFile(QFile &file, QIODevice::OpenMode flags) const { file.setFileName(f); -- cgit v0.12