Almost empty implementation used in batch mode. More...

#include <projectmanagerui.h>

Inheritance diagram for BatchProjectManagerUI:

Collaboration diagram for BatchProjectManagerUI:

Public Member Functions
cbAuiNotebook *	GetNotebook () override

cbTreeCtrl *	GetTree () override
	Retrieve a pointer to the project manager's tree (GUI). More...

void	RebuildTree () override
	Rebuild the project manager's tree. More...

void	FreezeTree () override
	Stop the tree control from updating. More...

void	UnfreezeTree (cb_unused bool force=false) override

wxTreeItemId	GetTreeSelection () override
	Get the selection of the project manager's tree (GUI). More...

void	ShowFileInTree (cb_unused ProjectFile &projectFile) override

void	UpdateActiveProject (cb_unused cbProject oldProject, cb_unused cbProject newProject, cb_unused bool refresh) override

void	RemoveProject (cb_unused cbProject *project) override

void	BeginLoadingWorkspace () override

void	CloseWorkspace () override

void	FinishLoadingProject (cb_unused cbProject project, cb_unused bool newAddition, cb_unused FilesGroupsAndMasks fileGroups) override

void	FinishLoadingWorkspace (cb_unused cbProject *activeProject, cb_unused const wxString &workspaceTitle) override

bool	QueryCloseAllProjects () override
	Checks whether all projects are saved. More...

bool	QueryCloseProject (cb_unused cbProject *proj, cb_unused bool dontsavefiles=false) override

bool	QueryCloseWorkspace () override
	Asks user to save the workspace, projects and files (Yes/No/cancel). More...

int	AskForBuildTargetIndex (cb_unused cbProject *project=nullptr) override

wxArrayInt	AskForMultiBuildTargetIndex (cb_unused cbProject *project=nullptr) override

void	ConfigureProjectDependencies (cb_unused cbProject *base=nullptr) override

void	SwitchToProjectsPage () override
	Switches the management's notebook to the Projects tab. More...

Public Member Functions inherited from cbProjectManagerUI
virtual	~cbProjectManagerUI ()

virtual void	UnfreezeTree (bool force=false)=0
	Le the tree control be updated again. More...

virtual void	ShowFileInTree (ProjectFile &projectFile)=0

virtual void	UpdateActiveProject (cbProject oldProject, cbProject newProject, bool refresh)=0

virtual void	RemoveProject (cbProject *project)=0

virtual void	FinishLoadingProject (cbProject project, bool newAddition, FilesGroupsAndMasks fileGroups)=0

virtual void	FinishLoadingWorkspace (cbProject *activeProject, const wxString &workspaceTitle)=0

virtual bool	QueryCloseProject (cbProject *proj, bool dontsavefiles=false)=0
	Checks whether project is saved. More...

virtual int	AskForBuildTargetIndex (cbProject *project=nullptr)=0
	Utility function. More...

virtual wxArrayInt	AskForMultiBuildTargetIndex (cbProject *project=nullptr)=0
	Utility function. More...

virtual void	ConfigureProjectDependencies (cbProject *base=nullptr)=0
	Displays a dialog to setup project dependencies. More...

Detailed Description

Almost empty implementation used in batch mode.

Definition at line 154 of file projectmanagerui.h.

Member Function Documentation

◆ AskForBuildTargetIndex()

int BatchProjectManagerUI::AskForBuildTargetIndex ( cb_unused cbProject * project = nullptr )

inlineoverride

Definition at line 190 of file projectmanagerui.h.

◆ AskForMultiBuildTargetIndex()

wxArrayInt BatchProjectManagerUI::AskForMultiBuildTargetIndex ( cb_unused cbProject * project = nullptr )

inlineoverride

Definition at line 191 of file projectmanagerui.h.

◆ BeginLoadingWorkspace()

void BatchProjectManagerUI::BeginLoadingWorkspace ( )

inlineoverridevirtual

Implements cbProjectManagerUI.

Definition at line 172 of file projectmanagerui.h.

◆ CloseWorkspace()

void BatchProjectManagerUI::CloseWorkspace ( )

inlineoverridevirtual

Implements cbProjectManagerUI.

Definition at line 173 of file projectmanagerui.h.

◆ ConfigureProjectDependencies()

void BatchProjectManagerUI::ConfigureProjectDependencies ( cb_unused cbProject * base = nullptr )

inlineoverride

Definition at line 195 of file projectmanagerui.h.

◆ FinishLoadingProject()

void BatchProjectManagerUI::FinishLoadingProject	(	cb_unused cbProject *	project,
		cb_unused bool	newAddition,
		cb_unused FilesGroupsAndMasks *	fileGroups
	)

inlineoverride

Definition at line 174 of file projectmanagerui.h.

◆ FinishLoadingWorkspace()

void BatchProjectManagerUI::FinishLoadingWorkspace	(	cb_unused cbProject *	activeProject,
		cb_unused const wxString &	workspaceTitle
	)

inlineoverride

Definition at line 178 of file projectmanagerui.h.

◆ FreezeTree()

void BatchProjectManagerUI::FreezeTree ( )

inlineoverridevirtual

Stop the tree control from updating.

Note: This operation is accumulative. This means you have to call UnfreezeTree() as many times as you 've called FreezeTree() for the tree control to un-freeze (except if you call UnfreezeTree(true)).

Implements cbProjectManagerUI.

Definition at line 160 of file projectmanagerui.h.

◆ GetNotebook()

cbAuiNotebook* BatchProjectManagerUI::GetNotebook ( )

inlineoverridevirtual

Implements cbProjectManagerUI.

Definition at line 157 of file projectmanagerui.h.

◆ GetTree()

cbTreeCtrl* BatchProjectManagerUI::GetTree ( )

inlineoverridevirtual

Retrieve a pointer to the project manager's tree (GUI).

Returns: A pointer to a wxTreeCtrl window.

Implements cbProjectManagerUI.

Definition at line 158 of file projectmanagerui.h.

◆ GetTreeSelection()

wxTreeItemId BatchProjectManagerUI::GetTreeSelection ( )

inlineoverridevirtual

Get the selection of the project manager's tree (GUI).

This must be used instead of tree->GetSelection() because the tree has the wxTR_MULTIPLE style. This usually returns the first item in the selection list, but if there is a right-click popup menu then the user may have selected several items and right-clicked on one, so return the right-click item instead. of the first

Returns: A wxTreeItemId of the selected tree item.

Implements cbProjectManagerUI.

Definition at line 162 of file projectmanagerui.h.

◆ QueryCloseAllProjects()

bool BatchProjectManagerUI::QueryCloseAllProjects ( )

inlineoverridevirtual

Checks whether all projects are saved.

If not, asks the user to save and saves accordingly.

Returns: False if the user pressed cancel. Note: calls QueryCloseProject for all projects.

Implements cbProjectManagerUI.

Definition at line 182 of file projectmanagerui.h.

◆ QueryCloseProject()

bool BatchProjectManagerUI::QueryCloseProject	(	cb_unused cbProject *	proj,
		cb_unused bool	dontsavefiles = `false`
	)

inlineoverride

Definition at line 183 of file projectmanagerui.h.

◆ QueryCloseWorkspace()

bool BatchProjectManagerUI::QueryCloseWorkspace ( )

inlineoverridevirtual

Asks user to save the workspace, projects and files (Yes/No/cancel).

If user pressed Yes, it saves accordingly.

Returns: False if the user pressed cancel; true otherwise. After this function is called and returns true, it is safe to close the workspace, all files and projects without asking the user later.

Implements cbProjectManagerUI.

Definition at line 188 of file projectmanagerui.h.

◆ RebuildTree()

void BatchProjectManagerUI::RebuildTree ( )

inlineoverridevirtual

Rebuild the project manager's tree.

Implements cbProjectManagerUI.

Definition at line 159 of file projectmanagerui.h.

◆ RemoveProject()

void BatchProjectManagerUI::RemoveProject ( cb_unused cbProject * project )

inlineoverride

Definition at line 171 of file projectmanagerui.h.

◆ ShowFileInTree()

void BatchProjectManagerUI::ShowFileInTree ( cb_unused ProjectFile & projectFile )

inlineoverride

Definition at line 164 of file projectmanagerui.h.

◆ SwitchToProjectsPage()

void BatchProjectManagerUI::SwitchToProjectsPage ( )

inlineoverridevirtual

Switches the management's notebook to the Projects tab.

Implements cbProjectManagerUI.

Definition at line 196 of file projectmanagerui.h.

◆ UnfreezeTree()

void BatchProjectManagerUI::UnfreezeTree ( cb_unused bool force = false )

inlineoverride

Definition at line 161 of file projectmanagerui.h.

◆ UpdateActiveProject()

void BatchProjectManagerUI::UpdateActiveProject	(	cb_unused cbProject *	oldProject,
		cb_unused cbProject *	newProject,
		cb_unused bool	refresh
	)

inlineoverride

Definition at line 166 of file projectmanagerui.h.

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

projectmanagerui.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ AskForBuildTargetIndex()

◆ AskForMultiBuildTargetIndex()

◆ BeginLoadingWorkspace()

◆ CloseWorkspace()

◆ ConfigureProjectDependencies()

◆ FinishLoadingProject()

◆ FinishLoadingWorkspace()

◆ FreezeTree()

◆ GetNotebook()

◆ GetTree()

◆ GetTreeSelection()

◆ QueryCloseAllProjects()

◆ QueryCloseProject()

◆ QueryCloseWorkspace()

◆ RebuildTree()

◆ RemoveProject()

◆ ShowFileInTree()

◆ SwitchToProjectsPage()

◆ UnfreezeTree()

◆ UpdateActiveProject()