odk/examples/python/toolpanel/toolpanel.py

   1 #
   2 # This file is part of the LibreOffice project.
   3 #
   4 # This Source Code Form is subject to the terms of the Mozilla Public
   5 # License, v. 2.0. If a copy of the MPL was not distributed with this
   6 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7 #
   8 # This file incorporates work covered by the following license notice:
   9 #
  10 #   Licensed to the Apache Software Foundation (ASF) under one or more
  11 #   contributor license agreements. See the NOTICE file distributed
  12 #   with this work for additional information regarding copyright
  13 #   ownership. The ASF licenses this file to you under the Apache
  14 #   License, Version 2.0 (the "License"); you may not use this file
  15 #   except in compliance with the License. You may obtain a copy of
  16 #   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17 #
  18 # inspired by core/testautomation/extensions/optional/input/extension_sources/TaskPaneComponent
  19 #
  20
  21 import unohelper
  22
  23 from com.sun.star.ui import XUIElementFactory
  24 from com.sun.star.ui import XUIElement
  25 from com.sun.star.ui.UIElementType import TOOLPANEL as unoTOOLPANEL
  26 from com.sun.star.ui import XToolPanel
  27
  28 implementation_name = "org.libreoffice.example.toolpanel.pocFactory" # as defined in Factory.xcu
  29 implementation_services = ("org.libreoffice.example.toolpanel.pocFactory",)
  30
  31 xdlPath = "toolpanels/poc.xdl" # the path inside the oxt
  32 extensionID = "org.libreoffice.example.toolpanel" # as defined in description.xml
  33
  34 ########################################################################
  35 ########################################################################
  36
  37 class pocToolPanel( unohelper.Base, XToolPanel ):
  38
  39         def __init__ ( self, xPanelWindow, ctx ):
  40
  41                 self.ctx = ctx
  42                 self.PanelWindow = xPanelWindow
  43                 self.Window = xPanelWindow
  44
  45         def createAccessible( self, i_parentAccessible ):
  46
  47                 return self.PanelWindow
  48
  49 ########################################################################
  50 ########################################################################
  51
  52 class pyPanel( unohelper.Base, XUIElement ):
  53
  54         def __init__ ( self, ctx, xFrame, xParentWindow, url ):
  55
  56                 self.ctx = ctx
  57                 self.xParentWindow = xParentWindow
  58                 self.toolpanel = None
  59                 self.m_panelRootWindow = None
  60
  61                 self.Frame = xFrame
  62                 self.ResourceURL = url
  63                 self.Type = unoTOOLPANEL
  64
  65
  66         def getRealInterface( self ):
  67
  68                 if not self.toolpanel:
  69                         rootWindow = self.getOrCreatePanelRootWindow()
  70                         self.toolpanel = pocToolPanel(rootWindow, self.ctx)
  71
  72                 return self.toolpanel
  73
  74         def getOrCreatePanelRootWindow( self ):
  75
  76                 pip = self.ctx.getValueByName("/singletons/com.sun.star.deployment.PackageInformationProvider" )
  77                 s = pip.getPackageLocation(extensionID)
  78                 dialogUrl = s + "/" + xdlPath
  79
  80                 provider = self.ctx.ServiceManager.createInstanceWithContext("com.sun.star.awt.ContainerWindowProvider",self.ctx)
  81                 self.m_panelRootWindow = provider.createContainerWindow(dialogUrl,"",self.xParentWindow, None)
  82
  83                 return self.m_panelRootWindow
  84
  85         def postDisposing( self ):
  86
  87                 super.postDisposing()
  88
  89                 if self.m_panelRootWindow:
  90                     self.m_panelRootWindow.dispose()
  91                     self.m_panelRootWindow = None
  92
  93                 self.toolpanel = None
  94
  95                 return
  96
  97 #######################################################################
  98 #######################################################################
  99
 100 class pocFactory( unohelper.Base, XUIElementFactory ):
 101
 102         def __init__ ( self, ctx ):
 103
 104                 self.ctx = ctx
 105
 106         def createUIElement( self, url, properties ):
 107
 108             xParentWindow = None
 109             xFrame = None
 110             xUIElement = None
 111
 112             for arg in properties:
 113                 if arg.Name == "Frame":
 114                     xFrame = arg.Value
 115                 elif arg.Name == "ParentWindow":
 116                     xParentWindow = arg.Value
 117
 118             if xFrame and xParentWindow:
 119                 try:
 120                     xUIElement = pyPanel(self.ctx, xFrame, xParentWindow, url)
 121                 except Exception as e:
 122                     print(e)
 123
 124             return xUIElement
 125
 126 ########################################################################
 127 ########################################################################
 128
 129 # pythonloader looks for a static g_ImplementationHelper variable
 130 g_ImplementationHelper = unohelper.ImplementationHelper ()
 131
 132 # add the FormatFactory class to the implementation container,
 133 # which the loader uses to register/instantiate the component.
 134 g_ImplementationHelper.addImplementation (pocFactory,
 135                                         implementation_name,
 136                                         implementation_services,
 137                                         )
 138