DirectoryReader - Revision history

WikiSysop: /* References */

2021-08-04T15:22:24Z

References

← Older revision		Revision as of 09:22, 4 August 2021
Line 77:		Line 77:
	[[File:Back.jpg\|right\|50px\|link=User Interface]]		[[File:Back.jpg\|right\|50px\|link=User Interface]]
	==References==		==References==
	'''Please Note:''' The base material for the contents found in this WiKi was sourced from Vectric Lua Interface for Gadgets, version 2.05, published ~~September 12~~, ~~2018~~. by Vectric Ltd. Most current document from Vertric can be downloaded at [https://gadgets.vectric.com/developerinfo.html Vertric Developer Information]		'''Please Note:''' The base material for the contents found in this WiKi was sourced from Vectric Lua Interface for Gadgets, version 10.0, published August 21, 2019. by Vectric Ltd. Most current document from Vertric can be downloaded at [https://gadgets.vectric.com/developerinfo.html Vertric Developer Information]

WikiSysop: /* :DirAtIndex(integer index) */

2021-08-04T15:18:21Z

:DirAtIndex(integer index)

← Older revision		Revision as of 09:18, 4 August 2021
Line 34:		Line 34:
	'''Returns:''' (DirectoryEntry for directory at passed index		'''Returns:''' (DirectoryEntry for directory at passed index
	index (integer) index of directory entry to get. Entries are indexed from 1 to:NumberOfDirs()		index (integer) index of directory entry to get. Entries are indexed from 1 to:NumberOfDirs()




	===:FileAtIndex(integer index)===		===:FileAtIndex(integer index)===

WikiSysop: /* DirectoryReader() */

2021-08-04T15:14:17Z

DirectoryReader()

← Older revision		Revision as of 09:14, 4 August 2021
Line 11:		Line 11:
	Create a new object used for building lists of files		Create a new object used for building lists of files

	''::local dir_reader = DirectoryReader()''		::''local dir_reader = DirectoryReader()''

	==Methods==		==Methods==

WikiSysop: /* Constructor */

2021-08-04T15:13:58Z

Constructor

← Older revision		Revision as of 09:13, 4 August 2021
Line 11:		Line 11:
	Create a new object used for building lists of files		Create a new object used for building lists of files

	''local dir_reader = DirectoryReader()''		''::local dir_reader = DirectoryReader()''

	==Methods==		==Methods==

WikiSysop: /* DirectoryReader() */

2021-08-04T15:13:41Z

DirectoryReader()

← Older revision		Revision as of 09:13, 4 August 2021
Line 11:		Line 11:
	Create a new object used for building lists of files		Create a new object used for building lists of files

	'''local dir_reader = DirectoryReader()'''		''local dir_reader = DirectoryReader()''

	==Methods==		==Methods==

WikiSysop: /* DirectoryReader() */

2021-08-04T15:13:15Z

DirectoryReader()

← Older revision		Revision as of 09:13, 4 August 2021
Line 10:		Line 10:
	===DirectoryReader()===		===DirectoryReader()===
	Create a new object used for building lists of files		Create a new object used for building lists of files
	~~local dir_reader = DirectoryReader()~~



			'''local dir_reader = DirectoryReader()'''

	==Methods==		==Methods==

WikiSysop: Created page with "link=User Interface Category:SDK This object is used to build a list of files and directories matching various criteria. ==Constructor==..."

2021-08-04T04:15:55Z

Created page with "right|50px|link=User Interface Category:SDK This object is used to build a list of files and directories matching various criteria. ==Constructor==..."

New page

[[File:Back.jpg|right|50px|link=User Interface]]
[[Category:SDK]]
This object is used to build a list of files and directories matching various criteria.

==Constructor==

===DirectoryReader()===
Create a new object used for building lists of files
local dir_reader = DirectoryReader()

==Methods==

===:BuildDirectoryList(string dir_path, bool recurse)===
Build a list of directories we will search for files
::''dir_path (string) path to build list of files from ''
::''recurse(bool) if true include sub directories as well''

===:ClearDirs()===
Clear list of directories

===:ClearFiles()===
Clear list of files

===:DirAtIndex(integer index)===
'''Returns:''' (DirectoryEntry for directory at passed index
index (integer) index of directory entry to get. Entries are indexed from 1 to:NumberOfDirs()

===:FileAtIndex(integer index)===
'''Returns:''' (FileEntry for file at passed index index (integer) index of file entry to get. Entries are indexed from 1 to:NumberOfFiles()

===:GetFiles(string filter, bool include_files_in_list, bool include_dirs_in_list)===
Add files or directories matching passed filter to list held by this object. Note this method can be called multiple times to add different sets of files

::''filter (string) Filter (eg "*.dxf") to use for finding matching files ''
::''include_files_in_list (bool) if true we collect names of matching files ''
::''include_dirs_in_list (bool) if true we collect names of matching directories''

===:SortDirs()===
Sort list of directories into alphabetical order

===:SortFiles(integer sort_order, bool reverse)===
Sort list of files into order
::''sort_order (integer) Sorting algorithm to use, options are''
::::''DirectoryReader.SORT_NONE''
::::''DirectoryReader.SORT_ALPHA''
::::''DirectoryReader.SORT_WRITE_DATE''
::::''DirectoryReader.SORT_SIZE''
::''reverse(bool) if true sort in reverse order''

===:NumberOfDirs()===
'''Returns:''' (the number of directories found

===:NumberOfFiles()===
'''Returns:''' (the number of files found

[[File:Back.jpg|right|50px|link=User Interface]]
==References==
'''Please Note:''' The base material for the contents found in this WiKi was sourced from Vectric Lua Interface for Gadgets, version 2.05, published September 12, 2018. by Vectric Ltd. Most current document from Vertric can be downloaded at [https://gadgets.vectric.com/developerinfo.html Vertric Developer Information]