File

Object Hierarchy:

Description:

if (file.buffer == null) {
    file.manager.buffer_provider.create_buffer(file);
}
var contents = yield file.buffer.read_async();

Content:

Properties:

• public FileBuffer? buffer { get; set; }
  File buffer instance (nullable).
• public int cursor_line { get; set; }
  Last cursor line number (stored in database, default: 0).
• public int cursor_offset { get; set; }
  Last cursor character offset (stored in database, default: 0).
• public string display_basename { owned get; }
  Display name with basename only: basename on first line. Format: { basename}\n
• public override string display_with_indicators { get; }
  Display text with status indicators (approved, unsaved).
• public string display_with_path { owned get; }
  Display name with path: basename on first line, dirname on second line in grey. Format: {basename}\n<span grey small dirname>
• public override string icon_name { get; set; }
• public bool is_need_approval { get; set; }
  Whether the file needs approval. true = needs approval, false = approved.
• public bool is_open { get; }
  Whether file is currently open in editor. Computed property: Returns true if file was viewed within last week.
• public bool is_unsaved { get; set; }
  Whether the file has unsaved changes.
• public int scroll_position { get; set; }
  Last scroll position (stored in database, optional, default: 0).

Creation methods:

• public File (ProjectManager manager)
  Constructor.
• public File.new_fake (ProjectManager manager, string path)
  Named constructor: Create a fake File object for files not in database.
• public File.new_from_info (ProjectManager manager, Folder? parent, FileInfo info, string path)
  Named constructor: Create a File from FileInfo.

Methods:

• public void approve ()
  Approve this file and all its FileHistory items.
• public async FileUpdateStatus check_updated ()
  Check if the file has been modified on disk and differs from the buffer.
• public string get_contents (int max_lines = 0)
  Gets file contents, optionally limited to first N lines.
• public int get_cursor_position ()
  Gets the current cursor position (line number).
• public string get_line_content (int line)
  Gets the content of a specific line.
• public int get_line_count ()
  Gets the total number of lines in the file.
• public string get_selected_code ()
  Gets the currently selected text (only valid for active file).
• public bool is_documentation ()
  Whether this file is a documentation file (plain text or markdown, not code).
• public async void revert () throws Error
  Revert this file to previous version from FileHistory backup.
• public override string to_summary (HashMap<int,VectorMetadata> keymap, string indent)
  Icon name for binding in lists. Returns icon_name if set, otherwise derives from file content type.

Signals:

• public signal void changed ()
  Emitted when file content changes.

Inherited Members: