Make orientation switch explicit on Symbian, too.
[dorian] / bookview.h
index f1627c4..daf605b 100644 (file)
@@ -6,10 +6,19 @@
 #include <QStringList>
 #include <QHash>
 #include <QImage>
+#include <QPoint>
 
 #include "book.h"
 
+#ifdef Q_OS_SYMBIAN
+#   include "mediakeysobserver.h"
+#endif
+
 class QModelIndex;
+class Progress;
+class QAbstractKineticScroller;
+class ProgressDialog;
+class FlickCharm;
 
 /** Visual representation of a book. */
 class BookView: public QWebView
@@ -18,43 +27,120 @@ class BookView: public QWebView
 
 public:
     explicit BookView(QWidget *parent = 0);
-    virtual ~BookView();
+
+    /** Set current book. */
     void setBook(Book *book);
+
+    /** Get current book. */
     Book *book();
+
+    /** Go to the position decribed by "bookmark". */
     void goToBookmark(const Book::Bookmark &bookmark);
-    void addBookmark();
-    void setLastBookmark();
+
+    /** Add bookmark to book at the current position. */
+    void addBookmark(const QString &note);
+
+    /** Save current reading position into book. */
+    void setLastBookmark(bool fast = false);
+
+    /** Go to given part + part fragment URL. */
+    void goToPart(int part, const QString &fragment);
+
+    /** Go to given fragment URL in current part. */
+    void goToFragment(const QString &fragment);
+
+    /** If grab is true, volume keys will generate act as page up/down. */
+    void grabVolumeKeys(bool grab);
 
 signals:
-    void chapterLoadStart(int index);
-    void chapterLoadEnd(int index);
-    void suppressedMouseButtonPress();
+    /** Part loading started. */
+    void partLoadStart(int index);
+
+    /** Part loading finished. */
+    void partLoadEnd(int index);
+
+    /** Signal progress in reading the book. */
+    void progress(qreal p);
 
 public slots:
+    /** Go to next part. */
     void goPrevious();
+
+    /** Go to previous part. */
     void goNext();
+
+    /** Actions to perform after URL loading finished. */
     void onLoadFinished(bool ok);
+
+    /** Handle settings changes. */
     void onSettingsChanged(const QString &key);
 
+    /** Add QObjects to the main frame. */
+    void addJavaScriptObjects();
+
+    /** Go to previous page. */
+    void goPreviousPage();
+
+    /** Go to next page. */
+    void goNextPage();
+
+    /** Restore saved position after URL loading finished. */
+    void restoreAfterLoad();
+
+    /** Restore book's last reading position. */
+    void restoreLastBookmark();
+
+protected slots:
+#ifdef Q_OS_SYMBIAN
+    /** Observe media keys. */
+    void onMediaKeysPressed(MediaKeysObserver::MediaKeys key);
+#endif
+
 protected:
-    virtual void paintEvent(QPaintEvent *e);
-    virtual void mousePressEvent(QMouseEvent *e);
+    void paintEvent(QPaintEvent *e);
+    void mousePressEvent(QMouseEvent *e);
+    void wheelEvent(QWheelEvent *);
     bool eventFilter(QObject *o, QEvent *e);
+    void timerEvent(QTimerEvent *e);
 
-private:
+    /** Load given part. */
     void loadContent(int index);
-    void addNavigationBar();
-    void extractIcons();
-    void removeIcons();
+
+    /** Get temporary directory for extracting book contents. */
     QString tmpPath();
 
-    int contentIndex;
-    Book *mBook;
-    bool restore;
-    qreal positionAfterLoad;
-    QImage bookmarkImage;
-    bool loaded;
-    bool mousePressed;
+    /** Go to a given (relative) position in current part. */
+    void goToPosition(qreal position);
+
+    /** Show reading progress. */
+    void showProgress();
+
+private:
+    int contentIndex;       /**< Current part in book. */
+    Book *mBook;            /**< Book to show. */
+    bool restorePositionAfterLoad;
+                            /**< If true, restore current position after load. */
+    qreal positionAfterLoad;/**< Position to be restored after load. */
+    bool restoreFragmentAfterLoad;
+                            /**< If true, restore fragment location after load. */
+    QString fragmentAfterLoad;
+                            /**< Fragment location to be restored after load. */
+    QImage bookmarkImage;   /**< Bookmark icon pre-loaded. */
+    bool loaded;            /**< True, if content has been loaded. */
+    bool mousePressed;      /**< Event filter's mouse button state. */
+    bool grabbingVolumeKeys;/**< True, if volume keys should be grabbed. */
+
+#if defined(Q_WS_MAEMO_5) || defined(Q_OS_SYMBIAN)
+    int scrollerMonitor;    /**< ID of timer monitoring kinetic scroll. */
+#endif
+
+#if defined(Q_WS_MAEMO_5)
+    QAbstractKineticScroller *scroller;
+#endif
+
+#if defined(Q_OS_SYMBIAN)
+    FlickCharm *charm;      /**< Kinetic scroller. */
+#endif
 };
 
 #endif // BOOKVIEW_H