Jumbo API documentation update

and some API fixed
ColorDialog is now OColorDialog!!! keep the namespace tidy!
ColorPopupMenu is now OColorPopupMenu!!! keep the namespace tidy
ColorDialog TT couldn't break bc we can so make it const QColor&
OTimePicker add some convience methods

more I might have forgot

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
@@ -4,113 +4,153 @@
            .>+-=
  _;:,     .>    :=|.         This library is free software; you can
 .> <`_,   >  .   <=          redistribute it and/or  modify it under
 :`=1 )Y*s>-.--   :           the terms of the GNU Library General Public
 .="- .-=="i,     .._         License as published by the Free Software
  - .   .-<_>     .<>         Foundation; either version 2 of the License,
      ._= =}       :          or (at your option) any later version.
     .%`+i>       _;_.
     .i_,=:_.      -<s.       This library is distributed in the hope that
      +  .  -:.       =       it will be useful,  but WITHOUT ANY WARRANTY;
     : ..    .:,     . . .    without even the implied warranty of
     =_        +     =;=|`    MERCHANTABILITY or FITNESS FOR A
   _.=:.       :    :=>`:     PARTICULAR PURPOSE. See the GNU
 ..}^=.=       =       ;      Library General Public License for more
 ++=   -.     .`     .:       details.
  :     =  ...= . :.=-
  -.   .:....=;==+<;          You should have received a copy of the GNU
   -_. . .   )=.  =           Library General Public License along with
     --        :-=`           this library; see the file COPYING.LIB.
                              If not, write to the Free Software Foundation,
                              Inc., 59 Temple Place - Suite 330,
                              Boston, MA 02111-1307, USA.
 
 */
 
 #include <qpe/applnk.h>
 #include <qstring.h>
 #include <qapplication.h>
 #include <qlayout.h>
 
 #include "ofiledialog.h"
 
+/**
+ * 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,
 			 QWidget *wid, int mode, int selector,
 			 const QString &dirName,
 			 const QString &fileName,
 			 const QMap<QString,QStringList>& mimetypes )
   : QDialog( wid, "OFileDialog", true )
 {
   //  QVBoxLayout *lay = new QVBoxLayout(this);
   //showMaximized();
   QVBoxLayout *lay = new QVBoxLayout(this );
   file = new OFileSelector(this , mode, selector,
 			   dirName, fileName,
 			   mimetypes );
   lay->addWidget( file );
 
   //lay->addWidget( file );
   //showFullScreen();
   setCaption( caption.isEmpty() ? tr("FileDialog") : caption );
   connect(file, SIGNAL(fileSelected(const QString&) ),
 	  this, SLOT(slotFileSelected(const QString&) ) );
 
   connect(file, SIGNAL(dirSelected(const QString &) ),
 	  this, SLOT(slotDirSelected(const QString &) ) );
 
 
   file->setYesCancelVisible( false );  // relayout
 }
+/**
+ * @returns the mimetype of the selected
+ * currently it return QString::null
+ */
 QString OFileDialog::mimetype()const
 {
   return QString::null;
 }
+
+/**
+ * @return the fileName
+ */
 QString OFileDialog::fileName()const
 {
   return file->selectedName();
 }
+
+/**
+ * return a DocLnk to the current file
+ */
 DocLnk OFileDialog::selectedDocument()const
 {
   return file->selectedDocument();
 }
+
+/**
+ * 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,
 				     const QString &startDir,
 				     const QString &file,
 				     const MimeTypes &mimes,
 				     QWidget *wid,
 				     const QString &caption )
 {
   QString ret;
   OFileDialog dlg( caption.isEmpty() ? tr("Open") : caption,
 		   wid, OFileSelector::OPEN, selector, startDir, file, mimes);
   dlg.showMaximized();
   if( dlg.exec() )
     ret = dlg.fileName();
 
   return ret;
 }
+
+/**
+ * This opens up a file dialog in save mode
+ * @see getOpenFileName
+ */
 QString OFileDialog::getSaveFileName(int selector,
 				  const QString &startDir,
 				  const QString &file,
 				  const MimeTypes &mimes,
 				  QWidget *wid,
 				  const QString &caption )
 {
   QString ret;
   OFileDialog dlg( caption.isEmpty() ? tr("Save") : caption,
 		   wid, OFileSelector::SAVE, selector, startDir, file, mimes);
   dlg.showMaximized();
   if( dlg.exec() )
     ret = dlg.fileName();
 
   return ret;
 }
 
 void OFileDialog::slotFileSelected(const QString & )
 {
   accept();
 }
 void OFileDialog::slotDirSelected(const QString & )
 {
   // if mode
   //accept();
 }