rnhmjoj/qutebrowser
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update HACKING. Closes #131.

Browse Source
This commit is contained in:
Florian Bruhin 2014-10-06 21:28:33 +02:00
parent fd9a3fc5e7
commit 4d35782cc2
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/HACKING.asciidoc
View File

@ -292,15 +292,17 @@ There are currently these object registries, also called 'scopes':
* The `global` scope, with objects which are used globally (`config`, * The `global` scope, with objects which are used globally (`config`,
`cookie-jar`, etc.) `cookie-jar`, etc.)
* The `tab` scope with objects which are per-tab (`hintmanager`, `webview`, * The `tab` scope with objects which are per-tab (`hintmanager`, `webview`,
etc.). Passing this scope to `objreg.get()` always selects the object in the etc.). Passing this scope to `objreg.get()` selects the object in the currently
currently focused tab. focused tab by default. A tab can be explicitely selected by passing
+tab=_tab-id_, window=_win-id_+ to it.
A new object can be registered by using A new object can be registered by using
+objreg.register(_name_, _object_[, scope=_scope_])+. An object should not be +objreg.register(_name_, _object_[, scope=_scope_, window=_win-id_,
registered twice. To update it, `update=True` has to be given. tab=_tab-id_])+. An object should not be registered twice. To update it,
`update=True` has to be given.
An object can be retrieved by using +objreg.get(_name_[, scope=_scope_])+. The An object can be retrieved by using +objreg.get(_name_[, scope=_scope_,
default scope is `global`. window=_win-id_, tab=_tab-id_])+. The default scope is `global`.
All objects can be printed by starting with the `--debug` flag and using the All objects can be printed by starting with the `--debug` flag and using the
`:debug-all-objects` command. `:debug-all-objects` command.