Add comments about API changes when possible again

Add currentWidget() method and mark it as since 1.2

1 files changed, 9 insertions, 2 deletions

diff --git a/libopie/otabwidget.h b/libopie/otabwidget.h
index c140c0b..acb9223 100644
--- a/libopie/otabwidget.h
+++ b/libopie/otabwidget.h
@@ -1,278 +1,285 @@
 /*
                             This file is part of the Opie Project
 
                              Copyright (c)  2002 Dan Williams <williamsdr@acm.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 OTABWIDGET_H
 #define OTABWIDGET_H
 
 #include "otabinfo.h"
 
 #include <qwidget.h>
 #include <qlist.h>
 
 class OTabBar;
 class QComboBox;
 class QPixmap;
 class QTabBar;
 class QWidgetStack;
 
 /**
  * @class OTabWidget
  * @brief The OTabWidget class provides a stack of widgets.
  *
  * OTabWidget is a derivation of TrollTech's QTabWidget which provides
  * a stack of widgets.  Widgets can be selected using either a tab bar or
  * drop down list box.
  *
  * The normal way to use OTabWidget is to do the following in the
  * constructor:
  * - Create a OTabWidget.
  * - Create a QWidget for each of the pages in the control, insert
  *   children into it, set up geometry management for it, and use addTab()
  *   to add the widget.
  */
 class OTabWidget : public QWidget
 {
     Q_OBJECT
 public:
 
 /**
  * @enum TabStyle
  * @brief Defines how the widget selection control is displayed.
  *
  * Valid values:
  * - Global: use globally selected options (qpe.conf - TabStyle & TabPosition)
  * - TextTab: Tabbed widget selection with text labels
  * - IconTab: Tabbed widget selection with icon labels, text label for active widget
  *            (similar to Opie launcher)
  * - TextList: Drop down list widget selection with text labels
  * - IconList: Drop down list widget selection with icon & text labels
  */
     enum TabStyle { Global, TextTab, IconTab, TextList, IconList };
 
 /**
  * @enum TabPosition
  * @brief Defines where the widget selection control is drawn.
  *
  * Valid values:
  * - Top: Widget selection control is drawn above widgets
  * - Bottom: Widget selection control is drawn below widgets
  */
     enum TabPosition { Top, Bottom };
 
 /**
  * @fn OTabWidget( QWidget *parent = 0, const char *name = 0, TabStyle s = Global, TabPosition p = Top )
  * @brief Object constructor.
  *
  * @param parent Pointer to parent of this control.
  * @param name Name of control.
  * @param s Style of widget selection control.
  * @param p Position of the widget selection control.
  *
  * Constructs a new OTabWidget control with parent and name.  The style and position parameters
  * determine how the widget selection control will be displayed.
  */
  // FIXME WFlags? -zecke
     OTabWidget( QWidget * = 0, const char * = 0, TabStyle = Global, TabPosition = Top );
 
 /**
  * @fn ~OTabWidget()
  * @brief Object destructor.
  */
     ~OTabWidget();
 
 /**
  * @fn addTab( QWidget *child, const QString &icon, const QString &label )
  * @brief Add new widget to control.
  *
  * @param child Widget control.
  * @param icon Path to icon.
  * @param label Text label.
  */
     void addTab( QWidget *, const QString &, const QString & );
 
 /**
  * @fn removePage( QWidget *widget )
  * @brief Remove widget from control.  Does not delete widget.
  *
  * @param widget Widget control to be removed.
  */
+    /* ### Page vs. Tab.. yes the widget is a Page but then is addTab wrong -zecke */
     void removePage( QWidget * );
 
 /**
  * @fn changeTab( QWidget *widget, const QString &icon, const QString &label )
  * @brief Change text and/or icon for existing tab
  *
  * @param child Widget control.
  * @param icon Path to icon.
  * @param label Text label.
  */
     void changeTab( QWidget *, const QString &, const QString & );
 
 /**
  * @fn tabStyle()const
  * @brief Returns current widget selection control style.
  */
     TabStyle tabStyle() const;
 
 /**
  * @fn setTabStyle( TabStyle s )
  * @brief Set the current widget selection control style.
  *
  * @param s New style to be used.
  */
     void setTabStyle( TabStyle );
 
 /**
  * @fn tabPosition()const
  * @brief Returns current widget selection control position.
  */
     TabPosition tabPosition() const;
 
 /**
  * @fn setTabPosition( TabPosition p )
  * @brief Set the current widget selection control position.
  *
  * @param p New position of widget selection control.
  */
     void setTabPosition( TabPosition );
 
 /**
  * @fn setCurrentTab( QWidget *childwidget )
  * @brief Selects and brings to top the desired widget by using widget pointer.
  *
  * @param childwidget Widget to select.
  */
     void setCurrentTab( QWidget * );
 
 /**
  * @fn setCurrentTab( const QString &tabname )
  * @brief Selects and brings to top the desired widget, by using label.
  *
  * @param tabname Text label for widget to select.
  */
     void setCurrentTab( const QString & );
 
 /**
  * @fn setCurrentTab( int )
  * @brief Selects and brings to top the desired widget, by using id.
  *
  * @param tab id for widget to select.
  */
     void setCurrentTab(int);
 
 /**
  * @fn sizeHint()const
  * @brief Reimplemented for internal purposes.
  */
     QSize sizeHint() const;
 
 /**
  * @fn currentTab( )
  * @brief returns current tab id.
  */
-    int currentTab();
-
+    // ### make const
+    int currentTab()/* const */;
+/**
+ * @brief returns the current page of the active tab
+ *
+ * @since 1.2
+ */
+    QWidget* currentWidget()const;
 
 protected:
 
 /**
  * @fn resizeEvent( QResizeEvent * )
  * @brief Reimplemented for internal purposes.
  */
     void resizeEvent( QResizeEvent * );
 
 private:
     OTabInfoList  tabs;
     OTabInfo     *currTab;
 
     TabStyle    tabBarStyle;
     TabPosition tabBarPosition;
 
     QWidgetStack *tabBarStack;
     OTabBar      *tabBar;
     QComboBox    *tabList;
 
     QWidgetStack *widgetStack;
     class Private;
     Private* d;
 
 /**
  * @fn loadSmooth( const QString &name )
  * @brief Loads icon for widget.
  *
  * @param name Name of icon image file.
  */
     QPixmap loadSmooth( const QString & );
 
 /**
  * @fn selectTab( OTabInfo *tab )
  * @brief Internal function to select desired widget.
  *
  * @param tab Pointer to data for widget.
  */
     void    selectTab( OTabInfo * );
 
 /**
  * @fn setUpLayout()
  * @brief Internal function to adjust layout.
  */
     void    setUpLayout();
 
 
 signals:
 /**
  * @fn currentChanegd( QWidget *widget )
  * @brief This signal is emitted whenever the widget has changed.
  *
  * @param widget Pointer to new current widget.
  */
     void currentChanged( QWidget * );
 
 private slots:
 
 /**
  * @fn slotTabBarSelected( int id )
  * @brief Slot which is called when a tab is selected.
  *
  * @param id ID of widget selected.
  */
     void slotTabBarSelected( int );
 
 /**
  * @fn slotTabListSelected( int index )
  * @brief Slot which is called when a drop down selection is made.
  *
  * @param id Index of widget selected.
  */
     void slotTabListSelected( int );
 };
 
 #endif