Plugin API

The list below gives fman's API. It lives in the Python module fman. For examples of how to use it, please refer to the Introduction or the Core plugin.

  • ApplicationCommand
    • .aliases
  • DirectoryPaneCommand
    • .get_chosen_files()
    • .pane
      • .get_selected_files()
      • .get_file_under_cursor()
      • .move_cursor_down(toggle_selection=False)
      • .move_cursor_up(toggle_selection=False)
      • .move_cursor_home(toggle_selection=False)
      • .move_cursor_end(toggle_selection=False)
      • .move_cursor_page_down(toggle_selection=False)
      • .move_cursor_page_up(toggle_selection=False)
      • .place_cursor_at(file_path)
      • .get_path()
      • .set_path(dir_path, callback=None)
      • .edit_name(file_path)
      • .select_all()
      • .clear_selection()
      • .toggle_selection(file_path)
      • get_commands()
      • run_command(name, args={})
      • get_command_aliases(command_name)
      • .window
        • .get_panes()
    • .aliases
  • DirectoryPaneListener
    • .on_doubleclicked(file_path)
    • .on_name_edited(file_path, new_name)
    • .on_path_changed()
    • .on_files_dropped(file_paths, dest_dir, is_copy_not_move)
    • .pane
  • load_json(name, default=None, save_on_quit=False)
  • save_json(name, value=None)
  • show_alert(text, buttons=OK, default_button=OK)
  • show_prompt(text, default='')
  • show_status_message(text, timeout_secs=None)
  • clear_status_message()
  • show_file_open_dialog(caption, dir_path, filter_text)
  • get_application_commands()
  • run_application_command(name, args={})
  • get_application_command_aliases(command_name)
  • show_quicksearch(get_items, get_tab_completion=None)
  • QuicksearchItem(value, title=None, highlight=None, hint='', description='')
  • clipboard
    • .clear()
    • .set_text(text)
    • .get_text()
    • .copy_files(file_paths)
    • .cut_files(file_paths)
    • .get_files()
    • .files_were_cut()
  • load_plugin(plugin_dir)
  • PLATFORM, FMAN_VERSION, DATA_DIRECTORY
  • OK, CANCEL, YES, NO, YES_TO_ALL, NO_TO_ALL, ABORT

If you have questions about developing plugins for fman, or want to suggest improvements/extensions to the API, please let us know. We want to make fman's plugin support truly outstanding. Your feedback can guide us there!