Skip to content

Commit

Permalink
add docs for autostart
Browse files Browse the repository at this point in the history
  • Loading branch information
sccolbert committed Feb 11, 2014
1 parent cb0ff33 commit a226c27
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions examples/workbench/crash_course.rst
Original file line number Diff line number Diff line change
Expand Up @@ -389,6 +389,14 @@ extension points:
window. The extension factory function should accep the workbench as
an argument and return an instance of Workspace.

'autostart'
Extensions to this point can be used to provide the id of a plugin
which should be started preemptively on application startup. The
extension should declare children of type Autostart. The plugins will
be started in order of extension rank. Warning - abusing this facility
can cause drastic slowdowns in application startup time. Only use it
if you are *absolutely* sure your plugin must be loaded on startup.

The plugin declares the following extensions:

'default_application_factory'
Expand Down Expand Up @@ -632,6 +640,21 @@ stop
of the workspace. The content Container will be destroyed automatically
after this method returns.

Autostart
~~~~~~~~~
The Autostart class is a declarative class which is used to supply the
plugin id for a plugin which should be automatically started on application
startup.

The Autostart class can be imported from `enaml.workbench.ui.api`.

It has the following attributes of interest.

plugin_id
This is the id of the plugin to start on application startup. The
manifest for the plugin must be registered before the ui plugin is
started.

UI Workbench
------------
The UIWorkbench class is a simple sublass of Workbench for creating ui
Expand Down

0 comments on commit a226c27

Please sign in to comment.