tm_workspace.h File Reference

Data Structures
struct	TMWorkspace

Functions
gboolean	tm_workspace_add_object (TMWorkObject *work_object)
gboolean	tm_workspace_remove_object (TMWorkObject *work_object, gboolean do_free, gboolean update)

Detailed Description

The TMWorkspace structure is meant to be used as a singleton to store application wide tag information.

The workspace is intended to contain a list of global tags and a set of work objects (projects or individual files). You need not use the workspace, though, to use tag manager, unless you need things like global tags and a place to store all current open projects and individual files. TMWorkspace is derived from TMWorkObject.

Function Documentation

gboolean tm_workspace_add_object

(

TMWorkObject *

work_object

)

Adds a work object (source file or project) to the workspace.

Parameters

work_object

The work object to add to the project.

Returns

TRUE on success, FALSE on failure (e.g. object already exixts).

gboolean tm_workspace_remove_object	(	TMWorkObject *	work_object,
		gboolean	do_free,
		gboolean	update
	)

Removes a member object from the workspace if it exists.

Parameters

work_object	Pointer to the work object to be removed.
do_free	Whether the work object is to be freed as well.
update	Whether to update workspace objects.

Returns

TRUE on success, FALSE on failure (e.g. the work object does not exist).