Difference between revisions of "Features/Evince Introspection Bindings"

Latest revision as of 14:09, 5 November 2013

Summary

The pygtk bindings used until F14 to use the evince backend in Read activity, are no longer present in F16. We need use the new gi based bindings

Owner

Gonzalo Odiard

Current status

Targeted release: 0.96
Last updated: 31 Jan 2012
Percentage of completion: 100%

Initial information

This feature depends on evince 3.4 (shipped in F17)

The bindings are already fixed and packaged in Fedora Rawhide

Implementation plan

The first step is port this simple demo to gtk3:

e = evince.View()
docmodel = evince.DocumentModel()
doc = evince.document_factory_get_document('file:///path/to/file/example.pdf')
docmodel.set_document(doc)
e.set_model(model)

With gtk 3 is:

from gi.repository import Gtk, Gio
from gi.repository import EvinceDocument
from gi.repository import EvinceView

class HelloWorldApp(Gtk.Application):
   def __init__(self):
       Gtk.Application.__init__(self, application_id="apps.test.helloevince",
                                flags=Gio.ApplicationFlags.FLAGS_NONE)
       self.connect("activate", self.on_activate)
       
   def on_activate(self, data=None):
       window = Gtk.Window(type=Gtk.WindowType.TOPLEVEL)
       window.set_title("Evince Gtk3 Python Example")
       window.set_border_width(24)

       scroll = Gtk.ScrolledWindow()
       window.add(scroll)

       EvinceDocument.init()
       doc = EvinceDocument.Document.factory_get_document('file:///home/gonzalo/Desktop/AjedrezyLeyendas-Postmortem.pdf')
       view = EvinceView.View()
       model = EvinceView.DocumentModel()
       model.set_document(doc)
       view.set_model(model)
       scroll.add(view)

       window.show_all()
       self.add_window(window)
   
if __name__ == "__main__":
   app = HelloWorldApp()
   app.run(None)

More information

Not directly related. Evince developers have a request to support epub format [1].

We are implementing our own epub reader displaying it with webkit. If implemented in evince, we can simplify our code a lot.

Benefit to Sugar

Have a working Read activity. Evince does not include the old bindings anymore.

Scope

What work do the developers have to accomplish to complete the feature in time for release? Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?

UI Design

Does the feature have a direct impact on the work flow, or does it need a UI? Link here mockups, or add detailed descriptions.

How To Test

Need be tested in a F17 based image

Dependencies

Evince 3.4

Release Notes

This change is a internal implementation issue. To the users should be almost equal than the previous version.

Comments and Discussion

See discussion tab for this feature

@@ Line 1: / Line 1: @@
-<noinclude>{{TOCright}}
+<noinclude>
-[[Category:Feature Page Incomplete]]
+[[Category:FeatureLanded|Evince Introspection Bindings]]
-[[Category:Feature|WebKit]]
 <!-- You can add categories to tie features back to real deployments/schools requesting them, for example
 [[Category:Features requested by School Xyz|<Feature Name>]] (the |Feature Name option sorts the entry on the category page under the first letter of <Feature Name>). -->
@@ Line 16: / Line 15: @@
 == Current status ==
 * Targeted release: 0.96
-* Last updated: 04/11/2011
+* Last updated: 31 Jan 2012
-* Percentage of completion: 80%
+* Percentage of completion: 100%
 == Initial information ==
-* The bindings are not ready to use. We need work closely with upstream to solve the remaining issues.
+* This feature depends on evince  3.4 (shipped in F17)
-There is a related bug https://bugzilla.gnome.org/show_bug.cgi?id=635705
+* The bindings are already fixed and packaged in Fedora Rawhide
-the evince developers know we need it, and they are working on this.
-The patches are against evince 3.4 (shipped in F17), after review of the patches, we need look if it can be backported to evince 3.2
-to update Fedora 16.
 === Implementation plan ===
@@ Line 81: / Line 77: @@
 == Benefit to Sugar ==
-''What is the benefit to the platform?  If this is a major capability update, what has changed?  If this is a new feature, what capabilities does it bring? Why will Sugar become a better platform or project because of this feature?''
-''Make sure to note here as well if this feature has been requested by a specific deployment, or if it has emerged from a bug report.''
+Have a working Read activity. Evince does not include the old bindings anymore.
 == Scope ==
@@ Line 93: / Line 88: @@
 == How To Test ==
-== User Experience ==
+Need be tested in a F17 based image
-''If this feature is noticeable by its target audience, how will their experiences change as a result?  Describe what they will see or notice.''
 == Dependencies ==
+Evince 3.4
-== Contingency Plan ==
+== Release Notes ==
-''If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "None necessary, revert to previous release behaviour."  Or it might not.  If your feature is not completed in time, we want to assure others that other parts of Sugar will not be in jeopardy.''
-== Documentation ==
+This change is a internal implementation issue. To the users should be almost equal than the previous version.
-''Is there upstream documentation on this feature, or notes you have written yourself?  Has this topic been discussed in the mailing list or during a meeting? Link to that material here so other interested developers can get involved.''
-== Release Notes ==
-''The Sugar Release Notes inform end-users about what is new in the release. An Example is [[0.84/Notes]]. The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this feature, indicate them here.  You can also link to upstream documentation if it satisfies this need.  This information forms the basis of the release notes edited by the release team and shipped with the release.''
 == Comments and Discussion ==
 * See [[{{TALKPAGENAME}}|discussion tab for this feature]]