Skip to main content

plugins.treeview

local treeview = require "plugins.treeview"

cache​

(field) cache: table

count_lines​

(field) count_lines: integer

expanded​

(field) expanded: table

hovered_item​

(field) hovered_item: unknown

init_size​

(field) init_size: boolean

item_icon_width​

(field) item_icon_width: number

item_text_spacing​

(field) item_text_spacing: number

last_active_view​

(field) last_active_view: unknown

last_scroll_y​

(field) last_scroll_y: integer

scroll_width​

(field) scroll_width: integer

scrollable​

(field) scrollable: boolean

selected_item​

(field) selected_item: any

show_hidden​

(field) show_hidden: boolean

show_ignored​

(field) show_ignored: boolean

target_size​

(field) target_size: any

tooltip​

(field) tooltip: table

visible​

(field) visible: boolean

watches​

(field) watches: table

config.plugins.treeview​

Configuration options for treeview plugin.

animate_scroll_to_focused_file​

(field) animate_scroll_to_focused_file: boolean

Smoothly scroll to focused file.

config_spec​

(field) config_spec: table

The config specification used by gui generators

expand_dirs_to_focused_file​

(field) expand_dirs_to_focused_file: boolean

Automatically expands directories to select focused file.

highlight_focused_file​

(field) highlight_focused_file: boolean

Selects the file you are editing on the treeview.

scroll_to_focused_file​

(field) scroll_to_focused_file: boolean

Automatically scrolls the treeview to focused file.

show_hidden​

(field) show_hidden: boolean

Show hidden files and directories.

show_ignored​

(field) show_ignored: boolean

Show ignored files and directories.

size​

(field) size: number

Default treeview width.

__tostring​

(method) plugins.treeview:__tostring()
  -> string

draw​

(method) plugins.treeview:draw()

draw_item​

(method) plugins.treeview:draw_item(item: any, active: any, hovered: any, x: any, y: any, w: any, h: any)
  -> number
  2. number
  3. number
  4. number

draw_item_background​

(method) plugins.treeview:draw_item_background(item: any, active: any, hovered: any, x: any, y: any, w: any, h: any)

draw_item_body​

(method) plugins.treeview:draw_item_body(item: any, active: any, hovered: any, x: any, y: any, w: any, h: any)
  -> number
  2. number
  3. number
  4. number

draw_item_chevron​

(method) plugins.treeview:draw_item_chevron(item: any, active: any, hovered: any, x: any, y: any, w: any, h: any)
  -> number

draw_item_icon​

(method) plugins.treeview:draw_item_icon(item: any, active: any, hovered: any, x: any, y: any, w: any, h: any)
  -> number

draw_item_text​

(method) plugins.treeview:draw_item_text(item: any, active: any, hovered: any, x: any, y: any, w: any, h: any)
  -> number
  2. number
  3. number
  4. number

draw_tooltip​

(method) plugins.treeview:draw_tooltip()

each_item​

(method) plugins.treeview:each_item()
  -> fun(...any):...unknown

get_cached​

(method) plugins.treeview:get_cached(project: any, path: any)
  -> table|unknown|nil

get_h_scrollable_size​

(method) plugins.treeview:get_h_scrollable_size()
  -> number

get_item​

(method) plugins.treeview:get_item(item: any, where: any)
  -> unknown
  2. unknown
  3. unknown
  4. unknown
  5. unknown

get_item_height​

(method) plugins.treeview:get_item_height()
  -> number

get_item_icon​

(method) plugins.treeview:get_item_icon(item: any, active: any, hovered: any)
  -> string
  2. renderer.font
  3. unknown

@return: renderer.font

get_item_text​

(method) plugins.treeview:get_item_text(item: any, active: any, hovered: any)
  -> unknown
  2. renderer.font
  3. unknown

@return: renderer.font

get_items​

(method) plugins.treeview:get_items(project: any, path: any, x: any, y: any, w: any, h: any)
  -> integer

get_name​

(method) plugins.treeview:get_name()
  -> nil

get_next​

(method) plugins.treeview:get_next(item: any)
  -> unknown
  2. unknown
  3. unknown
  4. unknown
  5. unknown

get_parent​

(method) plugins.treeview:get_parent(item: any)
  -> unknown|nil
  2. unknown|nil

get_previous​

(method) plugins.treeview:get_previous(item: any)
  -> unknown
  2. unknown
  3. unknown
  4. unknown
  5. unknown

get_scrollable_size​

(method) plugins.treeview:get_scrollable_size()
  -> number

get_text_bounding_box​

(method) plugins.treeview:get_text_bounding_box(item: any, x: any, y: any, w: any, h: any)
  -> unknown
  2. unknown
  3. number
  4. unknown

new​

(method) plugins.treeview:new()

on_mouse_left​

(method) plugins.treeview:on_mouse_left()

on_mouse_moved​

(method) plugins.treeview:on_mouse_moved(px: any, py: any, ...any)

on_scale_change​

(method) plugins.treeview:on_scale_change(new_scale: any, prev_scale: any)

open_doc​

(method) plugins.treeview:open_doc(filename: any)

set_selection​

(method) plugins.treeview:set_selection(selection: any, selection_y: any, center: any, instant: any)

set_selection_to_path​

(method) plugins.treeview:set_selection_to_path(path: string, expand: boolean, scroll_to: boolean, instant: boolean)
  -> table?

Sets the selection to the file with the specified path.

@param path: string — Absolute path of item to select

@param expand: boolean — Expand dirs leading to the item

@param scroll_to: boolean — Scroll to make the item visible

@param instant: boolean — Don't animate the scroll

@return: table? — The selected item

set_target_size​

(method) plugins.treeview:set_target_size(axis: any, value: any)
  -> boolean

toggle_expand​

(method) plugins.treeview:toggle_expand(toggle: any, item: any)

update​

(method) plugins.treeview:update()