CorsixTH Lua Documentation

FileTreeNode Class

A tree node representing a file (or directory) in the physical file-system.

Declared on: line 184 of Lua/dialogs/tree_ctrl.lua.
Inheritance: FileTreeNode ยป TreeNode
Subclasses: DirTreeNode, FilteredFileTreeNode

Method Index

Member Index

(*) only used in superclass methods
function FileTreeNode:FileTreeNode(path)

Parameters:

NameTypeDescription
path ? ?

Declared on: line 192 of Lua/dialogs/tree_ctrl.lua.

function FileTreeNode:childPath(item)

Parameters:

NameTypeDescription
item ? ?

Declared on: line 261 of Lua/dialogs/tree_ctrl.lua.

function FileTreeNode:createNewNode(path)

Parameters:

NameTypeDescription
path ? ?

Declared on: line 304 of Lua/dialogs/tree_ctrl.lua.

function FileTreeNode:getChildByIndex(idx)

Parameters:

NameTypeDescription
idx ? ?

Overrides: TreeNode:getChildByIndex.
Declared on: line 412 of Lua/dialogs/tree_ctrl.lua.

function FileTreeNode:getIndexOfChild(child)

Parameters:

NameTypeDescription
child ? ?

Overrides: TreeNode:getIndexOfChild.
Declared on: line 417 of Lua/dialogs/tree_ctrl.lua.

function FileTreeNode:getMostRecentlyModifiedChildFile(file_name_filter)

- @param (optional) return the most recently modified child file which has this string in its name. @return nil if no child file is found otherwise return the FileTreedNode for mostly recently modified child file.

Parameters:

NameTypeDescription
file_name_filter ? ?

Declared on: line 209 of Lua/dialogs/tree_ctrl.lua.

function FileTreeNode:isValidFile(name)

Returns whether the given file name is valid in this tree. Override for desired behaviour.

Parameters:

NameTypeDescription
name ? ?

Declared on: line 298 of Lua/dialogs/tree_ctrl.lua.

function FileTreeNode:reSortChildren(sort_by, order)

Sorts the node and its children either by date or by name.

Parameters:

NameTypeDescription
sort_by ? What to sort by. Either "name" or "date".
order ? If the ordering should be "ascending" or "descending".

Declared on: line 338 of Lua/dialogs/tree_ctrl.lua.

function FileTreeNode:select()

Selects an item. By default everything selected is valid. Can be overridden by inheriting classes.

Declared on: line 443 of Lua/dialogs/tree_ctrl.lua.