Lumiera  0.pre.03
»edityourfreedom«
Wizard Class Reference

#include "gui/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 85 of file wizard.hpp.

Public Member Functions

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

Static Public Member Functions

static ID getErrorLogID ()
 

Private Attributes

ctrl::GlobalCtxglobalCtx_
 
unique_ptr< ctrl::NotificationHubnotificationHub_
 
unique_ptr< dialog::TestControltestControlWindow_
 

Additional Inherited Members

- Private Member Functions inherited from NonCopyable
 NonCopyable ()=default
 
 NonCopyable (NonCopyable const &)=delete
 
 ~NonCopyable ()=default
 
NonCopyableoperator= (NonCopyable const &)=delete
 

Constructor & Destructor Documentation

◆ Wizard()

Wizard ( ctrl::GlobalCtx globals)

Definition at line 71 of file wizard.cpp.

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

+ Here is the call graph for this function:

◆ ~Wizard()

~Wizard ( )

Definition at line 67 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 90 of file wizard.cpp.

References _, WindowLocator::findActiveWindow(), Config::get(), Wizard::globalCtx_, gui::KEY_AUTHORS, gui::KEY_COPYRIGHT, gui::KEY_TITLE, gui::KEY_VERSION, gui::KEY_WEBSITE, and GlobalCtx::windowLoc_.

Referenced by Actions::populateMainActions().

+ Here is the call graph for this function:
+ 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 126 of file wizard.cpp.

References WindowLocator::findActiveWindow(), UiBus::getAccessPoint(), Wizard::globalCtx_, Wizard::testControlWindow_, GlobalCtx::uiBus_, and GlobalCtx::windowLoc_.

Referenced by Actions::populateMainActions().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getErrorLogID()

static ID getErrorLogID ( )
inlinestatic

Definition at line 99 of file wizard.hpp.

References proc::asset::meta::theErrorLog_ID.

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

+ Here is the caller graph for this function:

Member Data Documentation

◆ globalCtx_

ctrl::GlobalCtx& globalCtx_
private

Definition at line 88 of file wizard.hpp.

Referenced by Wizard::launchTestCtrl(), Wizard::show_HelpAbout(), and Wizard::Wizard().

◆ notificationHub_

unique_ptr<ctrl::NotificationHub> notificationHub_
private

Definition at line 89 of file wizard.hpp.

Referenced by Wizard::Wizard().

◆ testControlWindow_

unique_ptr<dialog::TestControl> testControlWindow_
private

Definition at line 90 of file wizard.hpp.

Referenced by Wizard::launchTestCtrl().

+ Inheritance diagram for Wizard:
+ Collaboration diagram for Wizard:

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