Leo API Documentation Release 4.11Dev
Total Page:16
File Type:pdf, Size:1020Kb
Leo API Documentation Release 4.11dev Ed K. Ream May 31, 2018 Contents 1 leo Package 3 1.1 leo Package...............................................3 1.2 Subpackages...............................................3 1.2.1 core Package..........................................3 1.2.1.1 core Package.....................................3 1.2.1.2 bzr_version Module...............................3 1.2.1.3 format-code Module...............................3 1.2.1.4 leoApp Module...................................3 1.2.1.5 leoAtFile Module................................. 11 1.2.1.6 leoBridge Module................................. 22 1.2.1.7 leoBridgeTest Module.............................. 23 1.2.1.8 leoCache Module.................................. 23 1.2.1.9 leoChapters Module............................... 25 1.2.1.10 leoColor Module.................................. 27 1.2.1.11 leoCommands Module............................... 28 1.2.1.12 leoCompare Module................................ 40 1.2.1.13 leoConfig Module................................. 42 1.2.1.14 leoDebugger Module............................... 42 1.2.1.15 leoDynamicTest Module............................. 42 1.2.1.16 leoEditCommands Module............................ 43 1.2.1.17 leoFileCommands Module............................ 43 1.2.1.18 leoFind Module................................... 48 1.2.1.19 leoFrame Module.................................. 57 1.2.1.20 leoGlobals Module................................ 57 1.2.1.21 leoGui Module................................... 83 1.2.1.22 leoIPython Module................................ 83 1.2.1.23 leoImport Module................................. 83 1.2.1.24 leoInspect Module................................ 89 1.2.1.25 leoKeys Module................................... 89 1.2.1.26 leoMenu Module................................... 101 1.2.1.27 leoNodes Module.................................. 103 1.2.1.28 leoPlugins Module................................ 117 1.2.1.29 leoPymacs Module................................. 120 1.2.1.30 leoRst Module................................... 120 1.2.1.31 leoSessions Module............................... 120 1.2.1.32 leoShadow Module................................. 121 i 1.2.1.33 leoTangle Module................................. 124 1.2.1.34 leoTest Module................................... 128 1.2.1.35 leoUndo Module................................... 128 1.2.1.36 leoVersion Module................................ 132 1.2.1.37 runLeo Module................................... 132 1.2.2 extensions Package....................................... 132 1.2.2.1 extensions Package................................ 132 1.2.2.2 asciidoc Module.................................. 132 1.2.2.3 colors Module................................... 149 1.2.2.4 patch_11_01 Module............................... 149 1.2.2.5 sh Module....................................... 150 1.2.2.6 testExtension Module.............................. 150 1.2.3 external Package........................................ 150 1.2.3.1 external Package.................................. 150 1.2.3.2 codewise Module.................................. 150 1.2.3.3 edb Module...................................... 154 1.2.3.4 ipy_leo Module................................... 163 1.2.3.5 leoSAGlobals Module............................... 163 1.2.3.6 leoftsindex Module............................... 170 1.2.3.7 leosax Module................................... 170 1.2.3.8 lproto Module................................... 171 1.2.3.9 stringlist Module................................ 171 1.2.3.10 Subpackages...................................... 172 1.2.4 plugins Package......................................... 177 1.2.4.1 plugins Package.................................. 177 1.2.4.2 FileActions Module............................... 177 1.2.4.3 active_path Module............................... 178 1.2.4.4 add_directives Module............................. 181 1.2.4.5 at_folder Module................................. 181 1.2.4.6 at_produce Module................................ 182 1.2.4.7 at_view Module................................... 182 1.2.4.8 attrib_edit Module............................... 182 1.2.4.9 backlink Module.................................. 182 1.2.4.10 baseNativeTree Module............................. 182 1.2.4.11 bibtex Module................................... 182 1.2.4.12 bigdash Module................................... 184 1.2.4.13 bookmarks Module................................. 184 1.2.4.14 bzr_qcommands Module.............................. 184 1.2.4.15 chapter_hoist Module.............................. 184 1.2.4.16 codewisecompleter Module........................... 184 1.2.4.17 colorize_headlines Module.......................... 184 1.2.4.18 contextmenu Module............................... 184 1.2.4.19 ctagscompleter Module............................. 184 1.2.4.20 cursesGui Module................................. 184 1.2.4.21 datenodes Module................................. 184 1.2.4.22 debugger_pudb Module.............................. 185 1.2.4.23 dragdropgoodies Module............................ 185 1.2.4.24 dtest Module.................................... 185 1.2.4.25 dump_globals Module............................... 186 1.2.4.26 empty_leo_file Module............................. 186 1.2.4.27 enable_gc Module................................. 186 1.2.4.28 expfolder Module................................. 187 1.2.4.29 free_layout Module............................... 187 1.2.4.30 ftp Module...................................... 187 ii 1.2.4.31 geotag Module................................... 187 1.2.4.32 gitarchive Module................................ 187 1.2.4.33 graphcanvas Module............................... 188 1.2.4.34 gtkDialogs Module................................ 188 1.2.4.35 gtkGui Module................................... 188 1.2.4.36 import_cisco_config Module......................... 188 1.2.4.37 initinclass Module............................... 188 1.2.4.38 interact Module.................................. 189 1.2.4.39 internal_ipkernel Module........................... 189 1.2.4.40 ipython Module................................... 189 1.2.4.41 ironPythonGui Module.............................. 189 1.2.4.42 jinjarender Module............................... 189 1.2.4.43 leoOPML Module................................... 189 1.2.4.44 leo_interface Module.............................. 193 1.2.4.45 leo_pdf Module................................... 194 1.2.4.46 leo_to_html Module............................... 201 1.2.4.47 leo_to_rtf Module................................ 205 1.2.4.48 leocursor Module................................. 206 1.2.4.49 leofeeds Module.................................. 207 1.2.4.50 leofts Module................................... 208 1.2.4.51 leomail Module................................... 208 1.2.4.52 leomylyn Module.................................. 208 1.2.4.53 leoremote Module................................. 208 1.2.4.54 leoscreen Module................................. 208 1.2.4.55 lineNumbers Module............................... 208 1.2.4.56 livecode Module.................................. 209 1.2.4.57 macros Module................................... 209 1.2.4.58 maximizeNewWindows Module.......................... 210 1.2.4.59 mime Module..................................... 210 1.2.4.60 mnplugins Module................................. 211 1.2.4.61 mod_autosave Module............................... 211 1.2.4.62 mod_framesize Module.............................. 211 1.2.4.63 mod_http Module.................................. 212 1.2.4.64 mod_leo2ascd Module............................... 218 1.2.4.65 mod_read_dir_outline Module........................ 219 1.2.4.66 mod_scripting Module.............................. 219 1.2.4.67 mod_speedups Module............................... 219 1.2.4.68 mod_tempfname Module.............................. 220 1.2.4.69 mod_timestamp Module.............................. 220 1.2.4.70 multifile Module................................. 220 1.2.4.71 nav_qt Module................................... 221 1.2.4.72 nested_splitter Module............................ 221 1.2.4.73 niceNosent Module................................ 221 1.2.4.74 nodeActions Module............................... 221 1.2.4.75 nodediff Module.................................. 224 1.2.4.76 nodetags Module.................................. 226 1.2.4.77 nodewatch Module................................. 226 1.2.4.78 notebook Module.................................. 226 1.2.4.79 open_shell Module................................ 226 1.2.4.80 outline_export Module............................. 227 1.2.4.81 paste_as_headlines Module.......................... 227 1.2.4.82 pluginsTest Module............................... 227 1.2.4.83 plugins_menu Module............................... 227 1.2.4.84 pretty_print Module............................... 228 iii 1.2.4.85 projectwizard Module.............................. 229 1.2.4.86 python_terminal Module............................ 229 1.2.4.87 qtGui Module.................................... 229 1.2.4.88 qt_main Module................................... 229 1.2.4.89 qt_quicksearch Module............................. 229 1.2.4.90 qtframecommands Module............................ 229 1.2.4.91 quickMove Module................................. 229 1.2.4.92 quicksearch Module............................... 229 1.2.4.93 quit_leo