Folder information class for tree structure data More...

Inheritance diagram for Yukar.Common.Rom.Folder:

Public Member Functions
string	GetDisplayName (string inLanguage)
	Get display name in specified language More...

string	GetLocalName (string inLanguage)
	Get local name in specified language More...

void	SetLocalName (string inLanguage, string inName)
	Set local name in specified language More...

void	UpdateChildIds ()
	Reflect the contents of Childs to ChildIds More...

	Folder ()
	constructor More...

override void	load (BinaryReader reader)
	loading More...

override void	save (BinaryWriter writer)
	keep More...

override void	saveUsedGUID (BinaryWriter writer, bool inIncludeChildUseRomGUID)
	Export the GUID you are using (for tools) More...

void	initialize (Catalog inCatalog, bool includeChildrenFolder=false)
	Initialize folder from ChildIds More...

void	AddChild (RomItem child, bool toTop=false)
	Adding child elements More...

void	RemoveChild (RomItem child)
	Delete child element More...

List< RomItem >	AllItems (bool inIgnoreFolder=false)
	Get all child elements More...

List< Folder >	AllFolders ()
	Get all child folders More...

bool	IsEmpty (bool inIsResourceOnly)
	Is the folder empty? More...

List< RomItem >	ParseChilds (bool inIsAll=true)
	Get all child elements More...

string	FullPath ()
	Get full path of folder More...

Common.Rom.Folder	FindChildFolder (string path)
	Find child folders of specified path More...

Folder	Clone ()
	clone folder More...

Public Member Functions inherited from Yukar.Common.Rom.RomItem
string	getCategory (string locale=null)
	Get category path More...

	RomItem ()
	constructor More...

System.Drawing.Bitmap	getThumbnail (THUMBNAILMAKERNOTIFY notify, out bool setNotify)
	Get thumbnail image More...

System.Drawing.Bitmap	getThumbnail (THUMBNAILMAKERNOTIFY notify)
	Get thumbnail image More...

System.Drawing.Bitmap	getThumbnail ()
	Get thumbnail image More...

void	invalidateThumbnail ()
	Disable thumbnail images More...

void	invalidateThumbnail (THUMBNAILMAKERNOTIFY notify)
	Disable thumbnail images More...

void	forceInvalidateThumbnail (THUMBNAILMAKERNOTIFY notify)
	Force regeneration of thumbnail images More...

virtual void	save (BinaryWriter writer)
	keep More...

virtual void	load (BinaryReader reader)
	loading More...

virtual void	saveUsedGUID (BinaryWriter writer, bool inIncludeChildUseRomGUID)
	Export the GUID you are using (for tools) More...

void	saveUsedGUID (BinaryWriter writer)
	Export the GUID you are using (for tools) More...

virtual bool	initializingAfterLoading ()
	Initialization process after loading More...

virtual void	reImport ()
	Reimport More...

virtual void	export (string path)
	export More...

virtual void	onCatalogCleanup ()
	Catalog release processing More...

virtual void	onNameChanged ()
	Processing when renaming More...

void	copyFrom (Common.Rom.RomItem src)
	Copy data from another RomItem More...

virtual void	CheckRecourceConsistency (Catalog inCatalog)
	Consistency check (for tools) More...

virtual void	ChangeId (Dictionary< Guid, Rom.RomItem > inChangeIdDic)
	Replace the Id you are using with the corresponding Rom Id More...

void	ClearId (List< Rom.RomItem > inClearRomItemList)
	Removed rom usage in list More...

void	Dispose ()

void	AddUpdatecall (int count)
	Increase/decrease the thumbnail generation pending counter More...

void	save (BinaryWriter writer)
	keep More...

void	load (BinaryReader reader)
	loading More...

Static Public Member Functions
static Common.Rom.Folder	FindChildFolder (Common.Rom.Folder parent, string path)
	Find child folders of specified path More...

Static Public Member Functions inherited from Yukar.Common.Rom.RomItem
static bool	reImport (List< RomItem > inRomList)
	Reimport More...

static void	writeChunk (System.IO.BinaryWriter writer, IChunk rom)
	write chunk More...

static void	readChunk (System.IO.BinaryReader reader, IChunk rom)
	load chunk More...

static void	skipChunk (System.IO.BinaryReader reader)
	skip chunk More...

static T	Clone< T > (RomItem inSrc)
	Clone RomItem More...

static bool	equalChunk (IChunk a, IChunk b)
	Are the contents of the chunks equal? More...

static IChunk	duplicate (IChunk rom)
	Duplicate IChunk More...

Public Attributes
Guid	dlcGuid = Guid.Empty
	GUID of DLC or system project More...

Public Attributes inherited from Yukar.Common.Rom.RomItem
Guid	guId
	ID More...

String	name
	name More...

string	tags = ""
	tag More...

string	category = ""
	category More...

Properties
short	Signature `[get, set]`
	Folder signature (signature of the elements stored in the folder) More...

Dictionary< string, string >	LocalNameDic `[get]`
	local name dictionary More...

List< RomItem >	Childs `[get, set]`
	child element list More...

List< Guid >	ChildIds `[get, set]`
	Child element GUID list More...

bool	Visibility = true `[get, set]`
	View folder More...

bool	Locked = false `[get, set]`
	Lock folder More...

bool	IsExpanded `[get, set]`
	Folder expansion status More...

Properties inherited from Yukar.Common.Rom.RomItem
System.Drawing.Bitmap	Thumbnail `[get]`
	thumbnail image More...

ThumbnailStatusType	ThumbnailStatus = ThumbnailStatusType.Empty `[get, set]`
	Thumbnail generation status More...

string	Name `[get, set]`
	Get display name More...

virtual int	RefCount `[get]`
	reference count More...

virtual bool	UseRefCount `[get]`
	Should I use reference counting? More...

Folder	Parent `[get, set]`
	parent folder More...

Additional Inherited Members
Public Types inherited from Yukar.Common.Rom.RomItem
enum	ThumbnailStatusType { Empty = 0 , Creating , Created , Failed }
	Thumbnail image generation status More...

Static Public Attributes inherited from Yukar.Common.Rom.RomItem
static int	thumbnailWidth = 128
	Thumbnail image width (pixels) More...

static int	thumbnailHeight = 128
	Thumbnail image height (pixels) More...

const char	CATEGORY_SPLITTER = '\\'
	category delimiter More...

static CREATETHUMBNAIL	createThumbnailFunction = null
	Thumbnail generation function More...

const int	UnknownRefCount = -2000
	Constants when reference count is unknown More...

Protected Member Functions inherited from Yukar.Common.Rom.RomItem
virtual void	Dispose (bool disposing)

Detailed Description

Folder information class for tree structure data

Constructor & Destructor Documentation

◆ Folder()

Yukar.Common.Rom.Folder.Folder ( )

constructor

Member Function Documentation

◆ AddChild()

void Yukar.Common.Rom.Folder.AddChild	(	RomItem	child,
		bool	toTop = `false`
	)

Adding child elements

Parameters

child	Rom
toTop	add to top

◆ AllFolders()

List< Folder > Yukar.Common.Rom.Folder.AllFolders ( )

Get all child folders

Returns

◆ AllItems()

List< RomItem > Yukar.Common.Rom.Folder.AllItems ( bool inIgnoreFolder = false )

Get all child elements

Parameters

inIgnoreFolder Get list of child elements other than Folder type

Returns

◆ Clone()

Folder Yukar.Common.Rom.Folder.Clone ( )

clone folder

Returns

◆ FindChildFolder() [1/2]

static Common.Rom.Folder Yukar.Common.Rom.Folder.FindChildFolder	(	Common.Rom.Folder	parent,
		string	path
	)

static

Find child folders of specified path

Parameters

parent	parent folder
path	path

Returns

◆ FindChildFolder() [2/2]

Common.Rom.Folder Yukar.Common.Rom.Folder.FindChildFolder ( string path )

Find child folders of specified path

Parameters

path path

Returns

◆ FullPath()

string Yukar.Common.Rom.Folder.FullPath ( )

Get full path of folder

Returns

◆ GetDisplayName()

string Yukar.Common.Rom.Folder.GetDisplayName ( string inLanguage )

Get display name in specified language

Parameters

inLanguage language code

Returns

◆ GetLocalName()

string Yukar.Common.Rom.Folder.GetLocalName ( string inLanguage )

Get local name in specified language

Parameters

inLanguage language code

Returns

◆ initialize()

void Yukar.Common.Rom.Folder.initialize	(	Catalog	inCatalog,
		bool	includeChildrenFolder = `false`
	)

Initialize folder from ChildIds

Parameters

inCatalog	catalog
includeChildrenFolder	Initialize child folders recursively

◆ IsEmpty()

bool Yukar.Common.Rom.Folder.IsEmpty ( bool inIsResourceOnly )

Is the folder empty?

Parameters

inIsResourceOnly Targets only child elements other than Folder type

Returns

◆ load()

override void Yukar.Common.Rom.Folder.load ( BinaryReader reader )

virtual

loading

Parameters

reader leader

Reimplemented from Yukar.Common.Rom.RomItem.

◆ ParseChilds()

List< RomItem > Yukar.Common.Rom.Folder.ParseChilds ( bool inIsAll = true )

Get all child elements

Parameters

inIsAll Expand folders within folders

Returns

◆ RemoveChild()

void Yukar.Common.Rom.Folder.RemoveChild ( RomItem child )

Delete child element

Parameters

child Rom

◆ save()

override void Yukar.Common.Rom.Folder.save ( BinaryWriter writer )

virtual

keep

Parameters

writer Writer

Reimplemented from Yukar.Common.Rom.RomItem.

◆ saveUsedGUID()

override void Yukar.Common.Rom.Folder.saveUsedGUID	(	BinaryWriter	writer,
		bool	inIncludeChildUseRomGUID
	)

virtual

Export the GUID you are using (for tools)

Parameters

writer	Writer
inIncludeChildUseRomGUID	Does it also include the roms used by the roms used?

Reimplemented from Yukar.Common.Rom.RomItem.

◆ SetLocalName()

void Yukar.Common.Rom.Folder.SetLocalName	(	string	inLanguage,
		string	inName
	)

Set local name in specified language

Parameters

inLanguage	language code
inName	local name

◆ UpdateChildIds()

void Yukar.Common.Rom.Folder.UpdateChildIds ( )

Reflect the contents of Childs to ChildIds

Member Data Documentation

◆ dlcGuid

Guid Yukar.Common.Rom.Folder.dlcGuid = Guid.Empty

GUID of DLC or system project

Property Documentation

◆ ChildIds

List<Guid> Yukar.Common.Rom.Folder.ChildIds

getset

Child element GUID list

◆ Childs

List<RomItem> Yukar.Common.Rom.Folder.Childs

getset

child element list

◆ IsExpanded

bool Yukar.Common.Rom.Folder.IsExpanded

getset

Folder expansion status

◆ LocalNameDic

Dictionary<string, string> Yukar.Common.Rom.Folder.LocalNameDic

get

local name dictionary

◆ Locked

bool Yukar.Common.Rom.Folder.Locked = false

getset

Lock folder

◆ Signature

short Yukar.Common.Rom.Folder.Signature

getset

Folder signature (signature of the elements stored in the folder)

◆ Visibility

bool Yukar.Common.Rom.Folder.Visibility = true

getset

View folder

Public Member Functions

Static Public Member Functions

Public Attributes

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Folder()

Member Function Documentation

◆ AddChild()

◆ AllFolders()

◆ AllItems()

◆ Clone()

◆ FindChildFolder() [1/2]

◆ FindChildFolder() [2/2]

◆ FullPath()

◆ GetDisplayName()

◆ GetLocalName()

◆ initialize()

◆ IsEmpty()

◆ load()

◆ ParseChilds()

◆ RemoveChild()

◆ save()

◆ saveUsedGUID()

◆ SetLocalName()

◆ UpdateChildIds()

Member Data Documentation

◆ dlcGuid

Property Documentation

◆ ChildIds

◆ Childs

◆ IsExpanded

◆ LocalNameDic

◆ Locked

◆ Signature

◆ Visibility