CWorkspaceUnit Class Reference

Workspace unit description. More...

#include <cbworkspace.h>

Public Member Functions
void	Clear (void)
	Resets the workspace unit to the initial state. More...
void	Read (const TiXmlElement *UnitRoot)
	Reads the workspace unit settings from an XML document. More...
void	Show (void)
	Prints the workspace unit contents to standard output. More...
bool	LoadProject (const CString &WorkspacePath)
	Loads the workspace unit (project) from file. More...
	CWorkspaceUnit (void)
	Creates workspace unit. More...
	~CWorkspaceUnit (void)
	Destroys workspace unit. More...

Private Attributes
CString	m_FileName
	Workspace unit file name. More...
CStringList	m_Depends
	List of workspace unit dependencies. More...
CCodeBlocksProject	m_Project
	Contains project properties. More...
int	m_Weight
	Weight (priority) of the workspace unit. More...

Friends
class	CCodeBlocksWorkspace
class	CProjectWeightComparison

Detailed Description

Workspace unit description.

Contains properties of Code::Blocks workspace: subprojects, their dependencies and priorities.

Constructor & Destructor Documentation

CWorkspaceUnit::CWorkspaceUnit

(

void

)

Creates workspace unit.

CWorkspaceUnit::~CWorkspaceUnit

(

void

)

Destroys workspace unit.

Member Function Documentation

CWorkspaceUnit::Clear

(

void

)

Resets the workspace unit to the initial state.

CWorkspaceUnit::LoadProject

(

const CString &

WorkspacePath)

Loads the workspace unit (project) from file.

Returns

true if the workspace unit was successfully loaded, false otherwise.

Uses CBuildProject::LoadProject(const CString& FileName) with CWorkspaceUnit::m_FileName as the workspace unit file name.

CWorkspaceUnit::Read

(

const TiXmlElement *

UnitRoot)

Reads the workspace unit settings from an XML document.

Parameters

UnitRoot

an element of XML document.

CWorkspaceUnit::Show

(

void

)

Prints the workspace unit contents to standard output.

Friends And Related Function Documentation

friend class CCodeBlocksWorkspace

friend

friend class CProjectWeightComparison

friend

Member Data Documentation

CWorkspaceUnit::m_Depends

private

List of workspace unit dependencies.

Contains list of other workspace unit (project) names that this workspace unit requires to be built before itself.

CWorkspaceUnit::m_FileName

private

Workspace unit file name.

CWorkspaceUnit::m_Project

private

Contains project properties.

See Also

CCodeBlocksProject.

CWorkspaceUnit::m_Weight

private

Weight (priority) of the workspace unit.

Normally workspace unit weights range from 0 to 100. Lower weight means higher priority and vice versa. Workspace units with lower weights are compiled and linked first.

---

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

• src/cbworkspace.h
• src/cbworkspace.cpp
• src/doc/cbworkspace.dox