xref: /aoo41x/main/oovbaapi/ooo/vba/excel/XWorksheet.idl (revision 41b4bf98)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __ooo_vba_excel_XWorksheet_idl__
#define __ooo_vba_excel_XWorksheet_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __ooo_vba_XHelperInterface_idl__
#include <ooo/vba/XHelperInterface.idl>
#endif

#ifndef __com_sun_star_script_XInvocation_idl__
#include <com/sun/star/script/XInvocation.idl>
#endif

#ifndef __com_sun_star_container_XNamed_idl__
#include <com/sun/star/container/XNamed.idl>
#endif
//=============================================================================

module ooo {  module vba {  module excel {

//=============================================================================

interface XComments;
interface XRange;
interface XOutline;
interface XPageSetup;
interface XHPageBreaks;
interface XVPageBreaks;
interface XWorksheet
{
	interface ::ooo::vba::XHelperInterface;
	interface ::com::sun::star::script::XInvocation;
	interface ::com::sun::star::container::XNamed;

	[attribute] long Visible;
	[attribute, readonly] long StandardHeight;
	[attribute, readonly] long StandardWidth;
	[attribute, readonly] boolean ProtectionMode;
	[attribute, readonly] boolean ProtectContents;
	[attribute, readonly] boolean ProtectDrawingObjects;
	[attribute, readonly] boolean ProtectScenarios;
	[attribute, readonly] XRange UsedRange;
	[attribute, readonly] XWorksheet Next;
	[attribute, readonly] XWorksheet Previous;
	[attribute, readonly] string CodeName;
 	[attribute, readonly] short Index;
 	[attribute] long EnableSelection;
	[attribute] boolean AutoFilterMode;

	void Activate();
	void Calculate( );
	void Select();
	void Move([in] any Before,[in] any After );
	void Copy([in] any Before,[in] any After );
	void Paste([in] any Destination,[in] any Link);
	void Delete( );
	void Protect([in] any Password,[in] any DrawingObjects ,[in] any Contents,[in] any Scenarios,[in] any UserInterfaceOnly);
	void Unprotect([in] any Password );
	void CheckSpelling([in] any CustomDictionary,[in] any IgnoreUppercase, [in] any AlwaysSuggest,[in] any SpellingLang );
	void ShowDataForm();

	XRange Range([in] any Cell1, [in] any Cell2 );
	any ChartObjects([in] any Index);
	any PivotTables([in] any Index);
	any Comments([in] any Index);
	XOutline Outline();
	XPageSetup PageSetup();
	any HPageBreaks([in] any Index);
	any VPageBreaks([in] any Index);
	any OLEObjects([in] any Index);
	any Shapes([in] any Index);

    /*  The following form control related symbols do not refer to ActiveX form
        controls embedded in the sheet, but to the old-style drawing controls
        of Excel. This is an Excel-only feature. */
    any Buttons( [in] any Index );
    any CheckBoxes( [in] any Index );
    any DropDowns( [in] any Index );
    any GroupBoxes( [in] any Index );
    any Labels( [in] any Index );
    any ListBoxes( [in] any Index );
    any OptionButtons( [in] any Index );
    any ScrollBars( [in] any Index );
    any Spinners( [in] any Index );

// FIXME: should prolly inherit from Range somehow...
	XRange Cells( [in] any RowIndex, [in] any ColumnIndex );
	XRange Rows( [in] any Index );
	XRange Columns( [in] any Index );
    any Hyperlinks( [in] any Index );
	any Names( [in] any Index );

	any Evaluate( [in] string Name );

	void setEnableCalculation( [in] boolean EnableCalculation ) raises(com::sun::star::script::BasicErrorException);
	boolean getEnableCalculation() raises(com::sun::star::script::BasicErrorException);
	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, [in] any IgnorePrintAreas );
};

//=============================================================================

}; }; };

#endif