Search Toolkit Book for CWorkspaceFolder

#include <gui/objects/WorkspaceFolder.hpp>

Inheritance diagram for CWorkspaceFolder:

Collaboration diagram for CWorkspaceFolder:

Classes
class	IProjectVisitor

Public Types
typedef size_t	TId
	auto-incremented project Id, unique within an application session More...

Public Types inherited from CWorkspaceFolder_Base
enum class	E_memberIndex { e__allMandatory = 0 , e_info , e_folders , e_projects }

typedef CFolderInfo	TInfo

typedef list< CRef< CWorkspaceFolder > >	TFolders

typedef list< CRef< CGBProjectHandle > >	TProjects

typedef Tparent::CMemberIndex< E_memberIndex, 4 >	TmemberIndex

Public Types inherited from CObject
enum	EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
	Control filling of newly allocated memory. More...

typedef CObjectCounterLocker	TLockerType
	Default locker type for CRef. More...

typedef atomic< Uint8 >	TCounter
	Counter type is CAtomiCounter. More...

typedef Uint8	TCount
	Alias for value type of counter. More...

Public Member Functions
	CWorkspaceFolder (void)

	~CWorkspaceFolder (void)

TId	GetId () const

const CGBProjectHandle *	GetProject (CGBProjectHandle::TId id) const

CGBProjectHandle *	GetProject (CGBProjectHandle::TId id)

const CWorkspaceFolder *	FindParentFolder (CGBProjectHandle::TId id) const

CWorkspaceFolder *	FindParentFolder (CGBProjectHandle::TId id)

bool	RemoveProject (CGBProjectHandle::TId id)

CGBProjectHandle *	FindProjectById (CGBProjectHandle::TId id, bool recursive)

CGBProjectHandle *	FindProjectByFilename (const string &filename)
	finds a project in the folder and its sub folders More...

CWorkspaceFolder *	FindChildFolderById (TId id, bool recursive)

CWorkspaceFolder *	FindChildFolderByTitle (const string &title)

void	AddProject (CGBProjectHandle &project)

void	AddChildFolder (CWorkspaceFolder &child_folder)

void	RemoveChildFolder (TId id)

CRef< CWorkspaceFolder >	RemoveProjectFolder (CWorkspaceFolder::TId id)

bool	ForEachProject (IProjectVisitor &visitor, bool recursive)
	applies the given visitor to all projects until the visitor returns false More...

Public Member Functions inherited from CWorkspaceFolder_Base
	CWorkspaceFolder_Base (void)

virtual	~CWorkspaceFolder_Base (void)

	DECLARE_INTERNAL_TYPE_INFO ()

bool	IsSetInfo (void) const
	Check if a value has been assigned to Info data member. More...

bool	CanGetInfo (void) const
	Check if it is safe to call GetInfo method. More...

void	ResetInfo (void)
	Reset Info data member. More...

const TInfo &	GetInfo (void) const
	Get the Info member data. More...

void	SetInfo (TInfo &value)
	Assign a value to Info data member. More...

TInfo &	SetInfo (void)
	Assign a value to Info data member. More...

bool	IsSetFolders (void) const
	Check if a value has been assigned to Folders data member. More...

bool	CanGetFolders (void) const
	Check if it is safe to call GetFolders method. More...

void	ResetFolders (void)
	Reset Folders data member. More...

const TFolders &	GetFolders (void) const
	Get the Folders member data. More...

TFolders &	SetFolders (void)
	Assign a value to Folders data member. More...

bool	IsSetProjects (void) const
	Check if a value has been assigned to Projects data member. More...

bool	CanGetProjects (void) const
	Check if it is safe to call GetProjects method. More...

void	ResetProjects (void)
	Reset Projects data member. More...

const TProjects &	GetProjects (void) const
	Get the Projects member data. More...

TProjects &	SetProjects (void)
	Assign a value to Projects data member. More...

virtual void	Reset (void)
	Reset the whole object. More...

Public Member Functions inherited from CSerialObject
	CSerialObject (void)

virtual	~CSerialObject (void)

virtual const CTypeInfo *	GetThisTypeInfo (void) const =0

virtual void	Assign (const CSerialObject &source, ESerialRecursionMode how=eRecursive)
	Set object to copy of another one. More...

virtual bool	Equals (const CSerialObject &object, ESerialRecursionMode how=eRecursive) const
	Check if both objects contain the same values. More...

virtual void	DebugDump (CDebugDumpContext ddc, unsigned int depth) const
	Define method for dumping debug information. More...

void	ThrowUnassigned (TMemberIndex index) const

void	ThrowUnassigned (TMemberIndex index, const char *file_name, int file_line) const

bool	HasNamespaceName (void) const
	Check if object data type has namespace name. More...

const string &	GetNamespaceName (void) const
	Get namespace name. More...

bool	HasNamespacePrefix (void) const
	Check if data type has namespace prefix. More...

const string &	GetNamespacePrefix (void) const
	Get namespace prefix. More...

Public Member Functions inherited from CObject
	CObject (void)
	Constructor. More...

	CObject (const CObject &src)
	Copy constructor. More...

virtual	~CObject (void)
	Destructor. More...

CObject &	operator= (const CObject &src) THROWS_NONE
	Assignment operator. More...

bool	CanBeDeleted (void) const THROWS_NONE
	Check if object can be deleted. More...

bool	IsAllocatedInPool (void) const THROWS_NONE
	Check if object is allocated in memory pool (not system heap) More...

bool	Referenced (void) const THROWS_NONE
	Check if object is referenced. More...

bool	ReferencedOnlyOnce (void) const THROWS_NONE
	Check if object is referenced only once. More...

void	AddReference (void) const
	Add reference to object. More...

void	RemoveReference (void) const
	Remove reference to object. More...

void	ReleaseReference (void) const
	Remove reference without deleting object. More...

virtual void	DoNotDeleteThisObject (void)
	Mark this object as not allocated in heap – do not delete this object. More...

virtual void	DoDeleteThisObject (void)
	Mark this object as allocated in heap – object can be deleted. More...

void *	operator new (size_t size)
	Define new operator for memory allocation. More...

void *	operator new[] (size_t size)
	Define new[] operator for 'array' memory allocation. More...

void	operator delete (void *ptr)
	Define delete operator for memory deallocation. More...

void	operator delete[] (void *ptr)
	Define delete[] operator for memory deallocation. More...

void *	operator new (size_t size, void *place)
	Define new operator. More...

void	operator delete (void ptr, void place)
	Define delete operator. More...

void *	operator new (size_t size, CObjectMemoryPool *place)
	Define new operator using memory pool. More...

void	operator delete (void ptr, CObjectMemoryPool place)
	Define delete operator. More...

Public Member Functions inherited from CDebugDumpable
	CDebugDumpable (void)

virtual	~CDebugDumpable (void)

void	DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const

void	DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const

void	DumpToConsole (void) const

Protected Attributes
TId	m_Id
	instance run-time Id, unique within an application session More...

Static Protected Attributes
static CAtomicCounter	m_IdCounter

Private Types
typedef CWorkspaceFolder_Base	Tparent

Private Member Functions
	CWorkspaceFolder (const CWorkspaceFolder &value)

CWorkspaceFolder &	operator= (const CWorkspaceFolder &value)

Additional Inherited Members
Static Public Member Functions inherited from CSerialObject
static void	SetVerifyDataThread (ESerialVerifyData verify)

static void	SetVerifyDataGlobal (ESerialVerifyData verify)

static string	UnassignedString (void)

static CStringUTF8	UnassignedStringUTF8 (void)

static char	UnassignedByte (void)

Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void	ThrowNullPointerException (void)
	Define method to throw null pointer exception. More...

static NCBI_XNCBI_EXPORT void	ThrowNullPointerException (const type_info &type)

static EAllocFillMode	GetAllocFillMode (void)

static void	SetAllocFillMode (EAllocFillMode mode)

static void	SetAllocFillMode (const string &value)
	Set mode from configuration parameter value. More...

Static Public Member Functions inherited from CDebugDumpable
static void	EnableDebugDump (bool on)

Static Public Attributes inherited from CSerialObject
static const char *	ms_UnassignedStr = "<unassigned>"

static const char	ms_UnassignedByte = char(0xcd)

Static Public Attributes inherited from CObject
static const TCount	eCounterBitsCanBeDeleted = 1 << 0
	Define possible object states. More...

static const TCount	eCounterBitsInPlainHeap = 1 << 1
	Heap signature was found. More...

static const TCount	eCounterBitsPlaceMask
	Mask for 'in heap' state flags. More...

static const int	eCounterStep = 1 << 2
	Skip over the "in heap" bits. More...

static const TCount	eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
	Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...

static const TCount	eCounterStateMask
	Valid object, and object in heap. More...

Protected Member Functions inherited from CObject
virtual void	DeleteThis (void)
	Virtual method "deleting" this object. More...