Code::Blocks  SVN r11506
Public Member Functions | List of all members
NullProjectManagerUI Class Reference
Inheritance diagram for NullProjectManagerUI:
Collaboration diagram for NullProjectManagerUI:

Public Member Functions

cbAuiNotebookGetNotebook () override
 
cbTreeCtrlGetTree () 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 (bool force=false) override
 Le the tree control be updated again. More...
 
wxTreeItemId GetTreeSelection () override
 Get the selection of the project manager's tree (GUI). More...
 
void UpdateActiveProject (cbProject *WXUNUSED(oldProject), cbProject *WXUNUSED(newProject), bool WXUNUSED(refresh)) override
 
void RemoveProject (cbProject *WXUNUSED(project)) override
 
void BeginLoadingWorkspace () override
 
void CloseWorkspace () override
 
void FinishLoadingProject (cbProject *WXUNUSED(project), bool WXUNUSED(newAddition), FilesGroupsAndMasks *WXUNUSED(fileGroups)) override
 
void FinishLoadingWorkspace (cbProject *WXUNUSED(activeProject), const wxString &WXUNUSED(workspaceTitle)) override
 
void ShowFileInTree (ProjectFile &WXUNUSED(projectFile)) override
 
bool QueryCloseAllProjects () override
 Checks whether all projects are saved. More...
 
bool QueryCloseProject (cbProject *WXUNUSED(proj), bool dontsavefiles=false) override
 
bool QueryCloseWorkspace () override
 Asks user to save the workspace, projects and files (Yes/No/cancel). More...
 
int AskForBuildTargetIndex (cbProject *project=nullptr) override
 Utility function. More...
 
wxArrayInt AskForMultiBuildTargetIndex (cbProject *project=nullptr) override
 Utility function. More...
 
void ConfigureProjectDependencies (cbProject *base=nullptr) override
 Displays a dialog to setup project dependencies. More...
 
void SwitchToProjectsPage () override
 Switches the management's notebook to the Projects tab. More...
 
- Public Member Functions inherited from cbProjectManagerUI
virtual ~cbProjectManagerUI ()
 
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...
 

Detailed Description

Definition at line 49 of file projectmanager.cpp.

Member Function Documentation

◆ AskForBuildTargetIndex()

int NullProjectManagerUI::AskForBuildTargetIndex ( cbProject project = nullptr)
inlineoverridevirtual

Utility function.

Displays a single selection list of a project's build targets to choose from.

Parameters
projectThe project to use. If NULL, the active project is used.
Returns
The selected build target's index, or -1 if no build target was selected.

Implements cbProjectManagerUI.

Definition at line 68 of file projectmanager.cpp.

◆ AskForMultiBuildTargetIndex()

wxArrayInt NullProjectManagerUI::AskForMultiBuildTargetIndex ( cbProject project = nullptr)
inlineoverridevirtual

Utility function.

Displays a multiple selection list of a project's build targets to choose from.

Parameters
projectThe project to use. If NULL, the active project is used.
Returns
An integer array containing the selected build targets indices. This array will be empty if no build targets were selected.

Implements cbProjectManagerUI.

Definition at line 69 of file projectmanager.cpp.

◆ BeginLoadingWorkspace()

void NullProjectManagerUI::BeginLoadingWorkspace ( )
inlineoverridevirtual

Implements cbProjectManagerUI.

Definition at line 60 of file projectmanager.cpp.

◆ CloseWorkspace()

void NullProjectManagerUI::CloseWorkspace ( )
inlineoverridevirtual

Implements cbProjectManagerUI.

Definition at line 61 of file projectmanager.cpp.

◆ ConfigureProjectDependencies()

void NullProjectManagerUI::ConfigureProjectDependencies ( cbProject base = nullptr)
inlineoverridevirtual

Displays a dialog to setup project dependencies.

Parameters
baseThe project to setup its dependencies. Can be NULL (default) because there's a project selection combo in the dialog.

Implements cbProjectManagerUI.

Definition at line 70 of file projectmanager.cpp.

◆ FinishLoadingProject()

void NullProjectManagerUI::FinishLoadingProject ( cbProject WXUNUSEDproject,
bool   WXUNUSEDnewAddition,
FilesGroupsAndMasks WXUNUSEDfileGroups 
)
inlineoverride

Definition at line 62 of file projectmanager.cpp.

◆ FinishLoadingWorkspace()

void NullProjectManagerUI::FinishLoadingWorkspace ( cbProject WXUNUSEDactiveProject,
const wxString WXUNUSEDworkspaceTitle 
)
inlineoverride

Definition at line 63 of file projectmanager.cpp.

◆ FreezeTree()

void NullProjectManagerUI::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 55 of file projectmanager.cpp.

◆ GetNotebook()

cbAuiNotebook* NullProjectManagerUI::GetNotebook ( )
inlineoverridevirtual

Implements cbProjectManagerUI.

Definition at line 52 of file projectmanager.cpp.

◆ GetTree()

cbTreeCtrl* NullProjectManagerUI::GetTree ( )
inlineoverridevirtual

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

Returns
A pointer to a wxTreeCtrl window.

Implements cbProjectManagerUI.

Definition at line 53 of file projectmanager.cpp.

◆ GetTreeSelection()

wxTreeItemId NullProjectManagerUI::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 57 of file projectmanager.cpp.

◆ QueryCloseAllProjects()

bool NullProjectManagerUI::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 65 of file projectmanager.cpp.

◆ QueryCloseProject()

bool NullProjectManagerUI::QueryCloseProject ( cbProject WXUNUSEDproj,
bool  dontsavefiles = false 
)
inlineoverride

Definition at line 66 of file projectmanager.cpp.

◆ QueryCloseWorkspace()

bool NullProjectManagerUI::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 67 of file projectmanager.cpp.

◆ RebuildTree()

void NullProjectManagerUI::RebuildTree ( )
inlineoverridevirtual

Rebuild the project manager's tree.

Implements cbProjectManagerUI.

Definition at line 54 of file projectmanager.cpp.

◆ RemoveProject()

void NullProjectManagerUI::RemoveProject ( cbProject WXUNUSEDproject)
inlineoverride

Definition at line 59 of file projectmanager.cpp.

◆ ShowFileInTree()

void NullProjectManagerUI::ShowFileInTree ( ProjectFile WXUNUSEDprojectFile)
inlineoverride

Definition at line 64 of file projectmanager.cpp.

◆ SwitchToProjectsPage()

void NullProjectManagerUI::SwitchToProjectsPage ( )
inlineoverridevirtual

Switches the management's notebook to the Projects tab.

Implements cbProjectManagerUI.

Definition at line 71 of file projectmanager.cpp.

◆ UnfreezeTree()

void NullProjectManagerUI::UnfreezeTree ( bool  force = false)
inlineoverridevirtual

Le the tree control be updated again.

Parameters
forceIf true the tree control is forced to un-freeze. Else it depends on freeze-unfreeze balance (see note).
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 56 of file projectmanager.cpp.

◆ UpdateActiveProject()

void NullProjectManagerUI::UpdateActiveProject ( cbProject WXUNUSEDoldProject,
cbProject WXUNUSEDnewProject,
bool   WXUNUSEDrefresh 
)
inlineoverride

Definition at line 58 of file projectmanager.cpp.


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