ChecklistGuide.h

Go to the documentation of this file.

/******************************************************************************************************
 * (C) 2014 markummitchell@github.com. This file is part of Engauge Digitizer, which is released      *
 * under GNU General Public License version 2 (GPLv2) or (at your option) any later version. See file *
 * LICENSE or go to gnu.org/licenses for details. Distribution requires prior written permission.     *
 ******************************************************************************************************/
 
#ifndef CHECKLIST_GUIDE_H
#define CHECKLIST_GUIDE_H
 
#include <QDockWidget>
 
class ChecklistGuideBrowser;
class CmdMediator;

class ChecklistGuide : public QDockWidget
{
  Q_OBJECT;
 
 public:
  ChecklistGuide (QWidget *parent);

  bool browserIsEmpty () const;

  virtual void closeEvent(QCloseEvent *event);

  void setTemplateHtml (const QString &html,
                        const QStringList &curveNames);

  void update (const CmdMediator &cmdMediator,
               bool documentIsExported);
 
 signals:
  void signalChecklistClosed();
 
 private:
  ChecklistGuide ();
 
  // Display information using html, which is possible with QTextBrowser, so images can be embedded. Although the
  // format is structured as a tree, a tree widget is not used since tree widgets are not compatible with embedded images
  // (other than optional tree item icons on the left)
  ChecklistGuideBrowser *m_browser;
};
 
#endif // CHECKLIST_GUIDE_H