Apache OpenOffice Wiki - User contributions [en]

VBA Stub

2009-08-03T06:05:45Z

Fong:

=== [possibly incomplete ] List of Writer Api which implementation does nothing ===

{| class="prettytable"
| '''Object'''
| '''Stub'''
| '''Note'''

|-
| Application
| Application.EnableCancelKey
|

|-
| Bookmarks
| Bookmarks.DefaultSorting

Bookmarks.ShowHidden
|

|-
| DocumentProperty
| DocumentProperty.LinkToContent

DocumentProperty.LinkSource

DocumentProperty.Name

DocumentProperty.Type
|

|-
| Find
| Find.ReplaceWildcards
|

|-
| HeaderFooter
| HeaderFooter.LinkToPrevious

|

|-
| Options
| Options.DefaultBorderLineStyle

Options.DefaultBorderLineWidth

Options.DefaultBorderColorIndex

Options.ReplaceSelection

Options.MapPaperSize

Options.AutoFormatAsYouTypeApplyHeadings

Options.AutoFormatAsYouTypeApplyBulletedLists

Options.AutoFormatAsYouTypeApplyNumberedLists

Options.AutoFormatAsYouTypeFormatListItemBeginning

Options.AutoFormatAsYouTypeDefineStyles

Options.AutoFormatApplyHeadings

Options.AutoFormatApplyLists

Options.AutoFormatApplyBulletedLists
|

|-
| PageSetup
| PageSetup.SectionStart

PageSetup.Gutter
|

|-
| View
| View.SplitSpecial
|

|-
| TableOfContents
| TableOfContents.TabLeader
|

|-
| ListLevel
| ListLevel.LinkedStyle

ListLevel.NumberFormat

ListLevel.ResetOnHeight
|

|-
| Document
| Document.Protect

Document.ProtectionType

Document.UpdateStylesOnOpen

Document.PrintOut

Document.HyphenationZone
|

|}

Porting notes

Porting notes

2009-05-13T06:28:51Z

Fong: /* [possibly incomplete ] List of Writer Objects to port from helperapi */

=== Things to watch out for ===
* The mapping of the vba constants is different. Take for example the <tt>xlGuess</tt> constant, in VBA it's fully qualified name is <tt>Excel.XlYesNoGuess.xlGuess</tt>, in the helperapi it's <tt>com.sun.star.helper.constant.XlYesNoGuess.xlGuess</tt> and in oovbaapi it's <tt>org.openoffice.excel.XlYesNoGuess.xlGuess</tt>
* All objects in the helperapi extend [http://api.openoffice.org/source/browse/*checkout*/api/helperapi/impl/com/sun/star/helper/HelperInterfaceAdaptor.java?rev=1.1 HelperInterfaceAdaptor], nothing similar (yet) exists in oovbaapi so this can be ignored in the implementation
* There are a quite few helper classes in the helperapi project e.g. <tt>RangeHelper.java</tt> they shouldn't be confused with the actual implementation objects we wish to port.
* classes and idl files of the same name can exist in multiple namespaces and this can be confusing. Because the helperapi was written with both the word and excel api(s) in mind there can be classes that share a common implementation and interfaces e.g.
** <tt>com/sun/star/helper/calc/XShape.idl</tt>
** <tt>com/sun/star/helper/common/XShape.idl</tt>
** <tt>com/sun/star/helper/writer/XShape.idl</tt>
* Collections, these are handled differently see implementing a vba [[Porting notes#Collection|Collection]] in oovbaapi
* Every helperapi idl method defines [http://api.openoffice.org/source/browse/*checkout*/api/udkapi/com/sun/star/script/BasicErrorException.idl BasicErrorException] which allows and api method to transfer an error code and associated string paramater to basic.

=== Hints for porting idl ===
==== Objects with Default Properties ====
This is something not handled by the helperapi but something you should be aware of when implementing a vba compatibility object. What is a default property, an example probably explains the concept better.

Range("a1") = "text"

is a short cut for

Range("a1").Value = "text"

<tt>Value</tt> is a default property in the example above. We can provide similar behavior in basic with a compatibility api object ensuring the object implements [http://api.openoffice.org/source/browse/*checkout*/api/udkapi/com/sun/star/script/XDefaultProperty.idl XDefaultProperty.idl ]

==== Objects with Default Method ====

Similar to above some vba objects have a default method e.g. the <tt>Collection</tt> object

set col = Sheets
msgbox col(1).Name

is a short cut for

set col = Sheets
msgbox col.Item(1).Name

<tt>Item</tt> is a default method in the example above. We can provide similar behavior in basic with a compatibility api object ensuring the object implements [http://api.openoffice.org/source/browse/*checkout*/api/udkapi/com/sun/star/script/XDefaultMethod.idl XDefaultMethod.idl ]

==== Porting Collection objects ====
Generally all collection objects have a <tt>Count</tt> and an <tt>Item</tt> method and additionally the behaviour mentioned above. Also Collection objects can be used in a <tt>For Each</tt> loop. To cater for that a helper implementation object <tt>ScVbaCollectionBaseImpl</tt> provides the necessary information to the basic runtime to allow it to provide the classic vba <tt>Collection</tt> class syntax support. It also requires to be initialised by an XIndexAccess implementation. Additionally the class inheriting from <tt>ScVbaCollectionBaseImpl</tt> must provide the translation between the object iterated ( via XIndexAccess ) and the corrosponding compatibilty object returned to openoffice basic via the the <tt>createCollectionObject</tt> method.

A example of a ported <tt>Collection</tt> object can be found in the [[Porting example]] section

=== [possibly incomplete ] List of Calc Objects to port from helperapi ===
{| style="vertical-align:top; text-align:left; background-color:#efefef;"
|- style="background-color:#d6d6d6;font-weight:bold;"
| Object || helperapi implementation name || Porting started by || Status || Notes
|-
| XAreas.idl || xxxx || || seems complete || ||
|-
| XAutoFilter.idl || [http://api.openoffice.org/source/browse/*checkout*/api/helperapi/impl/com/sun/star/helper/calc/AutoFilterImpl.java AutoFilterImpl] || hanbo || in progress || there is a partial (untested) implementation in the porting example section, would be nice for some one to finish
|-
| XFilter.idl || [http://api.openoffice.org/source/browse/*checkout*/api/helperapi/impl/com/sun/star/helper/calc/FilterImpl.java FilterImpl.java] || hanbo || in progress || see above.
|-
| XFilters.idl || [http://api.openoffice.org/source/browse/*checkout*/api/helperapi/impl/com/sun/star/helper/calc/FiltersImpl.java FiltersImpl.java] || hanbo || in progress || see above.
|-
| XAxes.idl || [http://api.openoffice.org/source/browse/*checkout*/api/helperapi/impl/com/sun/star/helper/calc/AxesImpl.java AxesImpl.java] || npower || in progress ||
|-
| XAxis.idl || [http://api.openoffice.org/source/browse/*checkout*/api/helperapi/impl/com/sun/star/helper/calc/AxesImpl.java AxisImpl.java] || npower || in progress ||
|-
| XAxisTitle.idl || [http://api.openoffice.org/source/browse/*checkout*/api/helperapi/impl/com/sun/star/helper/calc/AxesTitleImpl.java AxisTitleImpl.java] || npower || complete || not-tested
|-
| XCharacters.idl || xxxx || || complete ||
|-
| XCalc.idl || xxxx || not required for porting see [[Application Object]] || || This is not a 'real' object but in a collection of global method/attributes that probably should be part of the XApplication.idl interface
|-
| XChartObject.idl || [http://api.openoffice.org/source/browse/*checkout*/api/helperapi/impl/com/sun/star/helper/calc/ChartObjectImpl.java ChartObjectImpl.java] || npower || complete || not-tested
|-
| XChartObjects.idl || [http://api.openoffice.org/source/browse/*checkout*/api/helperapi/impl/com/sun/star/helper/calc/ChartObjectsImpl.java ChartObjectsImpl.java] || npower || complete || not-tested
|-
| XChart.idl || [http://api.openoffice.org/source/browse/*checkout*/api/helperapi/impl/com/sun/star/helper/calc/ChartImpl.java ChartImpl.java] || npower || in progress ||
|-
| XCharts.idl || [http://api.openoffice.org/source/browse/*checkout*/api/helperapi/impl/com/sun/star/helper/calc/ChartsImpl.java ChartsImpl.java] || npower || in progress ||
|-
| XChartTitle.idl || [http://api.openoffice.org/source/browse/*checkout*/api/helperapi/impl/com/sun/star/helper/calc/ChartTileImpl.java ChartTitleImpl.java] || npower || complete || not-tested
|-
| XColorFormat.idl || xxxx || || ||
|-
| XComment.idl || xxxx || || complete ||
|-
| XDataLabel.idl || [http://api.openoffice.org/source/browse/*checkout*/api/helperapi/impl/com/sun/star/helper/calc/DataLabelImp.java DataLabelImpl.java] || npower || in progress ||
|-
| XDataLabels.idl || [http://api.openoffice.org/source/browse/*checkout*/api/helperapi/impl/com/sun/star/helper/calc/DataLabelsImp.java DataLabelsImpl.java] || npower || in progress ||
|-
| XFont.idl || xxxx || || complete ||
|-
| XFormatCondition.idl || xxxx || npower || complete || not tested
|-
| XFormatConditions.idl || xxxx || npower || complete || not tested
|-
| XFormat.idl || xxxx || npower || complete || not tested
|-
| XHPageBreak.idl || xxxx || || complete ||
|-
| XHPageBreaks.idl || xxxx || || complete ||
|-
| XInterior.idl || xxxx || || complete ||
|-
| XName.idl || NameImp.java || sola, Amelia || complete || not-tested ||
|-
| XNames.idl || NamesImp.java || sola, Amelia || complete ||not-tested ||
|-
| XOutline.idl || xxxx || || complete ||
|-
| XPageBreak.idl || xxxx || || complete ||
|-
|[http://api.openoffice.org/source/browse/api/helperapi/com/sun/star/helper/calc/XPageSetup.idl XPageSetup.idl] || [http://api.openoffice.org/source/browse/api/helperapi/impl/com/sun/star/helper/calc/PageSetupImpl.java PageSetupImpl] || Fong ||complete ||
|-
|[http://api.openoffice.org/source/browse/api/helperapi/com/sun/star/helper/calc/XPane.idl XPane.idl] || [http://api.openoffice.org/source/browse/api/helperapi/impl/com/sun/star/helper/calc/PaneImpl.java PaneImpl] || Jiao.Jianhua || calc complete||
|-
| XPoint.idl || xxxx || ||
|-
| XPoints.idl || xxxx || ||
|-
| XProtection.idl || xxxx || penghang || in progress ||
|-
| XQueryTable.idl || xxxx || ||
|-
| XQueryTables.idl || xxxx || ||
|-
| XSeriersCollection.idl || xxxx || || complete ||
|-
| XSeriers.idl || xxxx || || complete ||
|-
| XShape.idl || xxxx || jiao.jianhua || in progress ||
|-
| XShapes.idl || xxxx || jiao.jianhua || calc complete, no full text ||
|-
| XSheet.idl || xxxx || || complete ||
|-
| XSheets.idl || xxxx || || complete ||
|-
| XStyle.idl || xxxx || npower || complete || not tested
|-
| XStyles.idl || xxxx || npower || inprogress ||
|-
| XTextFrame.idl || xxxx || || ||
|-
| XTitle.idl || xxxx || || complete ||
|-
| XVPageBreak.idl || xxxx || wanglibing || complete ||
|-
| XVPageBreaks.idl|| xxxx || wanglibing || complete ||
|-
| XWindow.idl || xxxx || || complete ||
|-
| XWindows.idl || xxxx || || complete ||
|-
| XWorkbook.idl || xxxx || || complete ||
|-
| XWorkbooks.idl || xxxx || || complete ||
|-
| XWorksheetfunction.idl || xxxx || || complete ||
|}

=== [possibly incomplete ] List of Writer Objects to port from helperapi ===
{| style="vertical-align:top; text-align:left; background-color:#efefef;"
|- style="background-color:#d6d6d6;font-weight:bold;"
| Object || helperapi implementation name || Porting started by || Status || Notes
|-
| Application || || Fong || in progress || ||
|-
| Addins || || Fong || in progress ||
|-
| Addin || || Fong || in progress ||
|-
| AutoTextEntry || || Fong || in progress ||
|-
| AutoTextEntries || || Fong || in progress || ||
|-
| Border || || Fong || in progress || ||
|-
| Borders || || Fong || in progress || ||
|-
| Bookmark || || Fong || in progress || ||
|-
| Bookmarks || || Fong || in progress || ||
|-
| Cell || || || || ||
|-
| Cells || || || ||
|-
| Column || || || ||
|-
| Columns || || || ||
|-
| CommandBar || || Fong || in progress || ||
|-
| CommandBarButton || || Fong || in progress || ||
|-
| CommandBars || ||Fong || in progress|| ||
|-
| Dialog || || Fong || in progress || ||
|-
| Dialogs || || Fong || in progress ||
|-
| Document || ||Fong || in progress || ||
|-
| Documents || ||Fong || in progress || ||
|-
| DocumentProperty || || npower || in progress || ||
|-
| DocumentProperties || || npower || in progress || ||
|-
| Field || || Fong || in progress || ||
|-
| Fields || || Fong || in progress || ||
|-
| FillFormat || || Fong || in progress || ||
|-
| Find || || Fong || in progress || ||
|-
| Font || || npower || in progress || ||
|-
| FormField || || || ||
|-
| FormFields || || || || ||
|-
| Frame || || || || ||
|-
| Frames || || || || ||
|-
| HeaderFooter || || Fong || in progress || ||
|-
| HeadersFooters || || || || ||
|-
| LineFormat || || Fong || in progress || ||
|-
| ListFormat || || || || ||
|-
| ListGallery || || || || ||
|-
| ListGalleries || || || || ||
|-
| ListLevel || || || || ||
|-
| ListLevels || || || || ||
|-
| ListTemplate || || || || ||
|-
| ListTemplates || || || || ||
|-
| Global || || npower || in progress || ||
|-
| Options || || Fong || in progress || ||
|-
| Pane || || Fong || in progress ||
|-
| Panes || || Fong || in progress || ||
|-
| Paragraph || || Fong || in progress || ||
|-
| Paragraphs || || Fong || in progress || ||
|-
| ParagraphFormat || || Fong || in progress || ||
|-
| PageSetup || || Fong || in progress || ||
|-
| Range || || Fong || in progress || ||
|-
| Replacement || || Fong || in progress || ||
|-
| Revision || || || || ||
|-
| Revisions || || || || ||
|-
| Row || || || || ||
|-
| Rows || || || || ||
|-
| Selection || || Fong || in progress ||
|-
| Section || || Fong || in progress || ||
|-
| Sections || || Fong || in progress || ||
|-
| Shape || || Fong || in progress || ||
|-
| Shapes || || Fong || in progress || ||
|-
| ShapeRange || || Fong || in progress || || ||
|-
| Style || || Fong || in progress || ||
|-
| Styles || || Fong || in progress || ||
|-
| System || || Fong || in progress || ||
|-
| Table || || npower || in progress || ||
|-
| Tables || || npower || in progress ||
|-
| TableOfContent || || || || ||
|-
| TableOfContents || || || || ||
|-
| TabStop || || || || ||
|-
| TabStops || || || || ||
|-
| Template || || npower || in progress ||
|-
| TextFrame || || Fong || in progress || ||
|-
| Variable || || Fong || in progress || ||
|-
| Variables || || Fong || in progress || ||
|-
| View || || Fong || in progress || ||
|-
| Window || || Fong || in progress ||
|-
| WordBasic || || || || ||
|-
| WrapFormat || || Fong || in progress || ||
|}

=== Missing attributes/methods ( common to helperapi objects ) to port ===
[[Application Object]]

[[Range Object]]

Fong: /* ODF support */

= Character unit overview =
In CJK, especailly in China, character is used as a unit to measure some paragraph attributes, such as indentation, line spacing and tab stop. etc. Character unit is most useful in processing Chinese. For example, users are used to use two characters as the indent of first line of the paragraph.

'''＊＊大家好'''

'''大家好，才是真的好'''

With character unit, users need not worry about the layout confusion due to font size changing.

For line spacing of paragraph, line unit is used.

= Feature =

= Implementation =

= File format support =
== ODF support ==
As mentioned above, Characters unit is most used in left and right margins for a paragraph, and the indentation of first line for a paragraph. Line unit is used in top and bottom margins for a paragraph.

While ODF does not support character unit and line unit yet.

* Character Unit
In order to support character unit, "em" measurement should be added support in ODF.

"em" is a unit-based value of relative length that is measured against the current value of the font-size property.

There is only one relative unit of measure, the "em". The definition of "1em" is equal to the current font size. For example, a value of "1.25em" is 1.25 times the current font size.

When an em measurement is used in an expression, it is converted according to the font-size value of the current property's context. The result of the expression is an absolute length.

* Line Unit
Percentage unit is reused as line unit to specify the top and bottom margins for a paragraph, just like the fix line height in section 15.5.1. For example, a value of "125%" is 1.25 times for the highest character in a line.

= Appendix =
== Open XML support ==
* Line Spacing in Line Units
<code>[xml]
<xsd:complexType name="CT_Spacing">
<xsd:attribute name="beforeLines" type="ST_DecimalNumber" use="optional">
<xsd:annotation>
<xsd:documentation>Spacing Above Paragraph IN Line Units</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="afterLines" type="ST_DecimalNumber" use="optional">
<xsd:annotation>
<xsd:documentation>Spacing Below Paragraph in Line Units</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</code>

* Indentation In Character Units
<code>[xml]
<xsd:complexType name="CT_Ind">
<xsd:attribute name="leftChars" type="ST_DecimalNumber" use="optional">
<xsd:annotation>
<xsd:documentation>Left Indentation in Character Units</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="rightChars" type="ST_DecimalNumber" use="optional">
<xsd:annotation>
<xsd:documentation>Right Indentation in Character Units</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="hangingChars" type="ST_DecimalNumber" use="optional">
<xsd:annotation>
<xsd:documentation>Indentation Removed From First Line in Character Units</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="firstLineChars" type="ST_DecimalNumber" use="optional">
<xsd:annotation>
<xsd:documentation>Additional First Line Indentation in Character Units</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</code>

== UOF support ==
* Line Spacing In Line Units. (Part of schema)
<code>[xml]

<xsd:element name="段间距" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Line Spacing</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:all>
<xsd:element name="段前距" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Line Spacing Above Paragraph</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:choice>
<xsd:element name="相对值">
<xsd:annotation>
<xsd:documentation> Spacing Above Paragraph In Relative Value</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute ref="uof:locID" use="required" fixed="t0200"/>
<xsd:attribute name="值" type="xsd:float" use="required"/>
<xsd:attribute ref="uof:attrList" use="required" fixed="值"/>
</xsd:complexType>
</xsd:element>
</xsd:choice>
<xsd:attribute ref="uof:locID" use="required" fixed="t0196"/>
</xsd:complexType>
</xsd:element>
<xsd:element name="段后距" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Line Spacing Below Paragraph</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:choice>
<xsd:element name="相对值">
<xsd:annotation>
<xsd:documentation> Spacing Below Paragraph In Relative Value</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute ref="uof:locID" use="required" fixed="t0203"/>
<xsd:attribute name="值" type="xsd:float" use="required"/>
<xsd:attribute ref="uof:attrList" use="required" fixed="值"/>
</xsd:complexType>
</xsd:element>
</xsd:choice>
<xsd:attribute ref="uof:locID" use="required" fixed="t0197"/>
</xsd:complexType>
</xsd:element>
</xsd:all>
<xsd:attribute ref="uof:locID" use="required" fixed="t0058"/>
</xsd:complexType>
</xsd:element>
</code>

* Indentation In Character Units (Part of schema)

<code>[xml]
<xsd:complexType name="缩进类型">
<xsd:annotation>
<xsd:documentation>Indentation of Paragraph</xsd:documentation>
</xsd:annotation>
<xsd:all>
<xsd:element name="左" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Left Indentation</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:choice>
<xsd:element name="相对">
<xsd:annotation>
<xsd:documentation>Left Indentation In Relative Value</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="值" type="xsd:float" use="required"/>
<xsd:attribute ref="uof:locID" use="required" fixed="t0186"/>
<xsd:attribute ref="uof:attrList" use="required" fixed="值"/>
</xsd:complexType>
</xsd:element>
</xsd:choice>
<xsd:attribute ref="uof:locID" use="required" fixed="t0182"/>
</xsd:complexType>
</xsd:element>
<xsd:element name="右" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Right Indentation</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:choice>
<xsd:element name="相对">
<xsd:annotation>
<xsd:documentation>Right Indentation In Relative Value</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="值" type="xsd:float" use="required"/>
<xsd:attribute ref="uof:locID" use="required" fixed="t0188"/>
<xsd:attribute ref="uof:attrList" use="required" fixed="值"/>
</xsd:complexType>
</xsd:element>
</xsd:choice>
<xsd:attribute ref="uof:locID" use="required" fixed="t0183"/>
</xsd:complexType>
</xsd:element>
<xsd:element name="首行" minOccurs="0">
<xsd:annotation>
<xsd:documentation> First Line Indentation </xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:choice>
<xsd:element name="相对">
<xsd:annotation>
<xsd:documentation> First Line Indentation In Relative Value </xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="值" type="xsd:float" use="required"/>
<xsd:attribute ref="uof:locID" use="required" fixed="t0190"/>
<xsd:attribute ref="uof:attrList" use="required" fixed="值"/>
</xsd:complexType>
</xsd:element>
</xsd:choice>
<xsd:attribute ref="uof:locID" use="required" fixed="t0184"/>
</xsd:complexType>
</xsd:element>
</xsd:all>
</xsd:complexType>

</code>