summaryrefslogtreecommitdiff
path: root/src/frontend/displaywindow/cdisplaywindow.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/frontend/displaywindow/cdisplaywindow.h')
-rw-r--r--src/frontend/displaywindow/cdisplaywindow.h206
1 files changed, 140 insertions, 66 deletions
diff --git a/src/frontend/displaywindow/cdisplaywindow.h b/src/frontend/displaywindow/cdisplaywindow.h
index 6164e94..b23d856 100644
--- a/src/frontend/displaywindow/cdisplaywindow.h
+++ b/src/frontend/displaywindow/cdisplaywindow.h
@@ -20,10 +20,11 @@
class BtActionCollection;
class CDisplay;
-class CDisplaySettingsButton;
+class BtDisplaySettingsButton;
class CKeyChooser;
class CMDIArea;
-class CModuleChooserBar;
+//class CModuleChooserBar;
+class BtModuleChooserBar;
class CReadWindow;
class CSwordModuleInfo;
class CWriteWindow;
@@ -42,105 +43,153 @@ class CDisplayWindow : public QMainWindow, public CPointers {
PlainTextWindow = 2
};
- // Insert the keyboard accelerators of this window into the given KAccel object.
+ /** Insert the keyboard accelerators of this window into the given actioncollection.*/
static void insertKeyboardActions( BtActionCollection* const a );
- CMDIArea* mdi() const;
+ inline CMDIArea *mdi() const {
+ return m_mdi;
+ }
- // Returns the right window caption.
+ /** Returns the correct window caption.*/
const QString windowCaption();
- // Returns the used modules as a QPtrList
+ /** Returns the used modules as a pointer list.*/
QList<CSwordModuleInfo*> modules();
- // Store the settings of this window in the given CProfileWindow object.
+ /** Returns the used modules as a string list. */
+ inline const QStringList &getModuleList() const {
+ return m_modules;
+ }
+
+ /** Store the settings of this window in the given CProfileWindow object.*/
virtual void storeProfileSettings( Profile::CProfileWindow* profileWindow ) = 0;
- // Store the settings of this window in the given profile window.
+ /** Store the settings of this window in the given profile window.*/
virtual void applyProfileSettings( Profile::CProfileWindow* profileWindow ) = 0;
- // Sets the new filter options of this window.
- void setFilterOptions( CSwordBackend::FilterOptions& filterOptions );
-
- // Sets the new display options for this window.
- void setDisplayOptions( const CSwordBackend::DisplayOptions& displayOptions );
-
- // Returns the display options used by this display window.
- CSwordBackend::DisplayOptions& displayOptions();
+ /** Returns the display options used by this display window. */
+ inline const CSwordBackend::DisplayOptions &displayOptions() const {
+ return m_displayOptions;
+ }
- // Returns the filter options used by this window.
- CSwordBackend::FilterOptions& filterOptions();
+ /** Returns the filter options used by this window. */
+ inline const CSwordBackend::FilterOptions &filterOptions() const {
+ return m_filterOptions;
+ }
- // Set the ready status
- void setReady( const bool& ready );
+ /** Set the ready status. */
+ void setReady(bool ready);
- // Returns true if the widget is ready for use.
- bool isReady() const;
+ /** Returns true if the widget is ready for use. */
+ inline bool isReady() const {
+ return m_isReady;
+ }
- // Returns true if the window may be closed.
+ /** Returns true if the window may be closed.*/
virtual bool queryClose();
- // Returns the keychooser widget of this display window.
- CKeyChooser* keyChooser() const;
+ /** Returns the keychooser widget of this display window. */
+ inline CKeyChooser *keyChooser() const {
+ return m_keyChooser;
+ }
- // Sets the new sword key.
+ /** Sets the new sword key.*/
void setKey( CSwordKey* key );
- // Returns the key of this display window.
- CSwordKey* key() const;
+ /** Returns the key of this display window. */
+ inline CSwordKey *key() const {
+ Q_ASSERT(m_swordKey != 0);
+ return m_swordKey;
+ }
- // Initialize the window. Call this method from the outside, because calling this in the constructor is not possible!
+ /**
+ * Initialize the window. Call this method from the outside,
+ * because calling this in the constructor is not possible!
+ */
virtual bool init();
- // Sets the main toolbar.
+ /** Sets and inits the properties of the main navigation toolbar.*/
void setMainToolBar( QToolBar* bar );
- // Sets the buttons toolbar.
+ /** Sets and inits the properties of the tool buttons toolbar.*/
void setButtonsToolBar( QToolBar* bar );
- // Returns the main toolbar.
- QToolBar* mainToolBar() const;
+ /** Returns the main navigation toolbar. */
+ inline QToolBar *mainToolBar() const {
+ return m_mainToolBar;
+ }
- // Returns the buttons toolbar.
- QToolBar* buttonsToolBar() const;
+ /** Returns the tool buttons toolbar. */
+ inline QToolBar *buttonsToolBar() const {
+ return m_buttonsToolBar;
+ }
- // Initialize the toolbars
+ /** Initialize the toolbars.*/
virtual void initToolbars() = 0;
- // Returns the display settings button
- CDisplaySettingsButton* displaySettingsButton() const;
+ /** Returns the display settings button. */
+ inline BtDisplaySettingsButton *displaySettingsButton() const {
+ return m_displaySettingsButton;
+ }
- // Sets the display settings button.
- void setDisplaySettingsButton( CDisplaySettingsButton* button );
+ /** Sets the display settings button.*/
+ void setDisplaySettingsButton( BtDisplaySettingsButton* button );
virtual void setupPopupMenu() = 0;
- // Returns the display widget used by this implementation of CDisplayWindow.
- virtual CDisplay* displayWidget() const;
+ /** Returns the display widget used by this implementation of CDisplayWindow. */
+ virtual inline CDisplay *displayWidget() const {
+ Q_ASSERT(m_displayWidget != 0);
+ return m_displayWidget;
+ }
- // Sets the display widget used by this display window.
+ /** Sets the display widget used by this display window.*/
virtual void setDisplayWidget( CDisplay* newDisplay );
- // Returns whether syncs to the active window are allowed at this time for this display window
- // @return boolean value whether sync is allowed
+ /**
+ * Returns whether syncs to the active window are allowed at this time for this display window
+ * @return boolean value whether sync is allowed
+ */
virtual bool syncAllowed() const {
return false;
};
- BtActionCollection* actionCollection();
-
+ inline BtActionCollection *actionCollection() const {
+ return m_actionCollection;
+ }
+
+ signals:
+ /** The module list was set because backend was reloaded.*/
+ void sigModuleListSet(QStringList modules);
+ /** A module was added to this window.*/
+ void sigModuleAdded(int index, QString module);
+ void sigModuleReplaced(int index, QString newModule);
+ void sigModuleRemoved(int index);
+ /** The module list of window changed but backend list didn't.*/
+ void sigModuleListChanged();
public slots:
-
- // Lookup the specified key in the given module. If the module is not chosen withing
- // this display window create a new displaywindow with the right module in it.
+ /** Receives a signal telling that a module should be added.*/
+ void slotAddModule(int index, QString module);
+ void slotReplaceModule(int index, QString newModule);
+ void slotRemoveModule(int index);
+
+ /**
+ * Lookup the specified key in the given module. If the module is not chosen withing
+ * this display window create a new displaywindow with the right module in it.
+ */
virtual void lookupModKey( const QString& module, const QString& key );
- // Lookup the key in the chosen modules.
+ /** Lookup the key in the chosen modules.*/
virtual void lookupKey( const QString& key );
- // Refresh the settings of this window.
+ /** Refresh the settings of this window.*/
virtual void reload(CSwordBackend::SetupChangedReason reason);
+ void slotShowNavigator(bool show);
+ void slotShowToolButtons(bool show);
+ void slotShowModuleChooser(bool show);
+ void slotShowHeader(bool show);
+
protected:
friend class CMDIArea;
friend class CBibleReadWindow;
@@ -148,39 +197,63 @@ class CDisplayWindow : public QMainWindow, public CPointers {
CDisplayWindow(QList<CSwordModuleInfo*> modules, CMDIArea* parent);
virtual ~CDisplayWindow();
- // Initializes the intern keyboard actions.
+ /** Returns the display options used by this display window. */
+ inline CSwordBackend::DisplayOptions &displayOptions() {
+ return m_displayOptions;
+ }
+
+ /** Returns the filter options used by this window. */
+ inline CSwordBackend::FilterOptions &filterOptions() {
+ return m_filterOptions;
+ }
+
+ /** Initializes the internel keyboard actions.*/
virtual void initActions();
- // Sets the keychooser widget for this display window.
+ /** Sets the keychooser widget for this display window.*/
void setKeyChooser( CKeyChooser* ck );
- // Returns the module chooser bar.
- CModuleChooserBar* moduleChooserBar() const;
+ /** Returns the module chooser bar. */
+ inline BtModuleChooserBar *moduleChooserBar() const {
+ return m_moduleChooserBar;
+ }
- // Lookup the given key.
+ /** Lookup the given key.*/
virtual void lookupSwordKey( CSwordKey* ) = 0;
- // Sets the module chooser bar.
- void setModuleChooserBar( CModuleChooserBar* bar );
+ /** Sets the module chooser bar.*/
+ void setModuleChooserBar( BtModuleChooserBar* bar );
+
+ void setHeaderBar(QToolBar* header);
- // Sets the modules.
+ inline QToolBar *headerBar() const {
+ return m_headerBar;
+ }
+
+ /** Sets the modules. */
void setModules( const QList<CSwordModuleInfo*>& modules );
- // Initializes the signal / slot connections of this display window.
+ /** Initializes the signal / slot connections of this display window.*/
virtual void initConnections() = 0;
- // Initialize the view of this display window.
+ /** Initialize the view of this display window.*/
virtual void initView() = 0;
- // Returns the installed popup menu.
+ /** Returns the installed RMB popup menu.*/
QMenu* popup();
virtual void closeEvent(QCloseEvent* e);
protected slots:
+ /** Sets the new filter options of this window.*/
+ void setFilterOptions(const CSwordBackend::FilterOptions &filterOptions);
+
+ /** Sets the new display options for this window.*/
+ void setDisplayOptions(const CSwordBackend::DisplayOptions &displayOptions);
+
virtual void modulesChanged();
- // Lookup the current key. Used to refresh the display.
+ /** Lookup the current key. Used to refresh the display.*/
void lookup();
virtual void updatePopupMenu();
@@ -203,13 +276,14 @@ class CDisplayWindow : public QMainWindow, public CPointers {
CSwordBackend::FilterOptions m_filterOptions;
CSwordBackend::DisplayOptions m_displayOptions;
- CDisplaySettingsButton* m_displaySettingsButton;
+ BtDisplaySettingsButton* m_displaySettingsButton;
CKeyChooser* m_keyChooser;
CSwordKey* m_swordKey;
bool m_isReady;
- CModuleChooserBar* m_moduleChooserBar;
+ BtModuleChooserBar* m_moduleChooserBar;
QToolBar* m_mainToolBar;
QToolBar* m_buttonsToolBar;
+ QToolBar* m_headerBar;
QMenu* m_popupMenu;
CDisplay* m_displayWidget;
};
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-01 11:03:19 +0000