PyAbiWord
From AbiWiki
MartinSevior (Talk | contribs) |
(formatting details) |
||
| Line 1: | Line 1: | ||
| - | + | =PyAbiWord= | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
[[PyAbiWord|PyAbiWord]] is a set of wrappers around [[AbiWidget|AbiWidget]] that enable python programmers to use [[AbiWord|AbiWord]] in their [[PyGtk|PyGtk]] applications. | [[PyAbiWord|PyAbiWord]] is a set of wrappers around [[AbiWidget|AbiWidget]] that enable python programmers to use [[AbiWord|AbiWord]] in their [[PyGtk|PyGtk]] applications. | ||
| - | + | ==Getting the Source Code from SVN== | |
This set of code is available from the [[AbiWord|AbiWord]] cvs server with module name "pyabiword". | This set of code is available from the [[AbiWord|AbiWord]] cvs server with module name "pyabiword". | ||
| Line 20: | Line 15: | ||
svn co http://svn.abisource.com/pyabiword/trunk pyabiword | svn co http://svn.abisource.com/pyabiword/trunk pyabiword | ||
| - | + | ==Building pyabiword== | |
To build it, you must first build libabiword as described in [[AbiWordSDK|AbiWordSDK]]. Note that for post 2.6, libabiword should be built with the "--enable-dynamic" configure option. | To build it, you must first build libabiword as described in [[AbiWordSDK|AbiWordSDK]]. Note that for post 2.6, libabiword should be built with the "--enable-dynamic" configure option. | ||
| Line 50: | Line 45: | ||
environment variable is set so that /Path/To/Install/lib/python2.4/site-packages or Path/To/Install/lib/python2.5/site-packages is discoverable. | environment variable is set so that /Path/To/Install/lib/python2.4/site-packages or Path/To/Install/lib/python2.5/site-packages is discoverable. | ||
| - | To use the [[ | + | To use the [[AbiWidget]] from within python call the "Canvas()" method on the abiword object. This returns the [[AbiWidget]] object which can be used like any other [[PyGtk|PyGtk]] [[GtkWidget|GtkWidget]] in addition to it''s own methods. |
Like the C version of [[AbiWidget|AbiWidget]], by default, [[PyAbiWord|PyAbiWord]] starts in "OLPC" mode, which is "Normal View", with a small left border, zoom set to page widget and selections are made on per word granularity. | Like the C version of [[AbiWidget|AbiWidget]], by default, [[PyAbiWord|PyAbiWord]] starts in "OLPC" mode, which is "Normal View", with a small left border, zoom set to page widget and selections are made on per word granularity. | ||
| Line 68: | Line 63: | ||
The Python wrapper supports all the [[[AbiWordSignals|AbiWordSignals]] signals] emitted by [[AbiWidget|AbiWidget]]. | The Python wrapper supports all the [[[AbiWordSignals|AbiWordSignals]] signals] emitted by [[AbiWidget|AbiWidget]]. | ||
| - | + | = TableCreator = | |
In addition to [[AbiWidget|AbiWidget]], [[PyAbiWord|PyAbiWord]] also wraps a useful little widget [[TableCreator|TableCreator]]. This widget allows users to interactively insert a table of specified size by dragging a mouse. | In addition to [[AbiWidget|AbiWidget]], [[PyAbiWord|PyAbiWord]] also wraps a useful little widget [[TableCreator|TableCreator]]. This widget allows users to interactively insert a table of specified size by dragging a mouse. | ||
Follow the link to [[TableCreator|TableCreator]] to learn how to use this. | Follow the link to [[TableCreator|TableCreator]] to learn how to use this. | ||
| - | + | = Example Code = | |
| - | + | == A very simple program - test.py == | |
<pre> | <pre> | ||
#!/usr/bin/python | #!/usr/bin/python | ||
| Line 98: | Line 93: | ||
</pre> | </pre> | ||
| - | |||
| - | |||
| - | |||
| - | |||
| - | + | [[Category:Developer]] | |
| - | + | [[Category:Python]] | |
| - | [[Category: | + | |
Revision as of 07:45, 20 July 2009
Contents |
PyAbiWord
PyAbiWord is a set of wrappers around AbiWidget that enable python programmers to use AbiWord in their PyGtk applications.
Getting the Source Code from SVN
This set of code is available from the AbiWord cvs server with module name "pyabiword".
For version 2.6 (the current stable version of AbiWord) do:
svn co http://svn.abisource.com/pyabiword/branches/ABI-2-6-0-STABLE/ pyabiword
You get the current development version with:
svn co http://svn.abisource.com/pyabiword/trunk pyabiword
Building pyabiword
To build it, you must first build libabiword as described in AbiWordSDK. Note that for post 2.6, libabiword should be built with the "--enable-dynamic" configure option.
After that make sure that the
PKG_CONFIG_PATH
environment variable is set so that abiword-2.6.pc or abiword-2.7.pc is discoverable.
After that configure pyabiword with:
./configure --prefix=/Path/To/Install
and "make" it.
The appropriate packages will be placed in:
/Path/To/Install/lib/python2.4/site-packages
or
/Path/To/Install/lib/python2.5/site-packages
depending on your version of python. Then make sure your
PYTHONPATH
environment variable is set so that /Path/To/Install/lib/python2.4/site-packages or Path/To/Install/lib/python2.5/site-packages is discoverable.
To use the AbiWidget from within python call the "Canvas()" method on the abiword object. This returns the AbiWidget object which can be used like any other PyGtk GtkWidget in addition to its own methods.
Like the C version of AbiWidget, by default, PyAbiWord starts in "OLPC" mode, which is "Normal View", with a small left border, zoom set to page widget and selections are made on per word granularity.
You can turn this behaviour off with the:
set_show_margin(False)
and
set_word_selections(False)
Methods.
You can find a complete listing of all the methods available to the python AbiWidget at PyAbiWordMethods.
The Python wrapper supports all the [[[AbiWordSignals|AbiWordSignals]] signals] emitted by AbiWidget.
TableCreator
In addition to AbiWidget, PyAbiWord also wraps a useful little widget TableCreator. This widget allows users to interactively insert a table of specified size by dragging a mouse.
Follow the link to TableCreator to learn how to use this.
Example Code
A very simple program - test.py
#!/usr/bin/python
import sys
import pygtk
pygtk.require("2.0")
import gtk
import abiword
window = gtk.Window()
window.set_default_size(640, 480)
window.connect("delete-event", gtk.main_quit)
abi = abiword.Canvas()
window.add(abi)
window.show_all()
abi.load_file("test.abw")
gtk.main()
