ocarina/src/doc/events.txt
2010-02-24 23:34:02 -05:00

105 lines
2.8 KiB
Plaintext

Documentation for events.
cli-loop-begin:
Started in plugins.cline.loop.loop(), at the beginning of every loop
cli-loop-end:
Started in plugins.cline.loop.loop(), at the end of every loop
message-write:
Started in bt.message.py to print a message
Stopped in plugins.cline.message.insert()
plugins.cline.message.insert()
Invited in plugins.cline.loop.init(), Priority 90
Uses ncurses to display the message
core.bt.message.disp()
Invited in bt.message.py, Default priority
Uses the python print function to display text
scion-begin:
Started in core/scion.py to begin a loop
core.bt.scripting.runScripts()
Invited in core.bt.scripting.checkForScripts(), Priority 0
Runs all scripts
extra.sgtk.Plugin.loop()
Invited in extra.sgtk.Plugin.open(), Priority 90
Begins a gtk main loop
plugins.cline.loop.loop()
Invited in plugins.cli.Plugin.open(), Default priority
Removed in plugins.cli.Plugin.close()
Sets the command line loop and the default start function
scion-end:
Started in plugins.exit.run() to begin the shutdown procedure
core.manager.Manager.shutdown()
Invited in core.manager.Manager.__init__(), Priority 0
Disables and saves all active plugins
extra.sgtk.Plugin.close()
Invited in extra.sgtk.Plugin.open(), Priority 90
Stops the gtk main loop
core.aliases.Alias.save()
Invited in core.aliases.Alias.__init__(), Priority 90
Saves aliases to a file to be read in on next startup
core.settings.Settings.save()
Invited in core.settings.Settings.__init__(), Default priority
Saves all settings key/value pairs to a file
plugins.cline.loop.quit()
Invited in plugins.cli.Plugin.open(), Default priority
Removed in plugins.cli.Plugin.close()
Reverts ncurses stuff
scion-plugins-loaded:
Started in core/scion.py after loading plugins
core.bt.proc.setup()
Invited in session.py, Priority 0
Sets the application name and prints a welcome message
core.session.Session.setSession()
Invited in session.py, Priority 1
Creates the session directory if it doesn't already exist
core.settings.load()
Invited in core.settings.Settings.__init__(), Priority 2
Loads user settings from a saved file
core.aliases.Alias.load()
Invited in core.aliases.Alias.__init__(), Priority 3
Loads user aliases from a file
core.manager.startup()
Invited in core.manager.Manager.__init__(), Default priority
Enables the plugins that the user had enabled before the last shutdown
core.bt.scripting.checkForScripts()
Invited in core.bt.scripting, Default priority
Checks if scripts have been registered on startup
scion-process-args:
Started in core/session.py when we are given arguments
core.bt.scripting.isScript()
Invited in core.bt.scripting, Default priority
Checks if a file is a script