-rw-r--r-- | libopie/ofileselector.cpp | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/libopie/ofileselector.cpp b/libopie/ofileselector.cpp index 577e916..9afe9c7 100644 --- a/libopie/ofileselector.cpp +++ b/libopie/ofileselector.cpp @@ -630,2 +630,31 @@ 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, @@ -669,2 +698,6 @@ 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, @@ -765,2 +798,6 @@ void OFileSelector::initViews() { } + +/** + * d'tor + */ OFileSelector::~OFileSelector() { @@ -768,2 +805,10 @@ OFileSelector::~OFileSelector() { } + +/** + * Convience function for the fileselector + * make sure to delete the DocLnk + * + * @see DocLnk + * @todo remove in ODP + */ const DocLnk* OFileSelector::selected() { @@ -772,2 +817,7 @@ const DocLnk* OFileSelector::selected() { } + +/** + * + * @return the name of the selected file + */ QString OFileSelector::selectedName()const{ @@ -775,2 +825,6 @@ QString OFileSelector::selectedName()const{ } + +/** + * @return the selected path + */ QString OFileSelector::selectedPath()const { @@ -778,2 +832,6 @@ QString OFileSelector::selectedPath()const { } + +/** + * @return the directory name + */ QString OFileSelector::directory()const { @@ -781,2 +839,6 @@ QString OFileSelector::directory()const { } + +/** + * @return a DocLnk for the selected document + */ DocLnk OFileSelector::selectedDocument()const { @@ -784,2 +846,6 @@ DocLnk OFileSelector::selectedDocument()const { } + +/** + * @return the number of items for the current view + */ int OFileSelector::fileCount()const { @@ -787,2 +853,6 @@ int OFileSelector::fileCount()const { } + +/** + * @return reparse the file content + */ void OFileSelector::reread() { @@ -802,2 +872,6 @@ MimeTypes OFileSelector::mimeTypes()const { } + +/** + * @return the Mode of the OFileSelector + */ int OFileSelector::mode()const{ @@ -805,2 +879,6 @@ int OFileSelector::mode()const{ } + +/** + * @return the Selector of the OFileSelector + */ int OFileSelector::selector()const{ |