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 uno
  22 import unohelper
  23
  24 from com.sun.star.ui import XUIElementFactory
  25 from com.sun.star.ui import XUIElement
  26 from com.sun.star.ui.UIElementType import TOOLPANEL as unoTOOLPANEL
  27 from com.sun.star.ui import XToolPanel
  28
  29 implementation_name = "org.libreoffice.example.toolpanel.pocFactory" # as defined in Factory.xcu
  30 implementation_services = ("org.libreoffice.example.toolpanel.pocFactory",)
  31
  32 xdlPath = "toolpanels/poc.xdl" # the path inside the oxt
  33 extensionID = "org.libreoffice.example.toolpanel" # as defined in description.xml
  34
  35 ########################################################################
  36 ########################################################################
  37
  38 class pocToolPanel( unohelper.Base, XToolPanel ):
  39
  40         def __init__ ( self, xPanelWindow, ctx ):
  41
  42                 self.ctx = ctx
  43                 self.PanelWindow = xPanelWindow
  44                 self.Window = xPanelWindow
  45
  46         def createAccessible( self, i_parentAccessible ):
  47
  48                 return self.PanelWindow
  49
  50 ########################################################################
  51 ########################################################################
  52
  53 class pyPanel( unohelper.Base, XUIElement ):
  54
  55         def __init__ ( self, ctx, xFrame, xParentWindow, url ):
  56
  57                 self.ctx = ctx
  58                 self.xParentWindow = xParentWindow
  59                 self.toolpanel = None
  60                 self.m_panelRootWindow = None
  61
  62                 self.Frame = xFrame
  63                 self.ResourceURL = url
  64                 self.Type = unoTOOLPANEL
  65
  66
  67         def getRealInterface( self ):
  68
  69                 if not self.toolpanel:
  70                         rootWindow = self.getOrCreatePanelRootWindow()
  71                         self.toolpanel = pocToolPanel(rootWindow, self.ctx)
  72
  73                 return self.toolpanel
  74
  75         def getOrCreatePanelRootWindow( self ):
  76
  77                 pip = self.ctx.getValueByName("/singletons/com.sun.star.deployment.PackageInformationProvider" )
  78                 s = pip.getPackageLocation(extensionID)
  79                 dialogUrl = s + "/" + xdlPath
  80
  81                 provider = self.ctx.ServiceManager.createInstanceWithContext("com.sun.star.awt.ContainerWindowProvider",self.ctx)
  82                 self.m_panelRootWindow = provider.createContainerWindow(dialogUrl,"",self.xParentWindow, None)
  83
  84                 return self.m_panelRootWindow
  85
  86         def postDisposing( self ):
  87
  88                 super.postDisposing()
  89
  90                 if self.m_panelRootWindow:
  91                     self.m_panelRootWindow.dispose()
  92                     self.m_panelRootWindow = None
  93
  94                 self.toolpanel = None
  95
  96                 return
  97
  98 #######################################################################
  99 #######################################################################
 100
 101 class pocFactory( unohelper.Base, XUIElementFactory ):
 102
 103         def __init__ ( self, ctx ):
 104
 105                 self.ctx = ctx
 106
 107         def createUIElement( self, url, properties ):
 108
 109             xParentWindow = None
 110             xFrame = None
 111             xUIElement = None
 112
 113             for arg in properties:
 114                 if arg.Name == "Frame":
 115                     xFrame = arg.Value
 116                 elif arg.Name == "ParentWindow":
 117                     xParentWindow = arg.Value
 118
 119             if xFrame and xParentWindow:
 120                 try:
 121                     xUIElement = pyPanel(self.ctx, xFrame, xParentWindow, url)
 122                 except Exception as e:
 123                     print(e)
 124
 125             return xUIElement
 126
 127 ########################################################################
 128 ########################################################################
 129
 130 # pythonloader looks for a static g_ImplementationHelper variable
 131 g_ImplementationHelper = unohelper.ImplementationHelper ()
 132
 133 # add the FormatFactory class to the implementation container,
 134 # which the loader uses to register/instantiate the component.
 135 g_ImplementationHelper.addImplementation (pocFactory,
 136                                         implementation_name,
 137                                         implementation_services,
 138                                         )
 139