ChecklistGuide Class Reference

Dockable text window containing checklist guide. More...

#include <ChecklistGuide.h>

Inheritance diagram for ChecklistGuide:

Collaboration diagram for ChecklistGuide:

Signals
void	signalChecklistClosed ()
	Signal that this QDockWidget was just closed. More...

Public Member Functions
	ChecklistGuide (QWidget *parent)
	Single constructor. Parent is needed or else this widget cannot be redocked after being undocked. More...
bool	browserIsEmpty () const
	When browser is empty, it is pointless to show it. More...
virtual void	closeEvent (QCloseEvent *event)
	Catch close event so corresponding menu item in MainWindow can be updated accordingly. More...
void	setTemplateHtml (const QString &html, const QStringList &curveNames)
	Populate the browser with template html. More...
void	update (const CmdMediator &cmdMediator, bool documentIsExported)
	Update using current CmdMediator/Document state. More...

Detailed Description

Dockable text window containing checklist guide.

Definition at line 16 of file ChecklistGuide.h.

Constructor & Destructor Documentation

ChecklistGuide()

ChecklistGuide::ChecklistGuide

(

QWidget *

parent

)

Single constructor. Parent is needed or else this widget cannot be redocked after being undocked.

Definition at line 14 of file ChecklistGuide.cpp.

                                               :
  QDockWidget (parent),
  m_browser (nullptr)
{
  setVisible (false);
  setAllowedAreas (Qt::AllDockWidgetAreas);
  setWindowTitle (tr ("Checklist Guide")); // Appears in title bar when undocked
  setStatusTip (tr ("Checklist Guide"));
  setWhatsThis (tr ("Checklist Guide\n\n"
                    "This box contains a checklist of steps suggested by the Checklist Guide Wizard. Following "
                    "these steps should produce a set of digitized points in an output file.\n\n"
                    "To run the Checklist Guide Wizard when an image file is imported, select the "
                    "Help / Checklist Wizard menu option."));

  m_browser = new ChecklistGuideBrowser;
  setWidget (m_browser);
}

Member Function Documentation

browserIsEmpty()

bool ChecklistGuide::browserIsEmpty

(

)

const

When browser is empty, it is pointless to show it.

Definition at line 32 of file ChecklistGuide.cpp.

{
  return m_browser->toPlainText().isEmpty();
}

closeEvent()

void ChecklistGuide::closeEvent ( QCloseEvent *  event )

virtual

Catch close event so corresponding menu item in MainWindow can be updated accordingly.

Definition at line 37 of file ChecklistGuide.cpp.

{
  LOG4CPP_INFO_S ((*mainCat)) << "ChecklistGuide::closeEvent";

  emit signalChecklistClosed();
}

setTemplateHtml()

void ChecklistGuide::setTemplateHtml	(	const QString &	html,
		const QStringList &	curveNames
	)

Populate the browser with template html.

Definition at line 44 of file ChecklistGuide.cpp.

{
  LOG4CPP_INFO_S ((*mainCat)) << "ChecklistGuide::setTemplateHtml";

  m_browser->setTemplateHtml (html,
                              curveNames);
}

signalChecklistClosed

void ChecklistGuide::signalChecklistClosed ( )

signal

Signal that this QDockWidget was just closed.

update()

void ChecklistGuide::update	(	const CmdMediator &	cmdMediator,
		bool	documentIsExported
	)

Update using current CmdMediator/Document state.

Definition at line 53 of file ChecklistGuide.cpp.

{
  LOG4CPP_INFO_S ((*mainCat)) << "ChecklistGuide::update";

  ENGAUGE_CHECK_PTR (m_browser);

  m_browser->update (cmdMediator,
                     documentIsExported);
}

---

The documentation for this class was generated from the following files:

• Checklist/ChecklistGuide.h
• Checklist/ChecklistGuide.cpp