Add apie comments

QString -> const QString& fix

4 files changed, 9 insertions, 4 deletions

diff --git a/libopie2/opieui/odialog.h b/libopie2/opieui/odialog.h
index 7947dfb..4116ed7 100644
--- a/libopie2/opieui/odialog.h
+++ b/libopie2/opieui/odialog.h
@@ -1,88 +1,89 @@
 /*
                              This file is part of the Opie Project
 
                              (C) 2003 Michael 'Mickey' Lauer <mickey@tm.informatik.uni-frankfurt.de>
               =.
             .=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 ODIALOG_H
 #define ODIALOG_H
 
 class QLayoutItem;
 
 #include <qdialog.h>
 
 /**
  * Dialog with extended nonmodal support and methods for OPIE standard
  * compliance.
  *
  * The @ref marginHint() and @ref spacingHint() sizes shall be used
  * whenever you layout the interior of a dialog. One special note. If
  * you make your own action buttons (OK, Cancel etc), the space
  * beteween the buttons shall be @ref spacingHint(), whereas the space
  * above, below, to the right and to the left shall be @ref marginHint().
  * If you add a separator line above the buttons, there shall be a
  * @ref marginHint() between the buttons and the separator and a
  * @ref marginHint() above the separator as well.
  *
  * @author Michael 'Mickey' Lauer <mickey@tm.informatik.uni-frankfurt.de>
  */
+ // lets fix up Qt instead! Size does matter. -zecke
 
 class ODialog : public QDialog
 {
   Q_OBJECT
 
   public:
 
     /**
      * Constructor.
      *
      * Takes the same arguments as @ref QDialog.
      */
     ODialog(QWidget *parent = 0, const char *name = 0, bool modal = false, WFlags f = 0);
 
     /**
      * Return the number of pixels you shall use between a
      * dialog edge and the outermost widget(s) according to the KDE standard.
      **/
     static int marginHint();
 
     /**
      * Return the number of pixels you shall use between
      * widgets inside a dialog according to the KDE standard.
      */
     static int spacingHint();
 
   private:
     static int mMarginSize;
     static int mSpacingSize;
 
-    //class ODialogPrivate;
-    //ODialogPrivate *d;
+    class ODialogPrivate;
+    ODialogPrivate *d; // d pointer always needed! -zecke
 
 };
 #endif // ODIALOG_H
diff --git a/libopie2/opieui/oimageeffect.h b/libopie2/opieui/oimageeffect.h
index 313ea50..fb4d22d 100644
--- a/libopie2/opieui/oimageeffect.h
+++ b/libopie2/opieui/oimageeffect.h
@@ -1,130 +1,131 @@
 //FIXME: Revise for Opie - do we really need such fancy stuff on PDA's?
 //FIXME: Maybe not on SL5xxx, but surely on C700 :))
+//FIXME: I think we don#t need that -zecke
 
 /* This file is part of the KDE libraries
  Copyright (C) 1998, 1999, 2001, 2002 Daniel M. Duley <mosfet@interaccess.com>
  (C) 1998, 1999 Christian Tibirna <ctibirna@total.net>
  (C) 1998, 1999 Dirk A. Mueller <mueller@kde.org>
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 
 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
 
 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 */
 
 // $Id$
 
 #ifndef OIMAGEEFFECT_H
 #define OIMAGEEFFECT_H
 
 class QImage;
 class QSize;
 class QColor;
 
 /**
  * This class includes various @ref QImage based graphical effects.
  *
  * Everything is
  * static, so there is no need to create an instance of this class. You can
  * just call the static methods. They are encapsulated here merely to provide
  * a common namespace.
  */
 
 class OImageEffect
 {
 public:
     enum GradientType { VerticalGradient, HorizontalGradient,
                         DiagonalGradient, CrossDiagonalGradient,
                         PyramidGradient, RectangleGradient,
                         PipeCrossGradient, EllipticGradient };
     enum RGBComponent { Red, Green, Blue, Gray, All };
 
     enum Lighting {NorthLite, NWLite, WestLite, SWLite,
                    SouthLite, SELite, EastLite, NELite};
 
     enum ModulationType { Intensity, Saturation, HueShift, Contrast };
 
     enum NoiseType { UniformNoise=0, GaussianNoise, MultiplicativeGaussianNoise,
                      ImpulseNoise, LaplacianNoise, PoissonNoise};
 
     enum RotateDirection{ Rotate90, Rotate180, Rotate270 };
 
     /**
      * Create a gradient from color a to color b of the specified type.
      *
      * @param size The desired size of the gradient.
      * @param ca Color a
      * @param cb Color b
      * @param type The type of gradient.
      * @param ncols The number of colors to use when not running on a
      * truecolor display. The gradient will be dithered to this number of
      * colors. Pass 0 to prevent dithering.
      */
     static QImage gradient(const QSize &size, const QColor &ca,
                            const QColor &cb, GradientType type, int ncols=3);
 
     /**
      * Create an unbalanced gradient.
 
      * An unbalanced gradient is a gradient where the transition from
      * color a to color b is not linear, but in this case, exponential.
      *
      * @param size The desired size of the gradient.
      * @param ca Color a
      * @param cb Color b
      * @param type The type of gradient.
      * @param xfactor The x decay length. Use a value between -200 and 200.
      * @param yfactor The y decay length.
      * @param ncols The number of colors. See OPixmapEffect:gradient.
      */
     static QImage unbalancedGradient(const QSize &size, const QColor &ca,
 	    const QColor &cb, GradientType type, int xfactor = 100,
 	    int yfactor = 100, int ncols = 3);
 
     /**
      * Blends a color into the destination image, using an opacity
      * value for blending one into another. Very fast direct pixel
      * manipulation is used.
      *
      * @author Karol Szwed (gallium@kde.org)
      * @param clr source color to be blended into the destination image.
      * @param dst destination image in which the source will be blended into.
      * @param opacity opacity (in percent) which determines how much the source
      *                color will be blended into the destination image.
      * @return The destination image (dst) containing the result.
      */
     static QImage& blend(const QColor& clr, QImage& dst, float opacity);
 
     /**
      * Blend the src image into the destination image, using an opacity
      * value for blending one into another. Very fast direct pixel
      * manipulation is used.
      *
      * @author Karol Szwed (gallium@kde.org)
      * @param src source image to be blended into the destination image.
      * @param dst destination image in which the source will be blended into.
      * @param opacity opacity (in percent) which determines how much the source
      *                image will be blended into the destination image.
      * @return The destination image (dst) containing the result.
      */
     static QImage& blend(QImage& src, QImage& dst, float opacity);
 
      /**
      * Blend the provided image into a background of the indicated color.
diff --git a/libopie2/opieui/olistview.h b/libopie2/opieui/olistview.h
index bafc67c..b62e278 100644
--- a/libopie2/opieui/olistview.h
+++ b/libopie2/opieui/olistview.h
@@ -1,235 +1,235 @@
 /*
                              This file is part of the Opie Project
 
               =.             (C) 2003 Michael 'Mickey' Lauer <mickey@tm.informatik.uni-frankfurt.de>
             .=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 OLISTVIEW_H
 #define OLISTVIEW_H
 
 #include <qcolor.h>
 #include <qlistview.h>
 #include <qpen.h>
 #include <qdatastream.h>
 
 class OListViewItem;
 
 /**
  * A @ref QListView variant featuring visual and functional enhancements
  * like an alternate background for odd rows, an autostretch mode
  * for the width of the widget ( >= Qt 3 only ) and persistence capabilities.
  *
  * @author Michael 'Mickey' Lauer <mickey@tm.informatik.uni-frankfurt.de>
  * @short OListView list/tree widget.
  */
  class OListView: public QListView
 {
   public:
    /**
     * Constructor.
     *
     * The parameters @p parent and @p name are handled by
     * @ref QListView, as usual.
     */
     OListView ( QWidget *parent = 0, const char *name = 0 );
 
    /**
     * Destructor.
     */
     virtual ~OListView();
 
    /**
     * Let the last column fit exactly all the available width.
     */
     void setFullWidth( bool fullWidth );
 
    /**
     * Returns whether the last column is set to fit the available width.
     */
     bool fullWidth() const;
 
    /**
     * Reimplemented for full width support
     */
     virtual int addColumn( const QString& label, int width = -1 );
 
    /**
     * Reimplemented for full width support
     */
     virtual int addColumn( const QIconSet& iconset, const QString& label, int width = -1 );
 
    /**
     * Reimplemented for full width support
     */
     virtual void removeColumn(int index);
 
    /**
     * sets the alternate background background color.
     * This only has an effect if the items are OListViewItems
     *
     * @param c the color to use for every other item. Set to an invalid
     *        color to disable alternate colors.
     */
     void setAlternateBackground( const QColor &c );
 
    /**
     * sets the column separator pen.
     *
     * @param p the pen used to draw the column separator.
     */
     void setColumnSeparator( const QPen &p );
 
    /**
     * @return the alternate background color
     */
     const QColor& alternateBackground() const;
 
    /**
     * @return the column separator pen
     */
     const QPen& columnSeparator() const;
 
    /**
     * create a list view item as child of this object
     * @return the new object
     */
     virtual OListViewItem* childFactory();
 
-    #ifndef QT_NO_DATASTREAM
+#ifndef QT_NO_DATASTREAM
    /**
     * serialize this object to a @ref QDataStream
     * @param s the stream used to serialize this object.
     */
     virtual void serializeTo( QDataStream& s ) const;
 
    /**
     * serialize this object from a @ref QDataStream
     * @param s the stream used to serialize this object.
     */
     virtual void serializeFrom( QDataStream& s );
-    #endif
+#endif
 
   private:
     QColor m_alternateBackground;
     bool m_fullWidth;
     QPen m_columnSeparator;
 };
 
 #ifndef QT_NO_DATASTREAM
 /**
   * \relates QListView
   * Writes a listview to the stream and returns a reference to the stream.
   */
 QDataStream& operator<<( QDataStream& s, const OListView& lv );
 /**
   * \relates QListView
   * Reads a listview from the stream and returns a reference to the stream.
   */
 QDataStream& operator>>( QDataStream& s, OListView& lv );
 #endif // QT_NO_DATASTREAM
 
 //****************************** OListViewItem ******************************************************************
 
 class OListViewItem: public QListViewItem
 {
   public:
     OListViewItem( QListView * parent );
     OListViewItem( QListViewItem * parent );
     OListViewItem( QListView * parent, QListViewItem * after );
     OListViewItem( QListViewItem * parent, QListViewItem * after );
 
     OListViewItem( QListView * parent,
         QString,     QString = QString::null,
         QString = QString::null, QString = QString::null,
         QString = QString::null, QString = QString::null,
         QString = QString::null, QString = QString::null );
 
     OListViewItem( QListViewItem * parent,
         QString,     QString = QString::null,
         QString = QString::null, QString = QString::null,
         QString = QString::null, QString = QString::null,
         QString = QString::null, QString = QString::null );
 
     OListViewItem( QListView * parent, QListViewItem * after,
         QString,     QString = QString::null,
         QString = QString::null, QString = QString::null,
         QString = QString::null, QString = QString::null,
         QString = QString::null, QString = QString::null );
 
     OListViewItem( QListViewItem * parent, QListViewItem * after,
         QString,     QString = QString::null,
         QString = QString::null, QString = QString::null,
         QString = QString::null, QString = QString::null,
         QString = QString::null, QString = QString::null );
 
     virtual ~OListViewItem();
 
     const QColor& backgroundColor();
     bool isAlternate();
     void paintCell( QPainter *p, const QColorGroup &cg, int column, int width, int alignment );
     void init();
 
    /**
     * create a list view item as child of this object
     * @return the new object
     */
     virtual OListViewItem* childFactory();
 
     #ifndef QT_NO_DATASTREAM
    /**
     * serialize this object to or from a @ref QDataStream
     * @param s the stream used to serialize this object.
     */
     virtual void serializeTo( QDataStream& s ) const;
 
    /**
     * serialize this object to or from a @ref QDataStream
     * @param s the stream used to serialize this object.
     */
     virtual void serializeFrom( QDataStream& s );
     #endif
 
   private:
     bool m_known;
     bool m_odd;
 };
 
 #ifndef QT_NO_DATASTREAM
 /**
   * \relates QListViewItem
   * Writes a listview item and all subitems recursively to the stream
   * and returns a reference to the stream.
   */
 QDataStream& operator<<( QDataStream &s, const OListViewItem& lvi );
 /**
   * \relates QListViewItem
   * Reads a listview item from the stream and returns a reference to the stream.
   */
 QDataStream& operator>>( QDataStream &s, OListViewItem& lvi );
 #endif // QT_NO_DATASTREAM
 
 #endif // OLISTVIEW_H
diff --git a/libopie2/opieui/opopupmenu.h b/libopie2/opieui/opopupmenu.h
index 94f05f4..54e4301 100644
--- a/libopie2/opieui/opopupmenu.h
+++ b/libopie2/opieui/opopupmenu.h
@@ -1,128 +1,131 @@
+//FIXME what is ODE? ODE Desktop Environemt? -zecke
+//FIXME do we need titles? space is limited that is only eyecandy? -zecke
+//FIXME keyboard navigation is also not that popular on a PDA might be with a keyboard (tuxphone) -zecke
 /* This file is part of the ODE libraries
    Copyright (C) 2000 Daniel M. Duley <mosfet@kde.org>
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License version 2 as published by the Free Software Foundation.
 
    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.
 */
 #ifndef _OPOPUP_H
 #define _OPOPUP_H
 
 #define INCLUDE_MENUITEM_DEF
 
 /* QT */
 
 #include <qpopupmenu.h>
 
 /* OPIE */
 
 #include <opie2/opixmapeffect.h>
 
 /**
  * Title widget for use in @ref OPopupMenu.
  *
  * You usually don't have to create this manually since
  * @ref OPopupMenu::insertTitle will do it for you, but it is allowed if
  * you wish to customize it's look.
  *
  * @author Daniel M. Duley <mosfet@kde.org>
  * @short OPopupMenu title widget.
  */
 class OPopupTitle : public QWidget
 {
     Q_OBJECT
 
 public:
     /**
      * Constructs a title widget with the user specified gradient, pixmap,
      * and colors.
      */
     OPopupTitle(QWidget *parent=0, const char *name=0);
     /**
      * @deprecated
      * Constructs a title widget with the specified gradient and colors.
      */
     OPopupTitle(OPixmapEffect::GradientType gradient, const QColor &color,
                 const QColor &textColor, QWidget *parent=0,
                 const char *name=0);
     /**
      * @deprecated
      * Constructs a title widget with the specified pixmap and colors.
      */
     OPopupTitle(const OPixmap &background, const QColor &color,
                 const QColor &textColor, QWidget *parent=0,
                 const char *name=0);
     /**
      * Sets the title string and optional icon for the title widget.
      *
      * You will want to call this before inserting into a menu.
      */
     void setTitle(const QString &text, const QPixmap *icon=NULL);
     /**
      * Returns the current title.
      */
     QString title() const { return(titleStr); }
     /**
      * Returns the current icon.
      */
     QPixmap icon() const { return(miniicon); }
 
     QSize sizeHint() const;
 
 public slots:
     /// @since 3.1
     void setText( const QString &text );
     /// @since 3.1
     void setIcon( const QPixmap &pix );
 
 protected:
     void paintEvent(QPaintEvent *ev);
 
     QString titleStr;
     QPixmap miniicon;
     
     // Remove in KDE4
     OPixmapEffect::GradientType grType;
     QPixmap fill;
     QColor fgColor, bgColor, grHigh, grLow;
     bool useGradient;
 
 protected:
     virtual void virtual_hook( int id, void* data );
 private:
     class OPopupTitlePrivate;
     OPopupTitlePrivate *d;
 };
 
 /**
  * OPopupMenu is a class for menus with standard title items and keyboard
  * accessibility for popups with many options and/or varying options. It acts
  * identically to QPopupMenu, with the addition of insertTitle(),
  * changeTitle(), setKeyboardShortcutsEnabled() and
  * setKeyboardShortcutsExecute() methods.
  *
  * The titles support a text string, an icon, plus user defined gradients,
  * colors, and background pixmaps.
  *
  * The keyboard search algorithm is incremental with additional underlining
  * for user feedback.
  *
  * @short A menu with title items.
  * @author Daniel M. Duley <mosfet@kde.org>
  * @author Hamish Rodda <meddie@yoyo.its.monash.edu.au>
  */
 class OPopupMenu : public QPopupMenu {
     Q_OBJECT
 public:
     /**
      * Constructs a OPopupMenu.