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
@@ -599,103 +599,136 @@ QString OFileViewFileSystem::directory()const{
         return QString::null;
 
     OFileSelectorItem* item = m_view->currentItem();
     if (!item )
         return QString::null;
 
     return QDir(item->directory() ).absPath();
 }
 void OFileViewFileSystem::reread() {
     if (!m_view)
         return;
 
     m_view->reread( m_all );
 }
 int OFileViewFileSystem::fileCount()const{
     if (!m_view )
         return -1;
     return m_view->fileCount();
 }
 QWidget* OFileViewFileSystem::widget( QWidget* parent ) {
     if (!m_view ) {
         m_view = new OFileViewFileListView( parent, startDirectory(), selector() );
     }
     return m_view;
 }
 void OFileViewFileSystem::activate( const QString& str) {
     m_all =  (str != QObject::tr("Files") );
 
 
 }
 
 /* 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,
                               const MimeTypes& mimetypes,
                               bool showNew,  bool showClose)
     : QWidget( parent, "OFileSelector" )
 {
     m_current = 0;
     m_shNew = showNew;
     m_shClose = showClose;
     m_mimeType = mimetypes;
     m_startDir = dirName;
 
     m_mode = mode;
     m_selector = sel;
 
     initUI();
     m_lneEdit->setText( fileName );
     initMime();
     initViews();
 
     QString str;
     switch ( m_selector ) {
     default:
     case Normal:
         str = QObject::tr("Documents");
         m_cmbView->setCurrentItem( 0 );
         break;
     case Extended:
         str = QObject::tr("Files");
         m_cmbView->setCurrentItem( 1 );
         break;
     case ExtendedAll:
         str = QObject::tr("All Files");
         m_cmbView->setCurrentItem( 2 );
         break;
     }
     slotViewChange( str );
 
 }
+
+/**
+ * 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 )
     : QWidget( parent, name )
 {
     m_current = 0;
     m_shNew   = showNew;
     m_shClose = showClose;
     m_startDir = QPEApplication::documentDir();
 
     if (!mimeFilter.isEmpty() )
         m_mimeType.insert(mimeFilter, QStringList::split(";", mimeFilter ) );
 
     m_mode = OFileSelector::FileSelector;
     m_selector = OFileSelector::Normal;
 
     initUI();
     initMime();
     initViews();
     m_cmbView->setCurrentItem( 0 );
     slotViewChange( QObject::tr("Documents") );
 }
 /*
  * INIT UI will set up the basic GUI
  * Layout: Simple VBoxLayout
  * On top a WidgetStack containing the Views...
  *  - List View
  *  - Document View
  * Below we will have a Label + LineEdit
  * Below we will have two ComoBoxes one for choosing the view one for
  *       choosing the mimetype
  */
 void OFileSelector::initUI() {
@@ -734,104 +767,149 @@ bool OFileSelector::eventFilter (QObject *o, QEvent *e) {
 /*
  * This will insert the MimeTypes into the Combo Box
  * And also connect the changed signal
  *
  * AutoMimeTyping is disabled for now. It used to reparse a dir and then set available mimetypes
  */
 void OFileSelector::initMime() {
     MimeTypes::Iterator it;
     for ( it = m_mimeType.begin(); it != m_mimeType.end(); ++it ) {
         m_cmbMime->insertItem( it.key() );
     }
     m_cmbMime->setCurrentItem( 0 );
 
     connect( m_cmbMime, SIGNAL(activated(int) ),
              this, SLOT(slotMimeTypeChanged() ) );
 
 }
 void OFileSelector::initViews() {
     m_cmbView->insertItem( QObject::tr("Documents") );
     m_cmbView->insertItem( QObject::tr("Files") );
     m_cmbView->insertItem( QObject::tr("All Files") );
     connect(m_cmbView, SIGNAL(activated( const QString& ) ),
             this, SLOT(slotViewChange( const QString& ) ) );
 
 
     m_views.insert( QObject::tr("Documents"), new ODocumentFileView(this) );
 
     /* see above why add both */
     OFileViewInterface* in = new OFileViewFileSystem( this );
     m_views.insert( QObject::tr("Files"), in );
     m_views.insert( QObject::tr("All Files"), in );
 }
+
+/**
+ * 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() {
     DocLnk* lnk = new DocLnk( currentView()->selectedDocument() );
     return lnk;
 }
+
+/**
+ *
+ * @return the name of the selected file
+ */
 QString OFileSelector::selectedName()const{
        return currentView()->selectedName();
 }
+
+/**
+ * @return the selected path
+ */
 QString OFileSelector::selectedPath()const {
     return currentView()->selectedPath();
 }
+
+/**
+ * @return the directory name
+ */
 QString OFileSelector::directory()const {
     return currentView()->directory();
 }
+
+/**
+ * @return a DocLnk for the selected document
+ */
 DocLnk OFileSelector::selectedDocument()const {
     return currentView()->selectedDocument();
 }
+
+/**
+ * @return the number of items for the current view
+ */
 int OFileSelector::fileCount()const {
     return currentView()->fileCount();
 }
+
+/**
+ * @return  reparse the file content
+ */
 void OFileSelector::reread() {
     return currentView()->reread();
 }
 OFileViewInterface* OFileSelector::currentView()const{
     return m_current;
 }
 bool OFileSelector::showNew()const {
     return m_shNew;
 }
 bool OFileSelector::showClose()const {
     return m_shClose;
 }
 MimeTypes OFileSelector::mimeTypes()const {
     return m_mimeType;
 }
+
+/**
+ * @return the Mode of the OFileSelector
+ */
 int OFileSelector::mode()const{
     return m_mode;
 }
+
+/**
+ * @return the Selector of the OFileSelector
+ */
 int OFileSelector::selector()const{
     return m_selector;
 }
 QStringList OFileSelector::currentMimeType()const {
     return m_mimeType[m_cmbMime->currentText()];
 }
 void OFileSelector::slotMimeTypeChanged() {
     reread();
 }
 void OFileSelector::slotDocLnkBridge( const DocLnk& lnk) {
     m_lneEdit->setText( lnk.name() );
     emit fileSelected( lnk );
     emit fileSelected( lnk.name() );
 }
 void OFileSelector::slotFileBridge( const QString& str) {
     DocLnk lnk( str );
     emit fileSelected( lnk );
 }
 void OFileSelector::slotViewChange( const QString& view ) {
     OFileViewInterface* interface = m_views[view];
     if (!interface)
         return;
 
     interface->activate( view );
     if (m_current)
         m_stack->removeWidget( m_current->widget( m_stack ) );
 
     static int id = 1;
 
     m_stack->addWidget( interface->widget(m_stack), id );
     m_stack->raiseWidget( id );