| -rw-r--r-- | libopie2/opieui/fileselector/ofileselector.cpp | 72 | ||||
| -rw-r--r-- | libopie2/opieui/fileselector/ofileselector.h | 60 |
2 files changed, 131 insertions, 1 deletions
diff --git a/libopie2/opieui/fileselector/ofileselector.cpp b/libopie2/opieui/fileselector/ofileselector.cpp index 71d765c..600daff 100644 --- a/libopie2/opieui/fileselector/ofileselector.cpp +++ b/libopie2/opieui/fileselector/ofileselector.cpp @@ -812,4 +812,33 @@ void OFileViewFileSystem::activate( const QString& str) /* Selector */ +/** + * @short new and complete c'tor + * + * Create a OFileSelector to let the user select a file. It can + * either be used to open a file, select a save name in a dir or + * as a dropin for the FileSelector. + * + * <pre> + * QMap<QString, QStringList> mimeTypes; + * QStringList types; + * types << "text@slash* "; + * types << "audio@slash*"; + * mimeTypes.insert( tr("Audio and Text"), types ); + * mimeTypes.insert( tr("All"), "*@slash*); + * + * now you could create your fileselector + * </pre> + * + * + * @param parent the parent of this widget + * @param mode The mode from the enum Mode (Open,Save,FILESELECTOR) + * @param sel The selector to be used + * @param dirName The name of the dir to start int + * @param fileName The fileName placed in the fileselector lineedit + * @param mimetypes The MimeType map of used mimetypes + * @param showNew Show a New Button. Most likely to be used in the FileSelector view. + * @param showClose Show a Close Button. Most likely to be used in FileSelector view. + * + */ OFileSelector::OFileSelector( QWidget* parent, int mode, int sel, const QString& dirName, const QString& fileName, @@ -853,4 +882,8 @@ OFileSelector::OFileSelector( QWidget* parent, int mode, int sel, } + +/** + * This a convience c'tor to just substitute the use of FileSelector + */ OFileSelector::OFileSelector( const QString& mimeFilter, QWidget* parent, const char* name, bool showNew, bool showClose ) @@ -959,8 +992,20 @@ void OFileSelector::initViews() } +/** + * d'tor + */ OFileSelector::~OFileSelector() { } + + +/** + * Convience function for the fileselector + * make sure to delete the DocLnk + * + * @see DocLnk + * @todo remove in ODP + */ const DocLnk* OFileSelector::selected() { @@ -969,4 +1014,8 @@ const DocLnk* OFileSelector::selected() } +/** + * + * @return the name of the selected file + */ QString OFileSelector::selectedName()const { @@ -974,4 +1023,8 @@ QString OFileSelector::selectedName()const } + +/** + * @return the selected path + */ QString OFileSelector::selectedPath()const { @@ -979,4 +1032,7 @@ QString OFileSelector::selectedPath()const } +/** + * @return the directory name + */ QString OFileSelector::directory()const { @@ -984,4 +1040,7 @@ QString OFileSelector::directory()const } +/** + * @return a DocLnk for the selected document + */ DocLnk OFileSelector::selectedDocument()const { @@ -989,4 +1048,7 @@ DocLnk OFileSelector::selectedDocument()const } +/** + * @return the number of items for the current view + */ int OFileSelector::fileCount()const { @@ -994,4 +1056,7 @@ int OFileSelector::fileCount()const } +/** + * @return reparse the file content + */ void OFileSelector::reread() { @@ -1019,4 +1084,7 @@ MimeTypes OFileSelector::mimeTypes()const } +/** + * @return the Mode of the OFileSelector + */ int OFileSelector::mode()const { @@ -1024,4 +1092,8 @@ int OFileSelector::mode()const } + +/** + * @return the Selector of the OFileSelector + */ int OFileSelector::selector()const { diff --git a/libopie2/opieui/fileselector/ofileselector.h b/libopie2/opieui/fileselector/ofileselector.h index 7abe8b7..7fa657b 100644 --- a/libopie2/opieui/fileselector/ofileselector.h +++ b/libopie2/opieui/fileselector/ofileselector.h @@ -59,4 +59,16 @@ class OFileViewInterface; class OFileViewFileListView; + +/** + * @short a dropin replacement for the FileSelector + * + * This class is first used insert the OFileDialog. + * It supports multiple view and mimetype filtering for now. + * + * @see OFileDialog + * @see FileSelector + * @author zecke + * @version 0.1 + */ class OFileSelector : public QWidget { @@ -66,6 +78,18 @@ class OFileSelector : public QWidget public: + /** + * The Mode of the Fileselector + * Open = Open A File + * Save = Save a File + * FILESELECTOR = As A GUI in a screen to select a file + */ enum Mode { Open=1, Save=2, FileSelector=4, OPEN=1, SAVE=2, FILESELECTOR=4 }; // enum OldMode { OPEN=1, SAVE=2, FILESELECTOR = 4 }; + /** + * Normal = The old FileSelector + * Extended = Dir View + * ExtendedAll = Dir View with all hidden files + * Default = What the vendor considers best + */ enum Selector { Normal = 0, Extended=1, ExtendedAll =2, Default=3, NORMAL=0,EXTENDED=1, EXTENDED_ALL =2, DEFAULT=3 }; // enum OldSelector { NORMAL = 0, EXTENDED =1, EXTENDED_ALL = 2}; @@ -95,15 +119,49 @@ public: int selector()const; - + /** + * Set the Icon visible + * @param b Show or Hide the New Button + */ void setNewVisible( bool b ); + + /** + * Set the Icon visible + */ void setCloseVisible( bool b ); + + /** + * Set the Name Line visible + */ void setNameVisible( bool b ); signals: + /** + * dirSelected is emitted whenever changed into a different dir + */ void dirSelected( const QString& ); + + /** + * fileSelected is emitted when a file is selected + * it uses a DocLnk as parameter + */ void fileSelected( const DocLnk& ); + + /** + * fileSelected is emitted when a file is selected + * the complete path is a parameter + */ void fileSelected( const QString& ); + + /** + * Create a new File with a DocLnk + */ void newSelected( const DocLnk& ); + void closeMe(); + + /** + * Ok is emitted on a Qt::Key_Return or Q::Key_Enter + * in the line edit + */ void ok(); void cancel(); |