class

Opal::UI::FileDialog

Inherits Opal::UI::Control < Opal::UI::InputHookable < Opal::UI::Element < Opal::UI::Themable < Reference < Object

Interactive file and directory picker with directory traversal, file type filters, save file mode, new file/folder creation, theme compliance, and full mouse hit detection.

Constructors

new(initial_path : String = ".", mode : Symbol = :open_file, show_hidden : Bool = false, filters : Array(String) = [] of String, filter_presets : Array(Tuple(String, Array(String))) = [] of ::Tuple(String, Array(String)), preview_fn : Proc(String, String) | Nil = nil)

Instance methods

active_filter_idx

active_filter_idx=(active_filter_idx : Int32)

append_char(ch : Char) : Nil

backspace

canceled?

change_directory(new_path : String) : Nil

confirm_folder(folder_path : String = @current_path) : Bool

confirmed?

current_filter_extensions

Returns active file extensions allowed by the current filter preset or filter list

current_path

cursor

cursor=(cursor : Int32)

cursor_down

cursor_up

cycle_filter

entries

filename_input

Filename input for save / new file modes

filename_input=(filename_input : String)

Filename input for save / new file modes

filter_presets

filter_presets=(filter_presets : Array(Tuple(String, Array(String))))

filter_query

filter_query=(filter_query : String)

filtered_entries

filters

File type filters (e.g. [".cr", ".json"])

filters=(filters : Array(String))

File type filters (e.g. [".cr", ".json"])

go_up

handle_key(key : Terminal::KeyEvent) : Bool

Default key event handler. Override in subclasses if not using @default_input_proc.

handle_mouse(event : Terminal::MouseEvent) : Bool

Default mouse event handler. Override in subclasses if not using @default_input_proc.

load_entries(dir_path : String = @current_path) : Nil

mode

mode=(mode : Symbol)

open_selected

overwrite_warning=(overwrite_warning : Bool)

overwrite_warning?

page_down(lines : Int32 = 10) : Nil

page_up(lines : Int32 = 10) : Nil

preferred_size(available_w : Int32, available_h : Int32) : Tuple(Int32, Int32)

preview_fn

preview_fn=(preview_fn : Proc(String, String) | Nil)

render(buffer : Buffer, x : Int32, y : Int32, width : Int32, height : Int32) : Nil

selected_entry

selected_path

show_hidden?

toggle_hidden

validation_error

validation_error=(validation_error : String | Nil)