TextFlow API
Create a TextFlow API to support plugins
Blueprint information
- Status:
- Started
- Approver:
- None
- Priority:
- Undefined
- Drafter:
- Yuri Malheiros
- Direction:
- Needs approval
- Assignee:
- Yuri Malheiros
- Definition:
- Approved
- Series goal:
- Accepted for trunk
- Implementation:
- Good progress
- Milestone target:
- 0.3.1
- Started by
- Yuri Malheiros
- Completed by
Related branches
Related bugs
Bug #445636: create tf.app module | Fix Committed |
Bug #445647: rename textflow module to tf | Fix Committed |
Bug #448187: Move document module to tf directory | Fix Committed |
Bug #448209: Move preferencesmanager module to tf directory | Fix Committed |
Bug #449595: Move documentmanager module to tf directory | Fix Committed |
Bug #449601: Move window module to tf directory | Fix Committed |
Sprints
Whiteboard
The TF API is one more step to support language extensions created by users.
Users need a easy way to use the most relevant features of TextFlow to implement extensions. To achieve this we need to create a better API to some classes.
Now I will list these classes and their important points.
*** tf.app ***
This module provides functions to get important objects, for example, DocumentManager, PreferencesManager and MainWindow.
These objects will be created and assigned to a module variable. Then to get these objects you only need to do:
import tf.app
tf.app.some_object
So, we can stop to pass DocumentManager and MainWindow objects in classes constructors.
*** tf.document.
The Document class that already exists. We only need to put it in the root directory.
*** tf.window.Window() ***
The Window class that already exists. We need to put it in the root directory.
The API need a review.
*** tf.documentmana
The DocumentManager class that already exists. We need to put it in the root directory.
The API need a review.
*** tf.preferences.
The PreferencesManager class that already exists. We need to put it in the root directory and rename it.