Engauge Digitizer  2
ChecklistGuide.h
1 /******************************************************************************************************
2  * (C) 2014 markummitchell@github.com. This file is part of Engauge Digitizer, which is released *
3  * under GNU General Public License version 2 (GPLv2) or (at your option) any later version. See file *
4  * LICENSE or go to gnu.org/licenses for details. Distribution requires prior written permission. *
5  ******************************************************************************************************/
6 
7 #ifndef CHECKLIST_GUIDE_H
8 #define CHECKLIST_GUIDE_H
9 
10 #include <QDockWidget>
11 
13 class CmdMediator;
14 
16 class ChecklistGuide : public QDockWidget
17 {
18  Q_OBJECT;
19 
20  public:
22  ChecklistGuide (QWidget *parent);
23 
25  bool browserIsEmpty () const;
26 
28  virtual void closeEvent(QCloseEvent *event);
29 
31  void setTemplateHtml (const QString &html,
32  const QStringList &curveNames);
33 
35  void update (const CmdMediator &cmdMediator,
36  bool documentIsExported);
37 
38  signals:
40  void signalChecklistClosed();
41 
42  private:
43  ChecklistGuide ();
44 
45  // Display information using html, which is possible with QTextBrowser, so images can be embedded. Although the
46  // format is structured as a tree, a tree widget is not used since tree widgets are not compatible with embedded images
47  // (other than optional tree item icons on the left)
48  ChecklistGuideBrowser *m_browser;
49 };
50 
51 #endif // CHECKLIST_GUIDE_H
Dockable text window containing checklist guide.
void signalChecklistClosed()
Signal that this QDockWidget was just closed.
Class that adds rudimentary tree collapse/expand functionality to QTextBrowser.
virtual void closeEvent(QCloseEvent *event)
Catch close event so corresponding menu item in MainWindow can be updated accordingly.
Command queue stack.
Definition: CmdMediator.h:23
void update(const CmdMediator &cmdMediator, bool documentIsExported)
Update using current CmdMediator/Document state.
bool browserIsEmpty() const
When browser is empty, it is pointless to show it.
void setTemplateHtml(const QString &html, const QStringList &curveNames)
Populate the browser with template html.