xref: /aoo4110/main/oovbaapi/ooo/vba/excel/XRange.idl (revision b1cdbd2c)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __ooo_vba_excel_XRange_idl__
24#define __ooo_vba_excel_XRange_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
30#include <com/sun/star/lang/IllegalArgumentException.idl>
31#endif
32#ifndef __com_sun_star_container_XEnumerationAccess_idl__
33#include <com/sun/star/container/XEnumerationAccess.idl>
34#endif
35#ifndef __com_sun_star_script_XDefaultProperty_idl__
36#include <com/sun/star/script/XDefaultProperty.idl>
37#endif
38#ifndef __com_sun_star_script_XDefaultMethod_idl__
39#include <com/sun/star/script/XDefaultMethod.idl>
40#endif
41#ifndef __ooo_vba_XCollection_idl__
42#include <ooo/vba/XCollection.idl>
43#endif
44#ifndef __ooo_vba_excel_XFormat_idl__
45#include <ooo/vba/excel/XFormat.idl>
46#endif
47#ifndef __ooo_vba_XHelperInterface_idl__
48#include <ooo/vba/XHelperInterface.idl>
49#endif
50#ifndef __com_sun_star_helper_script_BasicErrorException_idl__
51#include <com/sun/star/script/BasicErrorException.idl>
52#endif
53//=============================================================================
54
55module ooo {  module vba {  module excel {
56
57interface XFont;
58interface XRows;
59interface XColumns;
60interface XComment;
61
62interface XInterior;
63interface XCharacters;
64interface XBorders;
65interface XValidation;
66interface XWorksheet;
67
68interface XRange
69{
70 	interface com::sun::star::container::XEnumerationAccess;
71	interface com::sun::star::script::XDefaultMethod;
72	interface com::sun::star::script::XDefaultProperty;
73	interface ::ooo::vba::excel::XFormat;
74	//interface ::ooo::vba::XHelperInterface;
75
76	[attribute] any Value;
77	[attribute] any Formula;
78	[attribute] any FormulaArray;
79	[attribute] any FormulaR1C1;
80	[attribute, readonly] long  Count;
81	[attribute, readonly] long Row;
82	[attribute, readonly] long Column;
83	[attribute, readonly] string Text;
84	[attribute, readonly] XRange EntireRow;
85	[attribute, readonly] XRange EntireColumn;
86	[attribute, readonly] XComment Comment;
87	[attribute] any Hidden;
88	[attribute] any ColumnWidth;
89	[attribute, readonly ] any Width;
90	[attribute, readonly] XWorksheet Worksheet;
91	[attribute] any RowHeight;
92	[attribute, readonly ] any Height;
93	[attribute, readonly ] any Top;
94	[attribute, readonly ] any Left;
95	[attribute] any PageBreak;
96	[attribute, readonly] XValidation Validation;
97	[attribute, readonly] any PrefixCharacter;
98	[attribute] any Style;
99	[attribute] any AddIndent;
100	[attribute] any ShowDetail;
101
102	XComment AddComment( [in] any Text );
103	void Clear();
104	void ClearComments();
105	void ClearContents();
106	void ClearFormats();
107	any HasFormula();
108	void FillLeft();
109	void FillRight();
110	void FillUp();
111	void FillDown();
112	XRange Item([in] any RowIndex, [in] any ColumnIndex) raises(com::sun::star::script::BasicErrorException);
113	XRange Offset([in] any RowOffset, [in] any ColumnOffset);
114	XRange CurrentRegion();
115	XRange CurrentArray();
116	string Characters([in] any Start, [in] any Length);
117	string Address( [in] any RowAbsolute, [in] any ColumnAbsolute, [in] any ReferenceStyle, [in] any External, [in] any RelativeTo );
118	XRange Cells([in] any RowIndex, [in] any ColumnIndex);
119	void Select();
120	void AutoOutline() raises(com::sun::star::script::BasicErrorException);
121	void Activate();
122	XRange Rows( [in] any RowIndex );
123	void Calculate() raises(com::sun::star::script::BasicErrorException);
124	XRange Columns( [in] any ColumnIndex );
125	void Copy([in] any Destination);
126	void Cut([in] any Destination);
127	XRange Resize( [in] any RowSize, [in] any ColumnSize );
128	XRange Range( [in] any Cell1, [in] any Cell2 );
129	any getCellRange();
130	void PasteSpecial([in] any Paste, [in] any Operation,[in] any SkipBlanks, [in] any Transpose);
131	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 );
132    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 );
133
134	void Sort( [in] any Key1, [in] any Order1, [in] any Key2, [in] any Type,
135		[in] any Order2, [in] any Key3, [in] any Order3,
136		[in] any Header, [in] any OrderCustom, [in] any MatchCase,
137		[in] any Orientation, [in] any SortMethod, [in] any DataOption1,
138		[in] any DataOption2, [in] any DataOption3 );
139	XRange End( [in] long Direction );
140	// bizarely I have to define Character method as character otherwise
141	// idl complains
142	XCharacters characters([in] any Start, [in] any Length);
143	void Delete( [in] any Shift );
144
145	any Areas( [in] any Item );
146	any BorderAround( [in] any LineStyle, [in] any Weight, [in] any ColorIndex, [in] any Color );
147        void AutoFilter([in ] any Field, [in] any Criteria1, [in] any Operator, [in] any Criteria2, [in] any VisibleDropDown);
148        void Insert([in] any Shift, [in] any CopyOrigin);
149        void Autofit();
150	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);
151	void AutoFill( [in] XRange Destination, [in] any Type );
152	boolean GoalSeek( [in] any Goal, [in] XRange ChangingCell );
153	void ClearOutline() raises(com::sun::star::script::BasicErrorException);
154	void Ungroup() raises(com::sun::star::script::BasicErrorException);
155	void Group() raises(com::sun::star::script::BasicErrorException);
156	void Merge([in] any Across) raises(com::sun::star::script::BasicErrorException);
157	void UnMerge() raises(com::sun::star::script::BasicErrorException);
158	XRange Next( ) raises ( com::sun::star::script::BasicErrorException );
159	XRange Previous( ) raises ( com::sun::star::script::BasicErrorException );
160 	XRange SpecialCells( [in] any Type, [in]  /*Optional*/ any Value ) raises ( com::sun::star::script::BasicErrorException );
161	void RemoveSubtotal() raises ( com::sun::star::script::BasicErrorException );
162	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 );
163	XRange MergeArea( ) raises ( com::sun::star::script::BasicErrorException );
164    any Hyperlinks( [in] any Index );
165};
166
167//=============================================================================
168
169}; }; };
170
171#endif
172
173
174