upgrade descriptions and synchronize readme and roadmap

9 files changed, 28 insertions, 118 deletions

diff --git a/libopie2/README b/libopie2/README
index daf6b27..5643d25 100644
--- a/libopie2/README
+++ b/libopie2/README
@@ -1,188 +1,165 @@
 /********************************************************************
 /*     This is an overview of the opielibs2 project
 /********************************************************************/
 
   Origin: opielibs is about creating classes to
           * optimize Qt classes for the embedded environment
           * provide sophisticated abstractions for developers
           * provide complete documentation and working examples
           * provide end users with a common look and feel
           * reduce memory footprint through sharing code
           * reduce possible bugs through reusing tested code
+          * improve the architecture of applications with design patterns
 
 --------------------------------------------------------
 0. Building 
 --------------------------------------------------------
 
 * for QPE run:
 	qmake libopie2.pro
 	make
 
 OR (even better)
 	cd $OPIEDIR
 	make menuconfig
 	make -k
 
 * for QT/X11 run:
 	qmake "platform=x11" libopie2.pro
 	make
 
 Make sure you have set $PLATFORM=x86-linux
 
 --------------------------------------------------------
 1. General Overview
 --------------------------------------------------------
 
 libopie is functionally seperated into the following libraries:
  - libopiecore
  - libopieui
  - libopiepim
  - libopiedb
  - libopienet
  - libopiemm
 
 1.1 Contents of libopiecore [ opiecore ]
 --------------------------------------------------------
 
+ - oapplication
+ - ostorage
+
  - odbgstream
  - ondbgstream
 
  - oprocctrl
  - oprocess
  - odevice
  - odevicebutton
 
  - oconfig
  - oconfiggroupsaver
 
- - ocompletionbase
- - ocompletion
- - ocomptreenodelist
- - ocomptreenode
- - ocompletionwrapper
-
  - oglobal
  - oglobalsettings
 
- - osortableitem
- - osortablevaluelist
-
 1.2 Contents of libopieui [ opieui ]
 --------------------------------------------------------
 
- - oapplication
-
  - ofiledialog
- - colordialog
  - oclickablelabel
  - ocolorbutton
- - colorpopupmenu
  - otabinfo
  - otabbar
  - otabwidget
  - ofontmenu
  - ofontselector
  - ofileview
  - oticker
 
  - olistview
  - olistviewitem
  - oversatileview
  - oversatileviewitem
- - ocompletionbox
- - olineedit
- - ocombobox
- - ohistorycombo
 
  - omessagebox
  - odialogbase
 
- - todayconfigwidget  (rather into opiepim?)
- - orecurrancewidget  (rather into opiepim?)
- - otimepicker        (rather into opiepim?)
+ - okeyconfigwidget
+ - otaskbarapplet
+ - otimepicker
 
 1.3 Contents of libopiepim [ opiepim ]
 --------------------------------------------------------
 
- - ocheckitem
- - todayplugininterface
-
-THIS STUFF IS OUTDATED/DEPRICATED AND SCHOULD NOT
-BE MOVED IN THE NEW LIBRARY !! 
-USE THE CLASSES IN libopie/pim INSTEAD !(eilers)
-
- - todoresource
- - todoevent
- - todovcalresource
+...
 
 1.4 Contents of libopiedb [ opiedb ]
 --------------------------------------------------------
 
- - xmltree
-
-THIS STUFF IS OUTDATED/DEPRICATED AND SCHOULD NOT
-BE MOVED IN THE NEW LIBRARY !! 
-USE THE CLASSES IN libopie/pim INSTEAD !(eilers)
- - tododb
+...
 
 1.5 Contents of libopienet [ opienet ]
 --------------------------------------------------------
 
  - onetwork
  - onetworkinterface
  - owirelessnetworkinterface
  - ochannelhopper
 
  - omonitoring
  - ociscomonitoring
  - owlanngmonitoring
  - ohostapmonitoring
  - oorinocomonitoring
 
  - opacketcapturer
  - opacket
  - oethernetpacket
  - owavelanpacket
  - ollcpacket
  - oippacket
  - oudppacket
  - otcppacket
 
- <libmail stuff>
- <libbend stuff>
- <libftp stuff>
-
 1.6 Contents of libopiemm [ opiemm ]
 --------------------------------------------------------
 
  - osoundsystem
  - oaudiointerface
  - osoundserver
 
 --------------------------------------------------------
 2.0 Feature Description
 --------------------------------------------------------
 
 2.1 libopiecore
 
 ...
 
 2.2 libopieui
 
 ...
 
 2.3 libopiepim
 
 ...
 
 2.4 libopiedb
 
 ...
 
 2.5 libopienet
 
 ...
 
 2.6 libopiemm
 
 ...
+
+--------------------------------------------------------
+3.0 Usage
+--------------------------------------------------------
+
+3.1 Namespaces
+
+
diff --git a/libopie2/ROADMAP b/libopie2/ROADMAP
index 966b67d..1685ba2 100644
--- a/libopie2/ROADMAP
+++ b/libopie2/ROADMAP
@@ -1,6 +1,7 @@
  [done] * import current status of opiecore, opienet and opieui
-        * add contents of libopie1 to libopie2 and functionally split it
-        * make libopie2 a drop-in-replacement for libopie1
+ [done] * add contents of libopie1 to libopie2 and functionally split it
+ [done] * make libopie2 a drop-in-replacement for libopie1
         * add doxygen documentation to all classes
-        * backport qt3-only stuff (?)
+        * add functionality from libqpe to libopie2
+        * make libopie2 a drop-in-replacement for libqpe1
 
diff --git a/libopie2/STATUS b/libopie2/STATUS
deleted file mode 100644
index eb3442c..0000000
--- a/libopie2/STATUS
+++ b/dev/null
@@ -1,68 +0,0 @@
-
-==================================================================
-March 2003 - Initial checkin into the Opie CVS:
-==================================================================
-
-So, this is what I have been working on over the last months.
-It's a part of what I think could migrate into our next generation
-opielibs.
-Of course this won't happen after we released Opie 1.0 and switched
-to Qt3-Embedded and gcc 3.
-
-Right now, there is content only in opiecore, opienet and opieui.
-A good part of code has been adapted from the kdelibs, which overall
-are pretty good however in details of heterogenous quality. I'm also
-not sure if all I ported should be kept, e.g. the pixmapeffect stuff
-seems unnecesary to me. However, we should not forget that Opie will
-make its debut on more powerful devices with greater display
-resolution, e.g. the Sharp C700, so we shouldn't limit ourselves in
-what should go into the libraries.
-
-Generally spoken, a lot of things are still very rough and messy,
-but I will keep improving this. Some details about what is usable
-and what is not follows:
-(everything compiles of course, otherwise I wouldn't have checked in :-)
-
-[-----------]
-[ opiecore ]
-[-----------]
-oapplication, oconfig, oglobal seem to be usable yet, oglobalsettings
-is still very messy and should be revised. A lot more thinking about how
-we should keep opie preferences, especially when moving to multi-user, has to be made.
-This will affect what goes into oglobalsettings and what configuration data
-format we will use. If we switch to Qt3 we will have to decide if we stay
-with OConfig deriving from Config or rewrite it using QSettings.
-
-[-----------]
-[  opiedb  ]
-[-----------]
-There is nothing here yet. The sqlite stuff should be here.
-
-[-----------]
-[ opienet ]
-[-----------]
-onetwork*, omonitoring* and the opacket stuff are pretty usable and not
-very far from being complete. documentation for these will come...
-Over the next days, opie-wellenreiter, opie-wirelessapplet and the
-forthcoming new opie-networkapplet will be using the
-new network classes.
-I think all the other network libraries spread throught opie, e.g.
-libbend, libmail, ftplib should be revised and become part of
-opienet eventually.
-
-[-----------]
-[ opiepim ]
-[-----------]
-Nothing here yet. The stuff currently in libopie/pim should be here.
-
-[-----------]
-[ opieui ]
-[-----------]
-Pretty messy yet, but some things are usable. Unfortunately, the UI
-stuff is very hard to backport to Qt2, so some things only work
-if compiled against Qt3, especially all the popupcompletion stuff.
-OListView however works nice and is currently used in opie-wellenreiter.
-
-==================================================================
-October 2002 - Started work on cornucopia aka opielib2
-==================================================================
\ No newline at end of file
diff --git a/libopie2/opiecore/config.in b/libopie2/opiecore/config.in
index f4483a2..0acde26 100644
--- a/libopie2/opiecore/config.in
+++ b/libopie2/opiecore/config.in
@@ -1,6 +1,6 @@
   config LIBOPIE2CORE
     boolean "libopie2core (application, configuration and debug related classes)"
-    default "n"
+    default "y"
     depends ( LIBQPE || LIBQPE-X11 )
     comment "libopie2core needs a libqpe (yet)"
     depends !( LIBQPE || LIBQPE-X11 )
diff --git a/libopie2/opiedb/config.in b/libopie2/opiedb/config.in
index 0205a83..8039f9c 100644
--- a/libopie2/opiedb/config.in
+++ b/libopie2/opiedb/config.in
@@ -1,7 +1,7 @@
   config LIBOPIE2DB
     boolean "libopie2db (database related classes)"
-    default "n"
+    default "y"
     depends ( LIBQPE || LIBQPE-X11 ) && LIBOPIE2CORE
     comment "libopie2db needs a libqpe and libopie2core"
     depends !(( LIBQPE || LIBQPE-X11 ) && LIBOPIE2CORE)
 
diff --git a/libopie2/opiemm/config.in b/libopie2/opiemm/config.in
index c95d14b..c32e06c 100644
--- a/libopie2/opiemm/config.in
+++ b/libopie2/opiemm/config.in
@@ -1,7 +1,7 @@
   config LIBOPIE2MM
     boolean "libopie2mm (audio and video related classes)"
-    default "n"
+    default "y"
     depends ( LIBQPE || LIBQPE-X11 ) && LIBOPIE2CORE
     comment "libopie2mm needs a libqpe and libopie2core"
     depends !(( LIBQPE || LIBQPE-X11 ) && LIBOPIE2CORE)
 
diff --git a/libopie2/opiepim/config.in b/libopie2/opiepim/config.in
index 2c920bb..33ef9b2 100644
--- a/libopie2/opiepim/config.in
+++ b/libopie2/opiepim/config.in
@@ -1,21 +1,21 @@
   config LIBOPIE2PIM
     boolean "libopie2pim (pim related classes)"
-    default "n"
+    default "y"
     depends ( LIBQPE || LIBQPE-X11 ) && LIBOPIE2CORE
     comment "libopie2pim needs a libqpe and libopie2core"
     depends !(( LIBQPE || LIBQPE-X11 ) && LIBOPIE2CORE )
 
   config SQL_PIM_BACKEND
     boolean "Enable SQL Backend for libopie2pim"
     default n
     help
         This adds the SQL-Support, using SQLite. Which database is used
         by the backends is defined by the file "pimaccess.conf" in the
         directory "Settings".
         There currently do exist to groups "[contact]" and "[todo]". You can
         select the used backend by the variable "usebackend=<type>", where
         <type> is "sql" or "xml". "xml" is the default !
         Important: The SQLite-library "libsqlite.so" must be installed !
     depends ( LIBOPIE2DB )
     comment "SQL-Support needs libopie2db (and libsqlite)"
     depends !( LIBOPIE2DB )
diff --git a/libopie2/opieui/config.in b/libopie2/opieui/config.in
index d40b5d9..9d157a5 100644
--- a/libopie2/opieui/config.in
+++ b/libopie2/opieui/config.in
@@ -1,7 +1,7 @@
   config LIBOPIE2UI
     boolean "libopie2ui (user interface related classes)"
-    default "n"
+    default "y"
     depends ( LIBQPE || LIBQPE-X11 ) && LIBOPIE2CORE
     comment "libopie2ui needs a libqpe and libopie2core"
     depends !(( LIBQPE || LIBQPE-X11 ) && LIBOPIE2CORE)
 
diff --git a/libopie2/opieui/otimepicker.h b/libopie2/opieui/otimepicker.h
index fb20781..894fbef 100644
--- a/libopie2/opieui/otimepicker.h
+++ b/libopie2/opieui/otimepicker.h
@@ -1,129 +1,129 @@
 /*
                              This file is part of the Opie Project
                              Copyright (C) Stefan Eilers <eilers.stefan@epost.de>
               =.             Copyright (C) The Opie Team <opie-devel@handhelds.org>
             .=l.
            .>+-=
  _;:,     .>    :=|.         This program 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 program 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.
 */
 
 #ifndef OTIMEPICKER_H
 #define OTIMEPICKER_H
 
 /* OPIE */
-#include <opie2/oclickablelabel.h>
-#include <opie2/otimepickerbase.h>
+#include "oclickablelabel.h"
+#include "otimepickerbase.h"
 
 /* QT */
 #include <qwidget.h>
 #include <qvaluelist.h>
 #include <qdatetime.h>
 #include <qdialog.h>
 
 
 namespace Opie {
 namespace Ui   {
 
 /**
  * A class to pick time. It uses clickable labels
  * internally to allow a quick selection of a time.
  * A time can be selected by two clicks of a user
  *
  * @short A widget to quickly pick a QTime
  * @version 1.0
  * @see QWidget
  * @see QTime
  * @author Hakan Ardo, Stefan Eilers
  */
 class OTimePicker : public QWidget
 {
     Q_OBJECT
 
 public:
     OTimePicker(QWidget* parent = 0, const char* name = 0, WFlags fl = 0);
 
 public slots:
     void setHour(int h);
     void setMinute(int m);
     void setTime( const QTime& );
     void setTime( int h,  int m );
 
 public:
     QTime time()const;
 
 private:
     QValueList<OClickableLabel *> hourLst;
     QValueList<OClickableLabel *> minuteLst;
     QTime tm;
     struct Private;
     Private *d;
 
 private slots:
     void slotHour(bool b);
     void slotMinute(bool b);
 
 signals:
     /**
      * gets emitted when the time got changed by the user
      */
     void timeChanged(const QTime &);
 };
 
 /**
  *
  * @short A small dialog to pick a time
  * @version 1.0
  * @author Stefan Eilers
  *
  **/
 
 class OTimePickerDialog: public OTimePickerDialogBase
 {
     Q_OBJECT
 
 public:
     OTimePickerDialog ( QWidget* parent = 0, const char* name = NULL, WFlags fl = 0 );
     ~OTimePickerDialog() { };
 
     QTime time()const;
 
 public slots:
     void setTime( const QTime& time );
     void setHour( const QString& hour );
     void setMinute( const QString& minute );
 
 private:
     OTimePicker *m_timePicker;
     QTime m_time;
     class Private;
     Private* d;
 };
 
 }
 }
 
 /* for Qt2  */
 #if ( QT_VERSION-0 >= 0x030000 )
 #error "Fix the UI File to use namespaces"
 #endif
 #endif