TutorialStateChecklistWizardAbstract Class Reference

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

#include <TutorialStateChecklistWizardAbstract.h>

Inheritance diagram for TutorialStateChecklistWizardAbstract:

Collaboration diagram for TutorialStateChecklistWizardAbstract:

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

Protected Member Functions
void	begin ()
	Common begin processing.
void	end ()
	Common end processing.
TutorialButton *	previous ()
	Previous button for hooking up button to slot.
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.
TutorialStateContext &	context ()
	Context class for the tutorial state machine.
QGraphicsPixmapItem *	createPixmapItem (const QString &resource, const QPoint &pos)
	Factory method for pixmap items.
QGraphicsTextItem *	createTextItem (const QString &text, const QPoint &pos)
	Factory method for text items.
QGraphicsTextItem *	createTitle (const QString &text)
	Factory method for title items.

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.

                                                                                                         : 
  TutorialStateAbstractBase (context),
  m_title (nullptr),
  m_background (nullptr),
  m_text0 (nullptr),
  m_text1 (nullptr),
  m_text2 (nullptr),
  m_text3 (nullptr),
  m_previous (nullptr)
{
}

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.

{
  LOG4CPP_INFO_S ((*mainCat)) << "TutorialStateChecklistWizardAbstract::begin ()";
 
  context().tutorialDlg().scene().clear ();
 
  m_title = createTitle (tr ("Checklist Wizard and Checklist Guide"));
  m_background = createPixmapItem (":/engauge/img/panel_checklist.png",
                                   QPoint (0, 30));
  m_text0 = createTextItem (tr ("For new Engauge users, a Checklist Wizard\n"
                                "is available when importing an image file.\n"
                                "This wizard produces a helpful checklist of\n"
                                "steps to follow to digitize the image file."),
                            QPoint (260, 30));
  m_text1 = createTextItem (tr ("Step 1 - Enable the menu option Help /\n"
                                "Checklist Guide Wizard."),
                            QPoint (285, 125));
  m_text2 = createTextItem (tr ("Step 2 - Import the file using File /\n"
                                "Import. The Checklist Wizard will appear\n"
                                "and ask some simple questions to\n"
                                "determine how the image can be\n"
                                "digitized."),
                            QPoint (285, 175));
  m_text3 = createTextItem (tr ("Additional options are available in\n"
                                "the various Settings menus.\n\n"
                                "This ends the tutorial. Good luck!"),
                            QPoint (285, 270));
 
  QSize backgroundSize = context().tutorialDlg().backgroundSize();
 
  m_previous = new TutorialButton (tr ("Previous"),
                                   context().tutorialDlg().scene());
  m_previous->setGeometry (QPoint (buttonMargin (),
                                   backgroundSize.height () - buttonMargin() - m_previous->size().height()));
}

end()

void TutorialStateChecklistWizardAbstract::end ( )

protectedvirtual

Common end processing.

Implements TutorialStateAbstractBase.

Reimplemented in TutorialStateChecklistWizardLines, and TutorialStateChecklistWizardPoints.

Definition at line 65 of file TutorialStateChecklistWizardAbstract.cpp.

{
  LOG4CPP_INFO_S ((*mainCat)) << "TutorialStateChecklistWizardAbstract::end ()";
 
  // It is not safe to remove and deallocate items here since an active TutorialButton
  // may be on the stack. So we clear the scene as the first step in the next begin()
}

previous()

TutorialButton * TutorialStateChecklistWizardAbstract::previous ( )

protected

Previous button for hooking up button to slot.

Definition at line 73 of file TutorialStateChecklistWizardAbstract.cpp.

{
  return m_previous;
}

---

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

• Tutorial/TutorialStateChecklistWizardAbstract.h
• Tutorial/TutorialStateChecklistWizardAbstract.cpp