TextFlow API

Registered by Yuri Malheiros on 2009-08-26

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:
milestone icon 0.3.1
Started by
Yuri Malheiros on 2009-10-07

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.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.documentmanager.DocumentManager() ***
The DocumentManager class that already exists. We need to put it in the root directory.
The API need a review.

*** tf.preferences.Preferences() ***
The PreferencesManager class that already exists. We need to put it in the root directory and rename it.

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.