summaryrefslogtreecommitdiff
path: root/libopie/ofiledialog.cc
Side-by-side diff
Diffstat (limited to 'libopie/ofiledialog.cc') (more/less context) (show whitespace changes)
-rw-r--r--libopie/ofiledialog.cc40
1 files changed, 40 insertions, 0 deletions
diff --git a/libopie/ofiledialog.cc b/libopie/ofiledialog.cc
index 4783004..9e725c2 100644
--- a/libopie/ofiledialog.cc
+++ b/libopie/ofiledialog.cc
@@ -35,2 +35,13 @@
+/**
+ * This constructs a modal dialog
+ *
+ * @param caption The caption of the dialog
+ * @param wid The parent widget
+ * @param mode The mode of the OFileSelector @see OFileSelector
+ * @param selector The selector of the OFileSelector
+ * @param dirName the dir or resource to start from
+ * @param fileName a proposed or existing filename
+ * @param mimetypes The mimeTypes
+ */
OFileDialog::OFileDialog(const QString &caption,
@@ -62,2 +73,6 @@ OFileDialog::OFileDialog(const QString &caption,
}
+/**
+ * @returns the mimetype of the selected
+ * currently it return QString::null
+ */
QString OFileDialog::mimetype()const
@@ -66,2 +81,6 @@ QString OFileDialog::mimetype()const
}
+
+/**
+ * @return the fileName
+ */
QString OFileDialog::fileName()const
@@ -70,2 +89,6 @@ QString OFileDialog::fileName()const
}
+
+/**
+ * return a DocLnk to the current file
+ */
DocLnk OFileDialog::selectedDocument()const
@@ -74,2 +97,14 @@ DocLnk OFileDialog::selectedDocument()const
}
+
+/**
+ * This opens up a filedialog in Open mode
+ *
+ * @param selector the Selector Mode
+ * @param startDir Where to start from
+ * @param file A proposed filename
+ * @param mimes A list of MimeTypes
+ * @param wid the parent
+ * @param caption of the dialog if QString::null tr("Open") will be used
+ * @return the fileName or QString::null
+ */
QString OFileDialog::getOpenFileName(int selector,
@@ -90,2 +125,7 @@ QString OFileDialog::getOpenFileName(int selector,
}
+
+/**
+ * This opens up a file dialog in save mode
+ * @see getOpenFileName
+ */
QString OFileDialog::getSaveFileName(int selector,