Wizard Class Reference

#include "stage/interact/wizard.hpp"

Description

Global cross-cutting navigation in interface space, foundation to implement user assistance and context sensitive help.

Todo:

initial draft as of 2/2017 – actual implementation has to be filled in

Definition at line 76 of file wizard.hpp.

Static Public Member Functions
static ID	getErrorLogID ()

Public Member Functions
	Wizard (ctrl::GlobalCtx &)
	~Wizard ()
void	show_HelpAbout ()
	show the notorious "about Lumiera" dialog.
void	launchTestCtrl ()
	Launch a non modal child window to trigger self-test actions.

Private Attributes
ctrl::GlobalCtx &	globalCtx_
unique_ptr< ctrl::NotificationHub >	notificationHub_
unique_ptr< dialog::TestControl >	testControlWindow_

Additional Inherited Members
Private Member Functions inherited from NonCopyable
	~NonCopyable ()=default
	NonCopyable ()=default
	NonCopyable (NonCopyable const &)=delete
NonCopyable &	operator= (NonCopyable const &)=delete

Constructor & Destructor Documentation

Wizard()

Wizard

(

ctrl::GlobalCtx &

globals

)

Definition at line 62 of file wizard.cpp.

References PanelLocator::find_or_create(), Wizard::globalCtx_, WindowLocator::locatePanel(), and GlobalCtx::windowLoc_.

Here is the call graph for this function:

~Wizard()

~Wizard

(

)

Definition at line 58 of file wizard.cpp.

Member Function Documentation

show_HelpAbout()

void show_HelpAbout

(

)

show the notorious "about Lumiera" dialog.

Something every application has and no user really cares about.

Definition at line 81 of file wizard.cpp.

References _, stage::KEY_AUTHORS, stage::KEY_COPYRIGHT, stage::KEY_TITLE, stage::KEY_VERSION, and stage::KEY_WEBSITE.

Referenced by Actions::populateMainActions().

Here is the caller graph for this function:

launchTestCtrl()

void launchTestCtrl

(

)

Launch a non modal child window to trigger self-test actions.

This is a tool for diagnostics and development. The operations exposed here allow to launch some hard wired actions and test routines, performing within the regular UI environment and on equal footing with user operated controls.

Definition at line 117 of file wizard.cpp.

Referenced by Actions::populateMainActions().

Here is the caller graph for this function:

getErrorLogID()

static ID getErrorLogID ( )

inlinestatic

Definition at line 90 of file wizard.hpp.

References steam::asset::meta::theErrorLog_ID.

Referenced by steam::cmd::COMMAND_DEFINITION(), steam::cmd::COMMAND_DEFINITION(), steam::cmd::COMMAND_DEFINITION(), and NotificationService::displayInfo().

Here is the caller graph for this function:

Member Data Documentation

globalCtx_

ctrl::GlobalCtx& globalCtx_

private

Definition at line 79 of file wizard.hpp.

Referenced by Wizard::Wizard().

notificationHub_

unique_ptr<ctrl::NotificationHub> notificationHub_

private

Definition at line 80 of file wizard.hpp.

testControlWindow_

unique_ptr<dialog::TestControl> testControlWindow_

private

Definition at line 81 of file wizard.hpp.

Inheritance diagram for Wizard:

Collaboration diagram for Wizard:

---

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

• wizard.hpp
• wizard.cpp