| blob | d8ddd6beb9cf71338a7f6bbb2f8d699d6b7b5fa9 |
1 /*
2 * This file is part of the LibreOffice project.
3 *
4 * This Source Code Form is subject to the terms of the Mozilla Public
5 * License, v. 2.0. If a copy of the MPL was not distributed with this
6 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
7 *
8 * This file incorporates work covered by the following license notice:
9 *
10 * Licensed to the Apache Software Foundation (ASF) under one or more
11 * contributor license agreements. See the NOTICE file distributed
12 * with this work for additional information regarding copyright
13 * ownership. The ASF licenses this file to you under the Apache
14 * License, Version 2.0 (the "License"); you may not use this file
15 * except in compliance with the License. You may obtain a copy of
16 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
17 */
25 // __________ implementation ____________________________________
27 /** This is a helper class for the spreadsheet and table samples.
28 It connects to a running office and creates a spreadsheet document.
29 Additionally it contains various helper functions.
30 */
32 {
34 // __ private members ___________________________________________
45 {
46 // Connect to a running office and get the service manager
48 // Create a new spreadsheet document
50 }
52 // __ helper methods ____________________________________________
54 /** Returns the service manager.
55 @return XMultiServiceFactory interface of the service manager. */
57 {
59 }
61 /** Returns the whole spreadsheet document.
62 @return XSpreadsheetDocument interface of the document. */
64 {
66 }
68 /** Returns the spreadsheet with the specified index (0-based).
69 @param nIndex The index of the sheet.
70 @return XSpreadsheet interface of the sheet. */
72 {
73 // Collection of sheets
85 }
87 /** Inserts a new empty spreadsheet with the specified name.
88 @param aName The name of the new sheet.
89 @param nIndex The insertion index.
90 @return The XSpreadsheet interface of the new sheet. */
93 {
94 // Collection of sheets
104 }
107 // Methods to fill values into cells.
109 /** Writes a double value into a spreadsheet.
110 @param xSheet The XSpreadsheet interface of the spreadsheet.
111 @param aCellName The address of the cell (or a named range).
112 @param fValue The value to write into the cell. */
115 String aCellName,
117 {
120 }
122 /** Writes a formula into a spreadsheet.
123 @param xSheet The XSpreadsheet interface of the spreadsheet.
124 @param aCellName The address of the cell (or a named range).
125 @param aFormula The formula to write into the cell. */
128 String aCellName,
129 String aFormula )
130 {
133 }
135 /** Writes a date with standard date format into a spreadsheet.
136 @param xSheet The XSpreadsheet interface of the spreadsheet.
137 @param aCellName The address of the cell (or a named range).
138 @param nDay The day of the date.
139 @param nMonth The month of the date.
140 @param nYear The year of the date. */
143 String aCellName,
145 {
146 // Set the date value.
152 // Set standard date format.
167 }
169 /** Draws a colored border around the range and writes the headline
170 in the first cell.
172 @param xSheet The XSpreadsheet interface of the spreadsheet.
173 @param aRange The address of the cell range (or a named range).
174 @param aHeadline The headline text. */
178 {
182 // draw border
201 // draw headline
214 // write headline
224 }
227 // Methods to create cell addresses and range addresses.
229 /** Creates a unoidl.com.sun.star.table.CellAddress and initializes it
230 with the given range.
231 @param xSheet The XSpreadsheet interface of the spreadsheet.
232 @param aCell The address of the cell (or a named cell). */
235 String aCell )
236 {
241 }
243 /** Creates a unoidl.com.sun.star.table.CellRangeAddress and initializes
244 it with the given range.
245 @param xSheet The XSpreadsheet interface of the spreadsheet.
246 @param aRange The address of the cell range (or a named range). */
249 {
254 }
257 // Methods to convert cell addresses and range addresses to strings.
259 /** Returns the text address of the cell.
260 @param nColumn The column index.
261 @param nRow The row index.
262 @return A string containing the cell address. */
264 {
271 }
273 /** Returns the text address of the cell range.
274 @param aCellRange The cell range address.
275 @return A string containing the cell range address. */
278 {
279 return
283 }
285 /** Returns the text address of the cell range.
286 @param xCellRange The XSheetCellRange interface of the cell range.
287 @param bWithSheet true = Include sheet name.
288 @return A string containing the cell range address. */
291 {
294 {
300 }
305 }
307 /** Returns a list of addresses of all cell ranges contained in the
308 collection.
310 @param xRangesIA The XIndexAccess interface of the collection.
311 @return A string containing the cell range address list. */
314 {
318 {
325 }
327 }
331 /** Connect to a running office that is accepting connections.
332 @return The ServiceManager to instantiate office components. */
334 {
339 }
342 {
344 }
346 /** Creates an empty spreadsheet document.
347 @return The XSpreadsheetDocument interface of the document. */
349 {
358 }
361 }