ChecklistGuideBrowser.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_BROWSER_H
#define CHECKLIST_GUIDE_BROWSER_H
 
#include "CmdMediator.h"
#include <QHash>
#include <QTextBrowser>

class ChecklistGuideBrowser : public QTextBrowser
{
  Q_OBJECT;
 
 public:
  ChecklistGuideBrowser();

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

  void update (const CmdMediator &cmdMediator,
               bool documentIsExported);
 
 private slots:
  void slotAnchorClicked (const QUrl &url);
 
 private:
 
  QString ahref (QString &html,
                 const QString &name) const;
 
  void check (QString &html,
              const QString &anchor,
              bool isChecked) const;
  void divHide (QString &html,
                const QString &anchor) const;
  void divShow (QString &html,
                const QString &anchor) const;

  QString processAhrefs (const QString &htmlBefore);

  QString processCheckboxes (const QString &htmlBefore);

  QString processDivs (const QString &htmlBefore);

  void refresh ();
 
  void repopulateCheckedTags (const CmdMediator &cmdMediator,
                              bool documentIsExported);
 
  QString m_templateHtml;
  QStringList m_curveNames; // Needed for iterating over all Curves in Document
 
  // Staging area for information that gets displayed. Since this information comes from two sources (QTextBrowser hyperlinks
  // and Document), this information is stored here. When either QTextBrowser or Document has new data, we update the info here
  // and then refresh the display
  QString m_anchor; // From user clicking on a hyperlink in the browser window. Empty value means no div gets shown
  QHash<QString, bool> m_checkedTags; // From Document. Each tag is in this lookup table if checked, otherwise unchecked. Boolean value is ignored
};
 
#endif // CHECKLIST_GUIDE_BROWSER_H