README.md

Far Manager Plugins API bindings for Python

The python plugin has only one purpose - to facilitate the writing of scripts that extend the capabilities of FarManager.

Useful links

• Far Manager website
• Far Manager Plugins API reference

Howto

• Just place far3python.dll and far3 directory inside plugins path searched by FarManager.

• Logging and logger configuration There is a logger.ini file, you can set your own log information preferences there. By default, the log is saved to the file w:/temp/far3-py.log.

• Fundamentals

• plugins must be accessible via PYTHONPATH

• the plugins are loaded with the command "py:load filename" for example py:load ucharmap

• unloading the plugin is done with the command "py:unload filename" for example py:unload ucharmap

• ucharmap - an example plugin showing part of the UTF-8 character set F11 + "Python Character Map" - display its dialog after pressing Enter/OK selected character is coppied into clipboard, character selection is done with mouse or arrows

• utranslate - how to use Google translate for spellchecker and text translation F11 + "Python Translate" - display help dialog

Testing

• 'CFFI callbacks test dialog - check CFFI generated bindings for dialog
• 'CFFI callbacks test settings - check CFFI generated bindings for settings

Implementation status

Basic API

Export functions

• ExitFARW
• GetGlobalInfoW
• GetPluginInfoW
• OpenW
• SetStartupInfoW

Service functions

• GetMsg
• InputBox
• Menu
• Message
• ShowHelp

Panel API

Export functions

• AnalyseW
• CloseAnalyseW
• ClosePanelW
• CompareW
• DeleteFilesW
• FreeFindDataW
• GetFilesW
• GetFindDataW
• GetOpenPanelInfoW
• MakeDirectoryW
• ProcessPanelEventW
• ProcessHostFileW
• ProcessPanelInputW
• PutFilesW
• SetDirectoryW
• SetFindListW

Service functions

• PanelControl
• FileFilterControl
• FreeDirList
• FreePluginDirList
• GetDirList
• GetPluginDirList

Editor API

Export functions

• ProcessEditorInputW
• ProcessEditorEventW

Service functions

• Editor
• EditorControl

Viewer API

Export functions

• ProcessViewerEventW

Service functions

• Viewer
• ViewerControl

Dialog API

Export functions

• ProcessDialogEventW

Service functions

• DefDlgProc
• DialogFree
• DialogInit
• DialogRun
• SendDlgMessage

Settings API

Export functions

• ConfigureW

Service functions

• SettingsControl

Plugin Manager API

Service functions

• PluginsControl

Miscellaneous API

Export functions

• ProcessConsoleInputW
• ProcessSynchroEventW

Service functions

• AdvControl
• ColorDialog
• RegExpControl
• RestoreScreen
• SaveScreen
• Text

Macro API

Service functions

• MacroControl

License

This project is licensed under the terms of the MIT license.

See LICENSE-MIT