xref: /aoo41x/main/oovbaapi/ooo/vba/excel/XRange.idl (revision cdf0e10c)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __ooo_vba_excel_XRange_idl__
28#define __ooo_vba_excel_XRange_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
34#include <com/sun/star/lang/IllegalArgumentException.idl>
35#endif
36#ifndef __com_sun_star_container_XEnumerationAccess_idl__
37#include <com/sun/star/container/XEnumerationAccess.idl>
38#endif
39#ifndef __com_sun_star_script_XDefaultProperty_idl__
40#include <com/sun/star/script/XDefaultProperty.idl>
41#endif
42#ifndef __com_sun_star_script_XDefaultMethod_idl__
43#include <com/sun/star/script/XDefaultMethod.idl>
44#endif
45#ifndef __ooo_vba_XCollection_idl__
46#include <ooo/vba/XCollection.idl>
47#endif
48#ifndef __ooo_vba_excel_XFormat_idl__
49#include <ooo/vba/excel/XFormat.idl>
50#endif
51#ifndef __ooo_vba_XHelperInterface_idl__
52#include <ooo/vba/XHelperInterface.idl>
53#endif
54#ifndef __com_sun_star_helper_script_BasicErrorException_idl__
55#include <com/sun/star/script/BasicErrorException.idl>
56#endif
57//=============================================================================
58
59module ooo {  module vba {  module excel {
60
61interface XFont;
62interface XRows;
63interface XColumns;
64interface XComment;
65
66interface XInterior;
67interface XCharacters;
68interface XBorders;
69interface XValidation;
70interface XWorksheet;
71
72interface XRange
73{
74 	interface com::sun::star::container::XEnumerationAccess;
75	interface com::sun::star::script::XDefaultMethod;
76	interface com::sun::star::script::XDefaultProperty;
77	interface ::ooo::vba::excel::XFormat;
78	//interface ::ooo::vba::XHelperInterface;
79
80	[attribute] any Value;
81	[attribute] any Formula;
82	[attribute] any FormulaArray;
83	[attribute] any FormulaR1C1;
84	[attribute, readonly] long  Count;
85	[attribute, readonly] long Row;
86	[attribute, readonly] long Column;
87	[attribute, readonly] string Text;
88	[attribute, readonly] XRange EntireRow;
89	[attribute, readonly] XRange EntireColumn;
90	[attribute, readonly] XComment Comment;
91	[attribute] any Hidden;
92	[attribute] any ColumnWidth;
93	[attribute, readonly ] any Width;
94	[attribute, readonly] XWorksheet Worksheet;
95	[attribute] any RowHeight;
96	[attribute, readonly ] any Height;
97	[attribute, readonly ] any Top;
98	[attribute, readonly ] any Left;
99	[attribute] any PageBreak;
100	[attribute, readonly] XValidation Validation;
101	[attribute, readonly] any PrefixCharacter;
102	[attribute] any Style;
103	[attribute] any AddIndent;
104	[attribute] any ShowDetail;
105
106	XComment AddComment( [in] any Text );
107	void Clear();
108	void ClearComments();
109	void ClearContents();
110	void ClearFormats();
111	any HasFormula();
112	void FillLeft();
113	void FillRight();
114	void FillUp();
115	void FillDown();
116	XRange Item([in] any RowIndex, [in] any ColumnIndex) raises(com::sun::star::script::BasicErrorException);
117	XRange Offset([in] any RowOffset, [in] any ColumnOffset);
118	XRange CurrentRegion();
119	XRange CurrentArray();
120	string Characters([in] any Start, [in] any Length);
121	string Address( [in] any RowAbsolute, [in] any ColumnAbsolute, [in] any ReferenceStyle, [in] any External, [in] any RelativeTo );
122	XRange Cells([in] any RowIndex, [in] any ColumnIndex);
123	void Select();
124	void AutoOutline() raises(com::sun::star::script::BasicErrorException);
125	void Activate();
126	XRange Rows( [in] any RowIndex );
127	void Calculate() raises(com::sun::star::script::BasicErrorException);
128	XRange Columns( [in] any ColumnIndex );
129	void Copy([in] any Destination);
130	void Cut([in] any Destination);
131	XRange Resize( [in] any RowSize, [in] any ColumnSize );
132	XRange Range( [in] any Cell1, [in] any Cell2 );
133	any getCellRange();
134	void PasteSpecial([in] any Paste, [in] any Operation,[in] any SkipBlanks, [in] any Transpose);
135	boolean  Replace( [in] string What, [in] string Replacement, [in] any LookAt, [in] any SearchOrder, [in] any MatchCase, [in] any MatchByte, [in] any SearchFormat, [in] any ReplaceFormat );
136    XRange Find( [in] any What, [in] any After, [in] any LookIn, [in] any LookAt, [in] any SearchOrder, [in] any SearchDirection, [in] any MatchCase, [in] any MatchByte, [in] any SearchFormat );
137
138	void Sort( [in] any Key1, [in] any Order1, [in] any Key2, [in] any Type,
139		[in] any Order2, [in] any Key3, [in] any Order3,
140		[in] any Header, [in] any OrderCustom, [in] any MatchCase,
141		[in] any Orientation, [in] any SortMethod, [in] any DataOption1,
142		[in] any DataOption2, [in] any DataOption3 );
143	XRange End( [in] long Direction );
144	// bizarely I have to define Character method as character otherwise
145	// idl complains
146	XCharacters characters([in] any Start, [in] any Length);
147	void Delete( [in] any Shift );
148
149	any Areas( [in] any Item );
150	any BorderAround( [in] any LineStyle, [in] any Weight, [in] any ColorIndex, [in] any Color );
151        void AutoFilter([in ] any Field, [in] any Criteria1, [in] any Operator, [in] any Criteria2, [in] any VisibleDropDown);
152        void Insert([in] any Shift, [in] any CopyOrigin);
153        void Autofit();
154	void PrintOut([in] any From, [in] any To, [in] any Copies, [in] any Preview, [in] any ActivePrinter, [in] any PrintToFile, [in] any Collate, [in] any PrToFileName);
155	void AutoFill( [in] XRange Destination, [in] any Type );
156	boolean GoalSeek( [in] any Goal, [in] XRange ChangingCell );
157	void ClearOutline() raises(com::sun::star::script::BasicErrorException);
158	void Ungroup() raises(com::sun::star::script::BasicErrorException);
159	void Group() raises(com::sun::star::script::BasicErrorException);
160	void Merge([in] any Across) raises(com::sun::star::script::BasicErrorException);
161	void UnMerge() raises(com::sun::star::script::BasicErrorException);
162	XRange Next( ) raises ( com::sun::star::script::BasicErrorException );
163	XRange Previous( ) raises ( com::sun::star::script::BasicErrorException );
164 	XRange SpecialCells( [in] any Type, [in]  /*Optional*/ any Value ) raises ( com::sun::star::script::BasicErrorException );
165	void RemoveSubtotal() raises ( com::sun::star::script::BasicErrorException );
166	void	Subtotal( [in] long GroupBy, [in] long Function, [in]  /*Optional*/ sequence<long> TotalList, [in]  /*Optional*/ any Replace, [in]  /*Optional*/ any PageBreaks, [in] any SummaryBelowData ) raises ( com::sun::star::script::BasicErrorException );
167	XRange MergeArea( ) raises ( com::sun::star::script::BasicErrorException );
168    any Hyperlinks( [in] any Index );
169};
170
171//=============================================================================
172
173}; }; };
174
175#endif
176
177
178