#include <Environment.hpp>

Inherits QObject.

Signals
void	MarginClick (Qt::MouseButton aButton, const QString &aSourcePtr, size_t aLineNumber)
void	MarginDrawRequest (const QString &aSourcePath, QPainter &aPainter, const QMap< size_t, QPoint > &aVisibleLineMap)
void	HighlightLinesRequest (const QString &aSourcePath, QList< size_t > &aLineList)
void	FocusedCopyRequest ()
void	PlatformUpdated (const QString &aPlatformName)
void	PlatformDeleted (const QString &aPlatformName)
void	WsfStandardApplicationPendingDestruction ()

Public Member Functions
	Environment ()
	~Environment () override
void	StartUp ()
void	Shutdown ()
void	UpdateMenus ()
void	PopulateRecents ()
bool	LoadScenario (const QStringList &aFiles)
void	FileOpen ()
void	OpenUrl (const QUrl &aUrl)
void	ProjectSettingsOpen (Project &aProject)
void	MarginClickAction (Qt::MouseButton aButton, TextSource *aSource, size_t aLineNumber)
void	MarginDraw (const QString &aSourcePath, QPainter &aPainter, const QMap< size_t, QPoint > &aVisibleLineMap)
void	GetHighlightLines (const QString &aSourcePath, QList< size_t > &aLineList)
void	LoadProject (const QUrl &aUrl)
void	BuildDeveloperMenu ()
void	CopyFocusedData ()
void	UpdatePlatform (const QString &aPlatformName)
void	DeletePlatform (const QString &aPlatformName)
void	DeleteSelection ()
WsfStandardApplication &	GetWsfStandardApplication ()
void	Undo ()
void	Redo ()
void	ClearUndo ()
void	BeginUndoCapture () noexcept
	Notifies the EditorManager to start capturing many changes to consider as one change.
bool	IsCapturingUndo () const noexcept
void	EndUndoCapture () noexcept
	Notifies the EditorManager to stop capturing many changes to consider as one change.
void	RequestSelectPlatform (const QString &aPlatformName)
void	SetVtkMoveMode (wizard::VtkInterface::MoveMode aMoveMode) noexcept
	Sets the MoveMode in the VtkInterface.
wizard::VtkInterface::MoveMode	GetVtkMoveMode () const noexcept
	Gets the MoveMode in the VtkInterface.
void	SetMapCloseConnection (const QMetaObject::Connection &aConnection) noexcept
QMetaObject::Connection	GetMapCloseConnection () const noexcept

Static Public Member Functions
static Environment &	GetInstance ()
static void	Create ()
static bool	Exists ()

Constructor & Destructor Documentation

◆ Environment()

wizard::Environment::Environment ( )

References wizard::Signals::ActionsForFileRequested(), wizard::ProxyWatcher::Create(), wizard::UiResources::Create(), wizard::ComponentPropertyManager::CreateInstance(), and wizSignals.

Referenced by Create(), and WsfStandardApplicationPendingDestruction().

◆ ~Environment()

wizard::Environment::~Environment ( )

override

References wizard::ProxyWatcher::Destroy(), wizard::UiResources::Destroy(), wizard::ComponentPropertyManager::DestroyInstance(), and WsfStandardApplicationPendingDestruction().

Member Function Documentation

◆ BeginUndoCapture()

void wizard::Environment::BeginUndoCapture ( )

noexcept

Notifies the EditorManager to start capturing many changes to consider as one change.

References wizard::EditorManager::BeginUndoCapture(), wizard::ProjectWorkspace::GetEditorManager(), and wizard::ProjectWorkspace::Instance().

Referenced by DeleteSelection().

◆ BuildDeveloperMenu()

void wizard::Environment::BuildDeveloperMenu ( )

References CopyFocusedData(), DeletePlatform(), and UpdatePlatform().

◆ ClearUndo()

void wizard::Environment::ClearUndo ( )

References wizard::EditorManager::ClearUndoStacks(), wizard::ProjectWorkspace::GetEditorManager(), and wizard::ProjectWorkspace::Instance().

Referenced by DeleteSelection().

◆ CopyFocusedData()

void wizard::Environment::CopyFocusedData ( )

References FocusedCopyRequest().

Referenced by BuildDeveloperMenu().

◆ Create()

void wizard::Environment::Create ( )

static

References Environment().

Referenced by wizard::Runner::run().

◆ DeletePlatform()

void wizard::Environment::DeletePlatform ( const QString & aPlatformName )

References PlatformDeleted().

Referenced by BuildDeveloperMenu().

◆ DeleteSelection()

void wizard::Environment::DeleteSelection ( )

References BeginUndoCapture(), ClearUndo(), EndUndoCapture(), GetMapCloseConnection(), GetVtkMoveMode(), GetWsfStandardApplication(), IsCapturingUndo(), Redo(), RequestSelectPlatform(), SetMapCloseConnection(), SetVtkMoveMode(), and Undo().

◆ EndUndoCapture()

void wizard::Environment::EndUndoCapture ( )

noexcept

Notifies the EditorManager to stop capturing many changes to consider as one change.

References wizard::EditorManager::EndUndoCapture(), wizard::ProjectWorkspace::GetEditorManager(), and wizard::ProjectWorkspace::Instance().

Referenced by DeleteSelection().

◆ Exists()

bool wizard::Environment::Exists ( )

inlinestatic

◆ FileOpen()

void wizard::Environment::FileOpen ( )

References wizard::ProjectWorkspace::Instance(), wizard::ProjectWorkspace::StopAllExecutions(), and wizRunMgr.

Referenced by PopulateRecents(), and UpdateMenus().

◆ FocusedCopyRequest

void wizard::Environment::FocusedCopyRequest ( )

signal

References FocusedCopyRequest().

Referenced by CopyFocusedData(), FocusedCopyRequest(), and wizard::PluginT< wkf::Plugin >::PluginT().

◆ GetHighlightLines()

void wizard::Environment::GetHighlightLines	(	const QString &	aSourcePath,
		QList< size_t > &	aLineList )

References HighlightLinesRequest().

◆ GetInstance()

wizard::Environment & wizard::Environment::GetInstance ( )

static

◆ GetMapCloseConnection()

QMetaObject::Connection wizard::Environment::GetMapCloseConnection ( ) const

noexcept

Get the connection responsible for closing the Map::DockWidget

Returns: the current connection responsible for closing the Map::DockWidget

Referenced by DeleteSelection().

◆ GetVtkMoveMode()

wizard::VtkInterface::MoveMode wizard::Environment::GetVtkMoveMode ( ) const

noexcept

Gets the MoveMode in the VtkInterface.

Referenced by DeleteSelection().

◆ GetWsfStandardApplication()

WsfStandardApplication & wizard::Environment::GetWsfStandardApplication ( )

Referenced by DeleteSelection().

◆ HighlightLinesRequest

void wizard::Environment::HighlightLinesRequest	(	const QString &	aSourcePath,
		QList< size_t > &	aLineList )

signal

References HighlightLinesRequest().

Referenced by GetHighlightLines(), HighlightLinesRequest(), and wizard::PluginT< wkf::Plugin >::PluginT().

◆ IsCapturingUndo()

bool wizard::Environment::IsCapturingUndo ( ) const

noexcept

Query the EditorManager whether it is capturing many changes to consider as one change

Returns: the status of the EditorManager's undo capture

References wizard::ProjectWorkspace::GetEditorManager(), wizard::ProjectWorkspace::Instance(), and wizard::EditorManager::IsCapturingUndo().

Referenced by DeleteSelection().

◆ LoadProject()

void wizard::Environment::LoadProject ( const QUrl & aUrl )

References wizard::ProjectWorkspace::GotoFile(), wizard::ProjectWorkspace::GotoRange(), wizard::ProjectWorkspace::Instance(), and LoadScenario().

Referenced by OpenUrl().

◆ LoadScenario()

bool wizard::Environment::LoadScenario ( const QStringList & aFiles )

References wizard::Project::FromXML(), wizard::Project::GotoFile(), PopulateRecents(), wizard::XML_Context::SetFileName(), wizard::Project::SetProjectDirectory(), wizard::Project::SetStartupFiles(), wizRunMgr, and wizSignals.

Referenced by LoadProject().

◆ MarginClick

void wizard::Environment::MarginClick	(	Qt::MouseButton	aButton,
		const QString &	aSourcePtr,
		size_t	aLineNumber )

signal

References MarginClick().

Referenced by MarginClick(), MarginClickAction(), and wizard::PluginT< wkf::Plugin >::PluginT().

◆ MarginClickAction()

void wizard::Environment::MarginClickAction	(	Qt::MouseButton	aButton,
		TextSource *	aSource,
		size_t	aLineNumber )

References wizard::TextSource::GetSystemPath(), and MarginClick().

◆ MarginDraw()

void wizard::Environment::MarginDraw	(	const QString &	aSourcePath,
		QPainter &	aPainter,
		const QMap< size_t, QPoint > &	aVisibleLineMap )

References MarginDrawRequest().

◆ MarginDrawRequest

void wizard::Environment::MarginDrawRequest	(	const QString &	aSourcePath,
		QPainter &	aPainter,
		const QMap< size_t, QPoint > &	aVisibleLineMap )

signal

References MarginDrawRequest().

Referenced by MarginDraw(), MarginDrawRequest(), and wizard::PluginT< wkf::Plugin >::PluginT().

◆ OpenUrl()

void wizard::Environment::OpenUrl ( const QUrl & aUrl )

References LoadProject(), and wizard::DocumentationInterpretter::LookupDocumentationUrl().

◆ PlatformDeleted

void wizard::Environment::PlatformDeleted ( const QString & aPlatformName )

signal

References PlatformDeleted().

Referenced by DeletePlatform(), PlatformDeleted(), and wizard::PluginT< wkf::Plugin >::PluginT().

◆ PlatformUpdated

void wizard::Environment::PlatformUpdated ( const QString & aPlatformName )

signal

References PlatformUpdated().

Referenced by PlatformUpdated(), wizard::PluginT< wkf::Plugin >::PluginT(), and UpdatePlatform().

◆ PopulateRecents()

void wizard::Environment::PopulateRecents ( )

References FileOpen(), and wizRunMgr.

Referenced by LoadScenario(), and UpdateMenus().

◆ ProjectSettingsOpen()

void wizard::Environment::ProjectSettingsOpen ( Project & aProject )

References wizard::ProjectSettingsDialog::Open().

◆ Redo()

void wizard::Environment::Redo ( )

References wizard::ProjectWorkspace::GetEditorManager(), wizard::ProjectWorkspace::Instance(), and wizard::EditorManager::Redo().

Referenced by DeleteSelection().

◆ RequestSelectPlatform()

void wizard::Environment::RequestSelectPlatform ( const QString & aPlatformName )

Note: If we create a platform by adding it to text, it will be a 'while' before the VaEntity exists. This lets the system know that when it does exist we want to select it.

Referenced by DeleteSelection().

◆ SetMapCloseConnection()

void wizard::Environment::SetMapCloseConnection ( const QMetaObject::Connection & aConnection )

noexcept

Set the connection responsible for closing the Map::DockWidget

Parameters

aConnection is the new connection responsible for closing the Map::DockWidget

Referenced by DeleteSelection().

◆ SetVtkMoveMode()

void wizard::Environment::SetVtkMoveMode ( wizard::VtkInterface::MoveMode aMoveMode )

noexcept

Sets the MoveMode in the VtkInterface.

Referenced by DeleteSelection().

◆ Shutdown()

void wizard::Environment::Shutdown ( )

◆ StartUp()

void wizard::Environment::StartUp ( )

◆ Undo()

void wizard::Environment::Undo ( )

References wizard::ProjectWorkspace::GetEditorManager(), wizard::ProjectWorkspace::Instance(), and wizard::EditorManager::Undo().

Referenced by DeleteSelection().

◆ UpdateMenus()

void wizard::Environment::UpdateMenus ( )

References FileOpen(), and PopulateRecents().

◆ UpdatePlatform()

void wizard::Environment::UpdatePlatform ( const QString & aPlatformName )

References PlatformUpdated().

Referenced by BuildDeveloperMenu().

◆ WsfStandardApplicationPendingDestruction

void wizard::Environment::WsfStandardApplicationPendingDestruction ( )

signal

References Environment(), and WsfStandardApplicationPendingDestruction().

Referenced by WsfStandardApplicationPendingDestruction(), and ~Environment().

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

Signals

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

◆ Environment()

◆ ~Environment()

Member Function Documentation

◆ BeginUndoCapture()

◆ BuildDeveloperMenu()

◆ ClearUndo()

◆ CopyFocusedData()

◆ Create()

◆ DeletePlatform()

◆ DeleteSelection()

◆ EndUndoCapture()

◆ Exists()

◆ FileOpen()

◆ FocusedCopyRequest

◆ GetHighlightLines()

◆ GetInstance()

◆ GetMapCloseConnection()

◆ GetVtkMoveMode()

◆ GetWsfStandardApplication()

◆ HighlightLinesRequest

◆ IsCapturingUndo()

◆ LoadProject()

◆ LoadScenario()

◆ MarginClick

◆ MarginClickAction()

◆ MarginDraw()

◆ MarginDrawRequest

◆ OpenUrl()

◆ PlatformDeleted

◆ PlatformUpdated

◆ PopulateRecents()

◆ ProjectSettingsOpen()

◆ Redo()

◆ RequestSelectPlatform()

◆ SetMapCloseConnection()

◆ SetVtkMoveMode()

◆ Shutdown()

◆ StartUp()

◆ Undo()

◆ UpdateMenus()

◆ UpdatePlatform()

◆ WsfStandardApplicationPendingDestruction