Engauge Digitizer  2
Public Member Functions | Protected Member Functions | List of all members
TutorialStateChecklistWizardAbstract Class Reference

Abstract class that supports checklist wizard panels. More...

#include <TutorialStateChecklistWizardAbstract.h>

Inheritance diagram for TutorialStateChecklistWizardAbstract:
Inheritance graph
Collaboration diagram for TutorialStateChecklistWizardAbstract:
Collaboration graph

Public Member Functions

 TutorialStateChecklistWizardAbstract (TutorialStateContext &context)
 Single constructor. More...
 
- Public Member Functions inherited from TutorialStateAbstractBase
 TutorialStateAbstractBase (TutorialStateContext &context)
 Single constructor. More...
 
virtual ~TutorialStateAbstractBase ()
 

Protected Member Functions

void begin ()
 Common begin processing. More...
 
void end ()
 Common end processing. More...
 
TutorialButton * previous ()
 Previous button for hooking up button to slot. More...
 
- Protected Member Functions inherited from TutorialStateAbstractBase
int buttonMargin () const
 Buttons are placed up against bottom side, and left or right side, separated by this margin. More...
 
TutorialStateContext & context ()
 Context class for the tutorial state machine. More...
 
QGraphicsPixmapItem * createPixmapItem (const QString &resource, const QPoint &pos)
 Factory method for pixmap items. More...
 
QGraphicsTextItem * createTextItem (const QString &text, const QPoint &pos)
 Factory method for text items. More...
 
QGraphicsTextItem * createTitle (const QString &text)
 Factory method for title items. More...
 

Detailed Description

Abstract class that supports checklist wizard panels.

Definition at line 18 of file TutorialStateChecklistWizardAbstract.h.

Constructor & Destructor Documentation

◆ TutorialStateChecklistWizardAbstract()

TutorialStateChecklistWizardAbstract::TutorialStateChecklistWizardAbstract ( TutorialStateContext &  context)

Single constructor.

Definition at line 17 of file TutorialStateChecklistWizardAbstract.cpp.

17  :
19  m_title (nullptr),
20  m_background (nullptr),
21  m_text0 (nullptr),
22  m_text1 (nullptr),
23  m_text2 (nullptr),
24  m_text3 (nullptr),
25  m_previous (nullptr)
26 {
27 }
One state manages one panel of the tutorial.
TutorialStateContext & context()
Context class for the tutorial state machine.

Member Function Documentation

◆ begin()

void TutorialStateChecklistWizardAbstract::begin ( )
protectedvirtual

Common begin processing.

Implements TutorialStateAbstractBase.

Reimplemented in TutorialStateChecklistWizardLines, and TutorialStateChecklistWizardPoints.

Definition at line 29 of file TutorialStateChecklistWizardAbstract.cpp.

30 {
31  LOG4CPP_INFO_S ((*mainCat)) << "TutorialStateChecklistWizardAbstract::begin ()";
32 
33  context().tutorialDlg().scene().clear ();
34 
35  m_title = createTitle (tr ("Checklist Wizard and Checklist Guide"));
36  m_background = createPixmapItem (":/engauge/img/panel_checklist.png",
37  QPoint (0, 30));
38  m_text0 = createTextItem (tr ("For new Engauge users, a Checklist Wizard\n"
39  "is available when importing an image file.\n"
40  "This wizard produces a helpful checklist of\n"
41  "steps to follow to digitize the image file."),
42  QPoint (260, 30));
43  m_text1 = createTextItem (tr ("Step 1 - Enable the menu option Help /\n"
44  "Checklist Guide Wizard."),
45  QPoint (285, 125));
46  m_text2 = createTextItem (tr ("Step 2 - Import the file using File /\n"
47  "Import. The Checklist Wizard will appear\n"
48  "and ask some simple questions to\n"
49  "determine how the image can be\n"
50  "digitized."),
51  QPoint (285, 175));
52  m_text3 = createTextItem (tr ("Additional options are available in\n"
53  "the various Settings menus.\n\n"
54  "This ends the tutorial. Good luck!"),
55  QPoint (285, 270));
56 
57  QSize backgroundSize = context().tutorialDlg().backgroundSize();
58 
59  m_previous = new TutorialButton (tr ("Previous"),
60  context().tutorialDlg().scene());
61  m_previous->setGeometry (QPoint (buttonMargin (),
62  backgroundSize.height () - buttonMargin() - m_previous->size().height()));
63 }
QSize size() const
Size of this button.
void setGeometry(const QPoint &pos)
Set the position. This is called after creation so screen extent is available for positioning calcula...
Show a button with text for clicking ion. The button is implemented using layering of two graphics it...
#define LOG4CPP_INFO_S(logger)
Definition: convenience.h:18
QGraphicsScene & scene()
Single scene the covers the entire tutorial dialog.
Definition: TutorialDlg.cpp:76
TutorialStateContext & context()
Context class for the tutorial state machine.
QGraphicsTextItem * createTextItem(const QString &text, const QPoint &pos)
Factory method for text items.
QGraphicsTextItem * createTitle(const QString &text)
Factory method for title items.
QGraphicsPixmapItem * createPixmapItem(const QString &resource, const QPoint &pos)
Factory method for pixmap items.
QSize backgroundSize() const
Make geometry available for layout.
Definition: TutorialDlg.cpp:44
log4cpp::Category * mainCat
Definition: Logger.cpp:14
int buttonMargin() const
Buttons are placed up against bottom side, and left or right side, separated by this margin...
TutorialDlg & tutorialDlg()
Access to tutorial dialogs and its scene.

◆ end()

void TutorialStateChecklistWizardAbstract::end ( )
protectedvirtual

Common end processing.

Implements TutorialStateAbstractBase.

Reimplemented in TutorialStateChecklistWizardLines, and TutorialStateChecklistWizardPoints.

Definition at line 65 of file TutorialStateChecklistWizardAbstract.cpp.

66 {
67  LOG4CPP_INFO_S ((*mainCat)) << "TutorialStateChecklistWizardAbstract::end ()";
68 
69  // It is not safe to remove and deallocate items here since an active TutorialButton
70  // may be on the stack. So we clear the scene as the first step in the next begin()
71 }
#define LOG4CPP_INFO_S(logger)
Definition: convenience.h:18
log4cpp::Category * mainCat
Definition: Logger.cpp:14

◆ previous()

TutorialButton * TutorialStateChecklistWizardAbstract::previous ( )
protected

Previous button for hooking up button to slot.

Definition at line 73 of file TutorialStateChecklistWizardAbstract.cpp.

74 {
75  return m_previous;
76 }

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