FileTreeNode Class
A tree node representing a file (or directory) in the physical file-system.
Inheritance: FileTreeNode ยป TreeNode
Subclasses: DirTreeNode, FilteredFileTreeNode
Method Index
- checkForChildren()
- childPath(item)
- contract() (inherited from TreeNode)
- createNewNode(path)
- expand() (overrides TreeNode:expand)
- getChildByIndex(idx) (overrides TreeNode:getChildByIndex)
- getChildCount() (overrides TreeNode:getChildCount)
- getControl() (inherited from TreeNode)
- getHighlightColour(canvas) (overrides TreeNode:getHighlightColour)
- getIndexOfChild(child) (overrides TreeNode:getIndexOfChild)
- getLabel() (overrides TreeNode:getLabel)
- getLastModification()
- getLevel() (inherited from TreeNode)
- getNextVisible() (inherited from TreeNode)
- getParent() (inherited from TreeNode)
- getPrevVisible() (inherited from TreeNode)
- getSelectColour(canvas) (inherited from TreeNode)
- hasChildren() (overrides TreeNode:hasChildren)
- isExpanded() (inherited from TreeNode)
- isValidFile(name)
- numVisibleDescendants() (inherited from TreeNode)
- reSortChildren(sort_by, order)
- select()
Member Index
- children
- control (*)
- filter_by
- has_children
- has_looked_for_children
- hidden (*)
- highlight_colour
- is_expanded (*)
- is_valid_directory
- is_valid_file
- label
- level (*)
- num_visible_descendants (*)
- order
- parent (*)
- path
- sort_by
function FileTreeNode:FileTreeNode(path)
Parameters:
| Name | Type | Description |
|---|---|---|
| path | ? | ? |
Declared on: line 186 of Lua/dialogs/tree_ctrl.lua.
function FileTreeNode:childPath(item)
Parameters:
| Name | Type | Description |
|---|---|---|
| item | ? | ? |
Declared on: line 199 of Lua/dialogs/tree_ctrl.lua.
function FileTreeNode:createNewNode(path)
Parameters:
| Name | Type | Description |
|---|---|---|
| path | ? | ? |
Declared on: line 241 of Lua/dialogs/tree_ctrl.lua.
function FileTreeNode:expand()
Overrides: TreeNode:expand.
Declared on: line 245 of Lua/dialogs/tree_ctrl.lua.
function FileTreeNode:getChildByIndex(idx)
Parameters:
| Name | Type | Description |
|---|---|---|
| idx | ? | ? |
Overrides: TreeNode:getChildByIndex.
Declared on: line 349 of Lua/dialogs/tree_ctrl.lua.
function FileTreeNode:getChildCount()
Overrides: TreeNode:getChildCount.
Declared on: line 344 of Lua/dialogs/tree_ctrl.lua.
function FileTreeNode:getHighlightColour(canvas)
Parameters:
| Name | Type | Description |
|---|---|---|
| canvas | ? | ? |
Overrides: TreeNode:getHighlightColour.
Declared on: line 324 of Lua/dialogs/tree_ctrl.lua.
function FileTreeNode:getIndexOfChild(child)
Parameters:
| Name | Type | Description |
|---|---|---|
| child | ? | ? |
Overrides: TreeNode:getIndexOfChild.
Declared on: line 354 of Lua/dialogs/tree_ctrl.lua.
function FileTreeNode:getLabel()
Overrides: TreeNode:getLabel.
Declared on: line 358 of Lua/dialogs/tree_ctrl.lua.
function FileTreeNode:hasChildren()
Overrides: TreeNode:hasChildren.
Declared on: line 207 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:
| Name | Type | Description |
|---|---|---|
| name | ? | ? |
Declared on: line 235 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:
| Name | Type | Description |
|---|---|---|
| sort_by | ? | What to sort by. Either "name" or "date". |
| order | ? | If the ordering should be "ascending" or "descending". |
Declared on: line 275 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 380 of Lua/dialogs/tree_ctrl.lua.