From 940b4d1848e8c70ab7642901a68594e8016caffc Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sat, 27 Apr 2024 18:51:28 +0200 Subject: Adding upstream version 1:7.0.4. Signed-off-by: Daniel Baumann --- scripting/examples/python/Capitalise.py | 80 ++++++++++++++ scripting/examples/python/HelloWorld.py | 38 +++++++ scripting/examples/python/InsertText.py | 61 +++++++++++ scripting/examples/python/NamedRanges.py | 59 +++++++++++ scripting/examples/python/SetCellColor.py | 15 +++ .../examples/python/pythonSamples/TableSample.py | 116 +++++++++++++++++++++ 6 files changed, 369 insertions(+) create mode 100644 scripting/examples/python/Capitalise.py create mode 100644 scripting/examples/python/HelloWorld.py create mode 100644 scripting/examples/python/InsertText.py create mode 100644 scripting/examples/python/NamedRanges.py create mode 100644 scripting/examples/python/SetCellColor.py create mode 100644 scripting/examples/python/pythonSamples/TableSample.py (limited to 'scripting/examples/python') diff --git a/scripting/examples/python/Capitalise.py b/scripting/examples/python/Capitalise.py new file mode 100644 index 000000000..05e82a37a --- /dev/null +++ b/scripting/examples/python/Capitalise.py @@ -0,0 +1,80 @@ +# +# This file is part of the LibreOffice project. +# +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/. +# +# This file incorporates work covered by the following license notice: +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed +# with this work for additional information regarding copyright +# ownership. The ASF licenses this file to you under the Apache +# License, Version 2.0 (the "License"); you may not use this file +# except in compliance with the License. You may obtain a copy of +# the License at http://www.apache.org/licenses/LICENSE-2.0 . +# + +# helper function +def getNewString( theString ) : + if( not theString or len(theString) ==0) : + return "" + # should we tokenize on "."? + if theString[0].isupper() and len(theString)>=2 and theString[1].isupper() : + # first two chars are UC => first UC, rest LC + newString=theString[0:1].upper() + theString[1:].lower(); + elif theString[0].isupper(): + # first char UC => all to LC + newString=theString.lower() + else: # all to UC. + newString=theString.upper() + return newString; + +def capitalisePython( ): + """Change the case of a selection, or current word from upper case, to first char upper case, to all lower case to upper case...""" + import string + + # The context variable is of type XScriptContext and is available to + # all BeanShell scripts executed by the Script Framework + xModel = XSCRIPTCONTEXT.getDocument() + + #the writer controller impl supports the css.view.XSelectionSupplier interface + xSelectionSupplier = xModel.getCurrentController() + + #see section 7.5.1 of developers' guide + xIndexAccess = xSelectionSupplier.getSelection() + count = xIndexAccess.getCount(); + if(count>=1): #ie we have a selection + i=0 + while i < count : + xTextRange = xIndexAccess.getByIndex(i); + #print "string: " + xTextRange.getString(); + theString = xTextRange.getString(); + if len(theString)==0 : + # sadly we can have a selection where nothing is selected + # in this case we get the XWordCursor and make a selection! + xText = xTextRange.getText(); + xWordCursor = xText.createTextCursorByRange(xTextRange); + if not xWordCursor.isStartOfWord(): + xWordCursor.gotoStartOfWord(False); + xWordCursor.gotoNextWord(True); + theString = xWordCursor.getString(); + newString = getNewString(theString); + if newString : + xWordCursor.setString(newString); + xSelectionSupplier.select(xWordCursor); + else : + + newString = getNewString( theString ); + if newString: + xTextRange.setString(newString); + xSelectionSupplier.select(xTextRange); + i+= 1 + + +# lists the scripts, that shall be visible inside OOo. Can be omitted, if +# all functions shall be visible, however here getNewString shall be suppressed +g_exportedScripts = capitalisePython, + +# vim: set shiftwidth=4 softtabstop=4 expandtab: diff --git a/scripting/examples/python/HelloWorld.py b/scripting/examples/python/HelloWorld.py new file mode 100644 index 000000000..8c3c9a814 --- /dev/null +++ b/scripting/examples/python/HelloWorld.py @@ -0,0 +1,38 @@ +# HelloWorld python script for the scripting framework + +# +# This file is part of the LibreOffice project. +# +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/. +# +# This file incorporates work covered by the following license notice: +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed +# with this work for additional information regarding copyright +# ownership. The ASF licenses this file to you under the Apache +# License, Version 2.0 (the "License"); you may not use this file +# except in compliance with the License. You may obtain a copy of +# the License at http://www.apache.org/licenses/LICENSE-2.0 . +# + +def HelloWorldPython( ): + """Prints the string 'Hello World(in Python)' into the current document""" +#get the doc from the scripting context which is made available to all scripts + desktop = XSCRIPTCONTEXT.getDesktop() + model = desktop.getCurrentComponent() +#check whether there's already an opened document. Otherwise, create a new one + if not hasattr(model, "Text"): + model = desktop.loadComponentFromURL( + "private:factory/swriter","_blank", 0, () ) +#get the XText interface + text = model.Text +#create an XTextRange at the end of the document + tRange = text.End +#and set the string + tRange.String = "Hello World (in Python)" + return None + +# vim: set shiftwidth=4 softtabstop=4 expandtab: diff --git a/scripting/examples/python/InsertText.py b/scripting/examples/python/InsertText.py new file mode 100644 index 000000000..e04874d52 --- /dev/null +++ b/scripting/examples/python/InsertText.py @@ -0,0 +1,61 @@ +# HelloWorld python script for the scripting framework + +# +# This file is part of the LibreOffice project. +# +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/. +# +# This file incorporates work covered by the following license notice: +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed +# with this work for additional information regarding copyright +# ownership. The ASF licenses this file to you under the Apache +# License, Version 2.0 (the "License"); you may not use this file +# except in compliance with the License. You may obtain a copy of +# the License at http://www.apache.org/licenses/LICENSE-2.0 . +# + +def InsertText(text): + """Inserts the argument string into the current document. + If there is a selection, the selection is replaced by it.""" + + # Get the doc from the scripting context which is made available to all scripts + desktop = XSCRIPTCONTEXT.getDesktop() + model = desktop.getCurrentComponent() + + # Check whether there's already an opened document. + if not hasattr(model, "Text"): + return + + # The context variable is of type XScriptContext and is available to + # all BeanShell scripts executed by the Script Framework + xModel = XSCRIPTCONTEXT.getDocument() + + #the writer controller impl supports the css.view.XSelectionSupplier interface + xSelectionSupplier = xModel.getCurrentController() + + #see section 7.5.1 of developers' guide + xIndexAccess = xSelectionSupplier.getSelection() + count = xIndexAccess.getCount(); + if count >= 1: #ie we have a selection + i = 0 + + while i < count: + xTextRange = xIndexAccess.getByIndex(i); + theString = xTextRange.getString(); + if not len(theString): + # Nothing really selected; just insert. + xText = xTextRange.getText(); + xWordCursor = xText.createTextCursorByRange(xTextRange); + xWordCursor.setString(text); + xSelectionSupplier.select(xWordCursor); + else: + # Replace the selection. + xTextRange.setString(text); + xSelectionSupplier.select(xTextRange); + + i += 1 + diff --git a/scripting/examples/python/NamedRanges.py b/scripting/examples/python/NamedRanges.py new file mode 100644 index 000000000..34307ae84 --- /dev/null +++ b/scripting/examples/python/NamedRanges.py @@ -0,0 +1,59 @@ +# -*- tab-width: 4; indent-tabs-mode: nil; py-indent-offset: 4 -*- +# +# This file is part of the LibreOffice project. +# +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/. +# + +import traceback +import uno + +def GetNamedRanges(): + """Returns a list of the named ranges in the document. + """ + try: + desktop = XSCRIPTCONTEXT.getDesktop() + model = desktop.getCurrentComponent() + rangeNames = model.NamedRanges.ElementNames + result = [] + for i in rangeNames: + range = model.NamedRanges.getByName(i).Content + result.append((i, range)) + return result + except Exception as e: + print("Caught Exception: " + str(e)) + tb = e.__traceback__ + traceback.print_tb(tb) + return None + +def DefineNamedRange(sheet, x0, y0, width, height, name): + """Defines a new (or replaces an existing) named range on a sheet, + using zero-based absolute coordinates + """ + desktop = XSCRIPTCONTEXT.getDesktop() + model = desktop.getCurrentComponent() + # FIXME: Is there some Python-callable API to turn a row and column into an A1 string? + # This obviously works only for the first 26 columns. + abc = "ABCDEFGHIJKLMNOPQRSTUVWXYZ" + content = "$" + sheet + "." + "$" + abc[x0 : x0+1] + "$" + str(y0+1) + ":" + "$" + abc[x0+width-1 : x0+width] + "$" + str(y0+height) + position = uno.createUnoStruct('com.sun.star.table.CellAddress') + position.Sheet = 0 + position.Column = 0 + position.Row = 0 + model.NamedRanges.addNewByName(name, content, position, 0) + return None + +def DeleteNamedRange(name): + try: + desktop = XSCRIPTCONTEXT.getDesktop() + model = desktop.getCurrentComponent() + model.NamedRanges.removeByName(name) + except Exception as e: + print("Caught Exception: " + str(e)) + tb = e.__traceback__ + traceback.print_tb(tb) + return None + +# vim: set shiftwidth=4 softtabstop=4 expandtab: diff --git a/scripting/examples/python/SetCellColor.py b/scripting/examples/python/SetCellColor.py new file mode 100644 index 000000000..743a6daa9 --- /dev/null +++ b/scripting/examples/python/SetCellColor.py @@ -0,0 +1,15 @@ +def SetCellColor(x, y, color): + """Sets the background of the cell at (x,y) (zero-based column and row + indices, for example (2,3) == C4) on the first sheet and + returns the contents of the cell as a string. + """ + #get the doc from the scripting context which is made available to all scripts + desktop = XSCRIPTCONTEXT.getDesktop() + model = desktop.getCurrentComponent() + #check whether there's already an opened document + if not hasattr(model, "Sheets"): + return "" + sheet = model.Sheets.Sheet1 + cell = sheet.getCellByPosition(x, y) + cell.CellBackColor = color + return cell.String diff --git a/scripting/examples/python/pythonSamples/TableSample.py b/scripting/examples/python/pythonSamples/TableSample.py new file mode 100644 index 000000000..a92c862c2 --- /dev/null +++ b/scripting/examples/python/pythonSamples/TableSample.py @@ -0,0 +1,116 @@ +# +# This file is part of the LibreOffice project. +# +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/. +# +# This file incorporates work covered by the following license notice: +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed +# with this work for additional information regarding copyright +# ownership. The ASF licenses this file to you under the Apache +# License, Version 2.0 (the "License"); you may not use this file +# except in compliance with the License. You may obtain a copy of +# the License at http://www.apache.org/licenses/LICENSE-2.0 . +# + +import uno + +# a UNO struct later needed to create a document +from com.sun.star.text.ControlCharacter import PARAGRAPH_BREAK +from com.sun.star.text.TextContentAnchorType import AS_CHARACTER +from com.sun.star.awt import Size + +from com.sun.star.lang import XMain + +def insertTextIntoCell( table, cellName, text, color ): + tableText = table.getCellByName( cellName ) + cursor = tableText.createTextCursor() + cursor.setPropertyValue( "CharColor", color ) + tableText.setString( text ) + + +def createTable(): + """creates a new writer document and inserts a table with some data (also known as the SWriter sample)""" + ctx = uno.getComponentContext() + smgr = ctx.ServiceManager + desktop = smgr.createInstanceWithContext( "com.sun.star.frame.Desktop",ctx) + + # open a writer document + doc = desktop.loadComponentFromURL( "private:factory/swriter","_blank", 0, () ) + + text = doc.Text + cursor = text.createTextCursor() + text.insertString( cursor, "The first line in the newly created text document.\n", 0 ) + text.insertString( cursor, "Now we are in the second line\n" , 0 ) + + # create a text table + table = doc.createInstance( "com.sun.star.text.TextTable" ) + + # with 4 rows and 4 columns + table.initialize( 4,4) + + text.insertTextContent( cursor, table, 0 ) + rows = table.Rows + + table.setPropertyValue( "BackTransparent", uno.Bool(0) ) + table.setPropertyValue( "BackColor", 13421823 ) + row = rows.getByIndex(0) + row.setPropertyValue( "BackTransparent", uno.Bool(0) ) + row.setPropertyValue( "BackColor", 6710932 ) + + textColor = 16777215 + + insertTextIntoCell( table, "A1", "FirstColumn", textColor ) + insertTextIntoCell( table, "B1", "SecondColumn", textColor ) + insertTextIntoCell( table, "C1", "ThirdColumn", textColor ) + insertTextIntoCell( table, "D1", "SUM", textColor ) + + values = ( (22.5,21.5,121.5), + (5615.3,615.3,-615.3), + (-2315.7,315.7,415.7) ) + table.getCellByName("A2").setValue(22.5) + table.getCellByName("B2").setValue(5615.3) + table.getCellByName("C2").setValue(-2315.7) + table.getCellByName("D2").setFormula("sum ") + + table.getCellByName("A3").setValue(21.5) + table.getCellByName("B3").setValue(615.3) + table.getCellByName("C3").setValue(-315.7) + table.getCellByName("D3").setFormula("sum ") + + table.getCellByName("A4").setValue(121.5) + table.getCellByName("B4").setValue(-615.3) + table.getCellByName("C4").setValue(415.7) + table.getCellByName("D4").setFormula("sum ") + + + cursor.setPropertyValue( "CharColor", 255 ) + cursor.setPropertyValue( "CharShadowed", uno.Bool(1) ) + + text.insertControlCharacter( cursor, PARAGRAPH_BREAK, 0 ) + text.insertString( cursor, " This is a colored Text - blue with shadow\n" , 0 ) + text.insertControlCharacter( cursor, PARAGRAPH_BREAK, 0 ) + + textFrame = doc.createInstance( "com.sun.star.text.TextFrame" ) + textFrame.setSize( Size(15000,400)) + textFrame.setPropertyValue( "AnchorType" , AS_CHARACTER ) + + text.insertTextContent( cursor, textFrame, 0 ) + + textInTextFrame = textFrame.getText() + cursorInTextFrame = textInTextFrame.createTextCursor() + textInTextFrame.insertString( cursorInTextFrame, "The first line in the newly created text frame.", 0 ) + textInTextFrame.insertString( cursorInTextFrame, "\nWith this second line the height of the rame raises.",0) + text.insertControlCharacter( cursor, PARAGRAPH_BREAK, 0 ) + + cursor.setPropertyValue( "CharColor", 65536 ) + cursor.setPropertyValue( "CharShadowed", uno.Bool(0) ) + + text.insertString( cursor, " That's all for now !!" , 0 ) + +g_exportedScripts = createTable, + +# vim: set shiftwidth=4 softtabstop=4 expandtab: -- cgit v1.2.3