Apache OpenOffice Wiki - User contributions [en]

Product Release

2015-05-14T17:24:22Z

JZA: /* Apache OpenOffice */

== Apache OpenOffice ==

OpenOffice.org was [http://incubator.apache.org/projects/openofficeorg.html transferred] to the [http://www.apache.org/foundation/ Apache Software Foundation] on June 1st, 2011 and it [https://blogs.apache.org/OOo/entry/openoffice_graduates_from_the_apache became an Apache Top-Level Project] on October 17, 2012.

The development model of the popular productivity suite changed to benefit from the huge experience the Foundation has with managing open source projects.

New releases of the product are accordingly named '''Apache OpenOffice'''.

=== Apache OpenOffice 4.x ===

* [https://blogs.apache.org/OOo/entry/announcing_apache_openoffice_4_1 Apache OpenOffice 4.1.1] (Aug, 23rd 2014)
* [https://blogs.apache.org/OOo/entry/the_apache_openoffice_project_announce Apache OpenOffice 4.1.0] (Apr. 29th, 2014)
* [https://blogs.apache.org/OOo/entry/announcing_apache_openoffice_4_0 Apache OpenOffice 4.0.1] (Oct. 1st, 2013)
* [https://blogs.apache.org/OOo/entry/a_short_celebration_and_then Apache OpenOffice 4.0.0] (Juli 23rd, 2013)

=== Apache OpenOffice 3.4 ===

* [http://blogs.apache.org/OOo/entry/announcing_apache_openoffice_3_41 Apache OpenOffice 3.4.1] (August 23rd, 2012)
** additional languages Danish, Norwegian, Swedish, Korean, Polish, Basque, Asturian and Scottish Gaelic (January 30th, 2013)
* [http://ooo-site.staging.apache.org/news/aoo34.html Apache OpenOffice 3.4.0] (May 8th 2012)

== Older Product Releases of OpenOffice.org ==

For release information please see the technical [http://development.openoffice.org/releases/index.html Release Notes] and a detailed [http://www.openoffice.org/dev_docs/features/index.html feature overview].

For a list of uploaded Developer Snapshots and Release Candidates/Releases see the [[Product_Release/builds_uploaded | table of uploaded builds]]. The most recent builds can be downloaded on the [http://download.openoffice.org download webpage].

For guidance on announcing new releases see [[PolicyMirrorLinking]].
<br>

=== Released OpenOffice.org 3.x.x ===

* [[OOoRelease33|OpenOffice.org 3.3.0]] (January 26th, 2011)
* [[OOoRelease321|OpenOffice.org 3.2.1]] (June 4th, 2010)
* [[OOoRelease32|OpenOffice.org 3.2.0]] (February 11th, 2010)
* [[OOoRelease311|OpenOffice.org 3.1.1]] (August 31st, 2009)
* [[OOoRelease31|OpenOffice.org 3.1.0]] (May 7th, 2009)
* [[OOoRelease301|OpenOffice.org 3.0.1]] (January 27th, 2009)
* [[OOoRelease30|OpenOffice.org 3.0.0]] (October 13th, 2008)

=== Released OpenOffice.org 2.x.x ===

* [[OOoRelease243|OpenOffice.org 2.4.3]] (September 04th, 2009)
* [[OOoRelease242|OpenOffice.org 2.4.2]] (October 28th, 2008)
* [[OOoRelease241|OpenOffice.org 2.4.1]] (June 10th, 2008)
* [[OOoRelease24|OpenOffice.org 2.4]] (March 27th, 2008)
* [[OOoRelease231|OpenOffice.org 2.3.1]] (December 4th, 2007)
* [[OOoRelease23|OpenOffice.org 2.3]] (September 17th, 2007)
* [[OOoRelease221|OpenOffice.org 2.2.1]] (June 12th, 2007)
* [[OOoRelease22|OpenOffice.org 2.2]] (March 29th, 2007)
* [[OOoRelease205|OpenOffice.org 2.1]] (December 12th, 2006)
* [[OOoRelease204|OpenOffice.org 2.0.4]] (October 13th, 2006)
* [[OOoRelease203|OpenOffice.org 2.0.3]] (June 29th, 2006)
* [[OOoRelease202|OpenOffice.org 2.0.2]] (March 8th, 2006)
* [[OOoRelease201|OpenOffice.org 2.0.1]] (December 21st, 2005)
* OpenOffice.org 2.0.0 (October 21st, 2005)

=== OpenOffice.org 1.1 ===

* OpenOffice.org 1.1.5 (September 9th, 2005)
* OpenOffice.org 1.1.4 (December 22th, 2004)
* OpenOffice.org 1.1.3 (October 4th, 2004)
* OpenOffice.org 1.1.2 (June 18th, 2004)
* OpenOffice.org 1.1.1
* OpenOffice.org 1.1.0 (October 1st, 2003)

=== OpenOffice.org 1.0 ===

* OpenOffice.org 1.0.3 (April 10th, 2003)
* OpenOffice.org 1.0.2 (January 20th, 2003) (tag "OpenOffice_1_0_2")
* OpenOffice.org 1.0.1 (July 17th, 2002) (tag "OpenOffice_1_0_1")

<br>

Older releases can be retrieved via the [ftp://archive.services.openoffice.org/pub/openoffice-archive/stable Archive Server].

[[Category:Releases]]
[[Category:Quality Assurance]]

Documentation/Building Guide AOO/Step by step

2015-03-28T01:11:32Z

JZA: Update to 4.1

{{DISPLAYTITLE:Step by step building guides for different platforms}}

__TOC__

This page is intended as a collection of simple step-by-step recipes to build Apache OpenOffice from source code. A more thorough explanation of what the individual steps do and why they are necessary can be found in the [[Documentation/Building_Guide_AOO|building guide]].
=Ubuntu 14.04=
The basic building steps under Ubuntu 12.04 (see below) are to be followed in Ubuntu 14.04 as well; however, there are some minor build issues that any developer, using this OS, needs to be aware of, if he gets stuck while building. The following is the list of issues, with their fixes, that a developer may face with:

* Issue 124712 (build broken in svl); see the link https://issues.apache.org/ooo/show_bug.cgi?id=124712 for detailed information.
If you are building trunk, the patch is already applied; if you are building from a release tag or tarball, the patch needs to be applied for all releases <= 4.1.1.

* Issue 125475; see the link https://issues.apache.org/ooo/show_bug.cgi?id=125475 for detailed information. This happens if you explicitly upgraded your GCC and related tools to version 4.9; it will not appear if you use GCC 4.8.x.

As the BZ says, it is because of buggy toolchain g++4.9. So for now in Ubuntu Linux 14.04, build the source using g++4.8.2, gcc4.8.2; these are the default compilers in Ubuntu Linux 14.04 anyway; please check it using the following commands:
g++ -v
gcc -v
if not, you've to download them.
sudo apt-get install g++-4.8
cd /usr/bin
rm gcc
rm g++
ln -s gcc-4.8 gcc
ln -s g++-4.8 g++

* Failed to find ./solver/420/unxlngx6.pro/lib/x86_64-linux-gnu/libstdc++.so.6.0.20 error.

cp /usr/lib/x86_64-linux-gnu/libstdc++.so.6.0.20 ./solver/420/unxlngx6.pro/lib/
rm ./solver/420/unxlngx6.pro/lib/libstdc++.so.6
ln -s ./solver/420/unxlngx6.pro/lib/libstdc++.so.6.0.20 ./solver/420/unxlngx6.pro/lib/libstdc++.so.6

* No such file or directory - connectivity/virtualdbtools.hxx while building svx.

if you get an error like this, then that means connectivity is not built properly. Build connectivity using build --all:connectivity and this error will go away.

=Ubuntu 12.04=

*Setup VirtualBox with Ubuntu 12.04 64 bit on Windows7 64bit host. A native installation is of course fine, too.
*Let updater update ca. 380 packages. Restart.
*Get the source. You can start with the source release or by checking out from SVN:
{| class="prettytable"
|-
! Source release
! SVN
|- valign="top"
| Build from source release if you want to build OpenOffice once but don't want to do any development.
| Build from SVN if you want to development work with OpenOffice.
|- valign="top"
|
* Download AOO 4.1.1 source tarball from
http://people.apache.org/~jsc/developer-snapshots/r1372282/src/aoo-4.1.1-incubating-src.tar.bz2

* Optional: Download signature from
http://people.apache.org/~jsc/developer-snapshots/r1372282/src/aoo-4.1.1-incubating-src.tar.bz2.asc

and verify the source tarball with
gpg --verify aoo-4.1.1-incubating-src.tar.bz2.asc \
aoo-4.1.1-incubating-src.tar.bz2
Note that you have to have the keys already imported to your key chain.
The keys can be found on the download page:

http://www.apache.org/dist/incubator/ooo/KEYS

* Unpack source:
cd /tmp
tar -xjf ~/Downloads/aoo-4.1.1-incubating-src.tar.bz2
cd aoo-4.1.1/main
|
* Start with creating a parent directory for the source code. Don't use <code>/tmp</code> because that is deleted on every boot:
sudo mkdir /source
sudo chown <your-user-name> /source
cd /source
* Install subversion and checkout the source:
sudo apt-get install subversion
svn co https://svn.apache.org/repos/asf/openoffice/trunk aoo-trunk
cd aoo-trunk/main
|}

* Install requirements (this will also install packages that are not listed):
sudo apt-get install g++ gcc bison flex libarchive-zip-perl libcups2-dev \
libpam0g-dev gperf libfreetype6-dev libxaw7-dev libfontconfig1-dev \
libxrandr-dev patch libgconf2-dev libgnomevfs2-dev ant libgtk2.0-dev \
junit junit4 libidl-dev liborbit2-dev openjdk-6-jdk libwww-perl \
libxml-parser-perl autoconf libssl-dev

* Run autoconf to generate configure script:
autoconf

* Configure (see the building guide section on [[Documentation/Building_Guide_AOO#Configuration_and_bootstrapping|configuration]] for further options):
./configure \
--with-dmake-url=http://dmake.apache-extras.org.codespot.com/files/dmake-4.12.tar.bz2 \
--with-epm-url=http://www.msweet.org/files/project2/epm-3.7-source.tar.gz \
--disable-odk \
--disable-binfilter

* Finish configuration and download missing tarballs and extensions:
./bootstrap

* Include the configured environment:
source LinuxX86-64Env.Set.sh

* Build:
cd instsetoo_native/
build --all
This may take a while to complete. Several hours are not uncommon. To speed things up you may want to run 'build' like this
build --all -P<n> -- -P<n>
to start a parallel build. Replace <n> with the number of CPU cores.

* Install:
sudo dpkg -i unxlngx6.pro/Apache_OpenOffice/deb/install/en-US/DEBS/*.deb
sudo dpkg -i unxlngx6.pro/Apache_OpenOffice/deb/install/en-US/DEBS/desktop-integration/openoffice.org4.1-debian-menus_4.1-9593_all.deb

* Start Apache OpenOffice:
/opt/openoffice.org3/program/soffice

=Windows 7=

'''Complete requirements found at [http://wiki.openoffice.org/wiki/Documentation/Building_Guide_AOO#General_Build_Requirements General Build Requirements] and [http://wiki.openoffice.org/wiki/Documentation/Building_Guide_AOO/Building_on_Windows Building on Windows].'''
This is a '''sample''' step-by-step guide - check the complete requirements and report on dev@openoffice.apache.org, if problems with this step-by-step guide occurs.

*Install cygwin, '''32bit version'''
**Browse to http://cygwin.com.
**Click on the setup.exe link (most recent Cygwin DLL at the moment is 1.7.16-1) to download the installer and run it.
**Click through the questions.
**On the "Choose A Download Site" select a nearby download server.
**Expect a "Setup Alert" dialog box on the first cygwin install on the computer.
**Click OK to close it.
**On the page that allows you to select additional packages just select wget (enter wget in the Search box and select the wget enty in the Web/Default section.
**Click Next to finish package selection.
**Click Next to resolve dependencies.
**After installation is finished click the Finish button to close the dialog.

*Start cygwin bash in a terminal
::One way to do this is:
::*Press WindowsKey-R
::*Enter c:\cygwin\Cygwin.bat
::*Hit Return.

* Install Java.
::Choose between JDK 1.7 or OpenJDK.

* Install Ant
**Browse to http://ant.apache.org/bindownload.cgi
**Chose a mirror near you.
**Download the zip archive (currently that is apache-ant-1.8.4-bin.zip).
**Open downloaded archive in file explorer and unzip it to a location of your choice, eg <code>c:\</code>. Note that <code>C:\Program Files (x86)</code> will not work due to problems of quoting the spaces and parentheses.

* Prepare to install missing cygwin packages by installing apt-cyg from googlecode.com<pre>cd to /cygdrive/c/temp</pre>(or any other temporary directory of your choice)<pre>wget http://apt-cyg.googlecode.com/svn/trunk/apt-cyg
chmod +x apt-cyg
mv apt-cyg /usr/local/bin/</pre>
* Use apt-cyg to install missing cygwin packages<pre>apt-cyg install perl zip unzip gperf autoconf rsync gcc4-g++ bison flex patch subversion</pre>or alternatively run setup and select the packages<br />If you will use git, you need in addition the packages<pre>git git-svn</pre>

* Replace symlinked awk with copy of gawk.exe:<pre>rm /usr/bin/awk
mv /usr/bin/gawk.exe /usr/bin/awk.exe</pre>Note that if the <code>rm</code> command fails then the <code>mv</code> is not necessary.

* Install Microsoft Windows SDK for Windows 7 and .NET Framework 3.5. SP1 (recommend by Microsoft)
** Browse to http://www.microsoft.com/en-us/download/details.aspx?id=3138.
** Download Setup.exe and run the web installer (note that it will be saved as Setup(1).exe to disambiguate from the previously downloaded cygwin installer.) You can use the default values in the installation dialog.
** Alternatively download the iso image http://www.microsoft.com/en-us/download/details.aspx?id=18950. Burn it to a dvd or unzip it.

* Download MS Visual C++ 2008 SP1 Redistributable Package (x86)
** http://www.microsoft.com/en-us/download/details.aspx?id=26368 ( There have been security updates, which are not included in older versions.)
**Download files vcredist_x86.exe and vcrestist_x64.exe<br /> If you download the most actual version of Apache OpenOffice and unpack it, you will find the files vcredist_x86.exe and vcredist_x64.exe in folder redist. You can use them as well.

* Optional: Install DirectX SDK (for graphics hardware support in the slide show)
** Browse to http://www.microsoft.com/en-us/download/details.aspx?displaylang=en&id=6812
** Download and run DXSDK_Jun10.exe

* Optional: Install NSIS installer (for creating the EXE installer)
** Browse to http://nsis.sourceforge.net
** Download and run the installer.

* Get AOO source code. You can use the source release or check out from SVN. Build from source release if you want to build OpenOffice once but don't want to contribute patches. If you will contribute patches, you need to generate them against an actual version of trunk. In this case check out from SVN to be able to rebase before generating patches. You can work with subversion or with git-svn.

::; Source release :
::* Browse to http://www.openoffice.org/download/other.html#tested-sdk and locate the table row that starts with "Source code"
::* Download source code in an archive format of your choice (note that tar.bz2 is typically smaller than tar.gz and zip)
::* Optional: Verify the archive - following given link or instructions.
::* Unpack source (in cygwin-terminal). Use the file name exactly as downloaded.<pre>cd /tmp
tar -xjf <download-location>/<downloaded-source-release.tar.bz2>
cd <unpacked-source>/main
</pre>

::; Checkout from SVN using subversion :
::*Get subversion (only first time)<pre>apt-cyg install subversion</pre>
::*Start with creating a parent directory for the source code: <pre>mkdir /cygdrive/c/source
cd /cygdrive/c/source</pre>
::*Check out source from Apache SVN repository<pre>svn co https://svn.apache.org/repos/asf/openoffice/trunk aoo-trunk
cd aoo-trunk/main</pre>

::; Checkout from SVN using git-svn :
::*Get git and git-svn (only first time)<pre>apt-cyg install git git-svn</pre>
::*Get the actual revision number from http://svn.apache.org/viewvc/OpenOffice/trunk/, e.g. 1234567
::*Create an empty directory and change to it, e.g.<pre>mkdir /cygdrive/c/source
cd /cygdrive/c/source</pre>
::*Check out source from Apache SVN repository<pre>git svn clone --revision 1234567:HEAD https://svn.apache.org/repos/asf/openoffice/trunk
cd trunk/main</pre>

* Remember the source path (this is optional, it keeps the following lines short):<pre>SourceMain=`pwd`</pre> [Why? I have not used it. [[User:Regina|Regina]] ([[User talk:Regina|talk]]) 21:42, 24 February 2013 (UTC)]
:[Added explanation above [[User:Andre|Andre]]]

* Optional: Get dbghelp.dll (for using the <code>--enable-dbgutil</code> configure option)
** This dll is part of MS Visual Studio.
** Copy file to <code>main/external/dbghelp</code>. Use Windows file manager or in cygwin terminal<pre>cp /cygdrive/c/Program\ Files\ $x86$/Microsoft\ Visual\ Studio\ 9.0/Common7/IDE/dbghelp.dll $SourceMain/external/dbghelp</pre>

* Copy vcredist_x86.exe and vcredist_x64.exe (see above) to main/external/vcredist.
** Use Windows file manager or in cygwin terminal<pre>cp <download-location>/vcredist_x86.exe $SourceMain/external/vcredist
cp <download-location>/vcredist_x64.exe $SourceMain/external/vcredist</pre>

* Get GDI+ redistributable.
**Browse to http://www.microsoft.com/en-us/download/details.aspx?id=18909
**Download WindowsXP-KB975337-x86-ENU.exe
**Run WindowsXP-KB975337-x86-ENU.exe
**Enter a temporary path (eg c:\temp\gdiplus) in the dialog and click OK to extract files
**Copy gdiplus.dll to main/external<pre>cp /cygdrive/c/temp/gdiplus/asms/10/msft/windows/gdiplus/gdiplus.dll $SourceMain/external/gdiplus/</pre>
** Remove the temporary path<pre>rm -fr /cygdrive/c/temp/gdiplus</pre>

* Get msvcr100.dll:<pre>cp /cygdrive/c/Windows/System32/msvcr100.dll $SourceMain/external/msvcp100</pre>

* Make sure that you are in the main source directory:<pre>cd $SourceMain</pre>

* Run autoconf to create the configure script:<pre>autoconf</pre>

* Call configure
** Run configure (adapt paths as necessary)<pre>SDK_PATH="/cygdrive/c/Program Files/Microsoft SDKs/Windows/v7.0"
./configure \
 --with-frame-home="$SDK_PATH" \
 --with-psdk-home="$SDK_PATH" \
 --with-midl-path="$SDK_PATH/bin" \
 --with-directx-home="C:/Program Files (x86)/Microsoft DirectX SDK (June 2010)" \
 --with-ant-home="/cygdrive/c/apache-ant-1.8.4" \
 --with-dmake-url="http://dmake.apache-extras.org.codespot.com/files/dmake-4.12.tar.bz2" \
 --with-epm-url="http://www.msweet.org/files/project2/epm-3.7-source.tar.gz" \
 --enable-pch \
 --disable-atl \
 --disable-activex \
 --without-junit</pre>If you have not installed the optional DirectX SDK then remove the <code>--with-directx-home switch</code>
*Finish configuration and download missing external source tarballs and extensions<pre>./bootstrap</pre>
* Include the configured environment<pre>source winenv.set.sh</pre>
* Build<pre>cd instsetoo_native/
build --all</pre>Depending on your computer this will take one or more hours to finish.

* Install<br/>There are three options:
*# Regular install with integration into Windows.<br/>This allows only one instance of AOO to be installed.
*#* Start setup.exe and click through dialog:<br/><pre>$SourceMain/instsetoo_native/wntmsci12.pro/OpenOffice/msi/install/en-US/setup.exe</pre>
*#* Apache OpenOffice can be started via the Windows start menu.
*# Install without integration into Windows.<br/>This allows several instance of AOO, based on the same version, to be installed side by side.<br/>It still requires Administrator permissions.
*#* Start <code>setup.exe</code> with option <code>-a</code>:<br/><pre>$SourceMain/instsetoo_native/wntmsci12.pro/OpenOffice/msi/install/en-US/setup.exe -a</pre>
*#* Enter an installation path into the dialog and click through the dialog to finish installation.
*#* Start AOO by running<br/><pre><installation-path>/program/soffice.exe</pre>
*# Unpack archive without installation.<br/>This does not require Administrator permissions
*#* Go to installation directory:<br/><pre>cd <installation-target></pre>
*#* Unzip archive:<br/><pre>unzip $SourceMain/instsetoo_native/wntmsci12.pro/OpenOffice/archive/install/en-US/Apache_OpenOffice_4.0.1_Win_x86_install-arc_en-US.zip</pre>
*#* Start AOO by running:<br/><pre>./Apache_OpenOffice_4.0.1_Win_x86_install-arc_en-US/program/soffice.exe</pre>

=[https://wiki.openoffice.org/wiki/Documentation/Building_Guide/Building_on_MacOSX Mac OS/X]=

[[Category:Documentation]][[Category:Development]][[Category:Porting]]

CellCustomAtributes

2015-02-18T03:00:20Z

JZA: Python modules

I created a spreadsheet with a user defined attribute like this....

<source lang=python>
>>> import Danny.OOo.OOoLib
>>> from Danny.OOo.OOoLib import *
>>> oDoc = StarDesktop.loadComponentFromURL( "private:factory/scalc", "_blank", 0, Array() )
>>> oSheet = oDoc.getSheets().getByIndex( 0 )
>>> oCell = oSheet.getCellByPosition( 2, 5 )
>>> oUserDefinedAttributes = oShape.UserDefinedAttributes

Traceback (most recent call last):
File "<pyshell#5>", line 1, in -toplevel-
oUserDefinedAttributes = oShape.UserDefinedAttributes
NameError: name 'oShape' is not defined
>>> oUserDefinedAttributes = oCell.UserDefinedAttributes
>>> oUserDefinedAttributes.hasByName( "MeowMix" )
False
>>> oMyAttribute = createUnoStruct( "com.sun.star.xml.AttributeData" )
>>> oMyAttribute.Type = "CDATA"
>>> oMyAttribute.Value = "Giddy Gat"
>>> oUserDefinedAttributes.insertByName( "MeowMix", oMyAttribute )
>>> oCell.UserDefinedAttributes = oUserDefinedAttributes
>>> oDoc.storeToURL( convertToURL( "C:\\Documents and Settings\\dbrewer\\Desktop\Test.sxc" ), Array() )
>>> oDoc.close( True )
>>>

</source>

Please note that it is IMPORTANT to store the collection of user attributes back to the property like so....

<source lang=python>oCell.UserDefinedAttributes = oUserDefinedAttributes</source>
in the example above.

Then, using a new python session, I reloaded the document and verified that it had my custom attribute.... <source lang=python>>>> from Danny.OOo.OOoLib import *
>>> oDoc = StarDesktop.loadComponentFromURL( convertToURL( "C:\\Documents and Settings\\dbrewer\\Desktop\Test.sxc" ), "_blank", 0, Array() )
>>> oSheet = oDoc.getSheets().getByIndex( 0 )
>>> oCell = oSheet.getCellByPosition( 2, 5 )
>>> oUserDefinedAttributes = oCell.UserDefinedAttributes
>>> oUserDefinedAttributes.hasByName( "MeowMix" )
True
>>> oMyAttribute = oUserDefinedAttributes.getByName( "MeowMix" )
>>> oMyAttribute.Value
u'Giddy Gat'
>>> oDoc.close( True )
>>> </source>

CellCustomAtributes

2015-02-18T02:59:24Z

JZA: Python modules

Python

2015-02-18T02:55:58Z

JZA: /* Hacking Around */

{{Extensions}}
[[image:Py-uno_128.png|PyUNO Logo]] [[image:Pyuno_logo_a.jpg]]

=== Python and OpenOffice ===
Apache OpenOffice 4 ships with the Python scripting language, version 2.7. OpenOffice.org 3.1 and above shipped with Python version 2.6.1 and older OpenOffice.org releases shipped with Python version 2.3.4. This Python distribution via OpenOffice comes with the [[Uno]] module, which connects the [[API|UNO API]] to the python scripting language. To run this version of Python on Linux, you can go directly to the OpenOffice PATH. And as one would expect with any distribution of Python, AOO-Python can be run from the command line as well.

If you already have a separate Python installation, you can import the uno module (the Python-UNO bridge) to it using [http://forum.openoffice.org/en/forum/viewtopic.php?f=45&t=36370&p=166783 these instructions].

If you already have a different version of Python installed on Windows, you can also access the [[API|UNO API]] using the [http://forum.openoffice.org//en/forum/viewtopic.php?f=45&t=36608&p=167909 COM bridge] instead of the Python bridge. Requires the [http://sourceforge.net/projects/pywin32/ add-on pywin32] module so Python can talk to COM. Note that while the UNO API is uniform, the implementation by the two bridges is slightly different, so the syntax required by each is also sometimes different.

==== Where is the IDE ? ====
OpenOffice's IDE doesn't support Python, so development has to be done from another editor that does. Any volunteer for a binding is welcomed. Here is a nice [http://pythonconquerstheuniverse.wordpress.com/category/the-python-debugger/ blog post] about using [http://www.vim.org VIM] a common Unix/Linux text editor configured in a way that acts like an IDE. Windows users can use [http://www.vim.org/download.php#pc Gvim] and [http://macvim.org/ MacVim] for OSX users.

==== Tips & Tricks ====

Here is some useful information about using python in AOO.

===== Debug output =====

If you launch a python script, any error will silently break the execution, making your extension hard to debug. To change this behaviour, one can change the
'''LogLevel'''
.

Have a look in
''/path/to/aoo/program/'''pythonscript.py'''''
and replace
''LogLevel.use = LogLevel.'''NONE'''''
with
''LogLevel.use = LogLevel.'''DEBUG'''''
.

There are also currently-undocumented environment variables that tell the pyUno bridge to log every call. Set the environment variable
''export PYUNO_LOGLEVEL=ARGS''
. The output may be a little hard to read, but helpful nonetheless.

Note that his applies only to Linux. For Windows, you need some more switches, and the output gets written to files (there is no stdout on windows :-( ).

There are still some error messages that won't appear in these logs; this will improve in the near future (cws pyunofixes4). Once the cws is integrated, I will document these switches on the official pyuno site.

''Thanks to Joerg Budischewski''
.

=== Python specific information for Extension creation ===
To create extensions for python, it is important that you have enough familiarity with the UNO components, as well as with packaging your code for easy distribution through the ''OpenOffice package manager''. Please check the tutorials to learn how to component-ize your code, and how to deploy remote scripting through a service implementation.

To learn to run Python on Windows, visit [[Using Python on Windows| this link]] for more detailed information.

{| align="center" cellspacing="0" cellpadding="0" style="border: 0px solid rgb(134, 194, 230);"
|- valign="top"
| style="width: 35%; padding-right: 15px;" | <div style="border-style: solid solid none; border-color: rgb(134, 194, 230) rgb(134, 194, 230) -moz-use-text-color; border-width: 1px 1px medium; padding: 5px; font-size: 120%; font-weight: bold; background-color: rgb(203, 222, 250);">Getting Started</div> <div style="border: 1px solid rgb(155, 192, 245); padding: 5px 5px 10px;">
*[[Python/Python_Language_Binding|Python Language Binding]]
*[[Python/Python_Loader|Python Loader]]
*[[Using Python on Windows]] - New to Python? Learn how to use python on Windows
*[[Using Python on Linux]] - A must read for an overview on Python and AOO relations
* [[pyUNO bridge]] - Official page of the PyUNO bridge at the [http://udk.openoffice.org/ UDK site] - ([http://www.fatcow.com/edu/mathtex-be/ ''Belorussian translation''])
* [[Python as a macro language]] in OpenOffice.org 2.x - How to use the Python scripting framework
* [[Python/Transfer_from_Basic_to_Python|Transfer from Basic to Python]]
* [http://lucasmanual.com/mywiki/OpenOffice PyUNO Manual] Lukasz created a pyUNO manual. '''new'''
* [[SQLAlquemyPyUNO|SQLAlchemy and PyUNO]] connecting OpenOffice to any database
* [http://www.linuxjournal.com/content/starting-stopping-and-connecting-openoffice-python Starting/Stopping and connecting using Python] From Linux Journal
* Introduction on testing pyUNO programs with [[doctests]]
* Create a [[PythonDialogBox|dialog box]] in PyUNO.
* [http://codesnippets.services.openoffice.org/Office/Office.ConnectViaPipe.snip Connect to Openoffice] from PyUNO
* [[PyUNO samples]] currently shipping with OpenOffice.org and the explanation.
* Enhanced [http://www.oooforum.org/forum/viewtopic.phtml?p=257496#257496 Capitalized.py] script by ''The gray Cardinal'' at the OpenOffice forum.

| style="width: 35%; padding-right: 15px;" | <div style="border-style: solid solid none; border-color: rgb(134, 194, 230) rgb(134, 194, 230) -moz-use-text-color; border-width: 1px 1px medium; padding: 5px; font-size: 120%; font-weight: bold; background-color: rgb(203, 222, 250);">PYUNO Modules</div> <div style="border: 1px solid rgb(155, 192, 245); padding: 5px 5px 10px;">
*[[Danny's Python Modules]] - Collection guide from DannyB's modules.
*[[PrinttoWriter.py]] - This makes it easy and convenient to print a bunch of text into a Writer document.
*[[CalcFunctions]] - Learn how Python can be used to develop Calc functions in Python
*[[Python-Calc]] - Various scripts to deal with Calc
*[[PythonContainers]] - Python container components
*[[PyUNOServer]] - The PyUNOServer is a script that works as an XML server for OpenOffice.org Calc
*[[calcParser]] - calcParser is a small parser using the native SAX utilities within the OpenOffice.org python
*[[OoConfig]] - OoConfig is a Python extension that seeks to provide a configuration editing facility similar to Mozilla's about:config
*[[Bibliographic/Hints and Tips/OOoRISExport.py|OOoRISExport.py]] - Exports the bibliographic database in RIS format. Also [http://bibliographic.openoffice.org/files/documents/124/3078/RISImport.py RISImport.py]
*[[Zotero_Plugin |Zotero Plugin]] - The Zotero plugin provides citation and bibliographic table insertion and editing functions for Writer documents.
*[http://oosheet.hacklab.com.br/ OOSheet] - High level python library to develop spreadsheet macros without the complexity of Uno. Focuses on spreadsheets, but may be useful for other documents.
|}

=== Hacking Around ===
*[[UNO component packaging]] - How to create UNO components as well as the basics of script componentizing
*[http://www.oooforum.org/forum/viewtopic.phtml?p=38234#38234 Python component to parse XML] - Python is great to parse XML, PyUNO is also excellent when working with XML
*[[Example of Service in Python]] - Learn how to run Python as a service, this is useful for remote scripting.
*[[CellCustomAtributes]] - Example of storing and retrieving a custom attribute on a spreadsheet cell.
*A simple [[daemon in Python]] - Learn how to run Python as a daemon
*[[Loook.py]] - a simple Python tool that searches for text strings in OpenOffice.org.
*[[odt2txt.py]] - convert ODF to plain text using python (and convert the txt to html).

=== Python rules OpenOffice (by B. Bois) ===
[[image:python_power_for_OOo.png|Python rules OpenOffice :-)]]

[[Category:Extensions]]
[[Category:Python]]
[[Category:Uno]]

Danny.OOo.OOoLib.py

2015-02-17T20:05:36Z

JZA: Adding bold strings.

This module makes programming OOo in Python much more like programming OOo in Basic. It also contains some frequently used functions that I typically write in Basic, such as '''makePropertyValue()'''.
When I write Components in Python, the first function in this module, the '''getServiceManager()''' function is replaced by a completely different implementation. Otherwise, even in a component, the features of this module are available.

<source lang=python>
#**********************************************************************
#
# Danny.OOo.OOoLib.py
#
# A module to easily work with OpenOffice.org.
#
#**********************************************************************
# Copyright (c) 2003-2004 Danny Brewer
# d29583@groovegarden.com
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# See: http://www.gnu.org/licenses/lgpl.html
#
#**********************************************************************
# If you make changes, please append to the change log below.
#
# Change Log
# Danny Brewer Revised 2004-06-07-01
#
#**********************************************************************

import string

# OOo's libraries
import uno

#------------------------------------------------------------
# Uno ServiceManager access
# A different version of this routine and global variable
# is needed for code running inside a component.
#------------------------------------------------------------

# The ServiceManager of the running OOo.
# It is cached in a global variable.
goServiceManager = False
def getServiceManager( cHost="localhost", cPort="8100" ):
"""Get the ServiceManager from the running OpenOffice.org.
Then retain it in the global variable goServiceManager for future use.
This is similar to the GetProcessServiceManager() in OOo Basic.
"""
global goServiceManager
if not goServiceManager:
# Get the uno component context from the PyUNO runtime
oLocalContext = uno.getComponentContext()
# Create the UnoUrlResolver on the Python side.
oLocalResolver = oLocalContext.ServiceManager.createInstanceWithContext(
"com.sun.star.bridge.UnoUrlResolver", oLocalContext )
# Connect to the running OpenOffice.org and get its context.
oContext = oLocalResolver.resolve( "uno:socket,host=" + cHost + ",port=" + cPort + ";urp;StarOffice.ComponentContext" )
# Get the ServiceManager object
goServiceManager = oContext.ServiceManager
return goServiceManager

#------------------------------------------------------------
# Uno convenience functions
# The stuff in this section is just to make
# python progrmaming of OOo more like using OOo Basic.
#------------------------------------------------------------

# This is the same as ServiceManager.createInstance( ... )
def createUnoService( cClass ):
"""A handy way to create a global objects within the running OOo.
Similar to the function of the same name in OOo Basic.
"""
oServiceManager = getServiceManager()
oObj = oServiceManager.createInstance( cClass )
return oObj

# The StarDesktop object. (global like in OOo Basic)
# It is cached in a global variable.
StarDesktop = None
def getDesktop():
"""An easy way to obtain the Desktop object from a running OOo.
"""
global StarDesktop
if StarDesktop == None:
StarDesktop = createUnoService( "com.sun.star.frame.Desktop" )
return StarDesktop
# preload the StarDesktop variable.
getDesktop()

# The CoreReflection object.
# It is cached in a global variable.
goCoreReflection = False
def getCoreReflection():
global goCoreReflection
if not goCoreReflection:
goCoreReflection = createUnoService( "com.sun.star.reflection.CoreReflection" )
return goCoreReflection

def createUnoStruct( cTypeName ):
"""Create a UNO struct and return it.
Similar to the function of the same name in OOo Basic.
"""
oCoreReflection = getCoreReflection()
# Get the IDL class for the type name
oXIdlClass = oCoreReflection.forName( cTypeName )
# Create the struct.
oReturnValue, oStruct = oXIdlClass.createObject( None )
return oStruct

#def newConnectionToOOo( cHost="localhost", cPort="8100" ):
# """Call this to establish, or re-establish a connection to OOo."""
# global goServiceManager
# global StarDesktop
# global goCoreReflection
# goServiceManager = False
# StarDesktop = None
# goCoreReflection = False
# getServiceManager( cHost, cPort )
# getDesktop()

#------------------------------------------------------------
# API helpers
#------------------------------------------------------------

def hasUnoInterface( oObject, cInterfaceName ):
"""Similar to Basic's HasUnoInterfaces() function, but singular not plural."""

# Get the Introspection service.
oIntrospection = createUnoService( "com.sun.star.beans.Introspection" )

# Now inspect the object to learn about it.
oObjInfo = oIntrospection.inspect( oObject )

# Obtain an array describing all methods of the object.
oMethods = oObjInfo.getMethods( uno.getConstantByName( "com.sun.star.beans.MethodConcept.ALL" ) )
# Now look at every method.
for oMethod in oMethods:
# Check the method's interface to see if
# these aren't the droids you're looking for.
cMethodInterfaceName = oMethod.getDeclaringClass().getName()
if cMethodInterfaceName == cInterfaceName:
return True
return False

def hasUnoInterfaces( oObject, *cInterfaces ):
"""Similar to the function of the same name in OOo Basic."""
for cInterface in cInterfaces:
if not hasUnoInterface( oObject, cInterface ):
return False
return True

#------------------------------------------------------------
# High level general purpose functions
#------------------------------------------------------------

def makePropertyValue( cName=None, uValue=None, nHandle=None, nState=None ):
"""Create a com.sun.star.beans.PropertyValue struct and return it.
"""
oPropertyValue = createUnoStruct( "com.sun.star.beans.PropertyValue" )

if cName != None:
oPropertyValue.Name = cName
if uValue != None:
oPropertyValue.Value = uValue
if nHandle != None:
oPropertyValue.Handle = nHandle
if nState != None:
oPropertyValue.State = nState

return oPropertyValue

def makePoint( nX, nY ):
"""Create a com.sun.star.awt.Point struct."""
oPoint = createUnoStruct( "com.sun.star.awt.Point" )
oPoint.X = nX
oPoint.Y = nY
return oPoint

def makeSize( nWidth, nHeight ):
"""Create a com.sun.star.awt.Size struct."""
oSize = createUnoStruct( "com.sun.star.awt.Size" )
oSize.Width = nWidth
oSize.Height = nHeight
return oSize

def makeRectangle( nX, nY, nWidth, nHeight ):
"""Create a com.sun.star.awt.Rectangle struct."""
oRect = createUnoStruct( "com.sun.star.awt.Rectangle" )
oRect.X = nX
oRect.Y = nY
oRect.Width = nWidth
oRect.Height = nHeight
return oRect

def Array( *args ):
"""This is just sugar coating so that code from OOoBasic which
contains the Array() function can work perfectly in python."""
tArray = ()
for arg in args:
tArray += (arg,)
return tArray

def loadComponentFromURL( cUrl, tProperties=() ):
"""Open or Create a document from it's URL.
New documents are created from URL's such as:
private:factory/sdraw
private:factory/swriter
private:factory/scalc
private:factory/simpress
"""
StarDesktop = getDesktop()
oDocument = StarDesktop.loadComponentFromURL( cUrl, "_blank", 0, tProperties )
return oDocument

#def makeWriterDocument():
# """Create a new OOo Writer document."""
# return loadComponentFromURL( "private:factory/swriter" )
#
#
#def makeCalcDocument():
# """Create a new OOo Calc document."""
# return loadComponentFromURL( "private:factory/scalc" )

#------------------------------------------------------------
# Styles
#------------------------------------------------------------

def defineStyle( oDrawDoc, cStyleFamily, cStyleName, cParentStyleName=None ):
"""Add a new style to the style catalog if it is not already present.
This returns the style object so that you can alter its properties.
"""

oStyleFamily = oDrawDoc.getStyleFamilies().getByName( cStyleFamily )

# Does the style already exist?
if oStyleFamily.hasByName( cStyleName ):
# then get it so we can return it.
oStyle = oStyleFamily.getByName( cStyleName )
else:
# Create new style object.
oStyle = oDrawDoc.createInstance( "com.sun.star.style.Style" )

# Set its parent style
if cParentStyleName != None:
oStyle.setParentStyle( cParentStyleName )

# Add the new style to the style family.
oStyleFamily.insertByName( cStyleName, oStyle )

return oStyle

def getStyle( oDrawDoc, cStyleFamily, cStyleName ):
"""Lookup and return a style from the document.
"""
return oDrawDoc.getStyleFamilies().getByName( cStyleFamily ).getByName( cStyleName )

#------------------------------------------------------------
# General Utility functions
#------------------------------------------------------------

def convertToURL( cPathname ):
"""Convert a Windows or Linux pathname into an OOo URL."""
if len( cPathname ) > 1:
if cPathname[1:2] == ":":
cPathname = "/" + cPathname[0] + "|" + cPathname[2:]
cPathname = string.replace( cPathname, "\\", "/" )
cPathname = "file://" + cPathname
return cPathname
</source>

[[Category:Extensions]]
[[Category:Python]]
[[Category:Uno]]

Danny's Python Modules

2015-02-17T20:04:47Z

JZA: Adding link on DrawLib.py

In this thread I am going to post some various Python modules from my growing library. The following links take you directly to the message where a particular class is posted.

[http://www.oooforum.org/forum/viewtopic.phtml?t=14409 Click here to see original posting]

'''[[Danny.OOo.OOoLib.py]]'''
This module makes programming OOo in Python much more like programming OOo in Basic. It also contains some frequently used functions that I typically write in Basic, such as '''makePropertyValue()'''.

'''[[Danny.OOo.DrawLib.py]]'''
This module has routines to make programming OOo Drawing documents easier. Much of this code was derrived from Basic code, that also appears in Danny's Draw Power Tools found at OOoMacros.org.

'''[[Danny.HSBConversions.py]]'''
HSB to RGB color space conversion routines. This module is a prerequisite for the module [[Danny.OOo.DrawLib.py]].

'''[[Danny.OOo.PrintToWriter.py]]'''
This makes it easy and convenient to print a bunch of text into a Writer document. See the example routine in the module that shows how easy this module is to use, and how useful it can be.

'''[[Danny.OOo.ConfigLib.py]]'''
Routines for working with the Configuration Manager.

'''[[Danny.OOo.DialogLib.py]]'''
A class to build a dialog box from the com.sun.star.awt.* services. This doesn't do anything you couldn't already do using OOo's UNO API, this just makes it much easier.

'''[[Danny.OOo.WindowLib.py]]'''
A class to build a modeless window from the com.sun.star.awt.* services. This doesn't do anything you couldn't already do using OOo's UNO API, this just makes it much easier.

'''[[Danny.OOo.Listeners.ListenerProcAdapters.py]]'''
This module has various helpers that make it extremely easy to create listeners on the fly, and make them call an arbitrary python procedure. See quick example that appears with the code.

'''[[Danny.OOo.Listeners.TopWindowListener.py]]'''
When you need to add a window listener to a top window, this class makes is easy to create such a listener. You can use this class, or your own subclass of it. If you create a subclass, you don't need to bother to implement every one of the methods, because you can inherit the empty implementations of methods from this class for the methods you are not interested in.

'''[[Danny.HeapSort]]'''
A simple implementation of HeapSort. Yet, it allows a customizable notion of "comparison" and "swapping" by passing in your own compareGreaterProc, and swapProc.
This is NOT an OOo specific module. It can be used for any type of Python code.

[[Category:Python]][[Category:External Project]]

Danny.OOo.WindowLib.py

2015-02-17T20:01:03Z

JZA: Adding categories

A class to build a modeless window from the com.sun.star.awt.* services. This doesn't do anything you couldn't already do using OOo's UNO API, this just makes it much easier.

This class IS NOT the actual OOo window, but you can get the OOo window or frame by calling getWindow() or getFrame() on this class.

You can change the window size, position, title, etc. You can add controls, and listeners for those controls to the window. This class can be used by subclassing it, or without subclassing it.

<source lang=python>
#**********************************************************************
#
# Danny.OOo.WindowLib.py
#
# A module to easily work with OpenOffice.org.
#
#**********************************************************************
# Copyright (c) 2003-2004 Danny Brewer
# d29583@groovegarden.com
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# See: http://www.gnu.org/licenses/lgpl.html
#
#**********************************************************************
# If you make changes, please append to the change log below.
#
# Change Log
# Danny Brewer Revised 2004-06-05-02
#
#**********************************************************************

# OOo's libraries
import uno
import unohelper

# Danny's libraries
from Danny.OOo.OOoLib import createUnoService, createUnoStruct
from Danny.OOo.OOoLib import makeRectangle, StarDesktop
#
from Danny.OOo.Listeners.ListenerProcAdapters import *

#----------
# com.sun.star.awt.WindowAttribute
#
# specifies that the window is initially visible.
com_sun_star_awt_WindowAttribute_SHOW = uno.getConstantByName( "com.sun.star.awt.WindowAttribute.SHOW" )
# specifies that the window fills the complete desktop area.
com_sun_star_awt_WindowAttribute_FULLSIZE = uno.getConstantByName( "com.sun.star.awt.WindowAttribute.FULLSIZE" )
com_sun_star_awt_WindowAttribute_OPTIMUMSIZE = uno.getConstantByName( "com.sun.star.awt.WindowAttribute.OPTIMUMSIZE" )
com_sun_star_awt_WindowAttribute_MINSIZE = uno.getConstantByName( "com.sun.star.awt.WindowAttribute.MINSIZE" )
# specifies that the window has visible borders.
com_sun_star_awt_WindowAttribute_BORDER = uno.getConstantByName( "com.sun.star.awt.WindowAttribute.BORDER" )
# specifies that the size of the window can be changed by the user.
com_sun_star_awt_WindowAttribute_SIZEABLE = uno.getConstantByName( "com.sun.star.awt.WindowAttribute.SIZEABLE" )
# specifies that the window can be moved by the user.
com_sun_star_awt_WindowAttribute_MOVEABLE = uno.getConstantByName( "com.sun.star.awt.WindowAttribute.MOVEABLE" )
# specifies that the window can be closed by the user.
com_sun_star_awt_WindowAttribute_CLOSEABLE = uno.getConstantByName( "com.sun.star.awt.WindowAttribute.CLOSEABLE" )
#[ DEPRECATED ] specifies that the window should support the XSystemDependentWindowPeer interface.
com_sun_star_awt_WindowAttribute_SYSTEMDEPENDENT = uno.getConstantByName( "com.sun.star.awt.WindowAttribute.SYSTEMDEPENDENT" )

# Default window attributes.
# The DBWindow class (and subclasses) use this as the default window attributes
# when you don't specify any window attributes on the constructor.
gnDefaultWindowAttributes = \
com_sun_star_awt_WindowAttribute_SHOW + \
com_sun_star_awt_WindowAttribute_BORDER + \
com_sun_star_awt_WindowAttribute_MOVEABLE + \
com_sun_star_awt_WindowAttribute_CLOSEABLE
# we could have addedd...
#com_sun_star_awt_WindowAttribute_SIZEABLE

# The global Awt Toolkit.
# This is initialized the first time it is needed.
#goAwtToolkit = createUnoService( "com.sun.star.awt.Toolkit" )
goAwtToolkit = None
#
def getAwtToolkit():
global goAwtToolkit
if goAwtToolkit == None:
goAwtToolkit = createUnoService( "com.sun.star.awt.Toolkit" )
return goAwtToolkit

# This class is a sugar coated abstraction for OOo's Awt Window.
# This can be used in two different ways...
# 1. by subclassing it (elegant)
# 2. without subclassing it (less elegant)
class DBWindow:
"""Class to build a modeless window from the com.sun.star.awt.* services.
This doesn't do anything you couldn't already do using OOo's UNO API,
this just makes it much easier.
This class IS NOT the actual OOo window, but you can get the OOo window or frame by calling getWindow() or getFrame() on this class.
You can change the window size, position, title, etc.
You can add controls, and listeners for those controls to the window.
This class can be used by subclassing it, or without subclassing it.
"""
def __init__( self, cTitle=None, tBoundsRect=None, nWindowAttributes=None ):
oAwtToolkit = getAwtToolkit()
oWindowDesc = self.createMyWindowDescriptor( tBoundsRect, nWindowAttributes )
self.oWindow = oAwtToolkit.createWindow( oWindowDesc )

# At this point, if you stop the program, you will have a
# new OOo window on the screen, but you cannot do anything
# with it. You cannot even close it!
# In fact, you have to kill the OOo process, as even OOo
# cannot close this window since it has no Frame and
# therefore is not integrated into the desktop environment.
# So we need to create a Frame for our window....

# Create a new frame.
self.oFrame = createUnoService( "com.sun.star.frame.Frame" )
# Initialize this frame with our new window.
self.oFrame.initialize( self.oWindow )
# Tell the frame that its parent is the Desktop.
self.oFrame.setCreator( StarDesktop )

if cTitle != None:
self.setWindowTitle( cTitle )

# A collection of controls on this window. (NOT control models, but controls.)
self.controls = {}

def createMyWindowDescriptor( self, tBoundsRect=None, nWindowAttributes=None ):
"""This returns the com.sun.star.awt.WindowDescriptor that will be used to create this window.
Your subclass can override this method to provide a modified window descriptor."""
if tBoundsRect == None:
tBoundsRect = makeRectangle( 100, 200, 300, 400 )
if nWindowAttributes == None:
nWindowAttributes = gnDefaultWindowAttributes
oAwtToolkit = getAwtToolkit()

oWindowDesc = createUnoStruct( "com.sun.star.awt.WindowDescriptor" )

# specifies a top level window on the desktop. It is also a container.
oWindowDesc.Type = uno.getConstantByName( "com.sun.star.awt.WindowClass.TOP" )

# specifies the name of the component service.
# A zero length name means that the vcl creates a blank top,
# a container, or a simple window.
oWindowDesc.WindowServiceName = ""

# specifies the parent of the component.
# If Parent == 0 && ParentIndex == -1 , then the window is on the desktop.
oWindowDesc.Parent = oAwtToolkit.getDesktopWindow()
# specifies the index of the parent window, if available.
# If Parent == 0 and this struct is a member of an array,
# then this is the offset from the beginning of the array to the parent.
# A value of -1 means desktop.
oWindowDesc.ParentIndex = -1

# specifies the position and size of the window.
# This member is ignored if the window attribute has
# WindowAttribute::FULLSIZE .
oWindowDesc.Bounds = tBoundsRect

# specifies the window attributes.
oWindowDesc.WindowAttributes = nWindowAttributes

return oWindowDesc

#--------------------------------------------------
# The following two methods
# getWindow() and getFrame()
# return the two objects that this class manages.
#--------------------------------------------------

def getWindow( self ):
"""Return the OOo Awt Window that this object represents.
The window object returned has the following interfaces...
com.sun.star.awt.XTopWindow
com.sun.star.awt.XWindow
com.sun.star.awt.XWindowPeer
com.sun.star.awt.XVclContainer [deprecated]
com.sun.star.awt.XVclContainerPeer [deprecated]
com.sun.star.awt.XVclWindowPeer [deprecated]
com.sun.star.awt.XLayoutConstraints
com.sun.star.awt.XView
com.sun.star.awt.XDevice
com.sun.star.lang.XEventListener
com.sun.star.lang.XComponent
com.sun.star.lang.XTypeProvider
com.sun.star.accessibility.XAccessible
Properties...
<object> MenuBar
<array> Windows
<array> Group
<object> PosSize
Boolean Visible
Boolean Enable
<object> Toolkit
<object> Pointer
Long Background
Boolean DesignMode
Long Foreground
<object> ControlFont
<object> MinimumSize
<object> PreferredSize
<object> AccessibleContext
<object> Graphics
<object> Size
<object> Info
<array> FontDescriptors
"""
return self.oWindow

def getFrame( self ):
"""Return the Frame for the OOo Awt Window that this object represents."""
return self.oFrame

#--------------------------------------------------
# The following methods represent part of the sugar coating
# that this class provides to manage the window.
#--------------------------------------------------

def windowClose( self ):
"""Close the window frame."""
self.getFrame().close( True )
self.oFrame = None
self.oWindow = None

def windowToFront( self ):
"""places this window at the top of the stacking order and shows it in front of any other windows."""
# By looking at the following line of code,
# and by looking at the list of interfaces from the comment in the getWindow() method,
# you should be able to figure out how to do lots of other things to this window.
self.getWindow().toFront()

def windowToBack( self ):
""" places this window at the bottom of the stacking order and makes the corresponding adjustment to other visible windows."""
self.getWindow().toBack()

def setWindowTitle( self, cTitle ):
"""Set the title of the window that this object represents."""
# By looking at the following line of code,
# and by looking at the com.sun.star.frame.Frame service,
# you should be able to figure out how to do lots of other things to this window.
self.getFrame().Title = cTitle

def getWindowTitle( self ):
"""Get the title of the window that this object represents"""
return self.getFrame().Title

def setWindowBackground( self, nColor ):
"""Set the background color of the window that this object represents."""
self.getWindow().setBackground( nColor )

def getWindowGraphics( self ):
"""Returns a com.sun.star.awt.XGraphics for the window that this object represents.
You can then call methods on the XGraphics to draw things into this window."""
return self.getWindow().getGraphics()

def setWindowPosSize( self, nX, nY, nWidth, nHeight ):
"""Set the position and size of the window."""
self.getWindow().setPosSize( nX, nY, nWidth, nHeight,
uno.getConstantByName( "com.sun.star.awt.PosSize.POSSIZE" ) )
def setWindowPosition( self, nX, nY ):
"""Set the position of the window."""
self.getWindow().setPosSize( nX, nY, 0, 0,
uno.getConstantByName( "com.sun.star.awt.PosSize.POS" ) )
def setWindowSize( self, nWidth, nHeight ):
"""Set the position and size of the window."""
self.getWindow().setPosSize( 0, 0, nWidth, nHeight,
uno.getConstantByName( "com.sun.star.awt.PosSize.SIZE" ) )
def getWindowPosSize( self ):
"""Returns a com.sun.star.awt.Rectangle that contains the position and size of this window."""
return self.getWindow().getPosSize()

def setWindowVisible( self, bVisible ):
"""Make this window (in)visible."""
self.getWindow().setVisible( bVisible )
def setWindowEnable( self, bEnable ):
"""Make this window (dis)enabled."""
self.getWindow().setEnable( bEnable )

def setWindowFocus( self ):
"""Set the focus to this window."""
self.getWindow().setFocus()

#--------------------------------------------------
# com.sun.star.awt.UnoControlButton
#--------------------------------------------------

def addButton( self, cCtrlName, nPositionX, nPositionY, nWidth, nHeight,
cLabel=None,
actionListenerProc=None ):
"""Add a Button control to the window."""
oControlModel = createUnoService( "com.sun.star.awt.UnoControlButtonModel" )
oControl = createUnoService( oControlModel.DefaultControl ) # Create a control and its model.
oControl.setModel( oControlModel ) # Introduce the model to the control.
oControl.createPeer( getAwtToolkit(), self.getWindow() ) # Make the control create its window peer.
# Keep a dictionary of controls we are managing in the window.
self.controls[ cCtrlName ] = oControl
# Set position and size
self.setPosSize( cCtrlName, nPositionX, nPositionY, nWidth, nHeight )

if cLabel != None:
oControlModel.Label = cLabel

if actionListenerProc != None:
self.addActionListenerProc( cCtrlName, actionListenerProc )

def setButtonLabel( self, cCtrlName, cLabel ):
"""Set the label of the control."""
oControl = self.getControl( cCtrlName )
oControl.setLabel( cLabel )

#--------------------------------------------------
# com.sun.star.awt.UnoControlCheckBox
#--------------------------------------------------

def addCheckBox( self, cCtrlName, nPositionX, nPositionY, nWidth, nHeight,
cLabel=None,
itemListenerProc=None ):
"""Add a CheckBox control to the window."""
oControlModel = createUnoService( "com.sun.star.awt.UnoControlCheckBoxModel" )
oControl = createUnoService( oControlModel.DefaultControl ) # Create a control and its model.
oControl.setModel( oControlModel ) # Introduce the model to the control.
oControl.createPeer( getAwtToolkit(), self.getWindow() ) # Make the control create its window peer.
# Keep a dictionary of controls we are managing in the window.
self.controls[ cCtrlName ] = oControl
# Set position and size
self.setPosSize( cCtrlName, nPositionX, nPositionY, nWidth, nHeight )

if cLabel != None:
oControlModel.Label = cLabel

if itemListenerProc != None:
self.addItemListenerProc( cCtrlName, itemListenerProc )

def setCheckBoxLabel( self, cCtrlName, cLabel ):
"""Set the label of the control."""
oControl = self.getControl( cCtrlName )
oControl.setLabel( cLabel )

def getCheckBoxState( self, cCtrlName ):
"""Get the state of the control."""
oControl = self.getControl( cCtrlName )
return oControl.getState();

def setCheckBoxState( self, cCtrlName, nState ):
"""Set the state of the control."""
oControl = self.getControl( cCtrlName )
oControl.setState( nState )

def enableCheckBoxTriState( self, cCtrlName, bTriStateEnable ):
"""Enable or disable the tri state mode of the control."""
oControl = self.getControl( cCtrlName )
oControl.enableTriState( bTriStateEnable )

#--------------------------------------------------
# com.sun.star.awt.UnoControlComboBox
#--------------------------------------------------

def addComboBox( self, cCtrlName, nPositionX, nPositionY, nWidth, nHeight,
bDropdown=True,
itemListenerProc=None,
actionListenerProc=None ):
"""Add a ComboBox control to the window."""
oControlModel = createUnoService( "com.sun.star.awt.UnoControlComboBoxModel" )
oControlModel.Dropdown = bDropdown
oControl = createUnoService( oControlModel.DefaultControl ) # Create a control and its model.
oControl.setModel( oControlModel ) # Introduce the model to the control.
oControl.createPeer( getAwtToolkit(), self.getWindow() ) # Make the control create its window peer.
# Keep a dictionary of controls we are managing in the window.
self.controls[ cCtrlName ] = oControl
# Set position and size
self.setPosSize( cCtrlName, nPositionX, nPositionY, nWidth, nHeight )

if itemListenerProc != None:
self.addItemListenerProc( cCtrlName, itemListenerProc )
if actionListenerProc != None:
self.addActionListenerProc( cCtrlName, actionListenerProc )

def addComboBoxItem( self, cCtrlName, cItemText, nPosition=-1 ):
"""Add an item to the ComboBox at specified position."""
oControl = self.getControl( cCtrlName )
if nPosition == -1: nPosition = self.getComboBoxItemCount( cCtrlName )
oControl.addItem( cItemText, nPosition )

def addComboBoxItems( self, cCtrlName, tcItemTexts, nPosition=0 ):
"""Add a tupple of items to the ComboBox at specified position."""
oControl = self.getControl( cCtrlName )
oControl.addItems( tcItemTexts, nPosition )

def removeComboBoxItems( self, cCtrlName, nPosition, nCount=1 ):
"""Remove items from a ComboBox."""
oControl = self.getControl( cCtrlName )
oControl.removeItems( nPosition, nCount )

def getComboBoxItemCount( self, cCtrlName ):
"""Get the number of items in a ComboBox."""
oControl = self.getControl( cCtrlName )
return oControl.getItemCount()

def getComboBoxItem( self, cCtrlName, nPosition ):
"""Return the item at specified position within the ComboBox."""
oControl = self.getControl( cCtrlName )
return oControl.getItem( nPosition )

def getComboBoxItems( self, cCtrlName ):
"""Return a tupple of all items in the ComboBox."""
oControl = self.getControl( cCtrlName )
return oControl.getItems()

def getComboBoxDropDownLineCount( self, cCtrlName ):
"""Returns the number of visible lines in the drop down mode."""
oControl = self.getControl( cCtrlName )
return oControl.getDropDownLineCount()

def setComboBoxDropDownLineCount( self, cCtrlName, nNumLines ):
"""Sets the number of visible lines in the drop down mode."""
oControl = self.getControl( cCtrlName )
oControl.setDropDownLineCount( nNumLines )

def getComboBoxText( self, cCtrlName ):
"""Get the text of the ComboBox."""
oControl = self.getControl( cCtrlName )
return oControl.getText();

def setComboBoxText( self, cCtrlName, cText ):
"""Set the text of the ComboBox."""
oControl = self.getControl( cCtrlName )
oControl.setText( cText )

def insertComboBoxText( self, cCtrlName, cText, nMinSelection, nMaxSelection ):
"""Insert text at specified position in the ComboBox."""
oControl = self.getControl( cCtrlName )
tSelection = Selection()
tSelection.Min = nMinSelection
tSelection.Max = nMaxSelection
oControl.insertText( tSelection, cText )

def getComboBoxSelectedText( self, cCtrlName ):
"""Get the selected text of the ComboBox."""
oControl = self.getControl( cCtrlName )
return oControl.getSelectedText();

def getComboBoxSelection( self, cCtrlName ):
"""Get the selection of the ComboBox.
This is a com.sun.star.awt.Selection struct with members Min and Max."""
oControl = self.getControl( cCtrlName )
return oControl.getSelection()

def isComboBoxEditable( self, cCtrlName ):
"""Indicate whether the text in the ComboBox is editable by the user."""
oControl = self.getControl( cCtrlName )
return oControl.isEditable()

def setComboBoxEditable( self, cCtrlName, bEditable ):
"""Set whether the text in the ComboBox is editable by the user."""
oControl = self.getControl( cCtrlName )
oControl.setEditable( bEditable )

def setComboBoxMaxTextLen( self, cCtrlName, nMaxLen ):
"""Set the maximum text length the ComboBox can have."""
oControl = self.getControl( cCtrlName )
oControl.setMaxTextLen( nMaxLen )

def getComboBoxMaxTextLen( self, cCtrlName ):
"""Get the maximum text length the ComboBox can have."""
oControl = self.getControl( cCtrlName )
oControl.getMaxTextLen()

#--------------------------------------------------
# com.sun.star.awt.UnoControlEdit
#--------------------------------------------------

def addEdit( self, cCtrlName, nPositionX, nPositionY, nWidth, nHeight,
cText=None,
textListenerProc=None ):
"""Add a Edit control to the window."""
oControlModel = createUnoService( "com.sun.star.awt.UnoControlEditModel" )
oControl = createUnoService( oControlModel.DefaultControl ) # Create a control and its model.
oControl.setModel( oControlModel ) # Introduce the model to the control.
oControl.createPeer( getAwtToolkit(), self.getWindow() ) # Make the control create its window peer.
# Keep a dictionary of controls we are managing in the window.
self.controls[ cCtrlName ] = oControl
# Set position and size
self.setPosSize( cCtrlName, nPositionX, nPositionY, nWidth, nHeight )

if cText != None:
self.setEditText( cCtrlName, cText )
if textListenerProc != None:
self.addTextListenerProc( cCtrlName, textListenerProc )

def getEditText( self, cCtrlName ):
"""Get the text of the edit box."""
oControl = self.getControl( cCtrlName )
return oControl.getText();

def setEditText( self, cCtrlName, cText ):
"""Set the text of the edit box."""
oControl = self.getControl( cCtrlName )
oControl.setText( cText )

def insertEditText( self, cCtrlName, cText, nMinSelection, nMaxSelection ):
"""Insert text at specified position in the edit box."""
oControl = self.getControl( cCtrlName )
tSelection = Selection()
tSelection.Min = nMinSelection
tSelection.Max = nMaxSelection
oControl.insertText( tSelection, cText )

def getEditSelectedText( self, cCtrlName ):
"""Get the selected text of the edit box."""
oControl = self.getControl( cCtrlName )
return oControl.getSelectedText();

def getEditSelection( self, cCtrlName ):
"""Get the selection of the edit box.
This is a com.sun.star.awt.Selection struct with members Min and Max."""
oControl = self.getControl( cCtrlName )
return oControl.getSelection()

def isEditEditable( self, cCtrlName ):
"""Indicate whether the text in the edit box is editable by the user."""
oControl = self.getControl( cCtrlName )
return oControl.isEditable()

def setEditEditable( self, cCtrlName, bEditable ):
"""Set whether the text in the edit box is editable by the user."""
oControl = self.getControl( cCtrlName )
oControl.setEditable( bEditable )

def setEditMaxTextLen( self, cCtrlName, nMaxLen ):
"""Set the maximum text length the edit box can have."""
oControl = self.getControl( cCtrlName )
oControl.setMaxTextLen( nMaxLen )

def getEditMaxTextLen( self, cCtrlName ):
"""Get the maximum text length the edit box can have."""
oControl = self.getControl( cCtrlName )
oControl.getMaxTextLen()

#--------------------------------------------------
# com.sun.star.awt.UnoControlFixedText
#--------------------------------------------------

def addFixedText( self, cCtrlName, nPositionX, nPositionY, nWidth, nHeight,
cLabel=None ):
"""Add a FixedText control to the window."""
oControlModel = createUnoService( "com.sun.star.awt.UnoControlFixedTextModel" )
oControl = createUnoService( oControlModel.DefaultControl ) # Create a control and its model.
oControl.setModel( oControlModel ) # Introduce the model to the control.
oControl.createPeer( getAwtToolkit(), self.getWindow() ) # Make the control create its window peer.
# Keep a dictionary of controls we are managing in the window.
self.controls[ cCtrlName ] = oControl
# Set position and size
self.setPosSize( cCtrlName, nPositionX, nPositionY, nWidth, nHeight )

if cLabel != None:
oControlModel.Label = cLabel

def getFixedTextText( self, cCtrlName ):
"""Get the text of the control."""
oControl = self.getControl( cCtrlName )
return oControl.getText();

def setFixedTextText( self, cCtrlName, cText ):
"""Set the text of the control."""
oControl = self.getControl( cCtrlName )
oControl.setText( cText )

def getFixedTextAlignment( self, cCtrlName ):
"""Get the alignment of the control. 0:left, 1:center, 2:right"""
oControl = self.getControl( cCtrlName )
return oControl.getAlignment();

def setFixedTextAlignment( self, cCtrlName, nAlignment ):
"""Set the alignment of the control. 0:left, 1:center, 2:right"""
oControl = self.getControl( cCtrlName )
oControl.setAlignment( nAlignment )

#--------------------------------------------------
# com.sun.star.awt.UnoControlImageControl
#--------------------------------------------------

def addImageControl( self, cCtrlName, nPositionX, nPositionY, nWidth, nHeight,
nBorder=1 ):
"""Add an ImageControl control to the window.
nBorder = 0:none, 1:3D border, 2:simple border"""
oControlModel = createUnoService( "com.sun.star.awt.UnoControlImageControlModel" )
oControlModel.Border = nBorder
oControl = createUnoService( oControlModel.DefaultControl ) # Create a control and its model.
oControl.setModel( oControlModel ) # Introduce the model to the control.
oControl.createPeer( getAwtToolkit(), self.getWindow() ) # Make the control create its window peer.
# Keep a dictionary of controls we are managing in the window.
self.controls[ cCtrlName ] = oControl
# Set position and size
self.setPosSize( cCtrlName, nPositionX, nPositionY, nWidth, nHeight )

def getImageControlImageURL( self, cCtrlName ):
"""Get the ImageURL of the control."""
self.getControlModelProperty( cCtrlName, "ImageURL" )

def setImageControlImageURL( self, cCtrlName, cImageURL ):
"""Get the ImageURL of the control."""
self.setControlModelProperty( cCtrlName, "ImageURL", cImageURL )

#--------------------------------------------------
# com.sun.star.awt.UnoControlListBox
#--------------------------------------------------

def addListBox( self, cCtrlName, nPositionX, nPositionY, nWidth, nHeight,
bDropdown=False,
itemListenerProc=None,
actionListenerProc=None ):
"""Add a ComboBox control to the window."""
oControlModel = createUnoService( "com.sun.star.awt.UnoControlListBoxModel" )
oControlModel.Dropdown = bDropdown
oControl = createUnoService( oControlModel.DefaultControl ) # Create a control and its model.
oControl.setModel( oControlModel ) # Introduce the model to the control.
oControl.createPeer( getAwtToolkit(), self.getWindow() ) # Make the control create its window peer.
# Keep a dictionary of controls we are managing in the window.
self.controls[ cCtrlName ] = oControl
# Set position and size
self.setPosSize( cCtrlName, nPositionX, nPositionY, nWidth, nHeight )

if itemListenerProc != None:
self.addItemListenerProc( cCtrlName, itemListenerProc )
if actionListenerProc != None:
self.addActionListenerProc( cCtrlName, actionListenerProc )

def addListBoxItem( self, cCtrlName, cItemText, nPosition=-1 ):
"""Add an item to the ListBox at specified position."""
oControl = self.getControl( cCtrlName )
if nPosition == -1: nPosition = self.getComboBoxItemCount( cCtrlName )
oControl.addItem( cItemText, nPosition )

def addListBoxItems( self, cCtrlName, tcItemTexts, nPosition=0 ):
"""Add a tupple of items to the ListBox at specified position."""
oControl = self.getControl( cCtrlName )
oControl.addItems( tcItemTexts, nPosition )

def removeListBoxItems( self, cCtrlName, nPosition, nCount=1 ):
"""Remove items from a ListBox."""
oControl = self.getControl( cCtrlName )
oControl.removeItems( nPosition, nCount )

def getListBoxItemCount( self, cCtrlName ):
"""Get the number of items in a ListBox."""
oControl = self.getControl( cCtrlName )
return oControl.getItemCount()

def getListBoxItem( self, cCtrlName, nPosition ):
"""Return the item at specified position within the ListBox."""
oControl = self.getControl( cCtrlName )
return oControl.getItem( nPosition )

def getListBoxItems( self, cCtrlName ):
"""Return a tupple of all items in the ListBox."""
oControl = self.getControl( cCtrlName )
return oControl.getItems()

def getListBoxSelectedItemPos( self, cCtrlName ):
"""Returns the position of the currently selected item."""
oControl = self.getControl( cCtrlName )
return oControl.getSelectedItemPos()

def getListBoxSelectedItemsPos( self, cCtrlName ):
"""Returns the positions of all currently selected items."""
oControl = self.getControl( cCtrlName )
return oControl.getSelectedItemsPos()

def getListBoxSelectedItem( self, cCtrlName ):
"""Returns the currently selected item."""
oControl = self.getControl( cCtrlName )
return oControl.getSelectedItem()

def getListBoxSelectedItems( self, cCtrlName ):
"""Returns all currently selected items."""
oControl = self.getControl( cCtrlName )
return oControl.getSelectedItems()

def selectListBoxItemPos( self, cCtrlName, nItemPos, bSelect=True ):
"""Select/Deselect the item at the specified position."""
oControl = self.getControl( cCtrlName )
return oControl.selectItemPos( nItemPos, bSelect )

def selectListBoxItemsPos( self, cCtrlName, tnItemPos, bSelect=True ):
"""Selects/Deselects the items at the specified positions."""
oControl = self.getControl( cCtrlName )
return oControl.selectItemsPos( tnItemPos, bSelect )

def selectListBoxItem( self, cCtrlName, cItemText, bSelect=True ):
"""Selects/Deselects the ispecified item."""
oControl = self.getControl( cCtrlName )
return oControl.selectItem( cItemText, bSelect )

def isListBoxMultipleMode( self, cCtrlName ):
"""Selects/Deselects the ispecified item."""
oControl = self.getControl( cCtrlName )
return oControl.isMutipleMode()

def setListBoxMultipleMode( self, cCtrlName, bMultipleMode ):
"""Selects/Deselects the ispecified item."""
oControl = self.getControl( cCtrlName )
return oControl.setMutipleMode( bMultipleMode )

def getListBoxDropDownLineCount( self, cCtrlName ):
"""Returns the number of visible lines in the drop down mode."""
oControl = self.getControl( cCtrlName )
return oControl.getDropDownLineCount()

def setListBoxDropDownLineCount( self, cCtrlName, nNumLines ):
"""Sets the number of visible lines in the drop down mode."""
oControl = self.getControl( cCtrlName )
oControl.setDropDownLineCount( nNumLines )

def makeListBoxItemVisible( self, nItemPos ):
"""Makes the item at the specified position visible by scrolling the list box."""
oControl = self.getControl( cCtrlName )
oControl.makeVisible( nItemPos )

#--------------------------------------------------
# Access controls and control models
#--------------------------------------------------

def getControl( self, cCtrlName ):
"""Get the control (not its model) for a particular control name.
The control returned includes the service com.sun.star.awt.UnoControl,
and another control-specific service which inherits from it.
"""
oControl = self.controls[ cCtrlName ]
return oControl

def getControlModel( self, cCtrlName ):
"""Get the control model (not the control) for a particular control name.
The model returned includes the service UnoControlModel,
and another control-specific service which inherits from it.
"""
oControl = self.getControl( cCtrlName )
oControlModel = oControl.getModel()
return oControlModel

#--------------------------------------------------
# Adjust properties of control models
#--------------------------------------------------

def setControlModelProperty( self, cCtrlName, cPropertyName, uValue ):
"""Set the value of a property of a control's model.
This affects the control model, not the control.
"""
oControlModel = self.getControlModel( cCtrlName )
oControlModel.setPropertyValue( cPropertyName, uValue )

def getControlModelProperty( self, cCtrlName, cPropertyName ):
"""Get the value of a property of a control's model.
This affects the control model, not the control.
"""
oControlModel = self.getControlModel( cCtrlName )
return oControlModel.getPropertyValue( cPropertyName )

#--------------------------------------------------
# Adjust controls (not models)
#--------------------------------------------------

# The following apply to all controls which are a
# com.sun.star.awt.UnoControl
# (which means all controls)

def setDesignMode( self, cCtrlName, bDesignMode=True ):
oControl = self.getControl( cCtrlName )
oControl.setDesignMode( bDesignMode )

def isDesignMode( self, cCtrlName, bDesignMode=True ):
oControl = self.getControl( cCtrlName )
return oControl.isDesignMode()

def isTransparent( self, cCtrlName, bDesignMode=True ):
oControl = self.getControl( cCtrlName )
return oControl.isTransparent()

def setPosSize( self, cCtrlName, nPositionX, nPositionY, nWidth, nHeight ):
"""Set the position and size of the window."""
oControl = self.getControl( cCtrlName )
# if negative coordinates are given for X or Y position,
# then make that coordinate be relative to the right/bottom
# edge of the window instead of to the left/top.
if nPositionX < 0 or nPositionY < 0:
oWindowPosSizeRect = self.getWindowPosSize()
if nPositionX < 0: nPositionX = oWindowPosSizeRect.Width + nPositionX - nWidth
if nPositionY < 0: nPositionY = oWindowPosSizeRect.Height + nPositionY - nHeight
oControl.setPosSize( nPositionX, nPositionY, nWidth, nHeight,
uno.getConstantByName( "com.sun.star.awt.PosSize.POSSIZE" ) )
def setPosition( self, cCtrlName, nPositionX, nPositionY ):
"""Set the position of the window."""
oControl = self.getControl( cCtrlName )
# if negative coordinates are given for X or Y position,
# then make that coordinate be relative to the right/bottom
# edge of the window instead of to the left/top.
if nPositionX < 0 or nPositionY < 0:
oCtrlPosSizeRect = oControl.getPosSize()
oWindowPosSizeRect = self.getWindowPosSize()
if nPositionX < 0: nPositionX = oWindowPosSizeRect.Width + nPositionX - oCtrlPosSizeRect.Width
if nPositionY < 0: nPositionY = oWindowPosSizeRect.Height + nPositionY - oCtrlPosSizeRect.Height
oControl.setPosSize( nPositionX, nPositionY, 0, 0,
uno.getConstantByName( "com.sun.star.awt.PosSize.POS" ) )
def setSize( self, cCtrlName, nWidth, nHeight ):
"""Set the position and size of the window."""
oControl = self.getControl( cCtrlName )
oControl.setPosSize( 0, 0, nWidth, nHeight,
uno.getConstantByName( "com.sun.star.awt.PosSize.SIZE" ) )
def getPosSize( self, cCtrlName ):
"""Returns a com.sun.star.awt.Rectangle that contains the position and size of this window."""
oControl = self.getControl( cCtrlName )
return oControl.getPosSize()

def setVisible( self, cCtrlName, bVisible ):
"""Show or hide the control."""
oControl = self.getControl( cCtrlName )
oControl.setVisible( bVisible )

def setEnable( self, cCtrlName, bEnable ):
"""Enable or disable the control."""
oControl = self.getControl( cCtrlName )
oControl.setEnable( bEnable )

def setFocus( self, cCtrlName ):
"""Set focus to the control."""
oControl = self.getControl( cCtrlName )
oControl.setFocus()

#--------------------------------------------------
# Add listeners to controls.
#--------------------------------------------------

# This applies to...
# UnoControlButton
# UnoControlComboBox
def addActionListenerProc( self, cCtrlName, actionListenerProc ):
"""Create an com.sun.star.awt.XActionListener object and add it to a control.
A listener object is created which will call the python procedure actionListenerProc.
The actionListenerProc can be either a method or a global procedure.
The following controls support XActionListener:
UnoControlButton
"""
oControl = self.getControl( cCtrlName )
oActionListener = ActionListenerProcAdapter( actionListenerProc )
oControl.addActionListener( oActionListener )

# This applies to...
# UnoControlCheckBox
# UnoControlComboBox
def addItemListenerProc( self, cCtrlName, itemListenerProc ):
"""Create an com.sun.star.awt.XItemListener object and add it to a control.
A listener object is created which will call the python procedure itemListenerProc.
The itemListenerProc can be either a method or a global procedure.
The following controls support XActionListener:
UnoControlCheckBox
"""
oControl = self.getControl( cCtrlName )
oActionListener = ItemListenerProcAdapter( itemListenerProc )
oControl.addItemListener( oActionListener )

# This applies to...
# UnoControlEdit
def addTextListenerProc( self, cCtrlName, textListenerProc ):
"""Create an com.sun.star.awt.XTextListener object and add it to a control.
A listener object is created which will call the python procedure textListenerProc.
The textListenerProc can be either a method or a global procedure.
The following controls support XTextListener:
UnoControlEdit
"""
oControl = self.getControl( cCtrlName )
oTextListener = TextListenerProcAdapter( textListenerProc )
oControl.addTextListener( oTextListener )

from com.sun.star.awt import XTopWindowListener
from com.sun.star.awt import XWindowListener
from com.sun.star.awt import XFocusListener
from com.sun.star.awt import XKeyListener
from com.sun.star.awt import XMouseListener
from com.sun.star.awt import XPaintListener
from com.sun.star.lang import XEventListener
class DBListenerWindow( DBWindow, unohelper.Base,
XKeyListener, XMouseListener, XPaintListener,
XFocusListener, XWindowListener, XTopWindowListener,
XEventListener ):
"""This is like a DBWindow, but has useful listener methods implemented directly in this class.
You can easily subclass this class, and override the various listener methods from the interfaces implemented by this class.
"""
def __init__( self, cTitle=None, tBoundsRect=None, nWindowAttributes=None ):
DBWindow.__init__( self,
cTitle=cTitle,
tBoundsRect=tBoundsRect,
nWindowAttributes=nWindowAttributes )

# Since this class implements the XTopWindowListener interface,
# add ourself as a listener to our own window.
self.oWindow.addTopWindowListener( self )

# Since this class implements the XWindowListener interface,
# add ourself as a listener to our own window.
self.oWindow.addWindowListener( self )

# Since this class implements the XFocusListener interface,
# add ourself as a listener to our own window.
self.oWindow.addFocusListener( self )

# Since this class implements the XKeyListener interface,
# add ourself as a listener to our own window.
self.oWindow.addKeyListener( self )

# Since this class implements the XMouseListener interface,
# add ourself as a listener to our own window.
self.oWindow.addMouseListener( self )

# Since this class implements the XPaintListener interface,
# add ourself as a listener to our own window.
self.oWindow.addPaintListener( self )

#--------------------------------------------------
# Interface: XTopWindowListener
#
# This interface is implemented so that your subclass
# can conveniently override these methods!
#
# Note that com.sun.star.lang.EventObject has the following members:
# Source which is a com.sun.star.uno.XInterface
# refers to the object that fired the event.
#--------------------------------------------------

# [oneway] void
# windowOpened( [in] com.sun.star.lang.EventObject tEvent );
def windowOpened( self, tEvent ):
"""is invoked when a window has been opened."""
pass

# [oneway] void
# windowClosing( [in] com.sun.star.lang.EventObject tEvent );
def windowClosing( self, tEvent ):
"""is invoked when a window is in the process of being closed.
The close operation can be overridden at this point."""
self.getWindow().dispose()

# [oneway] void
# windowClosed( [in] com.sun.star.lang.EventObject tEvent );
def windowClosed( self, tEvent ):
"""is invoked when a window has been closed."""
pass

# [oneway] void
# windowMinimized( [in] com.sun.star.lang.EventObject tEvent );
def windowMinimized( self, tEvent ):
"""is invoked when a window is iconified."""
pass

# [oneway] void
# windowNormalized( [in] com.sun.star.lang.EventObject tEvent );
def windowNormalized( self, tEvent ):
"""is invoked when a window is de-iconified."""
pass

# [oneway] void
# windowActivated( [in] com.sun.star.lang.EventObject tEvent );
def windowActivated( self, tEvent ):
"""is invoked when a window is activated."""
pass

# [oneway] void
# windowDeactivated( [in] com.sun.star.lang.EventObject tEvent );
def windowDeactivated( self, tEvent ):
"""is invoked when a window is de-activated."""
pass

#--------------------------------------------------
# Interface: XWindowListener
#
# This interface is implemented so that your subclass
# can conveniently override these methods!
#
# Note that com.sun.star.awt.WindowEvent has the following members:
# long X long Y
# long Width long Height
# long LeftInset long TopInset long RightInset long BottomInset
#--------------------------------------------------

# void
# windowResized( [in] WindowEvent tEvent );
def windowResized( self, tEvent ):
"""is invoked when the window has been resized."""
pass

# void
# windowMoved( [in] WindowEvent tEvent );
def windowMoved( self, tEvent ):
"""is invoked when the window has been moved."""
pass

# void
# windowShown( [in] EventObject tEvent );
def windowShown( self, tEvent ):
"""is invoked when the window has been shown."""
# please note the type of parameter is described
# above in the comment for XTopWindowListener.
pass

# void
# windowHidden( [in] EventObject tEvent );
def windowHidden( self, tEvent ):
"""is invoked when the window has been hidden."""
# please note the type of parameter is described
# above in the comment for XTopWindowListener.
pass

#--------------------------------------------------
# Interface: XFocusListener
#
# This interface is implemented so that your subclass
# can conveniently override these methods!
#
# Note that com.sun.star.awt.FocusEvent has the following members:
# short FocusFlags
# com.sun.star.uno.XInterface NextFocus
# boolean Temporary
#--------------------------------------------------

# [oneway] void
# focusGained( [in] FocusEvent tEvent );
def focusGained( self, tEvent ):
""" is invoked when a window gains the keyboard focus."""
pass

# [oneway] void
# focusLost( [in] FocusEvent tEvent );
def focusLost( self, tEvent ):
""" is invoked when a window loses the keyboard focus."""
pass

#--------------------------------------------------
# Interface: XKeyListener
#
# This interface is implemented so that your subclass
# can conveniently override these methods!
#
# Note that com.sun.star.awt.KeyEvent has the following members:
# short KeyCode (constant from com.sun.star.awt.Key)
# char KeyChar
# short KeyFunc (constant from com.sun.star.awt.KeyFunction)
#--------------------------------------------------

# [oneway] void
# keyPressed( [in] com.sun.star.awt.KeyEvent tEvent );
def keyPressed( self, tEvent ):
""" is invoked when a key has been pressed."""
pass

# [oneway] void
# keyReleased( [in] com.sun.star.awt.KeyEvent tEvent );
def keyReleased( self, tEvent ):
""" is invoked when a key has been released."""
pass

#--------------------------------------------------
# Interface: XMouseListener
#
# This interface is implemented so that your subclass
# can conveniently override these methods!
#
# Note that com.sun.star.awt.MouseEvent has the following members:
# short Buttons (constant from com.sun.star.awt.MouseButton)
# short X short Y
# long ClickCount
# boolean PupupTrigger
#--------------------------------------------------

# [oneway] void
# mousePressed( [in] com.sun.star.awt.MouseEvent tEvent );
def mousePressed( self, tEvent ):
"""is invoked when a mouse button has been pressed on a window."""
pass

# [oneway] void
# mouseReleased( [in] com.sun.star.awt.MouseEvent tEvent );
def mouseReleased( self, tEvent ):
"""is invoked when a mouse button has been released on a window."""
pass

# [oneway] void
# mouseEntered( [in] com.sun.star.awt.MouseEvent tEvent );
def mouseEntered( self, tEvent ):
"""is invoked when the mouse enters a window."""
pass

# [oneway] void
# mouseExited( [in] com.sun.star.awt.MouseEvent tEvent );
def mouseExited( self, tEvent ):
"""is invoked when the mouse exits a window."""
pass

#--------------------------------------------------
# Interface: XPaintListener
#
# This interface is implemented so that your subclass
# can conveniently override these methods!
#
# Note that com.sun.star.awt.PaintEvent has the following members:
# com.sun.star.awt.Rectangle UpdateRect
# short Count
#--------------------------------------------------

# [oneway] void
# windowPaint( [in] PaintEvent tEvent );
def windowPaint( self, tEvent ):
""" is invoked when a region of the window became invalid, e.g. when another window has been moved away."""
pass

#--------------------------------------------------
# Interface: XEventListener
#
# This interface is implemented so that your subclass
# can conveniently override these methods!
#
# Note that com.sun.star.lang.EventObject has the following members:
# Source which is a com.sun.star.uno.XInterface
# refers to the object that fired the event.
#--------------------------------------------------

# void
# disposing( [in] com.sun.star.lang.EventObject tEvent );
def disposing( self, tEvent ):
"""gets called when the broadcaster is about to be disposed."""
pass

# import Danny.OOo.WindowLib
# reload( Danny.OOo.WindowLib ); from Danny.OOo.WindowLib import *
</source>

[[Category:Extensions]]
[[Category:Python]]
[[Category:Uno]]

Danny.OOo.Listeners.ListenerProcAdapters.py

2015-02-17T20:00:45Z

JZA: Adding categories

This module has various helpers that make it extremely easy to create listeners on the fly, and make them call an arbitrary python procedure.
<source lang=python>
#**********************************************************************
#
# Danny.OOo.Listeners.ListenerProcAdapters.py
#
# A module to easily work with OpenOffice.org.
#
#**********************************************************************
# Copyright (c) 2003-2004 Danny Brewer
# d29583@groovegarden.com
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# See: http://www.gnu.org/licenses/lgpl.html
#
#**********************************************************************
# If you make changes, please append to the change log below.
#
# Change Log
# Danny Brewer Revised 2004-06-05-01
#
#**********************************************************************

# OOo's libraries
import uno
import unohelper

#--------------------------------------------------
# An ActionListener adapter.
# This object implements com.sun.star.awt.XActionListener.
# When actionPerformed is called, this will call an arbitrary
# python procedure, passing it...
# 1. the oActionEvent
# 2. any other parameters you specified to this object's constructor (as a tuple).
from com.sun.star.awt import XActionListener
class ActionListenerProcAdapter( unohelper.Base, XActionListener ):
def __init__( self, oProcToCall, tParams=() ):
self.oProcToCall = oProcToCall # a python procedure
self.tParams = tParams # a tuple

# oActionEvent is a com.sun.star.awt.ActionEvent struct.
def actionPerformed( self, oActionEvent ):
if callable( self.oProcToCall ):
apply( self.oProcToCall, (oActionEvent,) + self.tParams )

#--------------------------------------------------
# An ItemListener adapter.
# This object implements com.sun.star.awt.XItemListener.
# When itemStateChanged is called, this will call an arbitrary
# python procedure, passing it...
# 1. the oItemEvent
# 2. any other parameters you specified to this object's constructor (as a tuple).
from com.sun.star.awt import XItemListener
class ItemListenerProcAdapter( unohelper.Base, XItemListener ):
def __init__( self, oProcToCall, tParams=() ):
self.oProcToCall = oProcToCall # a python procedure
self.tParams = tParams # a tuple

# oItemEvent is a com.sun.star.awt.ItemEvent struct.
def itemStateChanged( self, oItemEvent ):
if callable( self.oProcToCall ):
apply( self.oProcToCall, (oItemEvent,) + self.tParams )

#--------------------------------------------------
# An TextListener adapter.
# This object implements com.sun.star.awt.XTextistener.
# When textChanged is called, this will call an arbitrary
# python procedure, passing it...
# 1. the oTextEvent
# 2. any other parameters you specified to this object's constructor (as a tuple).
from com.sun.star.awt import XTextListener
class TextListenerProcAdapter( unohelper.Base, XTextListener ):
def __init__( self, oProcToCall, tParams=() ):
self.oProcToCall = oProcToCall # a python procedure
self.tParams = tParams # a tuple

# oTextEvent is a com.sun.star.awt.TextEvent struct.
def textChanged( self, oTextEvent ):
if callable( self.oProcToCall ):
apply( self.oProcToCall, (oTextEvent,) + self.tParams )
<source>
[[Category:Extensions]]
[[Category:Python]]
[[Category:Uno]]

Danny.OOo.Listeners.TopWindowListener.py

2015-02-17T20:00:31Z

JZA: Adding categories

This is similar in purpose to the Danny.OOo.Listeners.ListenerProcAdapters.py module.

This one is NOT an adapter however. It is a class that you subclass. Your subclass does not need to implement every possible listener method, because you inherit the empty implementations from this class. So when you need to add a window listener to a TopWindow, this class comes in very handy.

<source lang=python>
#**********************************************************************
#
# Danny.OOo.Listeners.TopWindowListener.py
#
# A module to easily work with OpenOffice.org.
#
#**********************************************************************
# Copyright (c) 2003-2004 Danny Brewer
# d29583@groovegarden.com
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# See: http://www.gnu.org/licenses/lgpl.html
#
#**********************************************************************
# If you make changes, please append to the change log below.
#
# Change Log
# Danny Brewer Revised 2004-06-05-01
#
#**********************************************************************

# OOo's libraries
import uno
import unohelper

from com.sun.star.awt import XTopWindowListener

class TopWindowListener( XTopWindowListener ):
"""An empty implementation of com.sun.star.awt.XTopWindowListener.
It is useful for you to be able to subclass from this.
"""
# NOTE:
# If you subclass from this, you must either:
# 1. also subclass from unohelper.Base.
# 2. or otherwise implement com.sun.star.lang.XTypeProvider.

#----------------------------------------
# Interface: XTopWindowListener
#
# This interface is implemented so that your subclass
# can conveniently override these methods!
#
# Note that com.sun.star.lang.EventObject has the following members:
# Source which is a com.sun.star.uno.XInterface
# refers to the object that fired the event.
#----------------------------------------

# [oneway] void
# windowOpened( [in] com.sun.star.lang.EventObject tEvent );
def windowOpened( self, tEvent ):
"""is invoked when a window has been opened."""
pass

# [oneway] void
# windowClosing( [in] com.sun.star.lang.EventObject tEvent );
def windowClosing( self, tEvent ):
"""is invoked when a window is in the process of being closed.
The close operation can be overridden at this point."""
pass

# [oneway] void
# windowClosed( [in] com.sun.star.lang.EventObject tEvent );
def windowClosed( self, tEvent ):
"""is invoked when a window has been closed."""
pass

# [oneway] void
# windowMinimized( [in] com.sun.star.lang.EventObject tEvent );
def windowMinimized( self, tEvent ):
"""is invoked when a window is iconified."""
pass

# [oneway] void
# windowNormalized( [in] com.sun.star.lang.EventObject tEvent );
def windowNormalized( self, tEvent ):
"""is invoked when a window is de-iconified."""
pass

# [oneway] void
# windowActivated( [in] com.sun.star.lang.EventObject tEvent );
def windowActivated( self, tEvent ):
"""is invoked when a window is activated."""
pass

# [oneway] void
# windowDeactivated( [in] com.sun.star.lang.EventObject tEvent );
def windowDeactivated( self, tEvent ):
"""is invoked when a window is de-activated."""
pass
</source>
[[Category:Extensions]]
[[Category:Python]]
[[Category:Uno]]

Danny.HeapSort

2015-02-17T20:00:19Z

JZA: Adding categories

Here is my HeapSort module. This is NOT an OOo related module, but I am posting it because someone asked.....

<source lang=python>
#**********************************************************************
#
# Danny.HeapSort.py
#
#**********************************************************************
# Copyright (c) 2005 Danny Brewer
# d29583@groovegarden.com
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# See: http://www.gnu.org/licenses/lgpl.html
#
#**********************************************************************
# If you make changes, please append to the change log below.
#
# Change Log
# Danny Brewer Revised 2005-03-29
#
#**********************************************************************

def SwapItems( items, nIndex1, nIndex2 ):
"""Swap two items in the sequence. Return a new sequence with the swap.
nIndex1 and nIndex2 are zero based."""
item1 = items[nIndex1]
item2 = items[nIndex2]
items[nIndex1] = item2
items[nIndex2] = item1
return items

def ItemsCompareGreater( items, nIndex1, nIndex2 ):
"""Return True if the item at nIndex1 is greater than the item at nIndex2.
nIndex1 and nIndex2 are zero based."""
return items[nIndex1] > items[nIndex2]

def HeapSort( items,
compareGreaterProc=ItemsCompareGreater,
swapProc=SwapItems ):
MakeHeap( items, compareGreaterProc, swapProc )
nNumItems = len( items )
for i in range( nNumItems-1, -1, -1 ):
swapProc( items, 0, i )
SiftHeap( items, i, 0, compareGreaterProc, swapProc )
return items

def MakeHeap( items,
compareGreaterProc=ItemsCompareGreater,
swapProc=SwapItems ):
nNumItems = len( items )
for i in range( nNumItems-1, -1, -1 ):
SiftHeap( items, nNumItems, i, compareGreaterProc, swapProc )

def SiftHeap( items, nHeapSize, nTheNode,
compareGreaterProc=ItemsCompareGreater,
swapProc=SwapItems ):
nLargestNode = nTheNode
while True:
bNeedSwap = False
nParentNode = nLargestNode

nChildNode = nParentNode+nParentNode+1 # left child
if( nChildNode < nHeapSize and compareGreaterProc( items, nChildNode, nLargestNode ) ):
nLargestNode = nChildNode
bNeedSwap = True

nChildNode = nChildNode + 1 # right child
if( nChildNode < nHeapSize and compareGreaterProc( items, nChildNode, nLargestNode ) ):
nLargestNode = nChildNode
bNeedSwap = True

if bNeedSwap:
swapProc( items, nParentNode, nLargestNode )
else:
break
</source>
[[Category:Extensions]]
[[Category:Python]]
[[Category:Uno]]

Danny.OOo.DialogLib.py

2015-02-17T19:59:54Z

JZA: Adding categories

A class to build a dialog box from the com.sun.star.awt.* services. This doesn't do anything you couldn't already do using OOo's UNO API, this just makes it much easier.

You can change the dialog box size, position, title, etc. You can add controls, and listeners for those controls to the dialog box. This class can be used by subclassing it, or without subclassing it.

This module depends upon Danny.OOo.Listeners.ListenerProcAdapters.py found elsewhere in this thread.

<source lang=python>
#**********************************************************************
#
# Danny.OOo.DialogLib.py
#
# A module to easily work with OpenOffice.org.
#
#**********************************************************************
# Copyright (c) 2003-2004 Danny Brewer
# d29583@groovegarden.com
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# See: http://www.gnu.org/licenses/lgpl.html
#
#**********************************************************************
# If you make changes, please append to the change log below.
#
# Change Log
# Danny Brewer Revised 2004-06-05-01
#
#**********************************************************************

# OOo's libraries
import uno
import unohelper

# Danny's libraries
from Danny.OOo.OOoLib import createUnoService, createUnoStruct
from Danny.OOo.Listeners.ListenerProcAdapters import *
#from Danny.OOo.Listeners.TopWindowListener import TopWindowListener

# The global Awt Toolkit.
# This is initialized the first time it is needed.
#goAwtToolkit = createUnoService( "com.sun.star.awt.Toolkit" )
goAwtToolkit = None
#
def getAwtToolkit():
global goAwtToolkit
if goAwtToolkit == None:
goAwtToolkit = createUnoService( "com.sun.star.awt.Toolkit" )
return goAwtToolkit

# This class builds dialog boxes.
# This can be used in two different ways...
# 1. by subclassing it (elegant)
# 2. without subclassing it (less elegant)
class DBModalDialog:
"""Class to build a dialog box from the com.sun.star.awt.* services.
This doesn't do anything you couldn't already do using OOo's UNO API,
this just makes it much easier.
You can change the dialog box size, position, title, etc.
You can add controls, and listeners for those controls to the dialog box.
This class can be used by subclassing it, or without subclassing it.
"""
def __init__( self, nPositionX=None, nPositionY=None, nWidth=None, nHeight=None, cTitle=None ):
self.oDialogModel = createUnoService( "com.sun.star.awt.UnoControlDialogModel" )
if nPositionX != None: self.oDialogModel.PositionX = nPositionX
if nPositionY != None: self.oDialogModel.PositionY = nPositionY
if nWidth != None: self.oDialogModel.Width = nWidth
if nHeight != None: self.oDialogModel.Height = nHeight
if cTitle != None: self.oDialogModel.Title = cTitle
self.oDialogControl = createUnoService( "com.sun.star.awt.UnoControlDialog" )
self.oDialogControl.setModel( self.oDialogModel )

def release( self ):
"""Release resources.
After calling this, you can no longer use this object.
"""
self.oDialogControl.dispose()

#--------------------------------------------------
# Dialog box adjustments
#--------------------------------------------------

def setDialogPosition( self, nX, nY ):
self.oDialogModel.PositionX = nX
self.oDialogModel.PositionY = nY

def setDialogSize( self, nWidth, nHeight ):
self.oDialogModel.Width = nWidth
self.oDialogModel.Height = nHeight

def setDialogTitle( self, cCaption ):
self.oDialogModel.Title = cCaption

def setVisible( self, bVisible ):
self.oDialogControl.setVisible( bVisible )

#--------------------------------------------------
# com.sun.star.awt.UnoControlButton
#--------------------------------------------------

# After you add a Button control, you can call self.setControlModelProperty()
# passing any of the properties for a...
# com.sun.star.awt.UnoControlButtonModel
# com.sun.star.awt.UnoControlDialogElement
# com.sun.star.awt.UnoControlModel
def addButton( self, cCtrlName, nPositionX, nPositionY, nWidth, nHeight,
cLabel=None,
actionListenerProc=None,
nTabIndex=None ):
self.addControl( "com.sun.star.awt.UnoControlButtonModel",
cCtrlName, nPositionX, nPositionY, nWidth, nHeight,
cLabel=cLabel,
nTabIndex=nTabIndex )
if actionListenerProc != None:
self.addActionListenerProc( cCtrlName, actionListenerProc )

def setButtonLabel( self, cCtrlName, cLabel ):
"""Set the label of the control."""
oControl = self.getControl( cCtrlName )
oControl.setLabel( cLabel )

#--------------------------------------------------
# com.sun.star.awt.UnoControlCheckBox
#--------------------------------------------------

# After you add a CheckBox control, you can call self.setControlModelProperty()
# passing any of the properties for a...
# com.sun.star.awt.UnoControlCheckBoxModel
# com.sun.star.awt.UnoControlDialogElement
# com.sun.star.awt.UnoControlModel
def addCheckBox( self, cCtrlName, nPositionX, nPositionY, nWidth, nHeight,
cLabel=None,
itemListenerProc=None,
nTabIndex=None ):
self.addControl( "com.sun.star.awt.UnoControlCheckBoxModel",
cCtrlName, nPositionX, nPositionY, nWidth, nHeight,
cLabel=cLabel,
nTabIndex=nTabIndex )
if itemListenerProc != None:
self.addItemListenerProc( cCtrlName, itemListenerProc )

def setCheckBoxLabel( self, cCtrlName, cLabel ):
"""Set the label of the control."""
oControl = self.getControl( cCtrlName )
oControl.setLabel( cLabel )

def getCheckBoxState( self, cCtrlName ):
"""Get the state of the control."""
oControl = self.getControl( cCtrlName )
return oControl.getState();

def setCheckBoxState( self, cCtrlName, nState ):
"""Set the state of the control."""
oControl = self.getControl( cCtrlName )
oControl.setState( nState )

def enableCheckBoxTriState( self, cCtrlName, bTriStateEnable ):
"""Enable or disable the tri state mode of the control."""
oControl = self.getControl( cCtrlName )
oControl.enableTriState( bTriStateEnable )

#--------------------------------------------------
# com.sun.star.awt.UnoControlFixedText
#--------------------------------------------------

def addFixedText( self, cCtrlName, nPositionX, nPositionY, nWidth, nHeight,
cLabel=None ):
self.addControl( "com.sun.star.awt.UnoControlFixedTextModel",
cCtrlName, nPositionX, nPositionY, nWidth, nHeight,
cLabel=cLabel )

#--------------------------------------------------
# Add Controls to dialog
#--------------------------------------------------

def addControl( self, cCtrlServiceName,
cCtrlName, nPositionX, nPositionY, nWidth, nHeight,
cLabel=None,
nTabIndex=None ):
oControlModel = self.oDialogModel.createInstance( cCtrlServiceName )
self.oDialogModel.insertByName( cCtrlName, oControlModel )

# if negative coordinates are given for X or Y position,
# then make that coordinate be relative to the right/bottom
# edge of the dialog box instead of to the left/top.
if nPositionX < 0: nPositionX = self.oDialogModel.Width + nPositionX - nWidth
if nPositionY < 0: nPositionY = self.oDialogModel.Height + nPositionY - nHeight
oControlModel.PositionX = nPositionX
oControlModel.PositionY = nPositionY
oControlModel.Width = nWidth
oControlModel.Height = nHeight
oControlModel.Name = cCtrlName

if cLabel != None:
oControlModel.Label = cLabel

if nTabIndex != None:
oControlModel.TabIndex = nTabIndex

#--------------------------------------------------
# Access controls and control models
#--------------------------------------------------

def getControl( self, cCtrlName ):
"""Get the control (not its model) for a particular control name.
The control returned includes the service com.sun.star.awt.UnoControl,
and another control-specific service which inherits from it.
"""
oControl = self.oDialogControl.getControl( cCtrlName )
return oControl

def getControlModel( self, cCtrlName ):
"""Get the control model (not the control) for a particular control name.
The model returned includes the service UnoControlModel,
and another control-specific service which inherits from it.
"""
oControl = self.getControl( cCtrlName )
oControlModel = oControl.getModel()
return oControlModel

#--------------------------------------------------
# Adjust properties of control models
#--------------------------------------------------

def setControlModelProperty( self, cCtrlName, cPropertyName, uValue ):
"""Set the value of a property of a control's model.
This affects the control model, not the control.
"""
oControlModel = self.getControlModel( cCtrlName )
oControlModel.setPropertyValue( cPropertyName, uValue )

def getControlModelProperty( self, cCtrlName, cPropertyName ):
"""Get the value of a property of a control's model.
This affects the control model, not the control.
"""
oControlModel = self.getControlModel( cCtrlName )
return oControlModel.getPropertyValue( cPropertyName )

#--------------------------------------------------
# Sugar coated property adjustments to control models.
#--------------------------------------------------

def setEnabled( self, cCtrlName, bEnabled=True ):
"""Supported controls...
UnoControlButtonModel
UnoControlCheckBoxModel
"""
self.setControlModelProperty( cCtrlName, "Enabled", bEnabled )

def getEnabled( self, cCtrlName ):
"""Supported controls...
UnoControlButtonModel
UnoControlCheckBoxModel
"""
return self.getControlModelProperty( cCtrlName, "Enabled" )

def setState( self, cCtrlName, nState ):
"""Supported controls...
UnoControlButtonModel
UnoControlCheckBoxModel
"""
self.setControlModelProperty( cCtrlName, "State", nState )

def getState( self, cCtrlName ):
"""Supported controls...
UnoControlButtonModel
UnoControlCheckBoxModel
"""
return self.getControlModelProperty( cCtrlName, "State" )

def setLabel( self, cCtrlName, cLabel ):
"""Supported controls...
UnoControlButtonModel
UnoControlCheckBoxModel
"""
self.setControlModelProperty( cCtrlName, "Label", cLabel )

def getLabel( self, cCtrlName ):
"""Supported controls...
UnoControlButtonModel
UnoControlCheckBoxModel
"""
return self.getControlModelProperty( cCtrlName, "Label" )

def setHelpText( self, cCtrlName, cHelpText ):
"""Supported controls...
UnoControlButtonModel
UnoControlCheckBoxModel
"""
self.setControlModelProperty( cCtrlName, "HelpText", cHelpText )

def getHelpText( self, cCtrlName ):
"""Supported controls...
UnoControlButtonModel
UnoControlCheckBoxModel
"""
return self.getControlModelProperty( cCtrlName, "HelpText" )

#--------------------------------------------------
# Adjust controls (not models)
#--------------------------------------------------

# The following apply to all controls which are a
# com.sun.star.awt.UnoControl

def setDesignMode( self, cCtrlName, bDesignMode=True ):
oControl = self.getControl( cCtrlName )
oControl.setDesignMode( bDesignMode )

def isDesignMode( self, cCtrlName, bDesignMode=True ):
oControl = self.getControl( cCtrlName )
return oControl.isDesignMode()

def isTransparent( self, cCtrlName, bDesignMode=True ):
oControl = self.getControl( cCtrlName )
return oControl.isTransparent()

# The following apply to all controls which are a
# com.sun.star.awt.UnoControlDialogElement

def setPosition( self, cCtrlName, nPositionX, nPositionY ):
self.setControlModelProperty( cCtrlName, "PositionX", nPositionX )
self.setControlModelProperty( cCtrlName, "PositionY", nPositionY )
def setPositionX( self, cCtrlName, nPositionX ):
self.setControlModelProperty( cCtrlName, "PositionX", nPositionX )
def setPositionY( self, cCtrlName, nPositionY ):
self.setControlModelProperty( cCtrlName, "PositionY", nPositionY )
def getPositionX( self, cCtrlName ):
return self.getControlModelProperty( cCtrlName, "PositionX" )
def getPositionY( self, cCtrlName ):
return self.getControlModelProperty( cCtrlName, "PositionY" )

def setSize( self, cCtrlName, nWidth, nHeight ):
self.setControlModelProperty( cCtrlName, "Width", nWidth )
self.setControlModelProperty( cCtrlName, "Height", nHeight )
def setWidth( self, cCtrlName, nWidth ):
self.setControlModelProperty( cCtrlName, "Width", nWidth )
def setHeight( self, cCtrlName, nHeight ):
self.setControlModelProperty( cCtrlName, "Height", nHeight )
def getWidth( self, cCtrlName ):
return self.getControlModelProperty( cCtrlName, "Width" )
def getHeight( self, cCtrlName ):
return self.getControlModelProperty( cCtrlName, "Height" )

def setTabIndex( self, cCtrlName, nWidth, nTabIndex ):
self.setControlModelProperty( cCtrlName, "TabIndex", nTabIndex )
def getTabIndex( self, cCtrlName ):
return self.getControlModelProperty( cCtrlName, "TabIndex" )

def setStep( self, cCtrlName, nWidth, nStep ):
self.setControlModelProperty( cCtrlName, "Step", nStep )
def getStep( self, cCtrlName ):
return self.getControlModelProperty( cCtrlName, "Step" )

def setTag( self, cCtrlName, nWidth, cTag ):
self.setControlModelProperty( cCtrlName, "Tag", cTag )
def getTag( self, cCtrlName ):
return self.getControlModelProperty( cCtrlName, "Tag" )

#--------------------------------------------------
# Add listeners to controls.
#--------------------------------------------------

# This applies to...
# UnoControlButton
def addActionListenerProc( self, cCtrlName, actionListenerProc ):
"""Create an com.sun.star.awt.XActionListener object and add it to a control.
A listener object is created which will call the python procedure actionListenerProc.
The actionListenerProc can be either a method or a global procedure.
The following controls support XActionListener:
UnoControlButton
"""
oControl = self.getControl( cCtrlName )
oActionListener = ActionListenerProcAdapter( actionListenerProc )
oControl.addActionListener( oActionListener )

# This applies to...
# UnoControlCheckBox
def addItemListenerProc( self, cCtrlName, itemListenerProc ):
"""Create an com.sun.star.awt.XItemListener object and add it to a control.
A listener object is created which will call the python procedure itemListenerProc.
The itemListenerProc can be either a method or a global procedure.
The following controls support XActionListener:
UnoControlCheckBox
"""
oControl = self.getControl( cCtrlName )
oActionListener = ItemListenerProcAdapter( itemListenerProc )
oControl.addItemListener( oActionListener )

#--------------------------------------------------
# Display the modal dialog.
#--------------------------------------------------

def doModalDialog( self ):
"""Display the dialog as a modal dialog."""
self.oDialogControl.setVisible( True )
self.oDialogControl.execute()

def endExecute( self ):
"""Call this from within one of the listeners to end the modal dialog.
For instance, the listener on your OK or Cancel button would call this to end the dialog.
"""
self.oDialogControl.endExecute()

#--------------------------------------------------
# Example of Dialog box built by subclassing the DBModalDialog class.

class Test1Dialog( DBModalDialog ):
def __init__( self ):
DBModalDialog.__init__( self )
self.setDialogPosition( 60, 50 )
self.setDialogSize( 150, 80 )
self.setDialogTitle( "My Test1 Dialog" )
self.addButton( "btnOK", -10, -10, 30, 14, "OK",
actionListenerProc = self.btnOK_clicked )
self.addButton( "btnCancel", -50, -10, 30, 14, "Cancel",
actionListenerProc = self.btnCancel_clicked )
self.nOkClicks = 0
self.nCancelClicks = 0

# Called when the OK button is clicked.
def btnOK_clicked( self, oActionEvent ):
self.nOkClicks += 1

# Called when the Cancel button is clicked.
def btnCancel_clicked( self, oActionEvent ):
self.nCancelClicks += 1

def Test1():
oTestDialog = Test1Dialog()

# Display dialog box.
# This does not return until the dialog box is dismissed.
oTestDialog.doModalDialog()

# Print out the global button click counters.
print oTestDialog.nCancelClicks, oTestDialog.nOkClicks

#--------------------------------------------------
# Example of modal creating a dialog box without subclassing DBModalDialog.

# Global vars to keep track of button clicks.
nOkClicks = 0
nCancelClicks = 0
# Global procs, called as event listeners on button clicks.
def OKClicked( oActionEvent ):
global nOkClicks
nOkClicks += 1
def CancelClicked( oActionEvent ):
global nCancelClicks
nCancelClicks += 1

# Create a modal dialog box without subclassing DBModalDialog.
def Test2():
oTestDialog = DBModalDialog( 60, 50, 150, 80, "My Test2 Dialog" )
oTestDialog.addButton( "btnOK", -10, -10, 30, 14, "OK" )
oTestDialog.addButton( "btnCancel", -50, -10, 30, 14, "Cancel" )
oTestDialog.addFixedText( "lbl01", 10, 10, 30, 14, "Test1" )

# Install global event listener procs.
# Use the addActionListenerProc() routine instead of supplying the event
# listener to the addButton() as in first example.
oTestDialog.addActionListenerProc( "btnOK", OKClicked )
oTestDialog.addActionListenerProc( "btnCancel", CancelClicked )

# Display dialog box.
# This does not return until the dialog box is dismissed.
oTestDialog.doModalDialog()

# Print out the global button click counters.
print nCancelClicks, nOkClicks

#--------------------------------------------------
# Example of Dialog box built by subclassing the DBModalDialog class.

class ModalDoggieKittyMonkeyDialog( DBModalDialog ):
def __init__( self ):
self.nNumDoggies = 0
self.nNumKitties = 0
self.nNumMonkeys = 0
self.bTails = False
self.bOkay = False

DBModalDialog.__init__( self, 60, 50, 200, 90, "Doggie/Kitty/Monkey Dialog" )

# Add an OK and a Cancel button.
# Both buttons share an action listener named "self.btnOkOrCancel_clicked".
self.addButton( "btnOK", -10, -10, 50, 14, "OK",
actionListenerProc = self.btnOkOrCancel_clicked )
self.addButton( "btnCancel", -10 - 50 - 10, -10, 50, 14, "Cancel",
actionListenerProc = self.btnOkOrCancel_clicked )

# Add three buttons.
self.addButton( "btnDoggie", 5, 10, 50, 14, "Add Doggie",
actionListenerProc = self.btnDoggie_Clicked )
self.addButton( "btnKitty", 5, 30, 50, 14, "Add Kitty",
actionListenerProc = self.btnKitty_Clicked )
self.addButton( "btnMonkey", 5, 50, 50, 14, "Add Monkey",
actionListenerProc = self.btnMonkey_Clicked )

# Add a label to the dialog.
self.addFixedText( "lbl1", 60, 10, 100, 14, "Add some doggies, kitties, and monkeys." )

# Add a checkbox to the dialog.
self.addCheckBox( "chkTails", 60, 30, 50, 14, "With tails",
itemListenerProc = self.chkTails_changed )

def btnOkOrCancel_clicked( self, oActionEvent ):
"""Called when the OK or Cancel button is clicked."""
if oActionEvent.Source.getModel().Name == "btnOK":
self.bOkay = True
self.endExecute()

def btnDoggie_Clicked( self, oActionEvent ):
"""Called with the Doggie button is clicked."""
self.nNumDoggies += 1

def btnKitty_Clicked( self, oActionEvent ):
"""Called with the Kitty button is clicked."""
self.nNumKitties += 1

def btnMonkey_Clicked( self, oActionEvent ):
"""Called with the Monkey button is clicked."""
self.nNumMonkeys += 1

def chkTails_changed( self, oItemEvent ):
"""Called when the Tails checkbox is clicked."""
self.bTails = self.getState( "chkTails" )

def Test3():
oTestDialog = ModalDoggieKittyMonkeyDialog()
oTestDialog.doModalDialog()

# Print out the global button click counters.
print oTestDialog.nNumDoggies, oTestDialog.nNumKitties, oTestDialog.nNumMonkeys
print "okay:",oTestDialog.bOkay," tails:",oTestDialog.bTails, oTestDialog.getState( "chkTails" )

#>>> import Danny.OOo.DialogLib
#>>> reload( Danny.OOo.DialogLib ); from Danny.OOo.DialogLib import *

</source>

[[Category:Extensions]]
[[Category:Python]]
[[Category:Uno]]

Danny.OOo.ConfigLib.py

2015-02-17T19:59:39Z

JZA: Adding categories

Routines for working with the Configuration Manager.

<source lang=python>
#**********************************************************************
#
# Danny.OOo.ConfigLib.py
#
# A module to easily work with OpenOffice.org.
#
#**********************************************************************
# Copyright (c) 2003-2004 Danny Brewer
# d29583@groovegarden.com
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# See: http://www.gnu.org/licenses/lgpl.html
#
#**********************************************************************
# If you make changes, please append to the change log below.
#
# Change Log
# Danny Brewer Revised 2004-06-20-01
#
#**********************************************************************

# OOo's libraries
import uno
import unohelper

# Danny's libraries
from Danny.OOo.OOoLib import createUnoService, createUnoStruct
from Danny.OOo.OOoLib import makePropertyValue
from Danny.OOo.OOoLib import getServiceManager

def getConfigAccess( cNodePath, bWriteAccess=False, bEnableSync=True, bLazyWrite=False ):
"""An easy way to obtain a configuration node from the configuration manager."""
oConfigProvider = getServiceManager().createInstanceWithArguments(
"com.sun.star.configuration.ConfigurationProvider",
( makePropertyValue( "enablesync", bEnableSync ), ) )

if bWriteAccess:
cServiceName = "com.sun.star.configuration.ConfigurationUpdateAccess"
else:
cServiceName = "com.sun.star.configuration.ConfigurationAccess"

oConfigAccess = oConfigProvider.createInstanceWithArguments( cServiceName,
( makePropertyValue( "nodepath", cNodePath ),
makePropertyValue( "lazywrite", bLazyWrite ), ) )

return oConfigAccess

# oConfigAccess = getConfigAccess( "/org.openoffice.Office.Addons/AddonUI" )
# oElement = oConfigAccess.getByName( "AddonMenu" )
# tNames = oElement.getElementNames()
</source>
[[Category:Extensions]]
[[Category:Python]]
[[Category:Uno]]

Danny.OOo.PrintToWriter.py

2015-02-17T19:59:29Z

JZA: Adding categories

This makes it easy and convenient to print a bunch of text into a Writer document.

See the example routine in the module that shows how easy this module is to use, and how useful it can be.

<source lang=python>
#**********************************************************************
#
# Danny.OOo.PrintToWriter.py
#
# This makes it easy and convenient to print a bunch of text into
# a Writer document.
#
#**********************************************************************
# Copyright (c) 2003-2004 Danny Brewer
# d29583@groovegarden.com
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# See: http://www.gnu.org/licenses/lgpl.html
#
#**********************************************************************
# If you make changes, please append to the change log below.
#
# Change Log
# Danny Brewer Revised 2004-06-05-01
#
#**********************************************************************

# OOo's libraries
import uno

# Danny's libraries
from Danny.OOo.OOoLib import StarDesktop

com_sun_star_text_ControlCharacter_PARAGRAPH_BREAK = uno.getConstantByName( "com.sun.star.text.ControlCharacter.PARAGRAPH_BREAK" )
com_sun_star_text_ControlCharacter_LINE_BREAK = uno.getConstantByName( "com.sun.star.text.ControlCharacter.LINE_BREAK" )
com_sun_star_text_ControlCharacter_HARD_HYPHEN = uno.getConstantByName( "com.sun.star.text.ControlCharacter.HARD_HYPHEN" )
com_sun_star_text_ControlCharacter_SOFT_HYPHEN = uno.getConstantByName( "com.sun.star.text.ControlCharacter.SOFT_HYPHEN" )
com_sun_star_text_ControlCharacter_HARD_SPACE = uno.getConstantByName( "com.sun.star.text.ControlCharacter.HARD_SPACE" )
com_sun_star_text_ControlCharacter_APPEND_PARAGRAPH = uno.getConstantByName( "com.sun.star.text.ControlCharacter.APPEND_PARAGRAPH" )

class PrintToWriter:
"""A class which allows conveniently printing stuff into a Writer document.
Very useful for debugging, general output purposes, or even for creating reports."""
def __init__( self ):
self.oWriterDoc = StarDesktop.loadComponentFromURL( "private:factory/swriter", "_blank", 0, () )
self.oWriterText = self.oWriterDoc.getText()
self.oWriterCursor = self.oWriterText.createTextCursor()

def writeLn( self, *args ):
if len( args ) > 0:
apply( self.write, args )
self.writeParagraphBreak()

def write( self, arg1, *argsRest ):
self.writeOne( arg1 )
for arg in argsRest:
self.writeTab()
self.writeOne( arg )

def writeOne( self, arg, bAbsorb=False ):
self.writeString( str( arg ), bAbsorb )

def writeTab( self, bAbsorb=False ):
self.writeString( "\t", bAbsorb )

def writeParagraphBreak( self, bAbsorb=False ):
self.writeControlCharacter( com_sun_star_text_ControlCharacter_PARAGRAPH_BREAK, bAbsorb )

def writeString( self, cString, bAbsorb=False ):
self.oWriterText.insertString( self.oWriterCursor, cString, bAbsorb )

def writeControlCharacter( self, nCtrlChar, bAbsorb=False ):
self.oWriterText.insertControlCharacter( self.oWriterCursor, nCtrlChar, bAbsorb )

def example_PrintToWriter():
"""An example of how to use the PrintToWriter class to trivially create
a new Writer document, and write out text into it."""
oOutput = PrintToWriter()
oOutput.writeLn( "Hello World" )
oOutput.write( "String", 123, 456.23, True )
oOutput.writeLn()
oOutput.writeLn()

oOutput.writeLn( "Tab delimited values..." )

oOutput.write( 123 )
oOutput.writeTab()
oOutput.write( 456 )
oOutput.writeTab()
oOutput.write( 789 )
oOutput.writeLn()

oOutput.write( 465 )
oOutput.writeTab()
oOutput.write( 522 )
oOutput.writeTab()
oOutput.write( 835 )
oOutput.writeLn()

oOutput.write( 886 )
oOutput.writeTab()
oOutput.write( 164 )
oOutput.writeTab()
oOutput.write( 741 )
oOutput.writeLn()

</source>
[[Category:Extensions]]
[[Category:Python]]
[[Category:Uno]]

Danny.HSBConversions.py

2015-02-17T19:59:04Z

JZA: Adding categories

HSB to RGB color space conversion routines.

<source lang=python>
#**********************************************************************
#
# Danny.HSBConversions.py
#
#**********************************************************************
# Copyright (c) 2003-2004 Danny Brewer
# d29583@groovegarden.com
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# See: http://www.gnu.org/licenses/lgpl.html
#
#**********************************************************************
# If you make changes, please append to the change log below.
#
# Change Log
# Danny Brewer Revised 2003-08-21-01
#
#**********************************************************************

# HSB to RGB color space conversion routines.

def RGBtoHSB( nRed, nGreen, nBlue ):
"""RGB to HSB color space conversion routine.
nRed, nGreen and nBlue are all numbers from 0 to 255.
This routine returns three floating point numbers, nHue, nSaturation, nBrightness.
nHue, nSaturation and nBrightness are all from 0.0 to 1.0.
"""
nMin = min( nRed, nGreen, nBlue )
nMax = max( nRed, nGreen, nBlue )

if nMin == nMax:
# Grayscale
nHue = 0.0
nSaturation = 0.0
nBrightness = nMax
else:
if nRed == nMin:
d = nGreen = nBlue
h = 3.0
elif nGreen == nMin:
d = nBlue - nRed
h = 5.0
else:
d = nRed - nGreen
h = 1.0

nHue = ( h - ( float( d ) / (nMax - nMin) ) ) / 6.0
nSaturation = (nMax - nMin) / float( nMax )
nBrightness = nMax / 255.0

return nHue, nSaturation, nBrightness

def HSBtoRGB( nHue, nSaturation, nBrightness ):
"""HSB to RGB color space conversion routine.
nHue, nSaturation and nBrightness are all from 0.0 to 1.0.
This routine returns three integer numbers, nRed, nGreen, nBlue.
nRed, nGreen and nBlue are all numbers from 0 to 255.
"""
# Scale the brightness from a range of 0.0 thru 1.0
# to a range of 0.0 thru 255.0
# Then truncate to an integer.
nBrightness = int( min( nBrightness * 256.0, 255.0 ) )

if nSaturation == 0.0:
# Grayscale because there is no saturation
nRed = nBrightness
nGreen = nBrightness
nBlue = nBrightness
else:
# Make hue angle be within a single rotation.
# If the hue is > 1.0 or < 0.0, then it has
# "gone around the color wheel" too many times.
# For example, a value of 1.2 means that it has
# gone around the wheel 1.2 times, which is really
# the same ending angle as 0.2 trips around the wheel.
# Scale it back to the 0.0 to 1.0 range.
if nHue > 1.0:
nHue = nHue - int( nHue )
elif nHue < 0.0:
nHue = abs( nHue )
if nHue > 1.0:
nHue = nHue - int( nHue )
nHue = 1.0 - nHue
# Rescale hue to a range of 0.0 thru 6.0
nHue = nHue * 6.0
# Separate hue into int and fractional parts
iHue = int( nHue )
fHue = nHue - iHue
# Is hue even?
if iHue % 2 == 0:
fHue = 1.0 - fHue
#
m = nBrightness * (1.0 - nSaturation)
n = nBrightness * (1.0 - (nSaturation * fHue))

if iHue == 1:
nRed = n
nGreen = nBrightness
nBlue = m
elif iHue == 2:
nRed = m
nGreen = nBrightness
nBlue = n
elif iHue == 3:
nRed = m
nGreen = n
nBlue = nBrightness
elif iHue == 4:
nRed = n
nGreen = m
nBlue = nBrightness
elif iHue == 5:
nRed = nBrightness
nGreen = m
nBlue = n
else:
nRed = nBrightness
nGreen = n
nBlue = m

return nRed, nGreen, nBlue

</source>
[[Category:Extensions]]
[[Category:Python]]
[[Category:Uno]]

Danny.OOo.DrawLib.py

2015-02-17T19:58:46Z

JZA: Adding categories

This module has routines to make programming OOo Drawing documents easier. Much of this code was derrived from Basic code, that also appears in Danny's Draw Power Tools found at OOoMacros.org.

This module depends upon the modules...
* [[Danny.OOo.OOoLib.py]]
* [[Danny.HSBConversions.py]]
presented elsewhere in this thread.

<source lang=python>
#**********************************************************************
#
# Danny.OOo.DrawLib.py
#
# A module to easily work with OOo Drawings.
#
#**********************************************************************
# Copyright (c) 2003-2004 Danny Brewer
# d29583@groovegarden.com
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# See: http://www.gnu.org/licenses/lgpl.html
#
#**********************************************************************
# If you make changes, please append to the change log below.
#
# Change Log
# Danny Brewer Revised 2004-05-24-01
#
#**********************************************************************

# Python libraries
import math
import string

# Danny's libraries
from Danny import HSBConversions
from Danny.OOo.OOoLib import *

# OOo's libraries
import uno

#------------------------------------------------------------
# Functions for working with Draw documents.
#------------------------------------------------------------

def makeDrawDocument():
"""Create a new OOo Draw document."""
return loadComponentFromURL( "private:factory/sdraw" )

def makeImpressDocument():
"""Create a new OOo Impress document."""
return loadComponentFromURL( "private:factory/simpress" )

# Notes about some properties and constants for shape objects...

# LineStyle can be one of...
# com.sun.star.drawing.LineStyle.NONE
# com.sun.star.drawing.LineStyle.SOLID
# com.sun.star.drawing.LineStyle.DASH

# CircleKind can be one of...
# com.sun.star.drawing.CircleKind.FULL
# com.sun.star.drawing.CircleKind.SECTION ' a circle with a cut connected by two lines
# com.sun.star.drawing.CircleKind.CUT ' a circle with a cut connected by a line
# com.sun.star.drawing.CircleKind.ARC ' a circle with an open cut

# FillStyle can be one of...
# com.sun.star.drawing.FillStyle.NONE
# com.sun.star.drawing.FillStyle.SOLID
# com.sun.star.drawing.FillStyle.GRADIENT
# com.sun.star.drawing.FillStyle.HATCH
# com.sun.star.drawing.FillStyle.BITMAP

# TextHorizontalAdjust can be one of...
# com.sun.star.drawing.TextHorizontalAdjust.LEFT
# com.sun.star.drawing.TextHorizontalAdjust.CENTER
# com.sun.star.drawing.TextHorizontalAdjust.RIGHT
# com.sun.star.drawing.TextHorizontalAdjust.BLOCK

# TextVerticalAdjust can be one of...
# com.sun.star.drawing.TextVerticalAdjust.TOP
# com.sun.star.drawing.TextVerticalAdjust.CENTER
# com.sun.star.drawing.TextVerticalAdjust.BOTTOM
# com.sun.star.drawing.TextVerticalAdjust.BLOCK

# TextFitToSize can be one of...
# com.sun.star.drawing.TextFitToSizeType.NONE
# com.sun.star.drawing.TextFitToSizeType.PROPORTIONAL
# com.sun.star.drawing.TextFitToSizeType.ALLLINES
# com.sun.star.drawing.TextFitToSizeType.RESIZEATTR

# Useful code snippets...

# Accessing pages of a drawing document.
# oDrawPage = oDrawDoc.getDrawPages().getByIndex( 0 )
# oDrawPage = oDrawDoc.getDrawPages().getCount()
# oDrawPage = oDrawDoc.getDrawPages().insertByIndex( 1 )

#------------------------------------------------------------
# Document functions
#------------------------------------------------------------

def setDrawPageOrientationLandscape( oDrawPage ):
"""Pass in any GenericDrawPage object, and this changes it to landscape orientation,
in addition to swapping the height/width as you would expect.
"""
# Save some settings
nOldWidth = oDrawPage.Width
nOldHeight = oDrawPage.Height
nOldBorderTop = oDrawPage.BorderTop
nOldBorderLeft = oDrawPage.BorderLeft
nOldBorderRight = oDrawPage.BorderRight
nOldBorderBottom = oDrawPage.BorderBottom

# Change so that it will PRINT in landscape
oDrawPage.Orientation = uno.getConstantByName( "com.sun.star.view.PaperOrientation.LANDSCAPE" )

# Now change some paper dimensions to match
oDrawPage.Width = nOldHeight
oDrawPage.Height = nOldWidth
oDrawPage.BorderTop = nOldBorderRight
oDrawPage.BorderLeft = nOldBorderTop
oDrawPage.BorderRight = nOldBorderBottom
oDrawPage.BorderBottom = nOldBorderLeft

#------------------------------------------------------------
# Shape functions
#------------------------------------------------------------

def makeRectangleShape( oDrawDoc, oPosition=None, oSize=None ):
"""Create a new RectangleShape with an optional position and size."""
oShape = makeShape( oDrawDoc, "com.sun.star.drawing.RectangleShape", oPosition, oSize )
return oShape

def makeEllipseShape( oDrawDoc, oPosition=None, oSize=None ):
"""Create a new EllipseShape with an optional position and size."""
oShape = makeShape( oDrawDoc, "com.sun.star.drawing.EllipseShape", oPosition, oSize )
return oShape

def makeLineShape( oDrawDoc, oPosition=None, oSize=None ):
"""Create a new LineShape with an optional position and size."""
oShape = makeShape( oDrawDoc, "com.sun.star.drawing.LineShape", oPosition, oSize )
return oShape

def makeTextShape( oDrawDoc, oPosition=None, oSize=None ):
"""Create a new TextShape with an optional position and size."""
oShape = makeShape( oDrawDoc, "com.sun.star.drawing.TextShape", oPosition, oSize )
return oShape

def findShapeByName( oShapes, cShapeName ):
"""Find a named shape within an XShapes interface.
oShapes can be a drawing page, which supports the XShapes interface.
Thus, you can find a named shape within a draw page, or within a grouped shape,
or within a selection of sseveral shapes.
"""
nNumShapes = oShapes.getCount()
for i in range( nNumShapes ):
oShape = oShapes.getByIndex( i )
cTheShapeName = oShape.getName()
if cTheShapeName == cShapeName:
return oShape
return None

def makeShape( oDrawDoc, cShapeClassName, oPosition=None, oSize=None ):
"""Create a new shape of the specified class.
Position and size arguments are optional.
"""
oShape = oDrawDoc.createInstance( cShapeClassName )

if oPosition != None:
oShape.Position = oPosition
if oSize != None:
oShape.Size = oSize

return oShape

#------------------------------------------------------------
# Color manipulation
#------------------------------------------------------------

def rgbColor( nRed, nGreen, nBlue ):
"""Return an integer which repsents a color.
The color is specified in RGB notation.
Each of nRed, nGreen and nBlue must be a number from 0 to 255.
"""
return (int( nRed ) & 255) << 16 | (int( nGreen ) & 255) << 8 | (int( nBlue ) & 255)

def hsbColor( nHue, nSaturation, nBrightness ):
"""Return an integer which repsents a color.
The color is specified in HSB notation.
Each of nHue, nSaturation and nBrightness must be a number from 0.0 to 1.0.
"""
nRed, nGreen, nBlue = HSBConversions.HSBtoRGB( nHue, nSaturation, nBrightness )
return rgbColor( nRed, nGreen, nBlue )

def redColor( nColor ):
"""Return the Red component of a color as an integer from 0 to 255.
nColor is an integer representing a color.
This function is complimentary to the rgbColor function.
"""
return (int( nColor ) >> 16) & 255

def greenColor( nColor ):
"""Return the Green component of a color as an integer from 0 to 255.
nColor is an integer representing a color.
This function is complimentary to the rgbColor function.
"""
return (int( nColor ) >> 8) & 255

def blueColor( nColor ):
"""Return the Blue component of a color as an integer from 0 to 255.
nColor is an integer representing a color.
This function is complimentary to the rgbColor function.
"""
return int( nColor ) & 255

#------------------------------------------------------------
# Drawing routines
#------------------------------------------------------------

# Multiply this number by an OOo angle in 100'ths of a degree
# to convert to radians.
nRadiansPerHundredthDegree = math.pi / 18000

def drawLine( oDrawDoc, oDrawPage, x1,y1, x2,y2, nLineColor=None ):
"""Draw a line from x1,y1 to x2,y2. Optionally specify line color.
This adds the LineShape to the page.
The LineShape is returned.
"""
# make sure size is non-zero
#if x1 = x2: x2 = x1 + 1
#if y1 = y2: y2 = y1 + 1

oPosition = makePoint( x1, y1 )
oSize = makeSize( x2-x1, y2-y1 )

oShape = makeLineShape( oDrawDoc, oPosition, oSize )

if nLineColor != None:
oShape.LineColor = nLineColor
#oShape.LineWidth = 0

oDrawPage.add( oShape )
return oShape

def drawLineVector( oDrawDoc, oDrawPage, x1,y1, nAngle,nDistance, nLineColor=None ):
"""Draw a line from x1,y1 in the direction of nAngle, for a distance of nDistance.
nAngle is measured in radians, clockwise from the 3 O'Clock (east) direction.
nDistance is in 1000ths of a centimeter.
This adds the LineShape to the page.
The LineShape is returned.
"""
nDX = math.cos( nAngle ) * nDistance
nDY = math.sin( nAngle ) * nDistance

return drawLine( oDrawDoc, oDrawPage, x1,y1, x1+nDX,y1+nDY, nLineColor )

def drawAutoSizingText( oDrawDoc, oDrawPage,
cText, nHeight, nExtraWidthPercent=40 ):
"""Create a TextShape that will automatically resize its characters
to its shape bounding rectangle.
The TextShape is created with a specified height.
The width is determined based on the natural character width of the
text.
The initial position of the text is -10000,-10000, so that the text is not visible.
This returns the TextShape, which has already been added to the drawing page,
at coordinates which make it invisible.
You must set the object's Position property to make the text visible.
(Hint: You may look at the Size property to help you determine where
you want to place the text, for instance if you are trying to center
it, or place it relative to some other shape object.)
If you don't supply nExtraWidthPercent, then a default fudge factor is used.
This is the percentage of the average character width, which is added to the shape's
total width.
"""
# Create TextShape
oShape = makeTextShape( oDrawDoc, makePoint( -10000, -10000 ), makeSize( 1, 1 ) )

# Add it to the page.
oDrawPage.add( oShape )

# Make text stick to upper left corner of the shape rather than centered within the shape.
oShape.TextHorizontalAdjust = uno.getConstantByName( "com.sun.star.drawing.TextHorizontalAdjust.LEFT" )
oShape.TextVerticalAdjust = uno.getConstantByName( "com.sun.star.drawing.TextVerticalAdjust.TOP" )

# Make the shape auto-grow in size, based on the text.
# Once we set the text, in the next step, the shape will grow to some
# unknown size, based on the current font in use.
#oShape.TextAutoGrowHeight = True
oShape.TextAutoGrowWidth = True

# Set the text of the TextShape.
# Because of the TextAutoGrowWidth, the shape now occupies some unknown size.
oShape.setString( cText )

# Get the shape's current size.
nSaveHeight = oShape.Size.Height
nSaveWidth = oShape.Size.Width

# Make the shape NOT auto-grow in size, based on the text.
#oShape.TextAutoGrowHeight = False
oShape.TextAutoGrowWidth = False

# This next setting causes the TextShape to automatically resize its characters
# to fit the size of the text shape.
oShape.TextFitToSize = uno.getConstantByName( "com.sun.star.drawing.TextFitToSizeType.PROPORTIONAL" )

# Calculate the new width, based on the desired height,
# and saved width/height ratio for the current font in use.
nWidth = nSaveWidth * (float(nHeight) / nSaveHeight)

nAverageCharacterWidth = nWidth / len( cText )

nExtraWidth = nAverageCharacterWidth * (nExtraWidthPercent / 100.0)

oShape.TextLeftDistance = nExtraWidth
oShape.TextRightDistance = nExtraWidth
nWidth = nWidth + 2 * nExtraWidth

# Now resize the TextShape.
oShape.Size.Width = nWidth
oShape.Size.Height = nHeight

return oShape

def drawArcPath( oDrawDoc, oDrawPage,
nStartX, nStartY, nStartAngle,
nArcAngle, nArcRadius, bTurnLeft ):
"""Draw an arc of a circle from a starting position and direction.
The arc has a certian radius and arc angle,
and turns either to the left or to the right.
Parameters:
nStartX and nStartY are the starting position of the "turtle".
nStartAngle is the angle direction that the turtle is pointing,
in 100'ths of a degree.
An arc is drawn by moving the turtle forward and turning either left or right as it moves.
nArcAngle is the angle of the arc describing the turtle's path,
in 100'ths of a degree.
nArcRadius is the radius of the arc describing the turtle's path.
bTurnLeft is True if the turtle turns to the left, or False to turn to the right.
Four values are returned.
(1) the circle shape, (2) the new X position, (3) new Y position, and (4) new angle.
Use the last three return values as initial values to draw another arc
which is connected to the ending position of the arc just drawn.
"""

# Figure out how big of a circle that the arc is a part of.
nCircleDiameter = nArcRadius + nArcRadius
oCircleSize = makeSize( nCircleDiameter, nCircleDiameter )

# Figure out the position of the circle (ellipse) shape object.
#
# Determine the angle of the center point from the starting position.
if bTurnLeft:
nCenterPointAngle = nStartAngle + 9000
else:
nCenterPointAngle = nStartAngle - 9000
# Convert to radians.
nCenterPointAngle = nCenterPointAngle * nRadiansPerHundredthDegree
# Determine where the center of the circle shape should be.
nCenterX = nStartX + (nArcRadius * math.cos( nCenterPointAngle ))
nCenterY = nStartY - (nArcRadius * math.sin( nCenterPointAngle ))
oCirclePosition = makePoint( nCenterX - nArcRadius, nCenterY - nArcRadius )

# Figure out what arc portion of the circle needs to be drawn.
# Angles measures in 100'ths of a degree.
if bTurnLeft:
nCircleStartAngle = nStartAngle - 9000
nCircleEndAngle = nCircleStartAngle + nArcAngle
else:
nCircleEndAngle = nStartAngle + 9000
nCircleStartAngle = nCircleEndAngle - nArcAngle

# Make the circle shape.
oCircle = makeEllipseShape( oDrawDoc, oCirclePosition, oCircleSize )
# Fill in its properties
oCircle.FillStyle = uno.getConstantByName( "com.sun.star.drawing.FillStyle.NONE" )
oCircle.CircleKind = uno.getConstantByName( "com.sun.star.drawing.CircleKind.ARC" )
oCircle.CircleStartAngle = nCircleStartAngle
oCircle.CircleEndAngle = nCircleEndAngle
# Put it on the drawing
oDrawPage.add( oCircle )

# Figure out the ending turtle location and direction.
if bTurnLeft:
nEndAngle = nStartAngle - 9000 + nArcAngle
else:
nEndAngle = nStartAngle + 9000 - nArcAngle
# Convert to radians
nEndAngleRad = nEndAngle * nRadiansPerHundredthDegree
# Ending Position
nEndX = nCenterX + (nArcRadius * math.cos( nEndAngleRad ))
nEndY = nCenterY - (nArcRadius * math.sin( nEndAngleRad ))
# Ending angle
if bTurnLeft:
nEndAngle = normalizeOOoAngle( nEndAngle + 9000 )
else:
nEndAngle = normalizeOOoAngle( nEndAngle - 9000 )

return oCircle, nEndX, nEndY, nEndAngle

def drawSpiralOfArcs( oDrawDoc, oDrawPage,
nStartX, nStartY, nStartAngle,
nArcAngle, nArcRadius, bTurnLeft,
nNumArcs,
nRadiusGrowthMultiplier=1.0, nRadiusGrowthAddIn=0 ):
"""Draw a spiral starting from a certian position and direction.
The spiral turns either towards the left or towards the right.
Parameters:
nStartX and nStartY are the starting position of the "turtle".
nStartAngle is the angle direction that the turtle is pointing,
in 100'ths of a degree.
A spiral is drawn by moving the turtle forward and turning either left or right as it moves.
nArcAngle is the angle of the first arc of the spiral,
in 100'ths of a degree.
nArcRadius is the radius of the first arc of the spiral.
bTurnLeft is True if the turtle turns to the left, or False to turn to the right.
nNumArcs is the number of arcs which are drawn.
nRadiusGrowthMultiplier - the radius of the arc is multiplied by this after each arc is drawn.
Use a number such as 1.1 to cause the radius to grow geometrically as the spiral turns.
nRadiusGrowthAddIn - this is added to the radius after each arc.
Use a number, such as the original nArcRadius / number of arcs in a complete circle to cause the radius to grow arithmeteically as the spiral turns.
Four values are returned.
(1) the spiral shape, (2) the new X position, (3) new Y position, and (4) new angle.
Use the last three return values as initial values to draw another arc
which is connected to the ending position of the arc just drawn.
"""
nX = nStartX
nY = nStartY
nAngle = nStartAngle

oShapesToGroup = createUnoService( "com.sun.star.drawing.ShapeCollection" )
for i in range( nNumArcs - 1 ):
oArcShape, nX, nY, nAngle = drawArcPath( oDrawDoc, oDrawPage, nX, nY, nAngle, nArcAngle, nArcRadius, bTurnLeft )
nArcRadius = nArcRadius * nRadiusGrowthMultiplier + nRadiusGrowthAddIn

oShapesToGroup.add( oArcShape )
oSpiralShape = oDrawPage.group( oShapesToGroup )
return oSpiralShape, nX, nY, nAngle

#------------------------------------------------------------
# Styles
#------------------------------------------------------------

def defineGraphicsStyle( oDrawDoc, cStyleName, cParentStyleName=None ):
"""Add a new style to the style catalog if it is not already present.
This returns the style object so that you can alter its properties.
"""
return defineStyle( oDrawDoc, "graphics", cStyleName, cParentStyleName )

def getGraphicsStyle( oDrawDoc, cStyleName ):
"""Lookup and return a graphics style from the document.
"""
return getStyle( oDrawDoc, "graphics", cStyleName )

#------------------------------------------------------------
# General Utility functions
#------------------------------------------------------------

def normalizeOOoAngle( nAngleOOo ):
"""Given an angle in 100'ths of a degree,
adjust it to be from 0 to 360 degrees."""
if nAngleOOo < 0:
nSign = -1
else:
nSign = 1
nAngleOOo = nAngleOOo - (int( abs( nAngleOOo ) / 36000.0 ) * 36000 * nSign)
if nAngleOOo < 0:
nAngleOOo += 36000
return nAngleOOo
</source>
[[Category:Extensions]]
[[Category:Python]]
[[Category:Uno]]

Danny.OOo.OOoLib.py

2015-02-17T19:57:46Z

JZA: Adding categories

This module makes programming OOo in Python much more like programming OOo in Basic. It also contains some frequently used functions that I typically write in Basic, such as makePropertyValue().
When I write Components in Python, the first function in this module, the getServiceManager() function is replaced by a completely different implementation. Otherwise, even in a component, the features of this module are available.

<source lang=python>
#**********************************************************************
#
# Danny.OOo.OOoLib.py
#
# A module to easily work with OpenOffice.org.
#
#**********************************************************************
# Copyright (c) 2003-2004 Danny Brewer
# d29583@groovegarden.com
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# See: http://www.gnu.org/licenses/lgpl.html
#
#**********************************************************************
# If you make changes, please append to the change log below.
#
# Change Log
# Danny Brewer Revised 2004-06-07-01
#
#**********************************************************************

import string

# OOo's libraries
import uno

#------------------------------------------------------------
# Uno ServiceManager access
# A different version of this routine and global variable
# is needed for code running inside a component.
#------------------------------------------------------------

# The ServiceManager of the running OOo.
# It is cached in a global variable.
goServiceManager = False
def getServiceManager( cHost="localhost", cPort="8100" ):
"""Get the ServiceManager from the running OpenOffice.org.
Then retain it in the global variable goServiceManager for future use.
This is similar to the GetProcessServiceManager() in OOo Basic.
"""
global goServiceManager
if not goServiceManager:
# Get the uno component context from the PyUNO runtime
oLocalContext = uno.getComponentContext()
# Create the UnoUrlResolver on the Python side.
oLocalResolver = oLocalContext.ServiceManager.createInstanceWithContext(
"com.sun.star.bridge.UnoUrlResolver", oLocalContext )
# Connect to the running OpenOffice.org and get its context.
oContext = oLocalResolver.resolve( "uno:socket,host=" + cHost + ",port=" + cPort + ";urp;StarOffice.ComponentContext" )
# Get the ServiceManager object
goServiceManager = oContext.ServiceManager
return goServiceManager

#------------------------------------------------------------
# Uno convenience functions
# The stuff in this section is just to make
# python progrmaming of OOo more like using OOo Basic.
#------------------------------------------------------------

# This is the same as ServiceManager.createInstance( ... )
def createUnoService( cClass ):
"""A handy way to create a global objects within the running OOo.
Similar to the function of the same name in OOo Basic.
"""
oServiceManager = getServiceManager()
oObj = oServiceManager.createInstance( cClass )
return oObj

# The StarDesktop object. (global like in OOo Basic)
# It is cached in a global variable.
StarDesktop = None
def getDesktop():
"""An easy way to obtain the Desktop object from a running OOo.
"""
global StarDesktop
if StarDesktop == None:
StarDesktop = createUnoService( "com.sun.star.frame.Desktop" )
return StarDesktop
# preload the StarDesktop variable.
getDesktop()

# The CoreReflection object.
# It is cached in a global variable.
goCoreReflection = False
def getCoreReflection():
global goCoreReflection
if not goCoreReflection:
goCoreReflection = createUnoService( "com.sun.star.reflection.CoreReflection" )
return goCoreReflection

def createUnoStruct( cTypeName ):
"""Create a UNO struct and return it.
Similar to the function of the same name in OOo Basic.
"""
oCoreReflection = getCoreReflection()
# Get the IDL class for the type name
oXIdlClass = oCoreReflection.forName( cTypeName )
# Create the struct.
oReturnValue, oStruct = oXIdlClass.createObject( None )
return oStruct

#def newConnectionToOOo( cHost="localhost", cPort="8100" ):
# """Call this to establish, or re-establish a connection to OOo."""
# global goServiceManager
# global StarDesktop
# global goCoreReflection
# goServiceManager = False
# StarDesktop = None
# goCoreReflection = False
# getServiceManager( cHost, cPort )
# getDesktop()

#------------------------------------------------------------
# API helpers
#------------------------------------------------------------

def hasUnoInterface( oObject, cInterfaceName ):
"""Similar to Basic's HasUnoInterfaces() function, but singular not plural."""

# Get the Introspection service.
oIntrospection = createUnoService( "com.sun.star.beans.Introspection" )

# Now inspect the object to learn about it.
oObjInfo = oIntrospection.inspect( oObject )

# Obtain an array describing all methods of the object.
oMethods = oObjInfo.getMethods( uno.getConstantByName( "com.sun.star.beans.MethodConcept.ALL" ) )
# Now look at every method.
for oMethod in oMethods:
# Check the method's interface to see if
# these aren't the droids you're looking for.
cMethodInterfaceName = oMethod.getDeclaringClass().getName()
if cMethodInterfaceName == cInterfaceName:
return True
return False

def hasUnoInterfaces( oObject, *cInterfaces ):
"""Similar to the function of the same name in OOo Basic."""
for cInterface in cInterfaces:
if not hasUnoInterface( oObject, cInterface ):
return False
return True

#------------------------------------------------------------
# High level general purpose functions
#------------------------------------------------------------

def makePropertyValue( cName=None, uValue=None, nHandle=None, nState=None ):
"""Create a com.sun.star.beans.PropertyValue struct and return it.
"""
oPropertyValue = createUnoStruct( "com.sun.star.beans.PropertyValue" )

if cName != None:
oPropertyValue.Name = cName
if uValue != None:
oPropertyValue.Value = uValue
if nHandle != None:
oPropertyValue.Handle = nHandle
if nState != None:
oPropertyValue.State = nState

return oPropertyValue

def makePoint( nX, nY ):
"""Create a com.sun.star.awt.Point struct."""
oPoint = createUnoStruct( "com.sun.star.awt.Point" )
oPoint.X = nX
oPoint.Y = nY
return oPoint

def makeSize( nWidth, nHeight ):
"""Create a com.sun.star.awt.Size struct."""
oSize = createUnoStruct( "com.sun.star.awt.Size" )
oSize.Width = nWidth
oSize.Height = nHeight
return oSize

def makeRectangle( nX, nY, nWidth, nHeight ):
"""Create a com.sun.star.awt.Rectangle struct."""
oRect = createUnoStruct( "com.sun.star.awt.Rectangle" )
oRect.X = nX
oRect.Y = nY
oRect.Width = nWidth
oRect.Height = nHeight
return oRect

def Array( *args ):
"""This is just sugar coating so that code from OOoBasic which
contains the Array() function can work perfectly in python."""
tArray = ()
for arg in args:
tArray += (arg,)
return tArray

def loadComponentFromURL( cUrl, tProperties=() ):
"""Open or Create a document from it's URL.
New documents are created from URL's such as:
private:factory/sdraw
private:factory/swriter
private:factory/scalc
private:factory/simpress
"""
StarDesktop = getDesktop()
oDocument = StarDesktop.loadComponentFromURL( cUrl, "_blank", 0, tProperties )
return oDocument

#def makeWriterDocument():
# """Create a new OOo Writer document."""
# return loadComponentFromURL( "private:factory/swriter" )
#
#
#def makeCalcDocument():
# """Create a new OOo Calc document."""
# return loadComponentFromURL( "private:factory/scalc" )

#------------------------------------------------------------
# Styles
#------------------------------------------------------------

def defineStyle( oDrawDoc, cStyleFamily, cStyleName, cParentStyleName=None ):
"""Add a new style to the style catalog if it is not already present.
This returns the style object so that you can alter its properties.
"""

oStyleFamily = oDrawDoc.getStyleFamilies().getByName( cStyleFamily )

# Does the style already exist?
if oStyleFamily.hasByName( cStyleName ):
# then get it so we can return it.
oStyle = oStyleFamily.getByName( cStyleName )
else:
# Create new style object.
oStyle = oDrawDoc.createInstance( "com.sun.star.style.Style" )

# Set its parent style
if cParentStyleName != None:
oStyle.setParentStyle( cParentStyleName )

# Add the new style to the style family.
oStyleFamily.insertByName( cStyleName, oStyle )

return oStyle

def getStyle( oDrawDoc, cStyleFamily, cStyleName ):
"""Lookup and return a style from the document.
"""
return oDrawDoc.getStyleFamilies().getByName( cStyleFamily ).getByName( cStyleName )

#------------------------------------------------------------
# General Utility functions
#------------------------------------------------------------

def convertToURL( cPathname ):
"""Convert a Windows or Linux pathname into an OOo URL."""
if len( cPathname ) > 1:
if cPathname[1:2] == ":":
cPathname = "/" + cPathname[0] + "|" + cPathname[2:]
cPathname = string.replace( cPathname, "\\", "/" )
cPathname = "file://" + cPathname
return cPathname
</source>

[[Category:Extensions]]
[[Category:Python]]
[[Category:Uno]]

Danny.HeapSort

2015-02-17T19:53:32Z

JZA: Added code from oooforum.

Danny.OOo.WindowLib.py

2015-02-17T19:51:03Z

JZA: Added code from oooforum.

Danny.OOo.Listeners.TopWindowListener.py

2015-02-17T19:48:11Z

JZA: Added code from oooforum.

Danny.OOo.Listeners.ListenerProcAdapters.py

2015-02-17T19:46:07Z

JZA: Added code from oooforum.

Danny.OOo.DialogLib.py

2015-02-17T19:44:16Z

JZA: Added code from oooforum.

Danny.OOo.ConfigLib.py

2015-02-17T19:42:05Z

JZA: Added code from oooforum.

Danny.OOo.PrintToWriter.py

2015-02-17T19:40:15Z

JZA: Added code from oooforum.

Danny.HSBConversions.py

2015-02-17T19:36:27Z

JZA: Added code from oooforum.

Danny.OOo.DrawLib.py

2015-02-17T19:34:36Z

JZA: Source from oooforum

Danny.OOo.OOoLib.py

2015-02-17T19:27:44Z

JZA: Added code from oooforum.

Danny's Python Modules

2015-02-17T19:26:27Z

JZA: Add links to the source of the Danny Modules

In this thread I am going to post some various Python modules from my growing library. The following links take you directly to the message where a particular class is posted.

[http://www.oooforum.org/forum/viewtopic.phtml?t=14409 Click here to see original posting]

'''[[Danny.OOo.OOoLib.py]]'''
This module makes programming OOo in Python much more like programming OOo in Basic. It also contains some frequently used functions that I typically write in Basic, such as '''makePropertyValue()'''.

'''[[Danny.OOo.DrawLib.py]]'''
This module has routines to make programming OOo Drawing documents easier. Much of this code was derrived from Basic code, that also appears in Danny's Draw Power Tools found at OOoMacros.org.

'''[[Danny.HSBConversions.py]]'''
HSB to RGB color space conversion routines. This module is a prerequisite for the module Danny.OOo.DrawLib.py.

'''[[Danny.OOo.PrintToWriter.py]]'''
This makes it easy and convenient to print a bunch of text into a Writer document. See the example routine in the module that shows how easy this module is to use, and how useful it can be.

'''[[Danny.OOo.ConfigLib.py]]'''
Routines for working with the Configuration Manager.

'''[[Danny.OOo.DialogLib.py]]'''
A class to build a dialog box from the com.sun.star.awt.* services. This doesn't do anything you couldn't already do using OOo's UNO API, this just makes it much easier.

'''[[Danny.OOo.WindowLib.py]]'''
A class to build a modeless window from the com.sun.star.awt.* services. This doesn't do anything you couldn't already do using OOo's UNO API, this just makes it much easier.

'''[[Danny.OOo.Listeners.ListenerProcAdapters.py]]'''
This module has various helpers that make it extremely easy to create listeners on the fly, and make them call an arbitrary python procedure. See quick example that appears with the code.

'''[[Danny.OOo.Listeners.TopWindowListener.py]]'''
When you need to add a window listener to a top window, this class makes is easy to create such a listener. You can use this class, or your own subclass of it. If you create a subclass, you don't need to bother to implement every one of the methods, because you can inherit the empty implementations of methods from this class for the methods you are not interested in.

'''[[Danny.HeapSort]]'''
A simple implementation of HeapSort. Yet, it allows a customizable notion of "comparison" and "swapping" by passing in your own compareGreaterProc, and swapProc.
This is NOT an OOo specific module. It can be used for any type of Python code.

[[Category:Python]][[Category:External Project]]

PythonContainers

2015-02-17T19:22:07Z

JZA: Added code from oooforum.

Originally posted by DannyB on oooForum, read the original post [http://www.oooforum.org/forum/viewtopic.phtml?p=33986 here].
As a first experiment, here is a single python component program which implements two services.

The two new services are....

name.dannyBrewer.util.IndexContainer
name.dannyBrewer.util.NameContainer

Here is how you install the new component.
# Copy the text of the following python source code.
# Put it into a file named "DannyComponentTest2004052217.py"
# Put the file DannyComponentTest2004052217.py into the uno_components folder of your "user" folder.

The user folder on Windows is probably the folder named "user" under your OOo installation.
The user folder on Linux is contained within a folder in your home directory with a name like OpenOffice.org1.1.1.
(Note on Linux, be sure that when you copy the python program that it has no carriage returns, but instead has unix linefeeds. Otherwise the component will not install properly!)

(New edit 2005-03-28: It may in fact be important now on ALL platforms to make sure that the ".py" file of python source has its line endings separated by linefeeds only with NO carriage returns!)

* Be sure that OOo is NOT running.
* Run the command "pkgchk" in your OOo\programs folder.

<source lang=python>
import uno
import unohelper

g_ImplementationHelper = unohelper.ImplementationHelper()

##################################################################
class DannysUnoBaseClass:
cServiceName = ""
tServiceNames = ( cServiceName, )
# stuff to support the XTypeProvider interface.
tInterfaceTypes = (
uno.getTypeByName( "com.sun.star.lang.XServiceName" ),
uno.getTypeByName( "com.sun.star.lang.XServiceInfo" ),
uno.getTypeByName( "com.sun.star.lang.XTypeProvider" ),
)
uuid = uno.generateUuid()

# The component must have a ctor with the component context as argument.
def __init__( self, oContext ):
self.DannysUnoBaseClass_init( oContext )

def DannysUnoBaseClass_init( self, oContext ):
self.oContext = oContext

self.oCoreReflection = None
self.StarDesktop = None
self.getDesktop()

#----------------------------------------
# Danny's stuff to make programming less convenient.
#----------------------------------------

def getServiceManager( self ):
"""Get the ServiceManager from the running OpenOffice.org.
"""
return self.oContext.ServiceManager

def createUnoService( self, cClass ):
"""A handy way to create a global objects within the running OOo.
"""
oServiceManager = self.getServiceManager()
oObj = oServiceManager.createInstance( cClass )
return oObj

def getDesktop( self ):
"""An easy way to obtain the Desktop object from a running OOo.
"""
if self.StarDesktop == None:
self.StarDesktop = self.createUnoService( "com.sun.star.frame.Desktop" )
return self.StarDesktop

def getCoreReflection( self ):
if self.oCoreReflection == None:
self.oCoreReflection = self.createUnoService( "com.sun.star.reflection.CoreReflection" )
return oCoreReflection

def createUnoStruct( self, cTypeName ):
"""Create a UNO struct and return it.
"""
oCoreReflection = self.getCoreReflection()

# Get the IDL class for the type name
oXIdlClass = oCoreReflection.forName( cTypeName )

# Create the struct.
oReturnValue, oStruct = oXIdlClass.createObject( None )

return oStruct

def makePropertyValue( self, cName=None, uValue=None, nHandle=None, nState=None ):
"""Create a com.sun.star.beans.PropertyValue struct and return it.
"""
oPropertyValue = self.createUnoStruct( "com.sun.star.beans.PropertyValue" )

if cName != None:
oPropertyValue.Name = cName
if uValue != None:
oPropertyValue.Value = uValue
if nHandle != None:
oPropertyValue.Handle = nHandle
if nState != None:
oPropertyValue.State = nState

return oPropertyValue

#----------------------------------------
# Interface: XServiceName
#----------------------------------------

# string
# getServiceName();
def getServiceName( self ):
return self.cServiceName

#----------------------------------------
# Interface: XServiceInfo
#----------------------------------------

# string
# getImplementationName();
def getImplementationName( self ):
return self.cServiceName

# boolean
# supportsService( [in] string ServiceName );
def supportsService( self, cServiceName ):
return cServiceName in self.getSupportedServiceNames()

# sequence< string >
# getSupportedServiceNames();
def getSupportedServiceNames( self ):
return self.tServiceNames

#----------------------------------------
# Interface: XTypeProvider
#----------------------------------------

# sequence< type >
# getTypes();
def getTypes( self ):
#if self.tInterfaceTypes == None:
# self.tInterfaceTypes = ()
# for cTypeName in self.tInterfaces:
# self.tInterfaceTypes += ( uno.getTypeByName( cTypeName ), )
return self.tInterfaceTypes

# sequence< byte >
# getImplementationId();
def getImplementationId( self ):
return self.uuid

##################################################################
from com.sun.star.lang import IndexOutOfBoundsException

class IndexContainer( DannysUnoBaseClass ):
cServiceName = "name.dannyBrewer.util.IndexContainer"
tServiceNames = ( cServiceName, )
tInterfaceTypes = DannysUnoBaseClass.tInterfaceTypes + (
uno.getTypeByName( "com.sun.star.container.XIndexContainer" ),
uno.getTypeByName( "com.sun.star.container.XIndexReplace" ),
uno.getTypeByName( "com.sun.star.container.XIndexAccess" ),
uno.getTypeByName( "com.sun.star.container.XElementAccess" ),
)

# The component must have a ctor with the component context as argument.
def __init__( self, oContext ):
# Initialize the base class!
self.DannysUnoBaseClass_init( oContext )
# This is the list of items in the IndexContainer.
self.items = []

#----------------------------------------
# Interface: com.sun.star.container.XIndexContainer
#----------------------------------------

# void
# insertByIndex( [in] long nIndex,
# [in] any uElement );
def insertByIndex( self, nIndex, uElement ):
if nIndex < 0:
raise IndexOutOfBoundsException(
"""You specified an index that was less than zero.
""", self )
nItems = len( self.items )
if nIndex > nItems:
raise IndexOutOfBoundsException(
"""You specified an index that was greater than the last item in the container.
Since there are """ + str( nItems ) + """ items in the container, you must specify an
insert index that is from zero to """ + str( nItems ) + """.
""", self )
if nIndex == nItems:
self.items += [uElement]
return
self.items = self.items[0:nIndex] + [uElement] + self.items[nIndex:]

# void
# removeByIndex( [in] long nIndex );
def removeByIndex( self, nIndex ):
if nIndex < 0:
raise IndexOutOfBoundsException(
"""You specified an index that was less than zero.
""", self )
nItems = len( self.items )
if nIndex > nItems:
raise IndexOutOfBoundsException(
"""You specified an index that was greater than or equal to the last item in the container.
Since there are """ + str( nItems ) + """ items in the container, you must specify an
insert index that is from zero to """ + str( nItems-1 ) + """.
""", self )
self.items = self.items[0:nIndex] + self.items[nIndex+1:]

#----------------------------------------
# Interface: com.sun.star.container.XIndexReplace
#----------------------------------------

# void
# replaceByIndex( [in] long nIndes,
# [in] any uElement );
def replaceByIndex( self, nIndex, uElement ):
if nIndex < 0:
raise IndexOutOfBoundsException(
"""You specified an index that was less than zero.
""", self )
nItems = len( self.items )
if nIndex > nItems:
raise IndexOutOfBoundsException(
"""You specified an index that was greater than or equal to the last item in the container.
Since there are """ + str( nItems ) + """ items in the container, you must specify an
insert index that is from zero to """ + str( nItems-1 ) + """.
""", self )
self.items = self.items[0:nIndex] + [uElement] + self.items[nIndex+1:]

#----------------------------------------
# Interface: com.sun.star.container.XIndexAccess
#----------------------------------------

# long
# getCount();
def getCount( self ):
return len( self.items )

# any
# getByIndex( [in] long nIndex );
def getByIndex( self, nIndex ):
if nIndex < 0:
raise IndexOutOfBoundsException(
"""You specified an index that was less than zero.
""", self )
nItems = len( self.items )
if nIndex > nItems:
raise IndexOutOfBoundsException(
"""You specified an index that was greater than or equal to the last item in the container.
Since there are """ + str( nItems ) + """ items in the container, you must specify an
insert index that is from zero to """ + str( nItems-1 ) + """.
""", self )
return self.items[ nIndex ]

#----------------------------------------
# Interface: com.sun.star.container.XElementAccess
#----------------------------------------

# type
# getElementType();
def getElementType( self ):
return None

# boolean
# hasElements();
def hasElements( self ):
return len( self.items ) > 0

# Add the class to the implementation container,
# which the loader uses to register/instantiate the component.
g_ImplementationHelper.addImplementation(
# The class
IndexContainer,
# The implementation name.
# Change this name for your own service.
IndexContainer.cServiceName,
# A list of services that that are implemented.
IndexContainer.tServiceNames,
)

##################################################################
from com.sun.star.lang import IndexOutOfBoundsException
from com.sun.star.container import ElementExistException
from com.sun.star.container import NoSuchElementException

class NameContainer( DannysUnoBaseClass ):
cServiceName = "name.dannyBrewer.util.NameContainer"
tServiceNames = ( cServiceName, )
tInterfaceTypes = DannysUnoBaseClass.tInterfaceTypes + (
uno.getTypeByName( "com.sun.star.container.XNameContainer" ),
uno.getTypeByName( "com.sun.star.container.XNameReplace" ),
uno.getTypeByName( "com.sun.star.container.XNameAccess" ),
uno.getTypeByName( "com.sun.star.container.XIndexAccess" ),
uno.getTypeByName( "com.sun.star.container.XElementAccess" ),
)

# The component must have a ctor with the component context as argument.
def __init__( self, oContext ):
# Initialize the base class!
self.DannysUnoBaseClass_init( oContext )
# This is the dictionary of items in the NameContainer.
self.items = {}

#----------------------------------------
# Interface: com.sun.star.container.XNameContainer
#----------------------------------------

# void
# insertByName( [in] string cName,
# [in] any uElement );
def insertByName( self, cName, uElement ):
if self.items.has_key( cName ):
raise ElementExistException(
"""You specified an element name of \"""" + cName + """\"
which is already present in the container.
""", self )
self.items[ cName ] = uElement

# void
# removeByName( [in] string cName );
def removeByName( self, cName ):
if not self.items.has_key( cName ):
raise NoSuchElementException(
"""You specified an element name of \"""" + cName + """\"
which does not exist in the container.
""", self )
del self.items[ cName ]

#----------------------------------------
# Interface: com.sun.star.container.XNameReplace
#----------------------------------------

# void
# replaceByName( [in] string cName,
# [in] any uElement );
def replaceByName( self, cName, uElement ):
if not self.items.has_key( cName ):
raise NoSuchElementException(
"""You specified an element name of \"""" + cName + """\"
which does not exist in the container.
""", self )
self.items[ cName ] = uElement

#----------------------------------------
# Interface: com.sun.star.container.XNameAccess
#----------------------------------------

# any
# getByName( [in] string cName );
def getByName( self, cName ):
if not self.items.has_key( cName ):
raise NoSuchElementException(
"""You specified an element name of \"""" + cName + """\"
which does not exist in the container.
""", self )
return self.items[ cName ]

# boolean
# hasByName( [in] string cName );
def hasByName( self, cName ):
return self.items.has_key( cName )

# sequence< string >
# getElementNames();
def getElementNames( self ):
ret = ()
for item in self.items.keys():
ret += ( item, )
return ret

#----------------------------------------
# Interface: com.sun.star.container.XIndexAccess
#----------------------------------------

# long
# getCount();
def getCount( self ):
return len( self.items )

# any
# getByIndex( [in] long nIndex );
def getByIndex( self, nIndex ):
if nIndex < 0:
raise IndexOutOfBoundsException(
"""You specified an index that was less than zero.
""", self )
nItems = len( self.items )
if nIndex > nItems:
raise IndexOutOfBoundsException(
"""You specified an index that was greater than or equal to the last item in the container.
Since there are """ + str( nItems ) + """ items in the container, you must specify an
insert index that is from zero to """ + str( nItems-1 ) + """.
""", self )
return self.items.values()[ nIndex ]

#----------------------------------------
# Interface: com.sun.star.container.XElementAccess
#----------------------------------------

# type
# getElementType();
def getElementType( self ):
return None

# boolean
# hasElements();
def hasElements( self ):
return len( self.items ) > 0

# Add the class to the implementation container,
# which the loader uses to register/instantiate the component.
g_ImplementationHelper.addImplementation(
# The class
NameContainer,
# The implementation name.
# Change this name for your own service.
NameContainer.cServiceName,
# A list of services that that are implemented.
NameContainer.tServiceNames,
)
</source>

Python-Calc

2015-02-17T16:39:11Z

JZA: /* Underline each Nth row of cells */

This code was originally written on the oooforum, you can reach it [http://www.oooforum.org/forum/viewtopic.phtml?p=55393#55393 here]. The code was somewhat broken down into different areas so the reader can understand each step.

The intend of the code is to:
# Create a new spreadsheet
# Open an existing spreadsheet
# Insert strings inito a cell
# Insert formulas into a cell
# Insert graphs to a range

<source lang=python>

from Danny.OOo.OOoLib import *

def CalcExample():
# create a new Calc spreadsheet.
oDoc = StarDesktop.loadComponentFromURL( "private:factory/scalc", "_blank", 0, Array() )
#-----
# Use this instead to open an EXISTING calc document,
# and assign it to variable oDoc.
# cFile = "C:\Documents and Settings\danny\Desktop\MyCalc" # Windows
# cFile = "/home/danny/Desktop/MyCalc.sxc" # Linux
# cURL = convertToURL( cFile + ".sxc" )
# oDoc = StarDesktop.loadComponentFromURL( cURL, "_blank", 0, Array() )
#-----

# Here are two ways to get access to one of the various sheets
# in the spreadsheet document.
# Note that these don't make the sheet *vislble*, they merely give
# access to the sheet's content within the program.
oSheet = oDoc.getSheets().getByIndex( 0 ) # get the zero'th sheet
#oSheet = oDoc.getSheets().getByName( "Sheet3" ) # get by name

#-----
# Put some sales figures onto the sheet.
oSheet.getCellByPosition( 0, 0 ).setString( "Month" )
oSheet.getCellByPosition( 1, 0 ).setString( "Sales" )
oSheet.getCellByPosition( 2, 0 ).setString( "End Date" )

oSheet.getCellByPosition( 0, 1 ).setString( "Jan" )
oSheet.getCellByPosition( 0, 2 ).setString( "Feb" )
oSheet.getCellByPosition( 0, 3 ).setString( "Mar" )
oSheet.getCellByPosition( 0, 4 ).setString( "Apr" )
oSheet.getCellByPosition( 0, 5 ).setString( "May" )
oSheet.getCellByPosition( 0, 6 ).setString( "Jun" )
oSheet.getCellByPosition( 0, 7 ).setString( "Jul" )
oSheet.getCellByPosition( 0, 8 ).setString( "Aug" )
oSheet.getCellByPosition( 0, 9 ).setString( "Sep" )
oSheet.getCellByPosition( 0, 10 ).setString( "Oct" )
oSheet.getCellByPosition( 0, 11 ).setString( "Nov" )
oSheet.getCellByPosition( 0, 12 ).setString( "Dec" )

oSheet.getCellByPosition( 1, 1 ).setValue( 3826.37 )
oSheet.getCellByPosition( 1, 2 ).setValue( 3504.21 )
oSheet.getCellByPosition( 1, 3 ).setValue( 2961.45 )
oSheet.getCellByPosition( 1, 4 ).setValue( 2504.12 )
oSheet.getCellByPosition( 1, 5 ).setValue( 2713.98 )
oSheet.getCellByPosition( 1, 6 ).setValue( 2248.17 )
oSheet.getCellByPosition( 1, 7 ).setValue( 1802.13 )
oSheet.getCellByPosition( 1, 8 ).setValue( 2003.22 )
oSheet.getCellByPosition( 1, 9 ).setValue( 1502.54 )
oSheet.getCellByPosition( 1, 10 ).setValue( 1207.68 )
oSheet.getCellByPosition( 1, 11 ).setValue( 1319.71 )
oSheet.getCellByPosition( 1, 12 ).setValue( 786.03 )

oSheet.getCellByPosition( 2, 1 ).setFormula( "=DATE(2004;01;31)" )
oSheet.getCellByPosition( 2, 2 ).setFormula( "=DATE(2004;02;29)" )
oSheet.getCellByPosition( 2, 3 ).setFormula( "=DATE(2004;03;31)" )
oSheet.getCellByPosition( 2, 4 ).setFormula( "=DATE(2004;04;30)" )
oSheet.getCellByPosition( 2, 5 ).setFormula( "=DATE(2004;05;31)" )
oSheet.getCellByPosition( 2, 6 ).setFormula( "=DATE(2004;06;30)" )
oSheet.getCellByPosition( 2, 7 ).setFormula( "=DATE(2004;07;31)" )
oSheet.getCellByPosition( 2, 8 ).setFormula( "=DATE(2004;08;31)" )
oSheet.getCellByPosition( 2, 9 ).setFormula( "=DATE(2004;09;30)" )
# Note that these last three dates are not set as DATE() function calls.
oSheet.getCellByPosition( 2, 10 ).setFormula( "10/31/2004" )
oSheet.getCellByPosition( 2, 11 ).setFormula( "11/30/2004" )
oSheet.getCellRangeByName( "C13" ).setFormula( "12/31/2004" )
#-----

#-----
# Format the date cells as dates.
com_sun_star_util_NumberFormat_DATE = uno.getConstantByName( "com.sun.star.util.NumberFormat.DATE" )
oFormats = oDoc.getNumberFormats()
oLocale = createUnoStruct( "com.sun.star.lang.Locale" )
nDateKey = oFormats.getStandardFormat( com_sun_star_util_NumberFormat_DATE, oLocale )
oCell = oSheet.getCellRangeByName( "C2:C13" )
oCell.NumberFormat = nDateKey
#-----

#-----
# Now add a chart to the spreadsheet.

oCellRangeAddress = oSheet.getCellRangeByName( "A1:B13" ).getRangeAddress()
# oCellRangeAddress = MakeCellRangeAddress( 0, 0, 1, 1, 12 )
# Get the collection of charts from the sheet.
oCharts = oSheet.getCharts()
# Add a new chart with a specific name,
# in a specific rectangle on the drawing page,
# and connected to specific cells of the spreadsheet.
oCharts.addNewByName( "Sales",
makeRectangle( 8000, 1000, 16000, 10000 ),
Array( oCellRangeAddress ),
True, True )
# From the collection of charts, get the new chart we just created.
oChart = oCharts.getByName( "Sales" )
# Get the chart document model.
oChartDoc = oChart.getEmbeddedObject()

# Get the drawing text shape of the title of the chart.
oTitleTextShape = oChartDoc.getTitle()
# Change the title.
oTitleTextShape.String = "Sales Chart"

# Create a diagram.
oDiagram = oChartDoc.createInstance( "com.sun.star.chart.BarDiagram" )
# Set its parameters.
oDiagram.Vertical = True
# Make the chart use this diagram.
oChartDoc.setDiagram( oDiagram )

# Ask the chart what diagram it is using.
# (Unnecessary, since variable oDiagram already contains this value.)
oDiagram = oChartDoc.getDiagram()
# Make more changes to the diagram.
oDiagram.DataCaption = uno.getConstantByName( "com.sun.star.chart.ChartDataCaption.VALUE" )
oDiagram.DataRowSource = uno.getConstantByName( "com.sun.star.chart.ChartDataRowSource.COLUMNS" )
#
#-----

#-----
# Now demonstrate how to manipulate the sheets.

# Insert six more sheets into the document.
nNumSheetsCurrently = oDoc.getSheets().getCount()
oDoc.getSheets().insertNewByName( "Fred", nNumSheetsCurrently+1 )
oDoc.getSheets().insertNewByName( "Joe", nNumSheetsCurrently+2 )
oDoc.getSheets().insertNewByName( "Bill", nNumSheetsCurrently+3 )
oDoc.getSheets().insertNewByName( "Sam", nNumSheetsCurrently+4 )
oDoc.getSheets().insertNewByName( "Tom", nNumSheetsCurrently+5 )
oDoc.getSheets().insertNewByName( "David", nNumSheetsCurrently+6 )
# Now find a sheet named "Sheet2" and get rid of it.
oDoc.getSheets().removeByName( "Sheet2" )
# Now find the sheet named "Sam" and change its name to "Sheet 37"
oDoc.getSheets().getByName( "Sam" ).Name = "Sheet 37"
#
#-----

#-------
# Now print the document -- three different ways.

# Technique 1.
# Now print the document.
# Print two copies.
# Print pages 1 thru 4, and also page 10.
#
# NOTE: we would do it like this, except the word "print"
# has a special meaning in python, and cannot be invoked
# as a method.
#oDoc.print(
# Array(
# makePropertyValue( "CopyCount", 2 ),
# makePropertyValue( "Pages", "1-4;10" ) ) )
uno.invoke( oDoc, "print", ( Array(
makePropertyValue( "CopyCount", 2 ),
makePropertyValue( "Pages", "1-4;10" ) ), ) )

# Technique 2.
# Print the document already, without any arguments.
uno.invoke( oDoc, "print", ( Array(), ) )
#oDoc.print( Array() )

# Using technique 1 or 2, be sure not to close the document
# until printing is completed.
# http://www.oooforum.org/forum/viewtopic.php?p=23144#23144

# Technique 3.
# Print the document by bringing up the Print Job dialog box
# for the user to interact with.
oDocFrame = oDoc.getCurrentController().getFrame()
oDispatchHelper = createUnoService( "com.sun.star.frame.DispatchHelper" )
oDispatchHelper.executeDispatch( oDocFrame, ".uno:Print", "", 0, Array() )
# To learn some more about the dispatcher, see these articles...
# http://www.oooforum.org/forum/viewtopic.php?t=5058
# http://www.oooforum.org/forum/viewtopic.php?t=5057

#
#-------

#-------
# Now save the document

# Prepare the filename to save.
# We're going to save the file in several different formats,
# but all based on the same filename.
cFile = "C:\Documents and Settings\dbrewer\Desktop\MyCalc" # Windows
#cFile = "/home/danny/Desktop/MyCalc.sxc" # Linux

# Now save the spreadsheet in native OOo Calc format.
cURL = convertToURL( cFile + ".sxc" )
oDoc.storeAsURL( cURL, Array() )

# Note the above used storeAsUrl,
# the following use storeToUrl.

# Now save it in Excel format.
cURL = convertToURL( cFile + ".xls" )
oDoc.storeToURL( cURL, Array( makePropertyValue( "FilterName", "MS Excel 97" ) ) )

# Now save a PDF.
cURL = convertToURL( cFile + ".pdf" )
oDoc.storeToURL( cURL, Array( makePropertyValue( "FilterName", "calc_pdf_Export" ) ) )

# Now save it in CSV format.
cURL = convertToURL( cFile + ".csv" )
oDoc.storeToURL( cURL, Array( makePropertyValue( "FilterName", "Text - txt - csv (StarCalc)" ) ) )

# Now save it in DIF format.
cURL = convertToURL( cFile + ".dif" )
oDoc.storeToURL( cURL, Array( makePropertyValue( "FilterName", "DIF" ) ) )

# Now save it in SYLK format.
cURL = convertToURL( cFile + ".sylk" )
oDoc.storeToURL( cURL, Array( makePropertyValue( "FilterName", "SYLK" ) ) )

# Now save as HTML.
cURL = convertToURL( cFile + ".html" )
oDoc.storeToURL( cURL, Array( makePropertyValue( "FilterName", "HTML (StarCalc)" ) ) )

# A list of some filter names you can use for both loading
# and saving a document can be found here...
# http://www.oooforum.org/forum/viewtopic.php?t=3549

#
#-------

#-------
# Now close the document
oDoc.close( True )
#-------

# import Danny.OOo.Examples.CalcExamples
# reload( Danny.OOo.Examples.CalcExamples ); from Danny.OOo.Examples.CalcExamples import *

# CalcExample()

</source>

This code can be greatly enhanced, if you want to provide a better version of the code, please edit it and notify me for feedback. [[User:JZA|JZA]] ([[User talk:JZA|talk]])

== Set the font size of text in a spreadsheet ==
Here is an example of how to set the font size of text in a spreadsheet cell.
<source lang=python>
Sub Main
' Get this spreadsheet document
oDoc = ThisComponent
' Get the first sheet.
oSheet = oDoc.getSheets().getByIndex( 0 )
' Get cell A1
oCell = oSheet.getCellByPosition( 0, 0 )

' Put some text into the cell.
oCell.setString( "This is a test" )

' Get the cell's Text.
' You can do many things with this text, like you can do with Writer text.
oText = oCell.getText()
' Get a cursor on the text.
oCursor = oText.createTextCursor()

' Select ALL of the text.
oCursor.gotoStart( False ) ' goto start of text
oCursor.gotoEnd( True ) ' goto end of text while holding down SHIFT key
' Change selected char's height
oCursor.CharHeight = 34

' Select the first four characters
oCursor.gotoStart( False ) ' goto start of text
oCursor.goRight( 4, True ) ' go right 4 chars, holding down SHIFT key
' Change selected char's height
oCursor.CharHeight = 27
End Sub
</source>
If all of the text is of uniform size, and you want to increase the size of the entire text cell, then simply do....

<source lang=python>
Sub Main
' Get this spreadsheet document
oDoc = ThisComponent
' Get the first sheet.
oSheet = oDoc.getSheets().getByIndex( 0 )
' Get cell A1
oCell = oSheet.getCellByPosition( 0, 0 )

' Get the cell's Text.
' You can do many things with this text, like you can do with Writer text.
oText = oCell.getText()
' Get a cursor on the text.
oCursor = oText.createTextCursor()

' Select ALL of the text.
oCursor.gotoStart( False ) ' goto start of text
oCursor.gotoEnd( True ) ' goto end of text while holding down SHIFT key
' Change selected char's height
oCursor.CharHeight = oCursor.CharHeight + 1
End Sub

</source>
== Underline each Nth row of cells ==
Underline a row of cells, every Nth row, by setting the cell border bottom and Adjust the column widths of a certain range of columns.

<source lang="oobas">
Sub Main

' Create a new document.
oDoc = StarDesktop.loadComponentFromURL( "private:factory/scalc", "_blank", 0, Array() )
' Alternative: Use document that this macro is embedded into.
'oDoc = ThisComponent
' Alternative: Load document from disk
' CHANGE ME
'cFile = "C:\Documents and Settings\dbrewer\Desktop\Something.sxc" ' for Windows
'cFile = "/home/danny/Desktop/Something.sxc" ' for Linux
'cUrl = ConvertToUrl( cFile )
'oDoc = StarDesktop.loadComponentFromURL( cUrl, "_blank", 0, Array() )

' Get first sheet of the document -- the zero'th sheet.
oSheet = oDoc.getSheets().getByIndex( 0 )

UnderlineRows( oSheet )
AdjustColumnWidths( oSheet )
End Sub

' Pass in a single sheet of a spreadsheet document.
' This will create borders that underline certain cells.
Sub UnderlineRows( oSheet )
'-----
' CHANGE ME
' CHANGE ME
' You could turn these local variables into parameters.
nUnderlineFirstRow = 9
nUnderlineSkipRows = 4
nUnderlineLastRow = 50
cUnderlineFirstColumn = "A"
cUnderlineLastColumn = "I"

'nBorderColor = RGB( 0, 0, 0 ) ' Black
nBorderColor = RGB( 255, 200, 200 ) ' Pink

nInnerBorderWidth = 0 ' in 1000'th of cm
'nOuterBorderWidth = 75 ' in 1000'th of cm, means 0.075 cm width
nOuterBorderWidth = 1/32 * 2540 ' 1/32 inch (2.54 cm = 1 inch)
'-----

nRow = nUnderlineFirstRow
Do While nRow <= nUnderlineLastRow
' Form a string such as... "A19:I19"
cCellRangeName = cUnderlineFirstColumn + CSTR( nRow ) _
+ ":" + cUnderlineLastColumn + CSTR( nRow )

' Get the range of cells whose border is to be adjusted.
oCellRange = oSheet.getCellRangeByName( cCellRangeName )

'oCellRange.LeftBorder = MakeCellBorderLine( nBorderColor, nInnerBorderWidth, nOuterBorderWidth, 0 )
'oCellRange.RightBorder = MakeCellBorderLine( nBorderColor, nInnerBorderWidth, nOuterBorderWidth, 0 )
'oCellRange.TopBorder = MakeCellBorderLine( nBorderColor, nInnerBorderWidth, nOuterBorderWidth, 0 )
oCellRange.BottomBorder = MakeCellBorderLine( nBorderColor, nInnerBorderWidth, nOuterBorderWidth, 0 )

nRow = nRow + nUnderlineSkipRows
Loop
End Sub

' Pass in a single sheet of a spreadsheet document.
' This will set the column widths of certain cells.
Sub AdjustColumnWidths( oSheet )
'-----
' CHANGE ME
' CHANGE ME
' You could turn these local variables into parameters.
cFirstColumn = "A"
cLastColumn = "I"
'-----

' Turn the column names into column numbers.
nFirstColumn = CalcColumnNameToNumber( oSheet, cFirstColumn )
nLastColumn = CalcColumnNameToNumber( oSheet, cLastColumn )

' Get the collection of all columns on the sheet.
oColumns = oSheet.getColumns()

' Loop over each column...
For nCol = nFirstColumn To nLastColumn
' Get a single column
oColumn = oColumns.getByIndex( nCol )

' Change column width
oColumn.Width = 2.5 * 2540 ' 2.5 inches * 2.54 cm / inch.
Next
End Sub

Function MakeCellBorderLine( nColor, nInnerLineWidth, nOuterLineWidth, nLineDistance ) _
As com.sun.star.table.BorderLine
oBorderLine = createUnoStruct( "com.sun.star.table.BorderLine" )
With oBorderLine
.Color = nColor

.InnerLineWidth = nInnerLineWidth
.OuterLineWidth = nOuterLineWidth
.LineDistance = nLineDistance
End With
MakeCellBorderLine = oBorderLine
End Function

Function CalcColumnNameToNumber( oSheet As com.sun.star.sheet.Spreadsheet,_
cColumnName As String ) As Long
oColumns = oSheet.getColumns()
oColumn = oColumns.getByName( cColumnName )
oRangeAddress = oColumn.getRangeAddress()
nColumn = oRangeAddress.StartColumn
CalcColumnNameToNumber() = nColumn
End Function

</source>

== Take data from a Writer's table and insert in Calc ==
This code tries to do as mentioned, extract a table data from Writer and insert it in a Calc document.

<source lang=python>
Sub Main
' Work with the writer document that this macro is embedded into.
oWriterDoc = ThisComponent

' Get the collection of tables from the Writer doc.
oWriterTables = oWriterDoc.getTextTables()

' Get the table named FooBar.
' Each table has a name. We want the table named FooBar.
' To see or change the name of a table, first click in the table,
' then Format-->Table, pick the Table tab, and adjust the Name.
oWriterTable = oWriterTables.getByName( "FooBar" )

' Find out how many Rows and Columns the table has.
nRows = oWriterTable.getRows().getCount()
nCols = oWriterTable.getColumns().getCount()

' Create a new Calc spreadsheet.
oCalcDoc = StarDesktop.loadComponentFromURL( "private:factory/scalc", "_blank", 0, Array() )

' Get the first sheet of the document.
oSheet = oCalcDoc.getSheets().getByIndex( 0 )
' oSheet = oCalcDoc.getSheets().getByName( "Sheet1" ) ' an alternate way to get by name

' Determine where we are going to insert the data from the Writer table.
nFirstRow = 6
nFirstCol = 2

' Copy the data, row by row, column by column
For nRow = 0 To nRows-1
For nCol = 0 To nCols-1
oWriterCell = oWriterTable.getCellByPosition( nCol, nRow )
oCalcCell = oSheet.getCellByPosition( nCol+nFirstCol, nRow+nFirstRow )

' If the cell has a formula, then copy that...
If oWriterCell.getFormula() <> "" Then
oCalcCell.setFormula( oWriterCell.getFormula() )

' If the cell has a non-zero numeric value, then copy that...
ElseIf oWriterCell.getValue() <> 0 Then
oCalcCell.setValue( oWriterCell.getValue() )
' Question... what if the cell is numeric, but zero?
ElseIf oWriterCell.getString() = "0" Then
oCalcCell.setValue( oWriterCell.getValue() )

Else
oCalcCell.setString( oWriterCell.getString() )
EndIf
Next
Next
End Sub
</source>

Python-Calc

2015-02-17T16:35:41Z

JZA: /* Underline each Nth row of cells */

This code was originally written on the oooforum, you can reach it [http://www.oooforum.org/forum/viewtopic.phtml?p=55393#55393 here]. The code was somewhat broken down into different areas so the reader can understand each step.

The intend of the code is to:
# Create a new spreadsheet
# Open an existing spreadsheet
# Insert strings inito a cell
# Insert formulas into a cell
# Insert graphs to a range

<source lang=python>

from Danny.OOo.OOoLib import *

def CalcExample():
# create a new Calc spreadsheet.
oDoc = StarDesktop.loadComponentFromURL( "private:factory/scalc", "_blank", 0, Array() )
#-----
# Use this instead to open an EXISTING calc document,
# and assign it to variable oDoc.
# cFile = "C:\Documents and Settings\danny\Desktop\MyCalc" # Windows
# cFile = "/home/danny/Desktop/MyCalc.sxc" # Linux
# cURL = convertToURL( cFile + ".sxc" )
# oDoc = StarDesktop.loadComponentFromURL( cURL, "_blank", 0, Array() )
#-----

# Here are two ways to get access to one of the various sheets
# in the spreadsheet document.
# Note that these don't make the sheet *vislble*, they merely give
# access to the sheet's content within the program.
oSheet = oDoc.getSheets().getByIndex( 0 ) # get the zero'th sheet
#oSheet = oDoc.getSheets().getByName( "Sheet3" ) # get by name

#-----
# Put some sales figures onto the sheet.
oSheet.getCellByPosition( 0, 0 ).setString( "Month" )
oSheet.getCellByPosition( 1, 0 ).setString( "Sales" )
oSheet.getCellByPosition( 2, 0 ).setString( "End Date" )

oSheet.getCellByPosition( 0, 1 ).setString( "Jan" )
oSheet.getCellByPosition( 0, 2 ).setString( "Feb" )
oSheet.getCellByPosition( 0, 3 ).setString( "Mar" )
oSheet.getCellByPosition( 0, 4 ).setString( "Apr" )
oSheet.getCellByPosition( 0, 5 ).setString( "May" )
oSheet.getCellByPosition( 0, 6 ).setString( "Jun" )
oSheet.getCellByPosition( 0, 7 ).setString( "Jul" )
oSheet.getCellByPosition( 0, 8 ).setString( "Aug" )
oSheet.getCellByPosition( 0, 9 ).setString( "Sep" )
oSheet.getCellByPosition( 0, 10 ).setString( "Oct" )
oSheet.getCellByPosition( 0, 11 ).setString( "Nov" )
oSheet.getCellByPosition( 0, 12 ).setString( "Dec" )

oSheet.getCellByPosition( 1, 1 ).setValue( 3826.37 )
oSheet.getCellByPosition( 1, 2 ).setValue( 3504.21 )
oSheet.getCellByPosition( 1, 3 ).setValue( 2961.45 )
oSheet.getCellByPosition( 1, 4 ).setValue( 2504.12 )
oSheet.getCellByPosition( 1, 5 ).setValue( 2713.98 )
oSheet.getCellByPosition( 1, 6 ).setValue( 2248.17 )
oSheet.getCellByPosition( 1, 7 ).setValue( 1802.13 )
oSheet.getCellByPosition( 1, 8 ).setValue( 2003.22 )
oSheet.getCellByPosition( 1, 9 ).setValue( 1502.54 )
oSheet.getCellByPosition( 1, 10 ).setValue( 1207.68 )
oSheet.getCellByPosition( 1, 11 ).setValue( 1319.71 )
oSheet.getCellByPosition( 1, 12 ).setValue( 786.03 )

oSheet.getCellByPosition( 2, 1 ).setFormula( "=DATE(2004;01;31)" )
oSheet.getCellByPosition( 2, 2 ).setFormula( "=DATE(2004;02;29)" )
oSheet.getCellByPosition( 2, 3 ).setFormula( "=DATE(2004;03;31)" )
oSheet.getCellByPosition( 2, 4 ).setFormula( "=DATE(2004;04;30)" )
oSheet.getCellByPosition( 2, 5 ).setFormula( "=DATE(2004;05;31)" )
oSheet.getCellByPosition( 2, 6 ).setFormula( "=DATE(2004;06;30)" )
oSheet.getCellByPosition( 2, 7 ).setFormula( "=DATE(2004;07;31)" )
oSheet.getCellByPosition( 2, 8 ).setFormula( "=DATE(2004;08;31)" )
oSheet.getCellByPosition( 2, 9 ).setFormula( "=DATE(2004;09;30)" )
# Note that these last three dates are not set as DATE() function calls.
oSheet.getCellByPosition( 2, 10 ).setFormula( "10/31/2004" )
oSheet.getCellByPosition( 2, 11 ).setFormula( "11/30/2004" )
oSheet.getCellRangeByName( "C13" ).setFormula( "12/31/2004" )
#-----

#-----
# Format the date cells as dates.
com_sun_star_util_NumberFormat_DATE = uno.getConstantByName( "com.sun.star.util.NumberFormat.DATE" )
oFormats = oDoc.getNumberFormats()
oLocale = createUnoStruct( "com.sun.star.lang.Locale" )
nDateKey = oFormats.getStandardFormat( com_sun_star_util_NumberFormat_DATE, oLocale )
oCell = oSheet.getCellRangeByName( "C2:C13" )
oCell.NumberFormat = nDateKey
#-----

#-----
# Now add a chart to the spreadsheet.

oCellRangeAddress = oSheet.getCellRangeByName( "A1:B13" ).getRangeAddress()
# oCellRangeAddress = MakeCellRangeAddress( 0, 0, 1, 1, 12 )
# Get the collection of charts from the sheet.
oCharts = oSheet.getCharts()
# Add a new chart with a specific name,
# in a specific rectangle on the drawing page,
# and connected to specific cells of the spreadsheet.
oCharts.addNewByName( "Sales",
makeRectangle( 8000, 1000, 16000, 10000 ),
Array( oCellRangeAddress ),
True, True )
# From the collection of charts, get the new chart we just created.
oChart = oCharts.getByName( "Sales" )
# Get the chart document model.
oChartDoc = oChart.getEmbeddedObject()

# Get the drawing text shape of the title of the chart.
oTitleTextShape = oChartDoc.getTitle()
# Change the title.
oTitleTextShape.String = "Sales Chart"

# Create a diagram.
oDiagram = oChartDoc.createInstance( "com.sun.star.chart.BarDiagram" )
# Set its parameters.
oDiagram.Vertical = True
# Make the chart use this diagram.
oChartDoc.setDiagram( oDiagram )

# Ask the chart what diagram it is using.
# (Unnecessary, since variable oDiagram already contains this value.)
oDiagram = oChartDoc.getDiagram()
# Make more changes to the diagram.
oDiagram.DataCaption = uno.getConstantByName( "com.sun.star.chart.ChartDataCaption.VALUE" )
oDiagram.DataRowSource = uno.getConstantByName( "com.sun.star.chart.ChartDataRowSource.COLUMNS" )
#
#-----

#-----
# Now demonstrate how to manipulate the sheets.

# Insert six more sheets into the document.
nNumSheetsCurrently = oDoc.getSheets().getCount()
oDoc.getSheets().insertNewByName( "Fred", nNumSheetsCurrently+1 )
oDoc.getSheets().insertNewByName( "Joe", nNumSheetsCurrently+2 )
oDoc.getSheets().insertNewByName( "Bill", nNumSheetsCurrently+3 )
oDoc.getSheets().insertNewByName( "Sam", nNumSheetsCurrently+4 )
oDoc.getSheets().insertNewByName( "Tom", nNumSheetsCurrently+5 )
oDoc.getSheets().insertNewByName( "David", nNumSheetsCurrently+6 )
# Now find a sheet named "Sheet2" and get rid of it.
oDoc.getSheets().removeByName( "Sheet2" )
# Now find the sheet named "Sam" and change its name to "Sheet 37"
oDoc.getSheets().getByName( "Sam" ).Name = "Sheet 37"
#
#-----

#-------
# Now print the document -- three different ways.

# Technique 1.
# Now print the document.
# Print two copies.
# Print pages 1 thru 4, and also page 10.
#
# NOTE: we would do it like this, except the word "print"
# has a special meaning in python, and cannot be invoked
# as a method.
#oDoc.print(
# Array(
# makePropertyValue( "CopyCount", 2 ),
# makePropertyValue( "Pages", "1-4;10" ) ) )
uno.invoke( oDoc, "print", ( Array(
makePropertyValue( "CopyCount", 2 ),
makePropertyValue( "Pages", "1-4;10" ) ), ) )

# Technique 2.
# Print the document already, without any arguments.
uno.invoke( oDoc, "print", ( Array(), ) )
#oDoc.print( Array() )

# Using technique 1 or 2, be sure not to close the document
# until printing is completed.
# http://www.oooforum.org/forum/viewtopic.php?p=23144#23144

# Technique 3.
# Print the document by bringing up the Print Job dialog box
# for the user to interact with.
oDocFrame = oDoc.getCurrentController().getFrame()
oDispatchHelper = createUnoService( "com.sun.star.frame.DispatchHelper" )
oDispatchHelper.executeDispatch( oDocFrame, ".uno:Print", "", 0, Array() )
# To learn some more about the dispatcher, see these articles...
# http://www.oooforum.org/forum/viewtopic.php?t=5058
# http://www.oooforum.org/forum/viewtopic.php?t=5057

#
#-------

#-------
# Now save the document

# Prepare the filename to save.
# We're going to save the file in several different formats,
# but all based on the same filename.
cFile = "C:\Documents and Settings\dbrewer\Desktop\MyCalc" # Windows
#cFile = "/home/danny/Desktop/MyCalc.sxc" # Linux

# Now save the spreadsheet in native OOo Calc format.
cURL = convertToURL( cFile + ".sxc" )
oDoc.storeAsURL( cURL, Array() )

# Note the above used storeAsUrl,
# the following use storeToUrl.

# Now save it in Excel format.
cURL = convertToURL( cFile + ".xls" )
oDoc.storeToURL( cURL, Array( makePropertyValue( "FilterName", "MS Excel 97" ) ) )

# Now save a PDF.
cURL = convertToURL( cFile + ".pdf" )
oDoc.storeToURL( cURL, Array( makePropertyValue( "FilterName", "calc_pdf_Export" ) ) )

# Now save it in CSV format.
cURL = convertToURL( cFile + ".csv" )
oDoc.storeToURL( cURL, Array( makePropertyValue( "FilterName", "Text - txt - csv (StarCalc)" ) ) )

# Now save it in DIF format.
cURL = convertToURL( cFile + ".dif" )
oDoc.storeToURL( cURL, Array( makePropertyValue( "FilterName", "DIF" ) ) )

# Now save it in SYLK format.
cURL = convertToURL( cFile + ".sylk" )
oDoc.storeToURL( cURL, Array( makePropertyValue( "FilterName", "SYLK" ) ) )

# Now save as HTML.
cURL = convertToURL( cFile + ".html" )
oDoc.storeToURL( cURL, Array( makePropertyValue( "FilterName", "HTML (StarCalc)" ) ) )

# A list of some filter names you can use for both loading
# and saving a document can be found here...
# http://www.oooforum.org/forum/viewtopic.php?t=3549

#
#-------

#-------
# Now close the document
oDoc.close( True )
#-------

# import Danny.OOo.Examples.CalcExamples
# reload( Danny.OOo.Examples.CalcExamples ); from Danny.OOo.Examples.CalcExamples import *

# CalcExample()

</source>

This code can be greatly enhanced, if you want to provide a better version of the code, please edit it and notify me for feedback. [[User:JZA|JZA]] ([[User talk:JZA|talk]])

== Set the font size of text in a spreadsheet ==
Here is an example of how to set the font size of text in a spreadsheet cell.
<source lang=python>
Sub Main
' Get this spreadsheet document
oDoc = ThisComponent
' Get the first sheet.
oSheet = oDoc.getSheets().getByIndex( 0 )
' Get cell A1
oCell = oSheet.getCellByPosition( 0, 0 )

' Put some text into the cell.
oCell.setString( "This is a test" )

' Get the cell's Text.
' You can do many things with this text, like you can do with Writer text.
oText = oCell.getText()
' Get a cursor on the text.
oCursor = oText.createTextCursor()

' Select ALL of the text.
oCursor.gotoStart( False ) ' goto start of text
oCursor.gotoEnd( True ) ' goto end of text while holding down SHIFT key
' Change selected char's height
oCursor.CharHeight = 34

' Select the first four characters
oCursor.gotoStart( False ) ' goto start of text
oCursor.goRight( 4, True ) ' go right 4 chars, holding down SHIFT key
' Change selected char's height
oCursor.CharHeight = 27
End Sub
</source>
If all of the text is of uniform size, and you want to increase the size of the entire text cell, then simply do....

<source lang=python>
Sub Main
' Get this spreadsheet document
oDoc = ThisComponent
' Get the first sheet.
oSheet = oDoc.getSheets().getByIndex( 0 )
' Get cell A1
oCell = oSheet.getCellByPosition( 0, 0 )

' Get the cell's Text.
' You can do many things with this text, like you can do with Writer text.
oText = oCell.getText()
' Get a cursor on the text.
oCursor = oText.createTextCursor()

' Select ALL of the text.
oCursor.gotoStart( False ) ' goto start of text
oCursor.gotoEnd( True ) ' goto end of text while holding down SHIFT key
' Change selected char's height
oCursor.CharHeight = oCursor.CharHeight + 1
End Sub

</source>
== Underline each Nth row of cells ==
Underline a row of cells, every Nth row, by setting the cell border bottom and Adjust the column widths of a certain range of columns.

<source lang=basic>
Sub Main

' Create a new document.
oDoc = StarDesktop.loadComponentFromURL( "private:factory/scalc", "_blank", 0, Array() )
' Alternative: Use document that this macro is embedded into.
'oDoc = ThisComponent
' Alternative: Load document from disk
' CHANGE ME
'cFile = "C:\Documents and Settings\dbrewer\Desktop\Something.sxc" ' for Windows
'cFile = "/home/danny/Desktop/Something.sxc" ' for Linux
'cUrl = ConvertToUrl( cFile )
'oDoc = StarDesktop.loadComponentFromURL( cUrl, "_blank", 0, Array() )

' Get first sheet of the document -- the zero'th sheet.
oSheet = oDoc.getSheets().getByIndex( 0 )

UnderlineRows( oSheet )
AdjustColumnWidths( oSheet )
End Sub

' Pass in a single sheet of a spreadsheet document.
' This will create borders that underline certain cells.
Sub UnderlineRows( oSheet )
'-----
' CHANGE ME
' CHANGE ME
' You could turn these local variables into parameters.
nUnderlineFirstRow = 9
nUnderlineSkipRows = 4
nUnderlineLastRow = 50
cUnderlineFirstColumn = "A"
cUnderlineLastColumn = "I"

'nBorderColor = RGB( 0, 0, 0 ) ' Black
nBorderColor = RGB( 255, 200, 200 ) ' Pink

nInnerBorderWidth = 0 ' in 1000'th of cm
'nOuterBorderWidth = 75 ' in 1000'th of cm, means 0.075 cm width
nOuterBorderWidth = 1/32 * 2540 ' 1/32 inch (2.54 cm = 1 inch)
'-----

nRow = nUnderlineFirstRow
Do While nRow <= nUnderlineLastRow
' Form a string such as... "A19:I19"
cCellRangeName = cUnderlineFirstColumn + CSTR( nRow ) _
+ ":" + cUnderlineLastColumn + CSTR( nRow )

' Get the range of cells whose border is to be adjusted.
oCellRange = oSheet.getCellRangeByName( cCellRangeName )

'oCellRange.LeftBorder = MakeCellBorderLine( nBorderColor, nInnerBorderWidth, nOuterBorderWidth, 0 )
'oCellRange.RightBorder = MakeCellBorderLine( nBorderColor, nInnerBorderWidth, nOuterBorderWidth, 0 )
'oCellRange.TopBorder = MakeCellBorderLine( nBorderColor, nInnerBorderWidth, nOuterBorderWidth, 0 )
oCellRange.BottomBorder = MakeCellBorderLine( nBorderColor, nInnerBorderWidth, nOuterBorderWidth, 0 )

nRow = nRow + nUnderlineSkipRows
Loop
End Sub

' Pass in a single sheet of a spreadsheet document.
' This will set the column widths of certain cells.
Sub AdjustColumnWidths( oSheet )
'-----
' CHANGE ME
' CHANGE ME
' You could turn these local variables into parameters.
cFirstColumn = "A"
cLastColumn = "I"
'-----

' Turn the column names into column numbers.
nFirstColumn = CalcColumnNameToNumber( oSheet, cFirstColumn )
nLastColumn = CalcColumnNameToNumber( oSheet, cLastColumn )

' Get the collection of all columns on the sheet.
oColumns = oSheet.getColumns()

' Loop over each column...
For nCol = nFirstColumn To nLastColumn
' Get a single column
oColumn = oColumns.getByIndex( nCol )

' Change column width
oColumn.Width = 2.5 * 2540 ' 2.5 inches * 2.54 cm / inch.
Next
End Sub

Function MakeCellBorderLine( nColor, nInnerLineWidth, nOuterLineWidth, nLineDistance ) _
As com.sun.star.table.BorderLine
oBorderLine = createUnoStruct( "com.sun.star.table.BorderLine" )
With oBorderLine
.Color = nColor

.InnerLineWidth = nInnerLineWidth
.OuterLineWidth = nOuterLineWidth
.LineDistance = nLineDistance
End With
MakeCellBorderLine = oBorderLine
End Function

Function CalcColumnNameToNumber( oSheet As com.sun.star.sheet.Spreadsheet,_
cColumnName As String ) As Long
oColumns = oSheet.getColumns()
oColumn = oColumns.getByName( cColumnName )
oRangeAddress = oColumn.getRangeAddress()
nColumn = oRangeAddress.StartColumn
CalcColumnNameToNumber() = nColumn
End Function

</source>

== Take data from a Writer's table and insert in Calc ==
This code tries to do as mentioned, extract a table data from Writer and insert it in a Calc document.

<source lang=python>
Sub Main
' Work with the writer document that this macro is embedded into.
oWriterDoc = ThisComponent

' Get the collection of tables from the Writer doc.
oWriterTables = oWriterDoc.getTextTables()

' Get the table named FooBar.
' Each table has a name. We want the table named FooBar.
' To see or change the name of a table, first click in the table,
' then Format-->Table, pick the Table tab, and adjust the Name.
oWriterTable = oWriterTables.getByName( "FooBar" )

' Find out how many Rows and Columns the table has.
nRows = oWriterTable.getRows().getCount()
nCols = oWriterTable.getColumns().getCount()

' Create a new Calc spreadsheet.
oCalcDoc = StarDesktop.loadComponentFromURL( "private:factory/scalc", "_blank", 0, Array() )

' Get the first sheet of the document.
oSheet = oCalcDoc.getSheets().getByIndex( 0 )
' oSheet = oCalcDoc.getSheets().getByName( "Sheet1" ) ' an alternate way to get by name

' Determine where we are going to insert the data from the Writer table.
nFirstRow = 6
nFirstCol = 2

' Copy the data, row by row, column by column
For nRow = 0 To nRows-1
For nCol = 0 To nCols-1
oWriterCell = oWriterTable.getCellByPosition( nCol, nRow )
oCalcCell = oSheet.getCellByPosition( nCol+nFirstCol, nRow+nFirstRow )

' If the cell has a formula, then copy that...
If oWriterCell.getFormula() <> "" Then
oCalcCell.setFormula( oWriterCell.getFormula() )

' If the cell has a non-zero numeric value, then copy that...
ElseIf oWriterCell.getValue() <> 0 Then
oCalcCell.setValue( oWriterCell.getValue() )
' Question... what if the cell is numeric, but zero?
ElseIf oWriterCell.getString() = "0" Then
oCalcCell.setValue( oWriterCell.getValue() )

Else
oCalcCell.setString( oWriterCell.getString() )
EndIf
Next
Next
End Sub
</source>

Python-Calc

2015-02-17T16:34:52Z

JZA: Adding more code from oooforum.

This code was originally written on the oooforum, you can reach it [http://www.oooforum.org/forum/viewtopic.phtml?p=55393#55393 here]. The code was somewhat broken down into different areas so the reader can understand each step.

The intend of the code is to:
# Create a new spreadsheet
# Open an existing spreadsheet
# Insert strings inito a cell
# Insert formulas into a cell
# Insert graphs to a range

<source lang=python>

from Danny.OOo.OOoLib import *

def CalcExample():
# create a new Calc spreadsheet.
oDoc = StarDesktop.loadComponentFromURL( "private:factory/scalc", "_blank", 0, Array() )
#-----
# Use this instead to open an EXISTING calc document,
# and assign it to variable oDoc.
# cFile = "C:\Documents and Settings\danny\Desktop\MyCalc" # Windows
# cFile = "/home/danny/Desktop/MyCalc.sxc" # Linux
# cURL = convertToURL( cFile + ".sxc" )
# oDoc = StarDesktop.loadComponentFromURL( cURL, "_blank", 0, Array() )
#-----

# Here are two ways to get access to one of the various sheets
# in the spreadsheet document.
# Note that these don't make the sheet *vislble*, they merely give
# access to the sheet's content within the program.
oSheet = oDoc.getSheets().getByIndex( 0 ) # get the zero'th sheet
#oSheet = oDoc.getSheets().getByName( "Sheet3" ) # get by name

#-----
# Put some sales figures onto the sheet.
oSheet.getCellByPosition( 0, 0 ).setString( "Month" )
oSheet.getCellByPosition( 1, 0 ).setString( "Sales" )
oSheet.getCellByPosition( 2, 0 ).setString( "End Date" )

oSheet.getCellByPosition( 0, 1 ).setString( "Jan" )
oSheet.getCellByPosition( 0, 2 ).setString( "Feb" )
oSheet.getCellByPosition( 0, 3 ).setString( "Mar" )
oSheet.getCellByPosition( 0, 4 ).setString( "Apr" )
oSheet.getCellByPosition( 0, 5 ).setString( "May" )
oSheet.getCellByPosition( 0, 6 ).setString( "Jun" )
oSheet.getCellByPosition( 0, 7 ).setString( "Jul" )
oSheet.getCellByPosition( 0, 8 ).setString( "Aug" )
oSheet.getCellByPosition( 0, 9 ).setString( "Sep" )
oSheet.getCellByPosition( 0, 10 ).setString( "Oct" )
oSheet.getCellByPosition( 0, 11 ).setString( "Nov" )
oSheet.getCellByPosition( 0, 12 ).setString( "Dec" )

oSheet.getCellByPosition( 1, 1 ).setValue( 3826.37 )
oSheet.getCellByPosition( 1, 2 ).setValue( 3504.21 )
oSheet.getCellByPosition( 1, 3 ).setValue( 2961.45 )
oSheet.getCellByPosition( 1, 4 ).setValue( 2504.12 )
oSheet.getCellByPosition( 1, 5 ).setValue( 2713.98 )
oSheet.getCellByPosition( 1, 6 ).setValue( 2248.17 )
oSheet.getCellByPosition( 1, 7 ).setValue( 1802.13 )
oSheet.getCellByPosition( 1, 8 ).setValue( 2003.22 )
oSheet.getCellByPosition( 1, 9 ).setValue( 1502.54 )
oSheet.getCellByPosition( 1, 10 ).setValue( 1207.68 )
oSheet.getCellByPosition( 1, 11 ).setValue( 1319.71 )
oSheet.getCellByPosition( 1, 12 ).setValue( 786.03 )

oSheet.getCellByPosition( 2, 1 ).setFormula( "=DATE(2004;01;31)" )
oSheet.getCellByPosition( 2, 2 ).setFormula( "=DATE(2004;02;29)" )
oSheet.getCellByPosition( 2, 3 ).setFormula( "=DATE(2004;03;31)" )
oSheet.getCellByPosition( 2, 4 ).setFormula( "=DATE(2004;04;30)" )
oSheet.getCellByPosition( 2, 5 ).setFormula( "=DATE(2004;05;31)" )
oSheet.getCellByPosition( 2, 6 ).setFormula( "=DATE(2004;06;30)" )
oSheet.getCellByPosition( 2, 7 ).setFormula( "=DATE(2004;07;31)" )
oSheet.getCellByPosition( 2, 8 ).setFormula( "=DATE(2004;08;31)" )
oSheet.getCellByPosition( 2, 9 ).setFormula( "=DATE(2004;09;30)" )
# Note that these last three dates are not set as DATE() function calls.
oSheet.getCellByPosition( 2, 10 ).setFormula( "10/31/2004" )
oSheet.getCellByPosition( 2, 11 ).setFormula( "11/30/2004" )
oSheet.getCellRangeByName( "C13" ).setFormula( "12/31/2004" )
#-----

#-----
# Format the date cells as dates.
com_sun_star_util_NumberFormat_DATE = uno.getConstantByName( "com.sun.star.util.NumberFormat.DATE" )
oFormats = oDoc.getNumberFormats()
oLocale = createUnoStruct( "com.sun.star.lang.Locale" )
nDateKey = oFormats.getStandardFormat( com_sun_star_util_NumberFormat_DATE, oLocale )
oCell = oSheet.getCellRangeByName( "C2:C13" )
oCell.NumberFormat = nDateKey
#-----

#-----
# Now add a chart to the spreadsheet.

oCellRangeAddress = oSheet.getCellRangeByName( "A1:B13" ).getRangeAddress()
# oCellRangeAddress = MakeCellRangeAddress( 0, 0, 1, 1, 12 )
# Get the collection of charts from the sheet.
oCharts = oSheet.getCharts()
# Add a new chart with a specific name,
# in a specific rectangle on the drawing page,
# and connected to specific cells of the spreadsheet.
oCharts.addNewByName( "Sales",
makeRectangle( 8000, 1000, 16000, 10000 ),
Array( oCellRangeAddress ),
True, True )
# From the collection of charts, get the new chart we just created.
oChart = oCharts.getByName( "Sales" )
# Get the chart document model.
oChartDoc = oChart.getEmbeddedObject()

# Get the drawing text shape of the title of the chart.
oTitleTextShape = oChartDoc.getTitle()
# Change the title.
oTitleTextShape.String = "Sales Chart"

# Create a diagram.
oDiagram = oChartDoc.createInstance( "com.sun.star.chart.BarDiagram" )
# Set its parameters.
oDiagram.Vertical = True
# Make the chart use this diagram.
oChartDoc.setDiagram( oDiagram )

# Ask the chart what diagram it is using.
# (Unnecessary, since variable oDiagram already contains this value.)
oDiagram = oChartDoc.getDiagram()
# Make more changes to the diagram.
oDiagram.DataCaption = uno.getConstantByName( "com.sun.star.chart.ChartDataCaption.VALUE" )
oDiagram.DataRowSource = uno.getConstantByName( "com.sun.star.chart.ChartDataRowSource.COLUMNS" )
#
#-----

#-----
# Now demonstrate how to manipulate the sheets.

# Insert six more sheets into the document.
nNumSheetsCurrently = oDoc.getSheets().getCount()
oDoc.getSheets().insertNewByName( "Fred", nNumSheetsCurrently+1 )
oDoc.getSheets().insertNewByName( "Joe", nNumSheetsCurrently+2 )
oDoc.getSheets().insertNewByName( "Bill", nNumSheetsCurrently+3 )
oDoc.getSheets().insertNewByName( "Sam", nNumSheetsCurrently+4 )
oDoc.getSheets().insertNewByName( "Tom", nNumSheetsCurrently+5 )
oDoc.getSheets().insertNewByName( "David", nNumSheetsCurrently+6 )
# Now find a sheet named "Sheet2" and get rid of it.
oDoc.getSheets().removeByName( "Sheet2" )
# Now find the sheet named "Sam" and change its name to "Sheet 37"
oDoc.getSheets().getByName( "Sam" ).Name = "Sheet 37"
#
#-----

#-------
# Now print the document -- three different ways.

# Technique 1.
# Now print the document.
# Print two copies.
# Print pages 1 thru 4, and also page 10.
#
# NOTE: we would do it like this, except the word "print"
# has a special meaning in python, and cannot be invoked
# as a method.
#oDoc.print(
# Array(
# makePropertyValue( "CopyCount", 2 ),
# makePropertyValue( "Pages", "1-4;10" ) ) )
uno.invoke( oDoc, "print", ( Array(
makePropertyValue( "CopyCount", 2 ),
makePropertyValue( "Pages", "1-4;10" ) ), ) )

# Technique 2.
# Print the document already, without any arguments.
uno.invoke( oDoc, "print", ( Array(), ) )
#oDoc.print( Array() )

# Using technique 1 or 2, be sure not to close the document
# until printing is completed.
# http://www.oooforum.org/forum/viewtopic.php?p=23144#23144

# Technique 3.
# Print the document by bringing up the Print Job dialog box
# for the user to interact with.
oDocFrame = oDoc.getCurrentController().getFrame()
oDispatchHelper = createUnoService( "com.sun.star.frame.DispatchHelper" )
oDispatchHelper.executeDispatch( oDocFrame, ".uno:Print", "", 0, Array() )
# To learn some more about the dispatcher, see these articles...
# http://www.oooforum.org/forum/viewtopic.php?t=5058
# http://www.oooforum.org/forum/viewtopic.php?t=5057

#
#-------

#-------
# Now save the document

# Prepare the filename to save.
# We're going to save the file in several different formats,
# but all based on the same filename.
cFile = "C:\Documents and Settings\dbrewer\Desktop\MyCalc" # Windows
#cFile = "/home/danny/Desktop/MyCalc.sxc" # Linux

# Now save the spreadsheet in native OOo Calc format.
cURL = convertToURL( cFile + ".sxc" )
oDoc.storeAsURL( cURL, Array() )

# Note the above used storeAsUrl,
# the following use storeToUrl.

# Now save it in Excel format.
cURL = convertToURL( cFile + ".xls" )
oDoc.storeToURL( cURL, Array( makePropertyValue( "FilterName", "MS Excel 97" ) ) )

# Now save a PDF.
cURL = convertToURL( cFile + ".pdf" )
oDoc.storeToURL( cURL, Array( makePropertyValue( "FilterName", "calc_pdf_Export" ) ) )

# Now save it in CSV format.
cURL = convertToURL( cFile + ".csv" )
oDoc.storeToURL( cURL, Array( makePropertyValue( "FilterName", "Text - txt - csv (StarCalc)" ) ) )

# Now save it in DIF format.
cURL = convertToURL( cFile + ".dif" )
oDoc.storeToURL( cURL, Array( makePropertyValue( "FilterName", "DIF" ) ) )

# Now save it in SYLK format.
cURL = convertToURL( cFile + ".sylk" )
oDoc.storeToURL( cURL, Array( makePropertyValue( "FilterName", "SYLK" ) ) )

# Now save as HTML.
cURL = convertToURL( cFile + ".html" )
oDoc.storeToURL( cURL, Array( makePropertyValue( "FilterName", "HTML (StarCalc)" ) ) )

# A list of some filter names you can use for both loading
# and saving a document can be found here...
# http://www.oooforum.org/forum/viewtopic.php?t=3549

#
#-------

#-------
# Now close the document
oDoc.close( True )
#-------

# import Danny.OOo.Examples.CalcExamples
# reload( Danny.OOo.Examples.CalcExamples ); from Danny.OOo.Examples.CalcExamples import *

# CalcExample()

</source>

This code can be greatly enhanced, if you want to provide a better version of the code, please edit it and notify me for feedback. [[User:JZA|JZA]] ([[User talk:JZA|talk]])

== Set the font size of text in a spreadsheet ==
Here is an example of how to set the font size of text in a spreadsheet cell.
<source lang=python>
Sub Main
' Get this spreadsheet document
oDoc = ThisComponent
' Get the first sheet.
oSheet = oDoc.getSheets().getByIndex( 0 )
' Get cell A1
oCell = oSheet.getCellByPosition( 0, 0 )

' Put some text into the cell.
oCell.setString( "This is a test" )

' Get the cell's Text.
' You can do many things with this text, like you can do with Writer text.
oText = oCell.getText()
' Get a cursor on the text.
oCursor = oText.createTextCursor()

' Select ALL of the text.
oCursor.gotoStart( False ) ' goto start of text
oCursor.gotoEnd( True ) ' goto end of text while holding down SHIFT key
' Change selected char's height
oCursor.CharHeight = 34

' Select the first four characters
oCursor.gotoStart( False ) ' goto start of text
oCursor.goRight( 4, True ) ' go right 4 chars, holding down SHIFT key
' Change selected char's height
oCursor.CharHeight = 27
End Sub
</source>
If all of the text is of uniform size, and you want to increase the size of the entire text cell, then simply do....

<source lang=python>
Sub Main
' Get this spreadsheet document
oDoc = ThisComponent
' Get the first sheet.
oSheet = oDoc.getSheets().getByIndex( 0 )
' Get cell A1
oCell = oSheet.getCellByPosition( 0, 0 )

' Get the cell's Text.
' You can do many things with this text, like you can do with Writer text.
oText = oCell.getText()
' Get a cursor on the text.
oCursor = oText.createTextCursor()

' Select ALL of the text.
oCursor.gotoStart( False ) ' goto start of text
oCursor.gotoEnd( True ) ' goto end of text while holding down SHIFT key
' Change selected char's height
oCursor.CharHeight = oCursor.CharHeight + 1
End Sub

</source>
== Underline each Nth row of cells ==
Underline a row of cells, every Nth row, by setting the cell border bottom and Adjust the column widths of a certain range of columns.

<source lang=python>
Sub Main

' Create a new document.
oDoc = StarDesktop.loadComponentFromURL( "private:factory/scalc", "_blank", 0, Array() )
' Alternative: Use document that this macro is embedded into.
'oDoc = ThisComponent
' Alternative: Load document from disk
' CHANGE ME
'cFile = "C:\Documents and Settings\dbrewer\Desktop\Something.sxc" ' for Windows
'cFile = "/home/danny/Desktop/Something.sxc" ' for Linux
'cUrl = ConvertToUrl( cFile )
'oDoc = StarDesktop.loadComponentFromURL( cUrl, "_blank", 0, Array() )

' Get first sheet of the document -- the zero'th sheet.
oSheet = oDoc.getSheets().getByIndex( 0 )

UnderlineRows( oSheet )
AdjustColumnWidths( oSheet )
End Sub

' Pass in a single sheet of a spreadsheet document.
' This will create borders that underline certain cells.
Sub UnderlineRows( oSheet )
'-----
' CHANGE ME
' CHANGE ME
' You could turn these local variables into parameters.
nUnderlineFirstRow = 9
nUnderlineSkipRows = 4
nUnderlineLastRow = 50
cUnderlineFirstColumn = "A"
cUnderlineLastColumn = "I"

'nBorderColor = RGB( 0, 0, 0 ) ' Black
nBorderColor = RGB( 255, 200, 200 ) ' Pink

nInnerBorderWidth = 0 ' in 1000'th of cm
'nOuterBorderWidth = 75 ' in 1000'th of cm, means 0.075 cm width
nOuterBorderWidth = 1/32 * 2540 ' 1/32 inch (2.54 cm = 1 inch)
'-----

nRow = nUnderlineFirstRow
Do While nRow <= nUnderlineLastRow
' Form a string such as... "A19:I19"
cCellRangeName = cUnderlineFirstColumn + CSTR( nRow ) _
+ ":" + cUnderlineLastColumn + CSTR( nRow )

' Get the range of cells whose border is to be adjusted.
oCellRange = oSheet.getCellRangeByName( cCellRangeName )

'oCellRange.LeftBorder = MakeCellBorderLine( nBorderColor, nInnerBorderWidth, nOuterBorderWidth, 0 )
'oCellRange.RightBorder = MakeCellBorderLine( nBorderColor, nInnerBorderWidth, nOuterBorderWidth, 0 )
'oCellRange.TopBorder = MakeCellBorderLine( nBorderColor, nInnerBorderWidth, nOuterBorderWidth, 0 )
oCellRange.BottomBorder = MakeCellBorderLine( nBorderColor, nInnerBorderWidth, nOuterBorderWidth, 0 )

nRow = nRow + nUnderlineSkipRows
Loop
End Sub

' Pass in a single sheet of a spreadsheet document.
' This will set the column widths of certain cells.
Sub AdjustColumnWidths( oSheet )
'-----
' CHANGE ME
' CHANGE ME
' You could turn these local variables into parameters.
cFirstColumn = "A"
cLastColumn = "I"
'-----

' Turn the column names into column numbers.
nFirstColumn = CalcColumnNameToNumber( oSheet, cFirstColumn )
nLastColumn = CalcColumnNameToNumber( oSheet, cLastColumn )

' Get the collection of all columns on the sheet.
oColumns = oSheet.getColumns()

' Loop over each column...
For nCol = nFirstColumn To nLastColumn
' Get a single column
oColumn = oColumns.getByIndex( nCol )

' Change column width
oColumn.Width = 2.5 * 2540 ' 2.5 inches * 2.54 cm / inch.
Next
End Sub

Function MakeCellBorderLine( nColor, nInnerLineWidth, nOuterLineWidth, nLineDistance ) _
As com.sun.star.table.BorderLine
oBorderLine = createUnoStruct( "com.sun.star.table.BorderLine" )
With oBorderLine
.Color = nColor

.InnerLineWidth = nInnerLineWidth
.OuterLineWidth = nOuterLineWidth
.LineDistance = nLineDistance
End With
MakeCellBorderLine = oBorderLine
End Function

Function CalcColumnNameToNumber( oSheet As com.sun.star.sheet.Spreadsheet,_
cColumnName As String ) As Long
oColumns = oSheet.getColumns()
oColumn = oColumns.getByName( cColumnName )
oRangeAddress = oColumn.getRangeAddress()
nColumn = oRangeAddress.StartColumn
CalcColumnNameToNumber() = nColumn
End Function

</source>

== Take data from a Writer's table and insert in Calc ==
This code tries to do as mentioned, extract a table data from Writer and insert it in a Calc document.

<source lang=python>
Sub Main
' Work with the writer document that this macro is embedded into.
oWriterDoc = ThisComponent

' Get the collection of tables from the Writer doc.
oWriterTables = oWriterDoc.getTextTables()

' Get the table named FooBar.
' Each table has a name. We want the table named FooBar.
' To see or change the name of a table, first click in the table,
' then Format-->Table, pick the Table tab, and adjust the Name.
oWriterTable = oWriterTables.getByName( "FooBar" )

' Find out how many Rows and Columns the table has.
nRows = oWriterTable.getRows().getCount()
nCols = oWriterTable.getColumns().getCount()

' Create a new Calc spreadsheet.
oCalcDoc = StarDesktop.loadComponentFromURL( "private:factory/scalc", "_blank", 0, Array() )

' Get the first sheet of the document.
oSheet = oCalcDoc.getSheets().getByIndex( 0 )
' oSheet = oCalcDoc.getSheets().getByName( "Sheet1" ) ' an alternate way to get by name

' Determine where we are going to insert the data from the Writer table.
nFirstRow = 6
nFirstCol = 2

' Copy the data, row by row, column by column
For nRow = 0 To nRows-1
For nCol = 0 To nCols-1
oWriterCell = oWriterTable.getCellByPosition( nCol, nRow )
oCalcCell = oSheet.getCellByPosition( nCol+nFirstCol, nRow+nFirstRow )

' If the cell has a formula, then copy that...
If oWriterCell.getFormula() <> "" Then
oCalcCell.setFormula( oWriterCell.getFormula() )

' If the cell has a non-zero numeric value, then copy that...
ElseIf oWriterCell.getValue() <> 0 Then
oCalcCell.setValue( oWriterCell.getValue() )
' Question... what if the cell is numeric, but zero?
ElseIf oWriterCell.getString() = "0" Then
oCalcCell.setValue( oWriterCell.getValue() )

Else
oCalcCell.setString( oWriterCell.getString() )
EndIf
Next
Next
End Sub
</source>

Python-Calc

2015-02-17T16:28:53Z

JZA: Other code

Python-Calc

2015-02-17T16:24:22Z

JZA:

Python-Calc

2015-02-17T16:22:14Z

JZA: Added code from oooforum.

Python

2015-02-17T16:16:35Z

JZA: Link typo

{{Extensions}}
[[image:Py-uno_128.png|PyUNO Logo]] [[image:Pyuno_logo_a.jpg]]

=== Python and OpenOffice ===
Apache OpenOffice 4 ships with the Python scripting language, version 2.7. OpenOffice.org 3.1 and above shipped with Python version 2.6.1 and older OpenOffice.org releases shipped with Python version 2.3.4. This Python distribution via OpenOffice comes with the [[Uno]] module, which connects the [[API|UNO API]] to the python scripting language. To run this version of Python on Linux, you can go directly to the OpenOffice PATH. And as one would expect with any distribution of Python, AOO-Python can be run from the command line as well.

If you already have a separate Python installation, you can import the uno module (the Python-UNO bridge) to it using [http://forum.openoffice.org/en/forum/viewtopic.php?f=45&t=36370&p=166783 these instructions].

If you already have a different version of Python installed on Windows, you can also access the [[API|UNO API]] using the [http://forum.openoffice.org//en/forum/viewtopic.php?f=45&t=36608&p=167909 COM bridge] instead of the Python bridge. Requires the [http://sourceforge.net/projects/pywin32/ add-on pywin32] module so Python can talk to COM. Note that while the UNO API is uniform, the implementation by the two bridges is slightly different, so the syntax required by each is also sometimes different.

==== Where is the IDE ? ====
OpenOffice's IDE doesn't support Python, so development has to be done from another editor that does. Any volunteer for a binding is welcomed. Here is a nice [http://pythonconquerstheuniverse.wordpress.com/category/the-python-debugger/ blog post] about using [http://www.vim.org VIM] a common Unix/Linux text editor configured in a way that acts like an IDE. Windows users can use [http://www.vim.org/download.php#pc Gvim] and [http://macvim.org/ MacVim] for OSX users.

==== Tips & Tricks ====

Here is some useful information about using python in AOO.

===== Debug output =====

If you launch a python script, any error will silently break the execution, making your extension hard to debug. To change this behaviour, one can change the
'''LogLevel'''
.

Have a look in
''/path/to/aoo/program/'''pythonscript.py'''''
and replace
''LogLevel.use = LogLevel.'''NONE'''''
with
''LogLevel.use = LogLevel.'''DEBUG'''''
.

There are also currently-undocumented environment variables that tell the pyUno bridge to log every call. Set the environment variable
''export PYUNO_LOGLEVEL=ARGS''
. The output may be a little hard to read, but helpful nonetheless.

Note that his applies only to Linux. For Windows, you need some more switches, and the output gets written to files (there is no stdout on windows :-( ).

There are still some error messages that won't appear in these logs; this will improve in the near future (cws pyunofixes4). Once the cws is integrated, I will document these switches on the official pyuno site.

''Thanks to Joerg Budischewski''
.

=== Python specific information for Extension creation ===
To create extensions for python, it is important that you have enough familiarity with the UNO components, as well as with packaging your code for easy distribution through the ''OpenOffice package manager''. Please check the tutorials to learn how to component-ize your code, and how to deploy remote scripting through a service implementation.

To learn to run Python on Windows, visit [[Using Python on Windows| this link]] for more detailed information.

{| align="center" cellspacing="0" cellpadding="0" style="border: 0px solid rgb(134, 194, 230);"
|- valign="top"
| style="width: 35%; padding-right: 15px;" | <div style="border-style: solid solid none; border-color: rgb(134, 194, 230) rgb(134, 194, 230) -moz-use-text-color; border-width: 1px 1px medium; padding: 5px; font-size: 120%; font-weight: bold; background-color: rgb(203, 222, 250);">Getting Started</div> <div style="border: 1px solid rgb(155, 192, 245); padding: 5px 5px 10px;">
*[[Python/Python_Language_Binding|Python Language Binding]]
*[[Python/Python_Loader|Python Loader]]
*[[Using Python on Windows]] - New to Python? Learn how to use python on Windows
*[[Using Python on Linux]] - A must read for an overview on Python and AOO relations
* [[pyUNO bridge]] - Official page of the PyUNO bridge at the [http://udk.openoffice.org/ UDK site] - ([http://www.fatcow.com/edu/mathtex-be/ ''Belorussian translation''])
* [[Python as a macro language]] in OpenOffice.org 2.x - How to use the Python scripting framework
* [[Python/Transfer_from_Basic_to_Python|Transfer from Basic to Python]]
* [http://lucasmanual.com/mywiki/OpenOffice PyUNO Manual] Lukasz created a pyUNO manual. '''new'''
* [[SQLAlquemyPyUNO|SQLAlchemy and PyUNO]] connecting OpenOffice to any database
* [http://www.linuxjournal.com/content/starting-stopping-and-connecting-openoffice-python Starting/Stopping and connecting using Python] From Linux Journal
* Introduction on testing pyUNO programs with [[doctests]]
* Create a [[PythonDialogBox|dialog box]] in PyUNO.
* [http://codesnippets.services.openoffice.org/Office/Office.ConnectViaPipe.snip Connect to Openoffice] from PyUNO
* [[PyUNO samples]] currently shipping with OpenOffice.org and the explanation.
* Enhanced [http://www.oooforum.org/forum/viewtopic.phtml?p=257496#257496 Capitalized.py] script by ''The gray Cardinal'' at the OpenOffice forum.

| style="width: 35%; padding-right: 15px;" | <div style="border-style: solid solid none; border-color: rgb(134, 194, 230) rgb(134, 194, 230) -moz-use-text-color; border-width: 1px 1px medium; padding: 5px; font-size: 120%; font-weight: bold; background-color: rgb(203, 222, 250);">PYUNO Modules</div> <div style="border: 1px solid rgb(155, 192, 245); padding: 5px 5px 10px;">
*[[Danny's Python Modules]] - Collection guide from DannyB's modules.
*[[PrinttoWriter.py]] - This makes it easy and convenient to print a bunch of text into a Writer document.
*[[CalcFunctions]] - Learn how Python can be used to develop Calc functions in Python
*[[Python-Calc]] - Various scripts to deal with Calc
*[[PythonContainers]] - Python container components
*[[PyUNOServer]] - The PyUNOServer is a script that works as an XML server for OpenOffice.org Calc
*[[calcParser]] - calcParser is a small parser using the native SAX utilities within the OpenOffice.org python
*[[OoConfig]] - OoConfig is a Python extension that seeks to provide a configuration editing facility similar to Mozilla's about:config
*[[Bibliographic/Hints and Tips/OOoRISExport.py|OOoRISExport.py]] - Exports the bibliographic database in RIS format. Also [http://bibliographic.openoffice.org/files/documents/124/3078/RISImport.py RISImport.py]
*[[Zotero_Plugin |Zotero Plugin]] - The Zotero plugin provides citation and bibliographic table insertion and editing functions for Writer documents.
*[http://oosheet.hacklab.com.br/ OOSheet] - High level python library to develop spreadsheet macros without the complexity of Uno. Focuses on spreadsheets, but may be useful for other documents.
|}

=== Hacking Around ===
*[[UNO component packaging]] - How to create UNO components as well as the basics of script componentizing
*[http://www.oooforum.org/forum/viewtopic.phtml?p=38234#38234 Python component to parse XML] - Python is great to parse XML, PyUNO is also excellent when working with XML
*[[Example of Service in Python]] - Learn how to run Python as a service, this is useful for remote scripting.
*[http://www.oooforum.org/forum/viewtopic.phtml?p=76972#76972 Modify spreadsheet] - Example of storing and retrieving a custom attribute on a spreadsheet cell.
*A simple [[daemon in Python]] - Learn how to run Python as a daemon
*[[Loook.py]] - a simple Python tool that searches for text strings in OpenOffice.org.
*[[odt2txt.py]] - convert ODF to plain text using python (and convert the txt to html).

=== Python rules OpenOffice (by B. Bois) ===
[[image:python_power_for_OOo.png|Python rules OpenOffice :-)]]

[[Category:Extensions]]
[[Category:Python]]
[[Category:Uno]]

CalcFunctions

2015-02-17T16:15:15Z

JZA:

Originally posted in oooForum [http://www.oooforum.org/forum/viewtopic.phtml?t=8456 here]. This code tries to introduce native Calc functions coded in Python. This article is related to the [[Python]] series page tutorials.

This code deals with:
# Develop a trivial Calc function add on in Python.
# To be followed by more sophisticated functions.
# To be followed by eventually running a Poll on OOoForum asking what kind of functions shoudl be developed. (PLEASE don't post any answers to this question AT THIS TIME. This post is a ROADMAP, NOT A REQUEST for ideas.)
# Build a canned example, posted to OOoForum that is specifically designed for easy cloning and creation of new Calc functions.

The code has several issues, please read the forum topic for more detail issues on this code, also remember this code was never really debugged and is pretty old. So you are on your own. If you have a more update version or discover workarounds, please update the wiki.
<source lang=python>
import sys
import unohelper

from com.sun.star.sheet import XAddIn
from com.sun.star.sheet import XCompatibilityNames

from com.sun.star.lang import XServiceName
from com.sun.star.lang import XLocalizable

g_ImplementationHelper = unohelper.ImplementationHelper()

class DannysCalcFunctions1( unohelper.Base, XAddIn, XLocalizable, XCompatibilityNames, XServiceName ):
# The component must have a ctor with the component context as argument.
def __init__( self, oContext ):
self.oContext = oContext
self.oCoreReflection = None
self.StarDesktop = None
self.getDesktop()

#----------------------------------------
# Danny's stuff to make programming less convenient.
#----------------------------------------

def getServiceManager( self ):
"""Get the ServiceManager from the running OpenOffice.org.
"""
return self.oContext.ServiceManager

def createUnoService( self, cClass ):
"""A handy way to create a global objects within the running OOo.
"""
oServiceManager = self.getServiceManager()
oObj = oServiceManager.createInstance( cClass )
return oObj

def getDesktop( self ):
"""An easy way to obtain the Desktop object from a running OOo.
"""
if self.StarDesktop == None:
self.StarDesktop = self.createUnoService( "com.sun.star.frame.Desktop" )
return self.StarDesktop

def getCoreReflection( self ):
if self.oCoreReflection == None:
self.oCoreReflection = self.createUnoService( "com.sun.star.reflection.CoreReflection" )
return oCoreReflection

def createUnoStruct( self, cTypeName ):
"""Create a UNO struct and return it.
"""
oCoreReflection = self.getCoreReflection()

# Get the IDL class for the type name
oXIdlClass = oCoreReflection.forName( cTypeName )

# Create the struct.
oReturnValue, oStruct = oXIdlClass.createObject( None )

return oStruct

def makePropertyValue( self, cName=None, uValue=None, nHandle=None, nState=None ):
"""Create a com.sun.star.beans.PropertyValue struct and return it.
"""
oPropertyValue = self.createUnoStruct( "com.sun.star.beans.PropertyValue" )

if cName != None:
oPropertyValue.Name = cName
if uValue != None:
oPropertyValue.Value = uValue
if nHandle != None:
oPropertyValue.Handle = nHandle
if nState != None:
oPropertyValue.State = nState

return oPropertyValue

#----------------------------------------
# Inconvenience routines for working with structs needed later
#

def makeLocale( self, cLanguage="", cCountry="", cVariant="" ):
oLocale = self.createUnoStruct( "com.sun.star.lang.Locale" )
oLocale.Language = cLanguage
oLocale.Country = cCountry
oLocale.Variant = oVariant
return oLocale

def makeLocalizedName( self, stLocale, cName ):
oLocalizedName = self.createUnoStruct( "com.sun.star.sheet.LocalizedName" )
oLocalizedName.Locale = stLocale
oLocalizedName.Name = cName
return oLocalizedName

#----------------------------------------
# Interface: XAddIn
# Inherits from... XLocalizable
#----------------------------------------

# string
# getProgrammaticFuntionName( [in] string aDisplayName );
# Note: the method name spelling error is in the API!
def getProgrammaticFuntionName( self, cDisplayFnName ):
if cDisplayFnName == "AddFive":
return "nom.DannyBrewer.test.DannysCalcFunctions1.AddFive"
elif cDisplayFnName == "AddSix":
return "nom.DannyBrewer.test.DannysCalcFunctions1.AddSix"
return ""

# string
# getDisplayFunctionName( [in] string aProgrammaticName );
def getDisplayFunctioName( self, cProgrammaticFnName ):
if cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddFive":
return "AddFive"
elif cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddSix":
return "AddSix"
return ""

# string
# getFunctionDescription( [in] string aProgrammaticName );
def getFunctionDescription( self, ccProgrammaticFnName ):
if cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddFive":
return "Adds five to the argument."
elif cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddSix":
return "Add six to the argument."
return ""

# string
# getDisplayArgumentName( [in] string aProgrammaticName
# [in] long nArgument );
def getDisplayArgumentName( self, ccProgrammaticFnName, nArgNum ):
if cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddFive":
if nArgNum == 0:
return "number"
elif cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddSix":
if nArgNum == 0:
return "number"
return ""

# string
# getArgumentDescription( [in] string aProgrammaticName
# [in] long nArgument );
def getArgumentDescription( self, ccProgrammaticFnName, nArgNum ):
if cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddFive":
if nArgNum == 0:
return "A number to which five will be added."
elif cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddSix":
if nArgNum == 0:
return "A number to which six will be added."
return ""

# string
# getProgrammaticCategoryName( [in] string aProgrammaticName );
def getProgrammaticCategoryName( self, ccProgrammaticFnName ):
if cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddFive":
return "Add-In"
elif cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddSix":
return "Add-In"
return ""

# string
# getDisplayCategoryName( [in] string aProgrammaticName );
def getDisplayCategoryName( self, ccProgrammaticFnName ):
if cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddFive":
return "Add-In"
elif cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddSix":
return "Add-In"
return ""

#----------------------------------------
# Interface: XCompatibilityNames
#----------------------------------------

# sequence< LocalizedName >
# getCompatibilityNames( [in] string aProgrammaticName );
def getCompatibilityNames( self, ccProgrammaticFnName ):
if cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddFive":
return (
self.makeLocalizedName( self.makeLocale( "en", "US", "" ),
"AddFive" )
,)
elif cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddSix":
return (
self.makeLocalizedName( self.makeLocale( "en", "US", "" ),
"AddSix" )
,)
return ()

#----------------------------------------
# Interface: XLocalizable
# This is here because XAddIn inherits it.
#----------------------------------------

# void
# setLocale( [in] Locale eLocale );
def setLocale( self, stLocale ):
return

# Locale
# getLocale();
def getLocale( self ):
return self.makeLocale( "en", "US", "" )

#----------------------------------------
# Interface: XServiceName
#----------------------------------------

# string
# getServiceName();
def getServiceName( self ):
return "nom.DannyBrewer.test.DannysCalcFunctions1"

# add the class to the implementation container,
# which the loader uses to register/instantiate the component.
g_ImplementationHelper.addImplementation( \
# The class
DannysCalcFunctions1,
# The implementation name.
# Change this name for your own service.
"nom.DannyBrewer.test.DannysCalcFunctions1",
# A list of services that that are implemented.
("com.sun.star.sheet.AddIn",), )

</source>

Final notes on the code by danny:
It is also worth noting that I have not figured out where to actually implement the two functions AddFive() and AddSix(). All of the above is just the infrastructure for making the two functions and their descriptions and argument lists known to Calc.

I still have to finish reading the above linked section of the Developer's Guide again. Maybe I can figure out what I'm missing. Or maybe there is a fully working Calc function example somewhere else (even in a different language?) that I can examine?

CalcFunctions

2015-02-17T16:14:02Z

JZA: Added code from oooforum.

Originally posted in oooForum [http://www.oooforum.org/forum/viewtopic.phtml?t=8456 here].

This code deals with:
# Develop a trivial Calc function add on in Python.
# To be followed by more sophisticated functions.
# To be followed by eventually running a Poll on OOoForum asking what kind of functions shoudl be developed. (PLEASE don't post any answers to this question AT THIS TIME. This post is a ROADMAP, NOT A REQUEST for ideas.)
# Build a canned example, posted to OOoForum that is specifically designed for easy cloning and creation of new Calc functions.

The code has several issues, please read the forum topic for more detail issues on this code, also remember this code was never really debugged and is pretty old. So you are on your own. If you have a more update version or discover workarounds, please update the wiki.
<source lang=python>
import sys
import unohelper

from com.sun.star.sheet import XAddIn
from com.sun.star.sheet import XCompatibilityNames

from com.sun.star.lang import XServiceName
from com.sun.star.lang import XLocalizable

g_ImplementationHelper = unohelper.ImplementationHelper()

class DannysCalcFunctions1( unohelper.Base, XAddIn, XLocalizable, XCompatibilityNames, XServiceName ):
# The component must have a ctor with the component context as argument.
def __init__( self, oContext ):
self.oContext = oContext
self.oCoreReflection = None
self.StarDesktop = None
self.getDesktop()

#----------------------------------------
# Danny's stuff to make programming less convenient.
#----------------------------------------

def getServiceManager( self ):
"""Get the ServiceManager from the running OpenOffice.org.
"""
return self.oContext.ServiceManager

def createUnoService( self, cClass ):
"""A handy way to create a global objects within the running OOo.
"""
oServiceManager = self.getServiceManager()
oObj = oServiceManager.createInstance( cClass )
return oObj

def getDesktop( self ):
"""An easy way to obtain the Desktop object from a running OOo.
"""
if self.StarDesktop == None:
self.StarDesktop = self.createUnoService( "com.sun.star.frame.Desktop" )
return self.StarDesktop

def getCoreReflection( self ):
if self.oCoreReflection == None:
self.oCoreReflection = self.createUnoService( "com.sun.star.reflection.CoreReflection" )
return oCoreReflection

def createUnoStruct( self, cTypeName ):
"""Create a UNO struct and return it.
"""
oCoreReflection = self.getCoreReflection()

# Get the IDL class for the type name
oXIdlClass = oCoreReflection.forName( cTypeName )

# Create the struct.
oReturnValue, oStruct = oXIdlClass.createObject( None )

return oStruct

def makePropertyValue( self, cName=None, uValue=None, nHandle=None, nState=None ):
"""Create a com.sun.star.beans.PropertyValue struct and return it.
"""
oPropertyValue = self.createUnoStruct( "com.sun.star.beans.PropertyValue" )

if cName != None:
oPropertyValue.Name = cName
if uValue != None:
oPropertyValue.Value = uValue
if nHandle != None:
oPropertyValue.Handle = nHandle
if nState != None:
oPropertyValue.State = nState

return oPropertyValue

#----------------------------------------
# Inconvenience routines for working with structs needed later
#

def makeLocale( self, cLanguage="", cCountry="", cVariant="" ):
oLocale = self.createUnoStruct( "com.sun.star.lang.Locale" )
oLocale.Language = cLanguage
oLocale.Country = cCountry
oLocale.Variant = oVariant
return oLocale

def makeLocalizedName( self, stLocale, cName ):
oLocalizedName = self.createUnoStruct( "com.sun.star.sheet.LocalizedName" )
oLocalizedName.Locale = stLocale
oLocalizedName.Name = cName
return oLocalizedName

#----------------------------------------
# Interface: XAddIn
# Inherits from... XLocalizable
#----------------------------------------

# string
# getProgrammaticFuntionName( [in] string aDisplayName );
# Note: the method name spelling error is in the API!
def getProgrammaticFuntionName( self, cDisplayFnName ):
if cDisplayFnName == "AddFive":
return "nom.DannyBrewer.test.DannysCalcFunctions1.AddFive"
elif cDisplayFnName == "AddSix":
return "nom.DannyBrewer.test.DannysCalcFunctions1.AddSix"
return ""

# string
# getDisplayFunctionName( [in] string aProgrammaticName );
def getDisplayFunctioName( self, cProgrammaticFnName ):
if cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddFive":
return "AddFive"
elif cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddSix":
return "AddSix"
return ""

# string
# getFunctionDescription( [in] string aProgrammaticName );
def getFunctionDescription( self, ccProgrammaticFnName ):
if cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddFive":
return "Adds five to the argument."
elif cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddSix":
return "Add six to the argument."
return ""

# string
# getDisplayArgumentName( [in] string aProgrammaticName
# [in] long nArgument );
def getDisplayArgumentName( self, ccProgrammaticFnName, nArgNum ):
if cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddFive":
if nArgNum == 0:
return "number"
elif cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddSix":
if nArgNum == 0:
return "number"
return ""

# string
# getArgumentDescription( [in] string aProgrammaticName
# [in] long nArgument );
def getArgumentDescription( self, ccProgrammaticFnName, nArgNum ):
if cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddFive":
if nArgNum == 0:
return "A number to which five will be added."
elif cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddSix":
if nArgNum == 0:
return "A number to which six will be added."
return ""

# string
# getProgrammaticCategoryName( [in] string aProgrammaticName );
def getProgrammaticCategoryName( self, ccProgrammaticFnName ):
if cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddFive":
return "Add-In"
elif cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddSix":
return "Add-In"
return ""

# string
# getDisplayCategoryName( [in] string aProgrammaticName );
def getDisplayCategoryName( self, ccProgrammaticFnName ):
if cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddFive":
return "Add-In"
elif cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddSix":
return "Add-In"
return ""

#----------------------------------------
# Interface: XCompatibilityNames
#----------------------------------------

# sequence< LocalizedName >
# getCompatibilityNames( [in] string aProgrammaticName );
def getCompatibilityNames( self, ccProgrammaticFnName ):
if cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddFive":
return (
self.makeLocalizedName( self.makeLocale( "en", "US", "" ),
"AddFive" )
,)
elif cProgrammaticFnName == "nom.DannyBrewer.test.DannysCalcFunctions1.AddSix":
return (
self.makeLocalizedName( self.makeLocale( "en", "US", "" ),
"AddSix" )
,)
return ()

#----------------------------------------
# Interface: XLocalizable
# This is here because XAddIn inherits it.
#----------------------------------------

# void
# setLocale( [in] Locale eLocale );
def setLocale( self, stLocale ):
return

# Locale
# getLocale();
def getLocale( self ):
return self.makeLocale( "en", "US", "" )

#----------------------------------------
# Interface: XServiceName
#----------------------------------------

# string
# getServiceName();
def getServiceName( self ):
return "nom.DannyBrewer.test.DannysCalcFunctions1"

# add the class to the implementation container,
# which the loader uses to register/instantiate the component.
g_ImplementationHelper.addImplementation( \
# The class
DannysCalcFunctions1,
# The implementation name.
# Change this name for your own service.
"nom.DannyBrewer.test.DannysCalcFunctions1",
# A list of services that that are implemented.
("com.sun.star.sheet.AddIn",), )

</source>

Final notes on the code by danny:
It is also worth noting that I have not figured out where to actually implement the two functions AddFive() and AddSix(). All of the above is just the infrastructure for making the two functions and their descriptions and argument lists known to Calc.

I still have to finish reading the above linked section of the Developer's Guide again. Maybe I can figure out what I'm missing. Or maybe there is a fully working Calc function example somewhere else (even in a different language?) that I can examine?

Python

2015-02-17T16:08:10Z

JZA: move content to the wiki

{{Extensions}}
[[image:Py-uno_128.png|PyUNO Logo]] [[image:Pyuno_logo_a.jpg]]

=== Python and OpenOffice ===
Apache OpenOffice 4 ships with the Python scripting language, version 2.7. OpenOffice.org 3.1 and above shipped with Python version 2.6.1 and older OpenOffice.org releases shipped with Python version 2.3.4. This Python distribution via OpenOffice comes with the [[Uno]] module, which connects the [[API|UNO API]] to the python scripting language. To run this version of Python on Linux, you can go directly to the OpenOffice PATH. And as one would expect with any distribution of Python, AOO-Python can be run from the command line as well.

If you already have a separate Python installation, you can import the uno module (the Python-UNO bridge) to it using [http://forum.openoffice.org/en/forum/viewtopic.php?f=45&t=36370&p=166783 these instructions].

If you already have a different version of Python installed on Windows, you can also access the [[API|UNO API]] using the [http://forum.openoffice.org//en/forum/viewtopic.php?f=45&t=36608&p=167909 COM bridge] instead of the Python bridge. Requires the [http://sourceforge.net/projects/pywin32/ add-on pywin32] module so Python can talk to COM. Note that while the UNO API is uniform, the implementation by the two bridges is slightly different, so the syntax required by each is also sometimes different.

==== Where is the IDE ? ====
OpenOffice's IDE doesn't support Python, so development has to be done from another editor that does. Any volunteer for a binding is welcomed. Here is a nice [http://pythonconquerstheuniverse.wordpress.com/category/the-python-debugger/ blog post] about using [http://www.vim.org VIM] a common Unix/Linux text editor configured in a way that acts like an IDE. Windows users can use [http://www.vim.org/download.php#pc Gvim] and [http://macvim.org/ MacVim] for OSX users.

==== Tips & Tricks ====

Here is some useful information about using python in AOO.

===== Debug output =====

If you launch a python script, any error will silently break the execution, making your extension hard to debug. To change this behaviour, one can change the
'''LogLevel'''
.

Have a look in
''/path/to/aoo/program/'''pythonscript.py'''''
and replace
''LogLevel.use = LogLevel.'''NONE'''''
with
''LogLevel.use = LogLevel.'''DEBUG'''''
.

There are also currently-undocumented environment variables that tell the pyUno bridge to log every call. Set the environment variable
''export PYUNO_LOGLEVEL=ARGS''
. The output may be a little hard to read, but helpful nonetheless.

Note that his applies only to Linux. For Windows, you need some more switches, and the output gets written to files (there is no stdout on windows :-( ).

There are still some error messages that won't appear in these logs; this will improve in the near future (cws pyunofixes4). Once the cws is integrated, I will document these switches on the official pyuno site.

''Thanks to Joerg Budischewski''
.

=== Python specific information for Extension creation ===
To create extensions for python, it is important that you have enough familiarity with the UNO components, as well as with packaging your code for easy distribution through the ''OpenOffice package manager''. Please check the tutorials to learn how to component-ize your code, and how to deploy remote scripting through a service implementation.

To learn to run Python on Windows, visit [[Using Python on Windows| this link]] for more detailed information.

{| align="center" cellspacing="0" cellpadding="0" style="border: 0px solid rgb(134, 194, 230);"
|- valign="top"
| style="width: 35%; padding-right: 15px;" | <div style="border-style: solid solid none; border-color: rgb(134, 194, 230) rgb(134, 194, 230) -moz-use-text-color; border-width: 1px 1px medium; padding: 5px; font-size: 120%; font-weight: bold; background-color: rgb(203, 222, 250);">Getting Started</div> <div style="border: 1px solid rgb(155, 192, 245); padding: 5px 5px 10px;">
*[[Python/Python_Language_Binding|Python Language Binding]]
*[[Python/Python_Loader|Python Loader]]
*[[Using Python on Windows]] - New to Python? Learn how to use python on Windows
*[[Using Python on Linux]] - A must read for an overview on Python and AOO relations
* [[pyUNO bridge]] - Official page of the PyUNO bridge at the [http://udk.openoffice.org/ UDK site] - ([http://www.fatcow.com/edu/mathtex-be/ ''Belorussian translation''])
* [[Python as a macro language]] in OpenOffice.org 2.x - How to use the Python scripting framework
* [[Python/Transfer_from_Basic_to_Python|Transfer from Basic to Python]]
* [http://lucasmanual.com/mywiki/OpenOffice PyUNO Manual] Lukasz created a pyUNO manual. '''new'''
* [[SQLAlquemyPyUNO|SQLAlchemy and PyUNO]] connecting OpenOffice to any database
* [http://www.linuxjournal.com/content/starting-stopping-and-connecting-openoffice-python Starting/Stopping and connecting using Python] From Linux Journal
* Introduction on testing pyUNO programs with [[doctests]]
* Create a [[PythonDialogBox|dialog box]] in PyUNO.
* [http://codesnippets.services.openoffice.org/Office/Office.ConnectViaPipe.snip Connect to Openoffice] from PyUNO
* [[PyUNO samples]] currently shipping with OpenOffice.org and the explanation.
* Enhanced [http://www.oooforum.org/forum/viewtopic.phtml?p=257496#257496 Capitalized.py] script by ''The gray Cardinal'' at the OpenOffice forum.

| style="width: 35%; padding-right: 15px;" | <div style="border-style: solid solid none; border-color: rgb(134, 194, 230) rgb(134, 194, 230) -moz-use-text-color; border-width: 1px 1px medium; padding: 5px; font-size: 120%; font-weight: bold; background-color: rgb(203, 222, 250);">PYUNO Modules</div> <div style="border: 1px solid rgb(155, 192, 245); padding: 5px 5px 10px;">
*[[Danny's Python Modules]] - Collection guide from DannyB's modules.
*[[PrinttoWriter.py]] - This makes it easy and convenient to print a bunch of text into a Writer document.
*[[CalcFunctions]] - Learn how Python can be used to develop Calc functions in Python
*[[[Python-Calc]] - Various scripts to deal with Calc
*[[PythonContainers]] - Python container components
*[[PyUNOServer]] - The PyUNOServer is a script that works as an XML server for OpenOffice.org Calc
*[[calcParser]] - calcParser is a small parser using the native SAX utilities within the OpenOffice.org python
*[[OoConfig]] - OoConfig is a Python extension that seeks to provide a configuration editing facility similar to Mozilla's about:config
*[[Bibliographic/Hints and Tips/OOoRISExport.py|OOoRISExport.py]] - Exports the bibliographic database in RIS format. Also [http://bibliographic.openoffice.org/files/documents/124/3078/RISImport.py RISImport.py]
*[[Zotero_Plugin |Zotero Plugin]] - The Zotero plugin provides citation and bibliographic table insertion and editing functions for Writer documents.
*[http://oosheet.hacklab.com.br/ OOSheet] - High level python library to develop spreadsheet macros without the complexity of Uno. Focuses on spreadsheets, but may be useful for other documents.
|}

=== Hacking Around ===
*[[UNO component packaging]] - How to create UNO components as well as the basics of script componentizing
*[http://www.oooforum.org/forum/viewtopic.phtml?p=38234#38234 Python component to parse XML] - Python is great to parse XML, PyUNO is also excellent when working with XML
*[[Example of Service in Python]] - Learn how to run Python as a service, this is useful for remote scripting.
*[http://www.oooforum.org/forum/viewtopic.phtml?p=76972#76972 Modify spreadsheet] - Example of storing and retrieving a custom attribute on a spreadsheet cell.
*A simple [[daemon in Python]] - Learn how to run Python as a daemon
*[[Loook.py]] - a simple Python tool that searches for text strings in OpenOffice.org.
*[[odt2txt.py]] - convert ODF to plain text using python (and convert the txt to html).

=== Python rules OpenOffice (by B. Bois) ===
[[image:python_power_for_OOo.png|Python rules OpenOffice :-)]]

[[Category:Extensions]]
[[Category:Python]]
[[Category:Uno]]

Documentation/FAQ/Installation/How do I install Apache OpenOffice on Mac OS X?

2015-02-02T16:40:07Z

JZA:

{{DISPLAYTITLE:How do I install OpenOffice on Mac OS X?}}

<section begin=question />
'''How do I install OpenOffice on Mac OS X?'''
<section end=question />

<section begin=answer />



Visit the OpenOffice website at http://www.openoffice.org and locate the icon with the download option on the top menu bar of the website with the word 'Download'.

Click on it and you will be presented with a green area holding some options. Make sure your operating system 'OSX 64-bits' is selected (unless you have an older mac which would be 32-bit).

Select the version and language and click on '''Download full installation'''.

* Download the .dmg installation file.

* Drag and drop the OOo icon to the Application icon.

<section end=answer />

[[Category:Documentation/FAQ/Installation|1 Installation]]

User:JZA

2014-10-24T16:33:06Z

JZA: Reverted edits by JZA (talk) to last revision by Jza

Experienced member of the community with good experience in the codebase of openoffice.org and leadership managing open source groups. Have participated in tasks realated to promotion, consulting and trainning in free and open source software. Had also work for multinationals on Linux system administration and business development.

Had a professional background developed in the branch of IT in the United States, Eastern and Western Europe and Latin america.

Name: Alexandro Colorado
[[image:JZA_jathumb.jpg|right]]

Position: [http://es.openoffice.org Co-Lead of OpenOffice.org Spanish]

Years in the community: 8years (2002)

Years as an [[OOoES]] Lead: 6years (2004)

==== Position ====
* [[OOoES |OpenOffice.org ES]] community leader
* [http://bizdev.openoffice.org OpenOffice.org BizDev] community Co-lead
* [[Education_Project/Effort |OpenOffice.org Education]] community Co-lead
* [http://marketing.openoffice.org/contacts.html#namerica Community contact for Mexico]

==== Projects involved ====
* [http://es.openoffice.org OpenOffice.org Español]
** Web development
** Mailing list moderator
** Documentator
** Languge lead
* [http://xml.openoffice.org OpenOffice.org XML]
** Developer
* [http://dba.openoffice.org OpenOffice.org DBA]
** Documentator
* [http://marketing.openoffice.org OpenOffice.org Marketing]
** Marketing contact for Mexico
* [http://education.openoffice.org OpenOffice.org Education]
** Co-Lead for Education
** Certification tower lead
* [http://bizdev.openoffice.org OpenOffice.org BizDev]
** Co-Lead for BizDev
** Business database directory administrator
** Web development

Others:
* [http://www.alexandrocolorado.com/blog Personal OpenOffice.org Blog]
* [http://legacy.odeo.com/channel/24806/view/ OOoCast OpenOffice.org Podcast]

User:JZA

2014-10-24T16:31:54Z

JZA:

Experienced member of the community with good experience in the codebase of openoffice.org and leadership managing open source groups. Have participated in tasks realated to promotion, consulting and trainning in free and open source software. Had also work for multinationals on Linux system administration and business development.

Had a professional background developed in the branch of IT in the United States, Eastern and Western Europe and Latin america.

Name: Alexandro Colorado
[[image:JZA_jathumb.jpg|right]]

Position: [http://es.openoffice.org Co-Lead of OpenOffice.org Spanish]

Years in the community: 8years (2002)

Years as an [[OOoES]] Lead: 6years (2004)

==== Position ====
* [[OOoES |OpenOffice.org ES]] community leader
* [http://bizdev.openoffice.org OpenOffice.org BizDev] community Co-lead
* [[Education_Project/Effort |OpenOffice.org Education]] community Co-lead
* [http://marketing.openoffice.org/contacts.html#namerica Community contact for Latin america]

==== Projects involved ====
* [http://es.openoffice.org OpenOffice.org Español]
** Web development
** Mailing list moderator
** Documentator
** Languge lead
* [http://xml.openoffice.org OpenOffice.org XML]
** Developer
* [http://dba.openoffice.org OpenOffice.org DBA]
** Documentator
* [http://marketing.openoffice.org OpenOffice.org Marketing]
** Marketing contact for Mexico
* [http://education.openoffice.org OpenOffice.org Education]
** Co-Lead for Education
** Certification tower lead
* [http://bizdev.openoffice.org OpenOffice.org BizDev]
** Co-Lead for BizDev
** Business database directory administrator
** Web development

Others:
* [http://www.alexandrocolorado.com/blog Personal OpenOffice.org Blog]
* [http://legacy.odeo.com/channel/24806/view/ OOoCast OpenOffice.org Podcast]

Documentation/Building Guide AOO

2014-10-05T16:09:07Z

JZA: Added Notes

{{DISPLAYTITLE:Apache OpenOffice Building Guide}}

= Preface =
This guide will help you to build Apache OpenOffice from its source code. It details the prerequisites and explains how to download the source code, prepare and then run the build. [[Documentation/Building_Guide_AOO/Step_by_step|Step-by-step instructions]] for resolving the pre-requisites of individual platforms and building on them are available.

Here is the short version for the brave and impatient:
# Download the source: <code>svn co https://svn.apache.org/repos/asf/openoffice/trunk aoo</code>
# Configure: <code>cd main/ ; autoconf ; ./configure <some-switches> ; ./bootstrap</code>
# Build: <code>source <platform-dependend-name>.sh ; cd instsetoo_native ; build --all</code>
# Wait for an hour or more (The build can take up to 3 hours.)
# Enjoy

The detailed description below gives a broader introduction into the build process and explains for the various steps.

{{Template:Documentation/Note|This document is loosely based on an older [[Documentation/Building Guide|version]]. I have tried to avoid duplication and to move anything that all platforms have in common to this page. Many details have been removed on purpose because they refer to older version of OpenOffice.}}
* How to use cache

{{Documentation/SeeAlso|*[[How_to_build_Symphony%27s_source_code]] }}

= Getting help =
You can get help by searching this wiki or by asking questions on the [http://openoffice.apache.org/mailing-lists.html#development-mailing-list-public developers mailing list].

You can help us improve this guide by pointing out any errors (preferably after finding a solution).
Or don't be shy and edit (and improve) these pages yourself.

= Basics =

In order to build Apache OpenOffice you need a proper environment. This includes
* a command line interpreter, typically bourne shell compatible (sh or bash) inside a terminal. On Windows you will need to install Cygwin to provide it.
* C++ compiler and linker. The exact choice depends on the operating system.
* Perl interpreter and several modules.
* Many tools from the Unix world like make or sed.

See section [[#General_Build_Requirements | General Build Requirements]]
for an exact list of requirements.

= Getting the source =

The source code is available as SVN repository at https://svn.apache.org/repos/asf/openoffice

Check it out with

svn co https://svn.apache.org/repos/asf/openoffice/trunk aoo

More details about how to check out source code from SVN can be found [http://openoffice.apache.org/source.html here].

== Space Requirements ==

The checked out files take up somewhat over 5GB on disk (more than 150000 files in more than 7000 folders and the SVN overhead).

After building this becomes (on Windows7) almost 17GB (more than 406000 files in more than 23000 folders).

You can use git as well. There exists no guide for this, therefore ask on dev@openoffice.apache.org, if you want to use git.

= Organization of the source and output tree =

The source code has five top level directories:
;main/:contains most of the so called modules. Each module typically provides one or more libraries. The source code of the writer application for example can be found in main/sd/.
;test/:contains the new [[QA/test_automation_guide | automated testing framework]]
;ext_libraries/:is the new home of modules that build external libraries (libraries maintained outside of Apache OpenOffice and often outside Apache).
;ext_sources/:contains the tar balls (archives) of external libraries. They are included both for convenience and to make sure that specific versions remain available. Note that the source package of the Apache OpenOffice release does not contain any external tar balls.
;extras/:holds the localization data.

Most tools and scripts that are used for building are located below <code>main/solenv/</code>:
*dmake makefiles in <code>main/solenv/inc/</code>
*gmake makefiles in <code>main/solenv/gbuild/</code>
*executables and perl files in <code>main/solenv/bin/</code>
*perl modules in <code>main/bin/modules/</code>

Libraries and other output files that are shared between modules are stored in <code>main/solver/</code>.

=Building=

==Overview==

Building Apache OpenOffice consists of three steps:
;Configuring/bootstrapping:Detect platform, operating system, compiler, etc. and write the information into a shell script for later use. The developer can turn on or off certain features in this phase.
;Building:Compile the source code, transform other input files, apply localization.
;Packing:Create a set of files, the installation set, that can be installed on the respective operating system. This can be msi/cab files for windows, deb or rpm for Linux, dmg for Mac.

The configure step has to be carried out only once. Building and packing is necessary after every source code change. There are short cuts to avoid parts of these steps (when you know what you are doing.)

The building examples in this wiki document use only command line approaches to building. Depending on your expertise, it may be possible to use an IDE which allows specification of custom build scripts.

== General Build Requirements ==

The general requirements for all platforms are
{| class="prettytable"
|- valign="top"
! Requirement
! Description
! Configure switch
|- valign="top"
| Java JDK
| Java Implementation compatible with [http://java.sun.com/j2se/1.5/ JDK 1.5] or [http://java.sun.com/javase/6/ JDK 1.6]. [http://openjdk.java.net/ OpenJDK] is supported as well.

For Windows [http://www.oracle.com/technetwork/java/javase/downloads/index.html/ JDK 1.7] is recommended.
| --with-jdk-home=
|- valign="top"
| Perl
| Perl 5 - note: for Windows Perl will be installed as part of the cygwin environment.

Also required are the perl packages
Archive::Zip
LWP::UserAgent
XML::Parser
They can be installed from the shell with (you may have to run it with super user/administrator rights)
perl -MCPAN -e shell
If it is executed for the first time then CPAN will ask for configuration. Choose autoconfiguration.
Eventually the CPAN shell appears accepts commands. Install missing modules with
install <module-name>
Find more details [http://wiki.services.openoffice.org/wiki/CPAN_install here].<sup>5</sup>
|- valign="top"
| CUPS
| cups headers. Provided by a cups-devel package or a libcups2-devel

note: not for Windows
|- valign="top"
| PAM
| PAM support. Provided by a pam-devel package or a libpam-dev

note: not for Windows
|- valign="top"
| Apache Ant
| [http://ant.apache.org/ Ant 1.9 or later] (see note)
| --with-ant-home=
|- valign="top"
| Archiver
| zip and unzip - note: for Windows zip and unzip will be installed as part of the cygwin environment.
|- valign="top"
| gperf
| [http://www.gnu.org/software/gperf/gperf.html gperf] tool - note: for Windows gperf will be installed as part of the cygwin environment.
|- valign="top"
| NSS<sup>1</sup>
| For Windows the Mozilla build tools<sup>2</sup> are needed to build the nss module. They can be obtained [http://ftp.mozilla.org/pub/mozilla.org/mozilla/libraries/win32/ here].
|- valign="top"
| unowinreg.dll
| [http://tools.openoffice.org/unowinreg_prebuild/680/unowinreg.dll pre-built unowinreg.dll] (see note)
Without this file, configure will try to set up cross-compiling with windows.
note: Not for windows. Required on all non-windows platforms. Download with:
cd $SRC/main && wget -O external/unowinreg/unowinreg.dll http://tools.openoffice.org/unowinreg_prebuild/680/unowinreg.dll
|-
|}

'''Notes:'''
# The nss module ("Network Security Services") provides security services needed for e.g. password protection. NSS can be disabled using the configure switch <tt>--disable-nss-module</tt>.
# NSS is provided by the Mozilla project. Building it on Windows requires the [http://ftp.mozilla.org/pub/mozilla.org/mozilla/libraries/win32 MozillaBuild tools]. Get the latest version, install it and use the configure switch <tt>--with-mozilla-build</tt> to tell configure where the tools are installed. For example: <tt>--with-mozilla-build=c:/mozilla-build</tt>
# Please note that CPAN is not able to deal with usernames containing spaces. To work around this fact, when CPAN asks you to specify the CPAN build and cache directory, change the default suggestion to /cpan.
# Apache Ant: Assure a proper ant set-up by downloading and installing ant, in total, from the ant site linked above. If you are a Linux developer, your distro may not have ant setup correctly for building Apache OpenOffice.
# Use <tt>./configure --help</tt> to see all possible configuration options

See also the platform specific requirements for
*[[Documentation/Building_Guide_AOO/Building_on_Windows|Windows]]
*[[Documentation/Building_Guide_AOO/Building_on_Linux|Linux]]
*[[Documentation/Building_Guide_AOO/Building_on_MacOsX|MacOSX]]

==Configuration and bootstrapping==
This is typically done only once after the source code is checked out. Repeat this after changing your mind about options given to configure.

The call to
autoconf
creates the main/configure script from main/configure.in and some other input files.

The set of options/switches given to configure depends on the platform and your choice of features. To see all configure options for your system, type:
configure --help

A typical configuration call starts like this --
configure \
--with-dmake-url=http://dmake.apache-extras.org.codespot.com/files/dmake-4.12.tar.bz2 \
--with-epm-url=http://www.msweet.org/files/project2/epm-3.7-source.tar.gz \
It tells configure where to find the source code of external tools dmake and epm.

By default only source code under [http://www.apache.org/legal/3party.html#category-a category A] licenses is compiled and included. Besides the Apache License 2.0 this includes for example BSD and MIT/X11 license. If you want to enable features that rely on third party code under [http://www.apache.org/legal/3party.html#category-b category B] licenses (like MPL, CPL, EPL, etc) then add the option
--enable-category-b

For inclusion of externally hosted dictionary extensions add option
--enable-bundled-dictionaries
Note that dictionaries rely on a category B third party library (hunspell). Therefore <code>--enable-category-b</code> is a prerequisite for <code>--enable-bundled-dictionaries</code>. Dictionaries have a variety of licenses and are bundled without modification: they are not compiled.

The <code>--with-lang</code> option will introduce the build of additional language resources. This switch accepts one or more RFC 1766 language tags as arguments, unfortunately not all languages are supported. Check the <code>[http://svn.apache.org/viewvc/openoffice/trunk/main/solenv/inc/langlist.mk?view=markup solenv/inc/langlist.mk]</code> file for all the currently supported language tags. The environment variable WITH_LANG will then contain the language tags of the additional (en-US will always be build) languages. Example:
--with-lang="de fr"
enables the build of the localized German and French version.

To build with symbolic generation, add option
--enable-symbols
This would allow you to work with debugging symbols in gdb.

By default the result binaries will be packaged in the default format used by your OS/Distribution. Sometimes you might need a 'installed' format so that all files were put into installset directory. Add option
--with-package-format="installed"
This will speed up development process since it skipped packaging. In some cases, packaging rips the debugging symbol so this would be necessary for symbolic generation.

You can run the rat scan while building with option
--with-rat-scan
[[Documentation/Building_Guide_AOO/Rat_Scan|Here]] you can find details of the rat scan.

Finish this step by running
./bootstrap
This will build dmake and epm, download missing source code tar balls of external libraries, and download missing external dictionary extensions.

==Building==
Start by including the environment variables prepared by configure into your current environment with
<tt>source <shell-script-name></tt>
where <shell-script-name> depends on your platform:
{| class="prettytable"
|-
!platform id
!<shell-script-name>
|-
| wntmsci12
| winenv.set.sh
|-
| unxlngi6
| LinuxX86Env.Set.sh
|-
| unxlngx6
| LinuxX86-64Env.Set.sh
|-
| unxmacci
| MacOSXX64Env.Set.sh
|}
Look into main/set_soenv for more platforms. (search for lines <code>$OUTPATH = "<platform>";</code> and the nearby line <code>$outfile = "<shell-script-name>";</code>. Add the suffix <code>.sh</code> for the bash variant.

If you want to build the whole office and the install sets then
cd main/instsetoo_native
build --all
You may want to experiment with the -P options for multi process builds to reduce the build time.
build --all -P<m> -- -P<n>
tells build to use <code>m</code> processes (build up to <code>m</code> modules in parallel) and <code>n</code> threads for each module.

Details about creating installation sets can be found [[Building_installation_packages|here]].

Building Apache OpenOffice uses a custom build command, build.pl, located in /main/solenv/bin.
You may find it helpful to learn more about build options from the [http://www.openoffice.org/tools/tools/build.html Build Documentation]

==Partial Builds==

Building the whole office takes a lot of time. Therefore it may be preferable to build only parts after making changes to the source code.
There are two different types of partial builds:
;Compatible:Can be used only when the code changes do not change exported interfaces. Use with care and only when you know what you are doing.
;Incompatible:Use for code changes that modify exported C++ or IDL interfaces, that modify resources that are used by other modules, or when you are not sure.
:If you are a new developer, you should probably always assume your changes are "incompatible" and follow the instructions for '''Incompatible Build'''.

===Make Systems Used by Apache OpenOffice===

For the following Build sections you should be aware that Apache OpenOffice uses two different '''make''' systems to build its modules.
*The older one is based on dmake
*The other and newer one is based on GNU make. This system is often referred to as gbuild.
When a module contains, among others, a Makefile and a Module_<module>.mk file then it is a gbuild module.

===Compatible Build===

After changing code in module <module> which does not change any exported interfaces do
{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build
deliver
|
cd <module>
make -sr
No explicit call to <code>deliver</code> is necessary for gbuild modules.
|}
to compile and deliver the resulting libraries to <code>main/solver/</code>. You may want to erase the output of a previous compilation:
{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build --from <module> --prepare
or faster (but without the un-deliver)
cd <module>
rm -fr <platform>/
|
cd <module>
make clean
|}

===Incompatible Build===

Modifications that change exported interfaces require not only the module to be rebuild that contains the modified code. All depending modules (dependencies are defined in <code><module>/prj/build.lst</code>) have to be rebuild as well. This is best done from <code>main/instsetoo_native/</code>:
<tt>cd main/instsetoo_native/</tt>
<tt>build --from <incompatible-module> --prepare</tt>
<tt>build --from <incompatible-module></tt>

The second line removes the output of all modules that have to be recompiled. The drawback of this command is that the output of modules which are build via gbuild are not removed. Thus, the following additional command performed after the second one will do the trick:
build --from <incompatible-module> --job="make clean; make clean debug=t" --ignore

===Frequently used options===

In order to add debug information to libraries and executables, add the <code>debug</code> switch to any <code>build</code> or <code>make</code> command:
{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build debug=t
|
cd <module>
make -sr debug=t
|}
Remember that for the gbuild system you have to use the debug flag also when cleaning a module (otherwise eg the wrong precompiled headers are deleted and are not rebuilt):
make clean debug=t

You can force make to rebuild dependency information by first deleting it with the depend option. It would be rebuilt automatically with the next build:
{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build depend=t
build
|
cd <module>
make -sr depend=t
make -sr
|}

= [http://wiki.openoffice.org/wiki/Documentation/Building_Guide_AOO/Step_by_step Step-by-Step Building Guide for Different Platforms] =
[[Category:Documentation]][[Category:Development]][[Category:Porting]]

= Building Apache OpenOffice with an IDE =
== [https://wiki.openoffice.org/wiki/OpenOffice_and_Eclipse Building with Eclipse] ==

Documentation/DevGuide/AppendixB/Useful XHTML Tags

2014-06-15T00:09:11Z

JZA: Source highlight

{{Documentation/DevGuide/AppendixBTOC
|ShowPrevNext=block
|PrevPage=Documentation/DevGuide/AppendixB/Special Documentation Tags
|NextPage=Documentation/DevGuide/AppendixC/Universal Content Providers
}}
{{Documentation/DevGuideLanguages|Documentation/DevGuide/AppendixB/{{SUBPAGENAME}}}}
{{DISPLAYTITLE:Useful XHTML Tags}}
__NOTOC__
Only a few XHTML tags are required for writing the documentation in idl files. The most important ones are listed in this section.

=== Paragraph: <nowiki><p> ... </p></nowiki> ===

This tag marks a normal paragraph. Consider that line breaks and empty lines in the idl file do not cause a line break or a paragraph break in the layout version. Explicit paragraph break markups, are necessary.

{{Documentation/Caution|Do not use <nowiki><br/></nowiki> or CR/LF for marking paragraphs. CR and LF are ignored, except within <nowiki><pre>...</pre></nowiki> and <nowiki><listing>...</listing></nowiki> areas. The <nowiki><br/></nowiki> tag is only for rare cases of explicit linebreaks.
<source lang=cpp>
/** does this and that.

This sentence should start with a "<p>". If not,
it still belongs to the previous paragraph!

This still belongs to the first paragraph. <nowiki><br/></nowiki>
As this sentence is as well!
*/
</source>
Consider using <tt>&lt;</tt> for <tt><</tt> and <tt>&gt;</tt> for <tt>></tt>, as shown in the example above.}}

=== Line Break: <nowiki><br/></nowiki> ===

This tag marks up a line break within the same paragraph. Consider line breaks and empty lines in the idl file do not cause a line break or a paragraph break when presented by the HTML browser. Explicit paragraph break markups are necessary.

=== Unordered List: <nowiki><ul><li> ... </li>... </ul></nowiki> ===

These tags mark the beginning and end of an unordered list, as list items.

Example:

<source lang=html4strict><ul>
<li>the first item </li>
<li>the second item </li>
<li>the third item </li>
</ul></source>

results in a list similar to:

* the first item
* the second item
* the third item

=== Ordered List: <nowiki><ol><li> ... </li>... </ol></nowiki> ===

These tags mark the beginning and end of an ordered list, as list items.

Example:

<source lang=html4strict><ol>
<li>the first item </li>
<li>the second item </li>
<li>the third item </li>
</ol></source>

results in a list similar to:

1.the first item

2.the second item

3.the third item

=== Definition List: <nowiki><dl><dt> ... </dt><dd> ... </dd>... </dl></nowiki> ===

These tags mark the beginning and end of a definition list, the definition tags and the definition data.

Example:

<source lang=html4strict><dl>
<dt>the first item</dt>
<dd>asfd asdf asdf asdf asdf</dd>

<dt>the second item</dt>
<dd>asfd asdf asdf asdf asdf</dd>

<dt>the third item</dt>
<dd>asfd asdf asdf asdf asdf</dd>
</dl></source>

results in a list similar to:

the first item
::asfd asdf asdf asdf asdf
the second item
::asfd asdf asdf asdf asdf
the third item
::asfd asdf asdf asdf asdf

=== Table: <nowiki><table><tr><td>...</td>...</tr>...</table></nowiki> ===

Defines a table with rows (tr) and columns (td).

=== Strong Emphasis: <nowiki><strong> ... </strong></nowiki> ===

These tags present a piece of text that is emphasized. In most cases this is bold, but the HTML-client defines what it actually is.

=== Slight Emphasis: <nowiki><em> ... </em></nowiki> ===

These tags present a piece of text emphasized slightly. In most cases this is italic, but the HTML-client defines what it actually is .

=== Anchor: <nowiki><a href="..."> ... </a></nowiki> ===

These tags specify a link to external documentation. The first "..." specifies the URL.

{{PDL1}}

[[Category:Documentation/Developer's Guide/Appendix]]

Documentation/DevGuide/AppendixB/Useful XHTML Tags

2014-06-15T00:07:45Z

JZA: /* Unordered List: ... ... */

{{Documentation/DevGuide/AppendixBTOC
|ShowPrevNext=block
|PrevPage=Documentation/DevGuide/AppendixB/Special Documentation Tags
|NextPage=Documentation/DevGuide/AppendixC/Universal Content Providers
}}
{{Documentation/DevGuideLanguages|Documentation/DevGuide/AppendixB/{{SUBPAGENAME}}}}
{{DISPLAYTITLE:Useful XHTML Tags}}
__NOTOC__
Only a few XHTML tags are required for writing the documentation in idl files. The most important ones are listed in this section.

=== Paragraph: <nowiki><p> ... </p></nowiki> ===

This tag marks a normal paragraph. Consider that line breaks and empty lines in the idl file do not cause a line break or a paragraph break in the layout version. Explicit paragraph break markups, are necessary.

{{Documentation/Caution|Do not use <nowiki><br/></nowiki> or CR/LF for marking paragraphs. CR and LF are ignored, except within <nowiki><pre>...</pre></nowiki> and <nowiki><listing>...</listing></nowiki> areas. The <nowiki><br/></nowiki> tag is only for rare cases of explicit linebreaks.
<source lang=cpp>
/** does this and that.

This sentence should start with a "<p>". If not,
it still belongs to the previous paragraph!

This still belongs to the first paragraph. <nowiki><br/></nowiki>
As this sentence is as well!
*/
</source>
Consider using <tt>&lt;</tt> for <tt><</tt> and <tt>&gt;</tt> for <tt>></tt>, as shown in the example above.}}

=== Line Break: <nowiki><br/></nowiki> ===

This tag marks up a line break within the same paragraph. Consider line breaks and empty lines in the idl file do not cause a line break or a paragraph break when presented by the HTML browser. Explicit paragraph break markups are necessary.

=== Unordered List: <nowiki><ul><li> ... </li>... </ul></nowiki> ===

These tags mark the beginning and end of an unordered list, as list items.

Example:

<source lang=html4strict><ul>
<li>the first item </li>
<li>the second item </li>
<li>the third item </li>
</ul></source>

results in a list similar to:

* the first item
* the second item
* the third item

=== Ordered List: <nowiki><ol><li> ... </li>... </ol></nowiki> ===

These tags mark the beginning and end of an ordered list, as list items.

Example:

<source lang=html4><ol>
<li>the first item </li>
<li>the second item </li>
<li>the third item </li>
</ol></source>

results in a list similar to:

1.the first item

2.the second item

3.the third item

=== Definition List: <nowiki><dl><dt> ... </dt><dd> ... </dd>... </dl></nowiki> ===

These tags mark the beginning and end of a definition list, the definition tags and the definition data.

Example:

<source lang=html4><dl>
<dt>the first item</dt>
<dd>asfd asdf asdf asdf asdf</dd>

<dt>the second item</dt>
<dd>asfd asdf asdf asdf asdf</dd>

<dt>the third item</dt>
<dd>asfd asdf asdf asdf asdf</dd>
</dl></source>

results in a list similar to:

the first item
::asfd asdf asdf asdf asdf
the second item
::asfd asdf asdf asdf asdf
the third item
::asfd asdf asdf asdf asdf

=== Table: <nowiki><table><tr><td>...</td>...</tr>...</table></nowiki> ===

Defines a table with rows (tr) and columns (td).

=== Strong Emphasis: <nowiki><strong> ... </strong></nowiki> ===

These tags present a piece of text that is emphasized. In most cases this is bold, but the HTML-client defines what it actually is.

=== Slight Emphasis: <nowiki><em> ... </em></nowiki> ===

These tags present a piece of text emphasized slightly. In most cases this is italic, but the HTML-client defines what it actually is .

=== Anchor: <nowiki><a href="..."> ... </a></nowiki> ===

These tags specify a link to external documentation. The first "..." specifies the URL.

{{PDL1}}

[[Category:Documentation/Developer's Guide/Appendix]]

Documentation/DevGuide/AppendixB/Useful XHTML Tags

2014-06-15T00:05:57Z

JZA: Html highlight

{{Documentation/DevGuide/AppendixBTOC
|ShowPrevNext=block
|PrevPage=Documentation/DevGuide/AppendixB/Special Documentation Tags
|NextPage=Documentation/DevGuide/AppendixC/Universal Content Providers
}}
{{Documentation/DevGuideLanguages|Documentation/DevGuide/AppendixB/{{SUBPAGENAME}}}}
{{DISPLAYTITLE:Useful XHTML Tags}}
__NOTOC__
Only a few XHTML tags are required for writing the documentation in idl files. The most important ones are listed in this section.

=== Paragraph: <nowiki><p> ... </p></nowiki> ===

This tag marks a normal paragraph. Consider that line breaks and empty lines in the idl file do not cause a line break or a paragraph break in the layout version. Explicit paragraph break markups, are necessary.

{{Documentation/Caution|Do not use <nowiki><br/></nowiki> or CR/LF for marking paragraphs. CR and LF are ignored, except within <nowiki><pre>...</pre></nowiki> and <nowiki><listing>...</listing></nowiki> areas. The <nowiki><br/></nowiki> tag is only for rare cases of explicit linebreaks.
<source lang=cpp>
/** does this and that.

This sentence should start with a "<p>". If not,
it still belongs to the previous paragraph!

This still belongs to the first paragraph. <nowiki><br/></nowiki>
As this sentence is as well!
*/
</source>
Consider using <tt>&lt;</tt> for <tt><</tt> and <tt>&gt;</tt> for <tt>></tt>, as shown in the example above.}}

=== Line Break: <nowiki><br/></nowiki> ===

This tag marks up a line break within the same paragraph. Consider line breaks and empty lines in the idl file do not cause a line break or a paragraph break when presented by the HTML browser. Explicit paragraph break markups are necessary.

=== Unordered List: <nowiki><ul><li> ... </li>... </ul></nowiki> ===

These tags mark the beginning and end of an unordered list, as list items.

Example:

<source lang=html4><ul>
<li>the first item </li>
<li>the second item </li>
<li>the third item </li>
</ul></source>

results in a list similar to:

* the first item
* the second item
* the third item

=== Ordered List: <nowiki><ol><li> ... </li>... </ol></nowiki> ===

These tags mark the beginning and end of an ordered list, as list items.

Example:

<source lang=html4><ol>
<li>the first item </li>
<li>the second item </li>
<li>the third item </li>
</ol></source>

results in a list similar to:

1.the first item

2.the second item

3.the third item

=== Definition List: <nowiki><dl><dt> ... </dt><dd> ... </dd>... </dl></nowiki> ===

These tags mark the beginning and end of a definition list, the definition tags and the definition data.

Example:

<source lang=html4><dl>
<dt>the first item</dt>
<dd>asfd asdf asdf asdf asdf</dd>

<dt>the second item</dt>
<dd>asfd asdf asdf asdf asdf</dd>

<dt>the third item</dt>
<dd>asfd asdf asdf asdf asdf</dd>
</dl></source>

results in a list similar to:

the first item
::asfd asdf asdf asdf asdf
the second item
::asfd asdf asdf asdf asdf
the third item
::asfd asdf asdf asdf asdf

=== Table: <nowiki><table><tr><td>...</td>...</tr>...</table></nowiki> ===

Defines a table with rows (tr) and columns (td).

=== Strong Emphasis: <nowiki><strong> ... </strong></nowiki> ===

These tags present a piece of text that is emphasized. In most cases this is bold, but the HTML-client defines what it actually is.

=== Slight Emphasis: <nowiki><em> ... </em></nowiki> ===

These tags present a piece of text emphasized slightly. In most cases this is italic, but the HTML-client defines what it actually is .

=== Anchor: <nowiki><a href="..."> ... </a></nowiki> ===

These tags specify a link to external documentation. The first "..." specifies the URL.

{{PDL1}}

[[Category:Documentation/Developer's Guide/Appendix]]

Documentation/DevGuide/AppendixB/Special Markups

2014-06-14T23:20:18Z

JZA: /* */

{{Documentation/DevGuide/AppendixBTOC
|ShowPrevNext=block
|PrevPage=Documentation/DevGuide/AppendixB/Element Documentation
|NextPage=Documentation/DevGuide/AppendixB/Special Documentation Tags
}}
{{Documentation/DevGuideLanguages|Documentation/DevGuide/AppendixB/{{SUBPAGENAME}}}}
{{DISPLAYTITLE:Special Markups}}
__NOTOC__
These markup tags are evaluated by the XSL processor that generates a layout version of the documentation, that is, into HTML or XHTML. These tags have to be well formed and in pairs with exactly the same upper and lowercase, as well.

To accentuate identifiers in the generated documentation and generate hyperlinks automatically when building the cross-reference table and checking consistency, all identifiers have to be marked up. Additionally, it is important for proofreading, because a single-word method name cannot be distinguished by a verb. Identifiers have to be excluded from re-editing by the proofreading editor.

The following markups are used:

=== <nowiki><atom></nowiki> ===

This markup is used for identifiers of atomar types, such as long, short, and string. If a sequence or array of the type is referred to, add the attribute dim with the number of bracket-pairs representing the number of dimensions.

Example:

<nowiki><atom>long</atom></nowiki>

For an example of sequences, see <nowiki><type></nowiki>.

=== <nowiki><type></nowiki> ===

This markup is used for identifiers of interfaces, services, typedefs, structs, exceptions, enums and constants-groups. If a sequence or array of the type is referred to, add the attribute dim with the number of bracket-pairs representing the number of dimensions.

Example:
<source lang=cpp>
<nowiki><type scope="com::sun::star::uno">XInterface</type>
<type dim="[][]">PropertyValue</type></nowiki>
</source>

=== <nowiki><member></nowiki> ===

This markup substitutes the deprecated method, field and property markups, and is used for fields of structs and exceptions, properties in service specifications and methods of interfaces.

Example:
<source lang=cpp>
<nowiki><member scope="com::sun::star::uno">XInterface::queryInterface()</member></nowiki>
</source>

=== <nowiki><const></nowiki> ===

This markup is used for symbolic constant identifiers of constant groups and enums.

Example:

<nowiki><const scope="...">ParagraphAdjust::LEFT</const></nowiki>

=== <nowiki><TRUE/>, <FALSE/></nowiki> ===

These markups represent the atomic constant for the boolean values TRUE and FALSE.

Example:

@returns
<nowiki><TRUE/> if the number is valid, otherwise <FALSE/>.</nowiki>

=== <nowiki><NULL/></nowiki> ===

This markup represents the atomic constant for a NULL value.

=== <nowiki><void/></nowiki> ===

This markup represents the atomic type void. This is identical to <nowiki><atom>void</atom></nowiki>.

=== <nowiki><code></nowiki> ===

This markup is used for inline code.

Example:

Use <nowiki><code>queryInterface( NULL )</code></nowiki> for:

<nowiki><listing>
This markup is used for multiple line code examples.
Example:
@example StarBASIC
<listing>
aCmp = StarDesktop.loadComponentFromURL( ... )
if ( isnull(aCmp) )
....
endif
</listing></nowiki>

{{PDL1}}

[[Category:Documentation/Developer's Guide/Appendix]]

Documentation/DevGuide/AppendixB/Special Markups

2014-06-14T23:19:20Z

JZA: Source highlited

{{Documentation/DevGuide/AppendixBTOC
|ShowPrevNext=block
|PrevPage=Documentation/DevGuide/AppendixB/Element Documentation
|NextPage=Documentation/DevGuide/AppendixB/Special Documentation Tags
}}
{{Documentation/DevGuideLanguages|Documentation/DevGuide/AppendixB/{{SUBPAGENAME}}}}
{{DISPLAYTITLE:Special Markups}}
__NOTOC__
These markup tags are evaluated by the XSL processor that generates a layout version of the documentation, that is, into HTML or XHTML. These tags have to be well formed and in pairs with exactly the same upper and lowercase, as well.

To accentuate identifiers in the generated documentation and generate hyperlinks automatically when building the cross-reference table and checking consistency, all identifiers have to be marked up. Additionally, it is important for proofreading, because a single-word method name cannot be distinguished by a verb. Identifiers have to be excluded from re-editing by the proofreading editor.

The following markups are used:

=== <nowiki><atom></nowiki> ===

This markup is used for identifiers of atomar types, such as long, short, and string. If a sequence or array of the type is referred to, add the attribute dim with the number of bracket-pairs representing the number of dimensions.

Example:

<nowiki><atom>long</atom></nowiki>

For an example of sequences, see <nowiki><type></nowiki>.

=== <nowiki><type></nowiki> ===

This markup is used for identifiers of interfaces, services, typedefs, structs, exceptions, enums and constants-groups. If a sequence or array of the type is referred to, add the attribute dim with the number of bracket-pairs representing the number of dimensions.

Example:
<source lang=cpp>
<nowiki><type scope="com::sun::star::uno">XInterface</type>
<type dim="[][]">PropertyValue</type></nowiki>
</source>

=== <nowiki><member></nowiki> ===

This markup substitutes the deprecated method, field and property markups, and is used for fields of structs and exceptions, properties in service specifications and methods of interfaces.

Example:

<nowiki><member scope="com::sun::star::uno">XInterface::queryInterface()</member></nowiki>

=== <nowiki><const></nowiki> ===

This markup is used for symbolic constant identifiers of constant groups and enums.

Example:

<nowiki><const scope="...">ParagraphAdjust::LEFT</const></nowiki>

=== <nowiki><TRUE/>, <FALSE/></nowiki> ===

These markups represent the atomic constant for the boolean values TRUE and FALSE.

Example:

@returns
<nowiki><TRUE/> if the number is valid, otherwise <FALSE/>.</nowiki>

=== <nowiki><NULL/></nowiki> ===

This markup represents the atomic constant for a NULL value.

=== <nowiki><void/></nowiki> ===

This markup represents the atomic type void. This is identical to <nowiki><atom>void</atom></nowiki>.

=== <nowiki><code></nowiki> ===

This markup is used for inline code.

Example:

Use <nowiki><code>queryInterface( NULL )</code></nowiki> for:

<nowiki><listing>
This markup is used for multiple line code examples.
Example:
@example StarBASIC
<listing>
aCmp = StarDesktop.loadComponentFromURL( ... )
if ( isnull(aCmp) )
....
endif
</listing></nowiki>

{{PDL1}}

[[Category:Documentation/Developer's Guide/Appendix]]

Documentation/DevGuide/AppendixB/Element Documentation

2014-06-14T22:43:40Z

JZA: Cpp source hightlight

{{Documentation/DevGuide/AppendixBTOC
|ShowPrevNext=block
|PrevPage=Documentation/DevGuide/AppendixB/File structure
|NextPage=Documentation/DevGuide/AppendixB/Special Markups
}}
{{Documentation/DevGuideLanguages|Documentation/DevGuide/AppendixB/{{SUBPAGENAME}}}}
{{DISPLAYTITLE:Element Documentation}}
__NOTOC__
=== General Element Documentation ===

Each element consists of three parts:

# a summary paragraph with XHTML/XML markups
# the main description with XHTML/XML markups
# extra parts formed by @-tags

==== Summary Paragraph ====

The first part ending with an XHTML paragraph tag, that is, <nowiki><p>, <dl>, <ul>, <ol></nowiki> etc.) or "@..." tag, is used as the summary in indexes.

{{Documentation/Caution|In contrast to JavaDoc, the first sentence is not used for the summary, but the first paragraph.}}

The first sentence begins with a lowercase letter if the name of the described element is the implied noun. In this case, the sentence must be logical when reading it with that name. Sometimes an auxiliary verb. in the most cases "is", has to be inserted.

==== Main Description ====

Between the summary paragraph and the "@..." tag there should be a clear and complete description about the declared element. This part must be delimited from the summary paragraph with an XHTML paragraph tag, including "<nowiki><dl></nowiki>" and "<nowiki><ol></nowiki>", that are starting a new paragraph.

==== @-Tagged Part ====

Put the @ tags at the end of each element's documentation. The tags are dependent on the kind of element described. Each of the @-tag ends when the elements documentation ends or the next @-tag begins.

The @author tag is superfluous, because the author is logged by the version control system. They are only used for {{PRODUCTNAME}} contributions if declarations are taken from other projects, such as Java.

The @version tag, known from JavaDoc, is not valid, because there cannot be more than one version of any UNOIDL element, due to compatibility.

On the same line behind the @-tag, only a single structural element is allowed. The parameter name is @param without the type and any attributes, the qualified exception is @throws , the qualified type is @see, and the programming language is @example. The @returns is by itself on the same line.

{{Documentation/Caution|Do not put normal text behind an @-tag on the same line:

/** ...

@param nPos put nothing else but the argument name here!
it is correct to put your documentation for the parameter here.

@throws com::sun::star::beans::UnknownPropertyException nothing else here!
when <nowiki><var>aName</var></nowiki> is not a known property.
*/
}}

=== Example for a Major Element Documentation ===

Each major element gets a header similar to the example shown below for an interface:
<source lang=Cpp>
//===========================================================================
/** controls lifetime of the object. Always needs a specified object owner.

<nowiki><p><em>Logical</em></nowiki> "Object" in this case means that the interfaces
actually can be supported by internal (i.e. aggregated) physical
objects. <nowiki></p></nowiki>

@see com::sun::star::uno::XInterface
for further information.

@since OOo 2.1.0
*/
interface XComponent: XInterface
{
</source>

=== Example for a Minor Element Documentation ===

Each minor element gets a header similar to the example shown below for a method:
<source lang=cpp>
//------------------------------------------------------------------------
/** adds an event listener to the object.

<nowiki><p>The broadcaster fires the disposing method of this listener if
the <method>XComponent::dispose()</method> method is called. </p></nowiki>

@param xListener
refers the the listener interface to be added.

@returns
<TRUE/> if the element is added, <FALSE/> otherwise.

@see removeEventListener
*/
boolean addEventListener( [in]XEventListener xListener );
</source>

{{PDL1}}

[[Category:Documentation/Developer's Guide/Appendix]]

Documentation/DevGuide/AppendixB/Element Documentation

2014-06-14T22:42:20Z

JZA: Source hightlight

{{Documentation/DevGuide/AppendixBTOC
|ShowPrevNext=block
|PrevPage=Documentation/DevGuide/AppendixB/File structure
|NextPage=Documentation/DevGuide/AppendixB/Special Markups
}}
{{Documentation/DevGuideLanguages|Documentation/DevGuide/AppendixB/{{SUBPAGENAME}}}}
{{DISPLAYTITLE:Element Documentation}}
__NOTOC__
=== General Element Documentation ===

Each element consists of three parts:

# a summary paragraph with XHTML/XML markups
# the main description with XHTML/XML markups
# extra parts formed by @-tags

==== Summary Paragraph ====

The first part ending with an XHTML paragraph tag, that is, <nowiki><p>, <dl>, <ul>, <ol></nowiki> etc.) or "@..." tag, is used as the summary in indexes.

{{Documentation/Caution|In contrast to JavaDoc, the first sentence is not used for the summary, but the first paragraph.}}

The first sentence begins with a lowercase letter if the name of the described element is the implied noun. In this case, the sentence must be logical when reading it with that name. Sometimes an auxiliary verb. in the most cases "is", has to be inserted.

==== Main Description ====

Between the summary paragraph and the "@..." tag there should be a clear and complete description about the declared element. This part must be delimited from the summary paragraph with an XHTML paragraph tag, including "<nowiki><dl></nowiki>" and "<nowiki><ol></nowiki>", that are starting a new paragraph.

==== @-Tagged Part ====

Put the @ tags at the end of each element's documentation. The tags are dependent on the kind of element described. Each of the @-tag ends when the elements documentation ends or the next @-tag begins.

The @author tag is superfluous, because the author is logged by the version control system. They are only used for {{PRODUCTNAME}} contributions if declarations are taken from other projects, such as Java.

The @version tag, known from JavaDoc, is not valid, because there cannot be more than one version of any UNOIDL element, due to compatibility.

On the same line behind the @-tag, only a single structural element is allowed. The parameter name is @param without the type and any attributes, the qualified exception is @throws , the qualified type is @see, and the programming language is @example. The @returns is by itself on the same line.

{{Documentation/Caution|Do not put normal text behind an @-tag on the same line:

/** ...

@param nPos put nothing else but the argument name here!
it is correct to put your documentation for the parameter here.

@throws com::sun::star::beans::UnknownPropertyException nothing else here!
when <nowiki><var>aName</var></nowiki> is not a known property.
*/
}}

=== Example for a Major Element Documentation ===

Each major element gets a header similar to the example shown below for an interface:
<source lang=Cpp>
//===========================================================================
/** controls lifetime of the object. Always needs a specified object owner.

<nowiki><p><em>Logical</em></nowiki> "Object" in this case means that the interfaces
actually can be supported by internal (i.e. aggregated) physical
objects. <nowiki></p></nowiki>

@see com::sun::star::uno::XInterface
for further information.

@since OOo 2.1.0
*/
interface XComponent: XInterface
{
</source>

=== Example for a Minor Element Documentation ===

Each minor element gets a header similar to the example shown below for a method:

//------------------------------------------------------------------------
/** adds an event listener to the object.

<nowiki><p>The broadcaster fires the disposing method of this listener if
the <method>XComponent::dispose()</method> method is called. </p></nowiki>

@param xListener
refers the the listener interface to be added.

@returns
<TRUE/> if the element is added, <FALSE/> otherwise.

@see removeEventListener
*/
boolean addEventListener( [in]XEventListener xListener );

{{PDL1}}

[[Category:Documentation/Developer's Guide/Appendix]]