Engauge Digitizer 2
Loading...
Searching...
No Matches
Signals | Public Member Functions | List of all members
ChecklistGuide Class Reference

Dockable text window containing checklist guide. More...

#include <ChecklistGuide.h>

Inheritance diagram for ChecklistGuide:
Inheritance graph
Collaboration diagram for ChecklistGuide:
Collaboration graph

Signals

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

Public Member Functions

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

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.

14 :
15 QDockWidget (parent),
16 m_browser (nullptr)
17{
18 setVisible (false);
19 setAllowedAreas (Qt::AllDockWidgetAreas);
20 setWindowTitle (tr ("Checklist Guide")); // Appears in title bar when undocked
21 setStatusTip (tr ("Checklist Guide"));
22 setWhatsThis (tr ("Checklist Guide\n\n"
23 "This box contains a checklist of steps suggested by the Checklist Guide Wizard. Following "
24 "these steps should produce a set of digitized points in an output file.\n\n"
25 "To run the Checklist Guide Wizard when an image file is imported, select the "
26 "Help / Checklist Wizard menu option."));
27
28 m_browser = new ChecklistGuideBrowser;
29 setWidget (m_browser);
30}
const int INNER_RADIUS_MIN
Class that adds rudimentary tree collapse/expand functionality to QTextBrowser.

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.

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

◆ 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.

38{
39 LOG4CPP_INFO_S ((*mainCat)) << "ChecklistGuide::closeEvent";
40
42}
log4cpp::Category * mainCat
Definition Logger.cpp:14
void signalChecklistClosed()
Signal that this QDockWidget was just closed.
#define LOG4CPP_INFO_S(logger)
Definition convenience.h:18

◆ setTemplateHtml()

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

Populate the browser with template html.

Definition at line 44 of file ChecklistGuide.cpp.

46{
47 LOG4CPP_INFO_S ((*mainCat)) << "ChecklistGuide::setTemplateHtml";
48
49 m_browser->setTemplateHtml (html,
50 curveNames);
51}
virtual void setTemplateHtml(const QString &html, const QStringList &curveNames)
Populate the browser with template html. The template html will be converted to real html.

◆ 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.

55{
56 LOG4CPP_INFO_S ((*mainCat)) << "ChecklistGuide::update";
57
58 ENGAUGE_CHECK_PTR (m_browser);
59
60 m_browser->update (cmdMediator,
62}
#define ENGAUGE_CHECK_PTR(ptr)
#endif
void update(const CmdMediator &cmdMediator, bool documentIsExported)
Update using current CmdMediator/Document state.

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