oovbaapi/ooo/vba/excel/XRange.idl

   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  */
  18 #ifndef __ooo_vba_excel_XRange_idl__
  19 #define __ooo_vba_excel_XRange_idl__
  20
  21 #include <com/sun/star/uno/XInterface.idl>
  22 #include <com/sun/star/lang/IllegalArgumentException.idl>
  23 #include <com/sun/star/container/XEnumerationAccess.idl>
  24 #include <com/sun/star/script/XDefaultProperty.idl>
  25 #include <com/sun/star/script/XDefaultMethod.idl>
  26 #include <com/sun/star/script/XErrorQuery.idl>
  27 #include <ooo/vba/XCollection.idl>
  28 #include <ooo/vba/excel/XFormat.idl>
  29 #include <ooo/vba/XHelperInterface.idl>
  30 #include <com/sun/star/script/BasicErrorException.idl>
  31
  32 //=============================================================================
  33
  34 module ooo {  module vba {  module excel {
  35
  36 interface XFont;
  37 interface XRows;
  38 interface XColumns;
  39 interface XComment;
  40
  41 interface XInterior;
  42 interface XCharacters;
  43 interface XBorders;
  44 interface XValidation;
  45 interface XWorksheet;
  46 interface XName;
  47
  48 interface XRange
  49 {
  50      interface com::sun::star::container::XEnumerationAccess;
  51     interface com::sun::star::script::XDefaultMethod;
  52     interface com::sun::star::script::XDefaultProperty;
  53     interface com::sun::star::script::XErrorQuery;
  54     interface ::ooo::vba::excel::XFormat;
  55     //interface ::ooo::vba::XHelperInterface;
  56
  57     [attribute] any Value;
  58     [attribute] any Formula;
  59     [attribute] any FormulaArray;
  60     [attribute] any FormulaR1C1;
  61     [attribute, readonly] long  Count;
  62     [attribute, readonly] long Row;
  63     [attribute, readonly] long Column;
  64     [attribute, readonly] string Text;
  65     [attribute, readonly] XRange EntireRow;
  66     [attribute, readonly] XRange EntireColumn;
  67     [attribute, readonly] XComment Comment;
  68     [attribute] any Hidden;
  69     [attribute] any ColumnWidth;
  70     [attribute, readonly ] any Width;
  71     [attribute, readonly] XWorksheet Worksheet;
  72     [attribute, readonly] XName Name;
  73     [attribute] any RowHeight;
  74     [attribute, readonly ] any Height;
  75     [attribute, readonly ] any Top;
  76     [attribute, readonly ] any Left;
  77     [attribute] any PageBreak;
  78     [attribute, readonly] XValidation Validation;
  79     [attribute, readonly] any PrefixCharacter;
  80     [attribute] any Style;
  81     [attribute] any AddIndent;
  82     [attribute] any ShowDetail;
  83
  84     XComment AddComment( [in] any Text );
  85     void Clear();
  86     void ClearComments();
  87     void ClearContents();
  88     void ClearFormats();
  89     any HasFormula();
  90     void FillLeft();
  91     void FillRight();
  92     void FillUp();
  93     void FillDown();
  94     XRange Item([in] any RowIndex, [in] any ColumnIndex) raises(com::sun::star::script::BasicErrorException);
  95     XRange Offset([in] any RowOffset, [in] any ColumnOffset);
  96     XRange CurrentRegion();
  97     XRange CurrentArray();
  98     string Characters([in] any Start, [in] any Length);
  99     string Address( [in] any RowAbsolute, [in] any ColumnAbsolute, [in] any ReferenceStyle, [in] any External, [in] any RelativeTo );
 100     XRange Cells([in] any RowIndex, [in] any ColumnIndex);
 101     void Select();
 102     void AutoOutline() raises(com::sun::star::script::BasicErrorException);
 103     void Activate();
 104     XRange Rows( [in] any RowIndex );
 105     void Calculate() raises(com::sun::star::script::BasicErrorException);
 106     XRange Columns( [in] any ColumnIndex );
 107     void Copy([in] any Destination);
 108     void Cut([in] any Destination);
 109     XRange Resize( [in] any RowSize, [in] any ColumnSize );
 110     XRange Range( [in] any Cell1, [in] any Cell2 );
 111     any getCellRange();
 112     void PasteSpecial([in] any Paste, [in] any Operation,[in] any SkipBlanks, [in] any Transpose);
 113     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 );
 114     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 );
 115
 116     void Sort( [in] any Key1, [in] any Order1, [in] any Key2, [in] any Type,
 117         [in] any Order2, [in] any Key3, [in] any Order3,
 118         [in] any Header, [in] any OrderCustom, [in] any MatchCase,
 119         [in] any Orientation, [in] any SortMethod, [in] any DataOption1,
 120         [in] any DataOption2, [in] any DataOption3 );
 121     XRange End( [in] long Direction );
 122     // bizarely I have to define Character method as character otherwise
 123     // idl complains
 124     XCharacters characters([in] any Start, [in] any Length);
 125     void Delete( [in] any Shift );
 126
 127     any Areas( [in] any Item );
 128     any BorderAround( [in] any LineStyle, [in] any Weight, [in] any ColorIndex, [in] any Color );
 129         void AutoFilter([in ] any Field, [in] any Criteria1, [in] any Operator, [in] any Criteria2, [in] any VisibleDropDown);
 130         void Insert([in] any Shift, [in] any CopyOrigin);
 131         void Autofit();
 132     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);
 133     void AutoFill( [in] XRange Destination, [in] any Type );
 134     boolean GoalSeek( [in] any Goal, [in] XRange ChangingCell );
 135     void ClearOutline() raises(com::sun::star::script::BasicErrorException);
 136     void Ungroup() raises(com::sun::star::script::BasicErrorException);
 137     void Group() raises(com::sun::star::script::BasicErrorException);
 138     void Merge([in] any Across) raises(com::sun::star::script::BasicErrorException);
 139     void UnMerge() raises(com::sun::star::script::BasicErrorException);
 140     XRange Next( ) raises ( com::sun::star::script::BasicErrorException );
 141     XRange Previous( ) raises ( com::sun::star::script::BasicErrorException );
 142      XRange SpecialCells( [in] any Type, [in]  /*Optional*/ any Value ) raises ( com::sun::star::script::BasicErrorException );
 143     void RemoveSubtotal() raises ( com::sun::star::script::BasicErrorException );
 144     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 );
 145     XRange MergeArea( ) raises ( com::sun::star::script::BasicErrorException );
 146     any Hyperlinks( [in] any Index );
 147 };
 148
 149 //=============================================================================
 150
 151 }; }; };
 152
 153 #endif
 154
 155