View source

From OpenOffice.org Wiki

You do not have permission to edit this page, for the following reasons:

• The action you have requested is limited to users in the group: Users.
• You must confirm your e-mail address before editing pages. Please set and validate your e-mail address through your user preferences.

You can view and copy the source of this page:

=== Step 1 Choose an object to port === I randomly picked the Filter object e.g. [http://api.openoffice.org/source/browse/*checkout*/api/helperapi/com/sun/star/helper/calc/XFilter.idl XFilter] in the helperapi ( of course you also want to make sure this object isn't already implemented in oovbaapi ). Browse the [http://api.openoffice.org/source/browse/api/helperapi/ helperapi] code to find where XFilter is implemented. It's implemented by [http://api.openoffice.org/source/browse/*checkout*/api/helperapi/impl/com/sun/star/helper/calc/FilterImpl.java FilterImpl.java] and it expects to be initialised by an [http://api.openoffice.org/source/browse/*checkout*/api/helperapi/com/sun/star/helper/calc/XAutoFilter.idl XAutoFilter] implementation object [http://api.openoffice.org/source/browse/*checkout*/api/helperapi/impl/com/sun/star/helper/calc/AutoFilterImpl.java AutoFilterImpl] so already an implementation not only for XFilter need to be provided but also and implementation for XAutoFilter as well. looking at XAutoFilter.idl you see that there is a <tt>Filters()</tt> attribute/method that returns a [[Collection]] of Filters, so additionally an implementation of the XFilters object is needed. The XAutoFilter implementation is the key object that the others are accessed/provided from. Searching through the source code you find this is an attribute of the [http://api.openoffice.org/source/browse/*checkout*/api/helperapi/impl/com/sun/star/helper/calc/SheetImpl.java SheetImpl] object so, to summarize, after initially choosing one object to have a crack at porting, you actually need to provide implementations for the following interfaces * XFilter * XAutoFilter * XFilters and also you need to add a new attribute to return an <tt>XAutoFilter</tt> implementation === Step 2 Port the idl files === It's worth taking a look at the [[porting notes#Hints for porting idl|idl]] section in the [[porting notes]] and examples of the ported idl files * [http://vba.openoffice.org/source/browse/*checkout*/vba/src/examples/port_helperapi/vbaapi-port/excel/XAutoFilter.idl XAutoFilter.idl] * [http://vba.openoffice.org/source/browse/*checkout*/vba/src/examples/port_helperapi/vbaapi-port/excel/XFilter.idl XFilter.idl] * [http://vba.openoffice.org/source/browse/*checkout*/vba/src/examples/port_helperapi/vbaapi-port/excel/XFilters.idl XFilters.idl] also modifications to existing files * [http://vba.openoffice.org/source/browse/*checkout*/vba/src/examples/port_helperapi/vbaapi-port/excel/add-new-idl.diff makefile.mk] add new idl file * [http://vba.openoffice.org/source/browse/*checkout*/vba/src/examples/port_helperapi/vbaapi-port/excel/add-new-attribute.diff XWorksheet.idl] add new AutoFilter attribute === Step 3 Prepare and provide implementation code === It's probably an idea just start with a stub implementation and then build on that. That's precisely what I will show here, once the stub implementation is in place you can get deeper into the implementation. I decided to try and port the <tt>AutoFilter</tt> implementation object first, the <tt>XAutofilter</tt> has two methods, <tt>Filters</tt> and <tt>Range</tt>. In the java version a helper class ( which doesn't exist in the c++ oovbaapi ) is used to convert from the <tt>CellRangeAddress</tt> obtained from the <tt>XDatabaseRange</tt> implementation object to a <tt>XRange</tt> implementation object. It's not necessary to do this in the c++ oovbaapi as we can create a <tt>ScVbaRange</tt> object from a <tt>table::XCellRange</tt> object, looking at the source code <tt>unoobj/datauno.cxx</tt> ( the <tt>XDatabaseRange</tt> implementation ) its clear that we can get a hold of a <tt>table::XCellRange</tt> object pretty easily by querying for the <tt>sheet::XCellRangeReferrer</tt> interface. Next to port is to create the filters collection. Collections are implemented quite differenty ( some details available from [[porting notes#Collection|Collection]] ) The <tt>FilterImpl</tt> object is a more straight forward port. Its worth noting however just doing a straight port from Java to C++ is maybe not the most efficient way to provide a compatibilty object due the differences in the two approaches, but it is at least a start. semi-ported ( and completely untested ) examples are * [http://vba.openoffice.org/source/browse/*checkout*/vba/src/examples/port_helperapi/sc-vba-port/vbaautofilter.hxx vbaautofilter.hxx] header file * [http://vba.openoffice.org/source/browse/*checkout*/vba/src/examples/port_helperapi/sc-vba-port/vbaautofilter.cxx vbaautofilter.cxx] implementation file *[http://vba.openoffice.org/source/browse/*checkout*/vba/src/examples/port_helperapi/sc-vba-port/vbafilters.hxx vbafilters.hxx] header file *[http://vba.openoffice.org/source/browse/*checkout*/vba/src/examples/port_helperapi/sc-vba-port/vbafilters.cxx vbafilters.cxx] implementation file *[http://vba.openoffice.org/source/browse/*checkout*/vba/src/examples/port_helperapi/sc-vba-port/vbafilter.hxx vbafilter.hxx] helper file *[http://vba.openoffice.org/source/browse/*checkout*/vba/src/examples/port_helperapi/sc-vba-port/vbafilter.cxx vbafilter.cxx] implementation file

Return to Porting example.