Trabajando con Apache OpenOffice

Conceptos iniciales

Este es el tema más importante para crear macros, de forma sencilla, pero se ven las bases para trabajar con todo AOO, por eso es importante no avanzar en estas notas, sin antes haber comprendido a cabalidad los temas presentes.

UNO (Universal Network Objects), es la especificación que da acceso a todos los objetos de Apache OpenOffice.

El API (Application Programer Interface) de Apache OpenOffice proporciona el acceso a toda la funcionalidad de AOO, independientemente del lenguaje.

La comunicación entre objetos UNO se basa en interfaces de objeto. Las interfaces pueden ser vistos desde el exterior o el interior de un objeto y proporcionan formas de ver o manipular el objeto.

Los servicios son agrupaciones lógicas de interfaces, son la forma en que un mismo objeto pueda ofrecer la funcionalidad de varias interfaces.

Los servicios se pueden implementar en librerías compartidas llamadas componentes UNO, con Python podemos crear componentes nuevos y generalmente el usuario final las recibe como una extensión OXT.

Los modulos pueden agrupar submodulos, servicios, excepciones, constantes, enumeraciones, etc, se utilizan para especificar bloques coherentes en la API, esto permite tener un APi bien estructurada.

Creando servicios

Para crear un servicio, usamos la fabrica de servicios (com.sun.star.lang.XMultiComponentFactory), una interfaz especial para crear nuevos servicios, pero para llegar a ella, tenemos que hacerlo a traves de la interfaz ComponentContext (com.sun.star.uno.XComponentContext), como puedes verlo en la siguiente imagen.

ComponentContext y ServiceManager

En pyUNO tenemos dos formas de acceder a esta interfaz, las dos son equivalentes por lo que puedes usar la que prefieras. En la introducción a Python se mencionó que la mayoría de sus herramientas están disponibles en librerias, estás librerias tienen que importarse antes de poder usarse, en nuestro caso importaremos la librería uno que nos da acceso (entre otras cosas) al contexto de ejecución de AOO.

import uno
 
def pruebas():
    ctx1 = XSCRIPTCONTEXT.getComponentContext()
    ctx2 = uno.getComponentContext()
    return

Ahora si, podemos acceder a la fábrica de servicios con el método getServiceManager().

import uno
 
def pruebas():
    ctx = uno.getComponentContext()
    sm = ctx.getServiceManager()
    return

Pero... ¿como sabemos que este objeto (ComponentContext) tiene este método getServiceManager()? porque lo estamos demostrando, si, también por eso, pero también porque puedes ver su documentación (com.sun.star.uno.XComponentContext) en el API de AOO, pero más importante aún, porque podemos hacer que el mismo objeto te diga todo lo que sabe hacer. Para ello haremos uso de una magnifica extensión que te tiene que acompañar el resto de tus días como programador de macros Python, nos referimos a MRI. Instala (tal vez tengas que reiniciar AOO para poder usarla) y la probamos de la siguiente manera.

import uno
 
def pruebas():
    ctx = uno.getComponentContext()
    # llamamos a la extensión MRI y le pasamos el objeto a inspeccionar
    mri(ctx)
    sm = ctx.getServiceManager()
    return 
 
def mri(target):
    ctx = uno.getComponentContext()
    sm = ctx.getServiceManager()    
    mri = sm.createInstanceWithContext('mytools.Mri', ctx)
    mri.inspect(target)
    return

Observa en la imágen siguiente, como hemos seleccionado los métodos del objeto y nos lista todos los que tenga, hemos remarcado el que por ahora nos interesa getServiceManager(), observa al final de la línea que efectivamente este método nos devuelve una instancia de la interfaz com.sun.star.lang.XMultiComponentFactory.

La gran ventaja de usar esta extensión (que por cierto esta hecha en Python), es que siempre te devolverá la información directamente del objeto, a esto se le llama instrospección. Acostumbrate a usarla.

Ahora si, ya podemos crear una instancia de cualquier servicio o interfaz disponible en AOO, por ejemplo, el servicio com.sun.star.frame.Desktop.

import uno
 
def pruebas():
    ctx = uno.getComponentContext()
    sm = ctx.getServiceManager()
    desktop = sm.createInstanceWithContext('com.sun.star.frame.Desktop', ctx)
    return

Existe una forma alternativa de crear este servicio, usando XSCRIPTCONTEXT de la siguiente manera.

    XSCRIPTCONTEXT.getDesktop()

¿Y para que sirve este servicio? Entre otras cosas para crear nuevos documentos.

nuevo = desktop.loadComponentFromURL('private:factory/scalc', '_default', 0, ())

Más adelante veremos a detalle este método y otros relacionados con los documentos de AOO.

El servicio com.sun.star.frame.Desktop es la instancia de la administración central para todas las aplicaciones AOO. Todas las ventanas de la aplicación AOO se organizan en una jerarquía de marcos que contienen componentes visibles.

Desktop administra los componentes y marcos.

Para los fines de crear macros es suficiente que recuerdes que, Desktop es el marco raíz de toda la jerarquía de documentos.

Para crear la instancia del servicio com.sun.star.frame.Desktop usamos un contexto y usamos el método createInstanceWithContext. Otros servicios no requieren de contexto para ser instanciados y usados, por ejemplo, el servicio com.sun.star.util.PathSettings que nos sirve para obtener las rutas de trabajo actuales en AOO, para estos casos usamos el método createInstance.

    rutas = sm.createInstance('com.sun.star.util.PathSettings')
    # mostramos la ruta de trabajo del usuario
    print (rutas.Work)

El documento activo

Tenemos dos formas de acceder al documento activo.

    doc1 = XSCRIPTCONTEXT.getDocument()
    doc2 = desktop.getCurrentComponent()
 
    print (doc1.getIdentifier())
    print (doc2.getIdentifier())

{{}}