操作指南

Python (pyuno) "Hello World" OpenOffice 插件

于 2009年2月6日

在我最近几篇关于 pyuno (SSConverter, OORunner) 的文章中，我们使用 pyuno 通过从 Python 运行 OpenOffice，并使用 pyuno 作为这两个进程之间的桥梁，将电子表格转换为 CSV 文件。在这篇文章中，我们将深入 OpenOffice 内部，并使用 pyuno 作为 OpenOffice 和嵌入式 Python 解释器（嵌入在 OpenOffice 内部）之间的桥梁。

按照惯例，我们学习新事物时的第一个程序必须是“Hello World”程序。这里的想法是在 OpenOffice 菜单中添加一个选项，该选项将在电子表格的第一个单元格中插入“Hello World”。作为此示例的起点，我使用了 pyuno udk 站点上的一个示例（页面上的第二个“Hello World”示例）。

那里的示例基本上与这里的示例做相同的事情，除了它将“Hello World”插入到 Writer（文字处理器）文档而不是电子表格中。人们会认为这是一个相当容易的转换，一旦我知道答案就是这样。困难的部分是弄清楚如何获取“电子表格”对象，然后如何从中获取“单元格”对象。这与其说是困难，不如说是耗时，需要花时间在文档中查找正确的信息。

经过几个小时的搜索和几次错误的尝试后，我找到了两个需要的接口：XSpreadsheetDocument 和 XCell。这些给了我修改示例以使其与电子表格一起工作所需的东西

 1 import uno
 2 import unohelper
 3 
 4 from com.sun.star.task import XJobExecutor
 5 
 6 # Implement an UNO component by deriving from the standard
 7 # unohelper.Base class and from the interface(s) you want to implement.
 8 class HelloWorldJob(unohelper.Base, XJobExecutor):
 9     def __init__(self, ctx):
10         # store the component context for later use
11         self.ctx = ctx
12 
13     def trigger(self, args):
14         # Retrieve the desktop object
15         desktop = self.ctx.ServiceManager.createInstanceWithContext("com.sun.star.frame.Desktop", self.ctx)
16 
17         # Get the spreadsheet.
18         spreadsheet = desktop.getCurrentComponent()
19 
20         # Get the collection of sheets in the spreadsheet.
21         sheets = spreadsheet.getSheets()
22 
23         # Get the first cell in the first sheet.
24         cell = sheets.getByIndex(0).getCellByPosition(0, 0)
25 
26         # Modify its contents.
27         if cell.getFormula():
28             cell.setFormula("Hello " + cell.getFormula())
29         else:
30             cell.setFormula("Hello world")
31 
32 
33 # pythonloader looks for a static g_ImplementationHelper variable
34 g_ImplementationHelper = unohelper.ImplementationHelper()
35 
36 g_ImplementationHelper.addImplementation( \
37         HelloWorldJob,                                # UNO object class
38         "org.openoffice.comp.pyuno.demo.HelloWorld",  # Implementation name
39         ("com.sun.star.task.Job",),)                  # List of implemented services

示例的核心是触发器方法的HelloWorldJob类。当调用插件时，将调用此方法。Trigger 执行以下步骤

它获取顶层桌面对象。

从桌面对象中，它获取当前组件。在这种情况下，当前组件是 SpreadsheetDocument。

从电子表格对象中，它获取电子表格中所有工作表的集合。

从工作表集合中，它获取第一个工作表，然后从该工作表中获取第一个 Cell。

使用单元格，如果单元格为空，则插入“Hello World”。如果工作表包含内容，则在旧内容前加上“Hello ”。

其余代码本质上是原始示例中的代码副本。

现在我们有了代码，我们需要将其集成到 OpenOffice 中。我们通过创建一个包含代码和一个描述插件的 XML 文件的 zip 文件来完成此操作。XML 文件再次基本上只是原始示例的副本

<?xml version="1.0" encoding="UTF-8"?>
<oor:node xmlns:oor="http://openoffice.org/2001/registry"
             xmlns:xs="http://www.w3.org/2001/XMLSchema"
             oor:name="Addons" oor:package="org.openoffice.Office">
  <node oor:name="AddonUI">
    <node oor:name="AddonMenu">
      <node oor:name="org.openoffice.comp.pyuno.demo.HelloWorld" oor:op="replace">
        <prop oor:name="URL" oor:type="xs:string">
          <value>service:org.openoffice.comp.pyuno.demo.HelloWorld?insert</value>
        </prop>
        <prop oor:name="ImageIdentifier" oor:type="xs:string">
          <value>private:image/3216</value>
        </prop>
        <prop oor:name="Title" oor:type="xs:string">
          <value xml:lang="en-US">Insert Hello World</value>
        </prop>
      </node>
    </node>
  </node>
</oor:node>

除了创建包含这两个文件的 zip 文件之外，您还需要运行unopkg以在 OpenOffice 中注册插件。以下 bash 脚本执行压缩和打包，然后运行 OpenOffice，以便您可以对其进行测试

#!/bin/bash

unopkg_bin=/usr/bin/unopkg
oocalc_bin=/usr/bin/oocalc

addons=Addons.xcu
python_file=hello_world_oocalc.py
zip_file=hello_world.zip

rm $zip_file
zip $zip_file $addons $python_file
$unopkg_bin remove $zip_file
$unopkg_bin add $zip_file

#export PYUNO_LOGLEVEL=CALL
export PYUNO_LOGLEVEL=ARGS
export PYUNO_LOGTARGET=stdout

$oocalc_bin