OpenOffice.orgのマクロをPythonで記述して動かす(Calcのアクティブもしくは任意のシートとセルのオブジェクトの取得)

ここではPython-UNOを用いたOpenOffice.org Calcの個別のシートとその中のセルのオブジェクトの取得に関するメモを扱い、実際のセル操作とその例については別記事で扱う。

操作するシートのオブジェクトを得る

マクロからセルの操作を行うためには、操作対象のシートのオブジェクトを事前に取得しておく必要がある。

アクティブシートオブジェクトの取得

アクティブなシートのオブジェクトは(Python-UNOのマクロスクリプトから常にアクセスできる)XSCRIPTCONTEXTオブジェクトのメンバ関数getDocument()で得たドキュメントオブジェクトのメンバCurrentControllerのメンバActiveSheet*1として得られるが、OpenOffice.org Calc上でマクロが実行された場合でないと得られない*2ため、ドキュメントオブジェクトのsupportsService()によるチェックを行うとよい。

class NotOOoCalcException(Exception):
  pass

class Bridge(object):
  def __init__(self):
    self._document = XSCRIPTCONTEXT.getDocument()

class OOoCalc(Bridge):
  def __init__(self):
    Bridge.__init__(self)
    if not self._document.supportsService('com.sun.star.sheet.SpreadsheetDocument'):
      self.run_errordialog(title='エラー', message='このマクロはOpenOffice.org Calcの中で実行してください')
      raise NotOOoCalcException()
    # ここまで処理が正常に進んだらOOo Calcの中であるとみなせる
    # CurrentControllerは「ようこそ」画面でマクロを実行した場合などには取得できないので
    # チェックの後でアクセスするようにする
    self.__current_controller = self._document.CurrentController
  def get_active_sheet(self):
    return self.__current_controller.ActiveSheet
  def set_active_sheet(self, value):
    self.__current_controller.ActiveSheet = value
  active_sheet = property(get_active_sheet, set_active_sheet)

def macroname():
  try:
    calc = OOoCalc()
  except NotOOoCalcException:
    return
  # ここからマクロのメイン処理
  sheet = calc.active_sheet
  cell = sheet.[メンバ関数]()

任意のシートのオブジェクトを取得

「OpenOffice.orgのマクロをPythonで記述して動かす(Calc上でマクロが動作しているかのチェックと全シートのオブジェクトの取得に関するメモ)」の要領で全てのシートを含むオブジェクトを取得し、メンバ関数getByIndex()(何番目かを指定)*3やgetByName()(シート名で指定)を呼ぶことで、戻り値として対象のシートのオブジェクトを得ることができる。

class NotOOoCalcException(Exception):
  pass

class Bridge(object):
  def __init__(self):
    self._document = XSCRIPTCONTEXT.getDocument()

class OOoCalc(Bridge):
  def __init__(self):
    Bridge.__init__(self)
    if not self._document.supportsService('com.sun.star.sheet.SpreadsheetDocument'):
      self.run_errordialog(title='エラー', message='このマクロはOpenOffice.org Calcの中で実行してください')
      raise NotOOoCalcException()
  @property
  def sheets(self): return self._document.Sheets

def macroname():
  try:
    calc = OOoCalc()
  except NotOOoCalcException:
    return
  # ここからマクロのメイン処理
  # 全てのシートのオブジェクト
  sheets = calc.sheets
  # 0番のインデックスを持つシートを取得する例
  # http://api.openoffice.org/docs/common/ref/com/sun/star/container/XIndexAccess.html
  sheet0 = sheets.getByIndex(0)
  # "Sheet2"の名前を持つシートを取得する例
  # http://api.openoffice.org/docs/common/ref/com/sun/star/container/XNameAccess.html
  sheet2 = sheets.getByName('Sheet2')