Public Member Functions
plStringBuilder	GetPathForDocumentGuid (const plUuid &guid)
	Resolve document GUID into an absolute path.

const plString &	GetProjectFile () const
	Returns the path to the 'plProject' file.

const plString	GetProjectName (bool bSanitize) const
	Returns the short name of the project (extracted from the path).

plString	GetProjectDirectory () const
	Returns the path in which the 'plProject' file is stored.

plString	GetProjectDataFolder () const
	Returns the directory path in which project settings etc. should be stored.

bool	IsDocumentInAllowedRoot (plStringView sDocumentPath, plString *out_pRelativePath=nullptr) const

void	AddAllowedDocumentRoot (plStringView sPath)

void	CreateSubFolder (plStringView sFolder) const
	Makes sure the given sub-folder exists inside the project directory.

Static Public Member Functions
static bool	IsProjectOpen ()

static bool	IsProjectClosing ()

static void	CloseProject ()

static void	SaveProjectState ()

static bool	CanCloseProject ()
	Returns true when the project can be closed. Uses plToolsProjectRequest::Type::CanCloseProject event.

static bool	CanCloseDocuments (plArrayPtr< plDocument * > documents)
	Returns true when the given list of documents can be closed. Uses plToolsProjectRequest::Type::CanCloseDocuments event.

static plInt32	SuggestContainerWindow (plDocument *pDoc)
	Returns the unique ID of the container window this document should use for its window. Uses plToolsProjectRequest::Type::SuggestContainerWindow event.

static plStatus	OpenProject (plStringView sProjectPath)

static plStatus	CreateProject (plStringView sProjectPath)

static void	BroadcastSaveAll ()
	Broadcasts the SaveAll event, though otherwise has no direct effect.

static void	BroadcastConfigChanged ()
	Sent when global project configuration data was changed and thus certain menus would need to update their content (or just deselect any item, forcing the user to reselect and thus update state)

static plString	FindProjectDirectoryForDocument (plStringView sDocumentPath)
	Starts at the given document and then searches the tree upwards until it finds an plProject file.

Static Public Attributes
static plEvent< const plToolsProjectEvent & >	s_Events

static plEvent< plToolsProjectRequest & >	s_Requests

Member Function Documentation

◆ GetProjectName()

const plString plToolsProject::GetProjectName ( bool bSanitize ) const

Returns the short name of the project (extracted from the path).

Parameters

bSanitize Whether to replace whitespace and other problematic characters, such that it can be used in code.

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