1 files changed, 55 insertions, 60 deletions

diff --git a/src/frontend/keychooser/cscrollbutton.h b/src/frontend/keychooser/cscrollbutton.h
index 3a38f37..3af4ca8 100644
--- a/src/frontend/keychooser/cscrollbutton.h
+++ b/src/frontend/keychooser/cscrollbutton.h
@@ -2,84 +2,79 @@
 *
 * This file is part of BibleTime's source code, http://www.bibletime.info/.
 *
-* Copyright 1999-2008 by the BibleTime developers.
+* Copyright 1999-2009 by the BibleTime developers.
 * The BibleTime source code is licensed under the GNU General Public License version 2.0.
 *
 **********/
 
-
-
 #ifndef CSRCOLLBUTTON_H
 #define CSRCOLLBUTTON_H
 
-
 #include <QToolButton>
 
-
 class QMouseEvent;
 class QWidget;
 class QMouseEvent;
 class QWheelEvent;
 
-/** This Class implements the direct chooser button used in the KeyChooser Widget
-  * @author The BibleTime team
-  */
-class CScrollButton : public QToolButton  {
-	Q_OBJECT
-public:
-	/**
-	* The constructor
-	*/
-	CScrollButton(QWidget *parent=0);
-	bool isLocked() const;
+/**
+* This Class implements the direct chooser button used in the KeyChooser Widget.
+* \author The BibleTime team.
+*/
+class CScrollButton: public QToolButton {
+    Q_OBJECT
+    public:
+        CScrollButton(QWidget *parent = 0);
+        virtual ~CScrollButton();
+
+    signals:
+        /**
+        * \brief The lock() signal is emitted when the button grabs the mouse
+        *        and enters the locked state.
+        */
+        void lock();
+
+        /**
+        * \brief The unlock() signal is emitted when the button releases the
+        *        leaves the locked state.
+        */
+        void unlock();
+
+        /**
+        * \brief Indicates a change the user made by moving the mouse.
+        *
+        * \param count the number of items to be changed in the KeyChooser
+        *              ComboBox.
+        */
+        void change_requested(int count);
 
-signals:
-	/**
-	* is emitted when the button enters locked state
-	*/
-	void lock()
-		;
-	/**
-	* is emitted when the button leaves locked state
-	*/
-	void unlock();
-	/**
-	* indicates a change the user made by moving the mouse
-	* @param count the number of items to be changed in the KeyChooser ComboBox
-	*/
-	void change_requested(int count);
+    protected:
+        /**
+        * \brief Grabs the mouse on left button click and emits lock().
+        */
+        virtual void mousePressEvent(QMouseEvent *e);
 
-protected slots:
-	/*
-	* used to process the button press events
-	*/
-	void was_pressed();
-	/**
-	* used to process the button release events
-	*/
-	void was_released();
+        /**
+        * \brief If the mouse is grabbed and we release the left mouse button,
+        *        releases the mouse and emits unlock().
+        */
+        virtual void mouseReleaseEvent(QMouseEvent *e);
 
-protected:
-	/**
-	* Reimplementation from @ref QWidget#mouseMoveEvent - processes
-	* the mouse move events
-	*/
-	virtual void mouseMoveEvent( QMouseEvent* e );
-	/**
-	* used to find the lock point - the middle of the button
-	* @return the lock point
-	*/
-	const QPoint get_lock_Point() const;
+        /**
+        * \brief Reimplementation from \ref QWidget#mouseMoveEvent - processes
+        *        the mouse move events
+        */
+        virtual void mouseMoveEvent(QMouseEvent *e);
 
-private:
-	/**
-	* Indicates whether the button is in locked state or not
-	*/
-	bool m_isLocked;
-	/**
-	* stores the lock point
-	*/
-	QPoint lock_Point;
+    protected:
+        /**
+        * \brief Indicates whether the button is in locked state or not.
+        *
+        * If the button is in the locked state, this means the mouse is grabbed
+        * and any mouse move events invoke calculation about whether to emit the
+        * \ref CScrollButton#change_requested signal.
+        */
+        bool m_isLocked;
 };
 
 #endif