offapi/com/sun/star/sheet/XViewPane.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XViewPane.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_sheet_XViewPane_idl__
  31 #define __com_sun_star_sheet_XViewPane_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_table_CellRangeAddress_idl__
  38 #include <com/sun/star/table/CellRangeAddress.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module sheet {
  45
  46 //=============================================================================
  47
  48 /** represents a pane in a view of a spreadsheet document.
  49
  50     @see com::sun::star::sheet::SpreadsheetViewPane
  51  */
  52 published interface XViewPane: com::sun::star::uno::XInterface
  53 {
  54     //-------------------------------------------------------------------------
  55
  56     /** returns the first column that is visible in the pane.
  57      */
  58     long getFirstVisibleColumn();
  59
  60     //-------------------------------------------------------------------------
  61
  62     /** sets the first column that is visible in the pane.
  63      */
  64     void setFirstVisibleColumn( [in] long nFirstVisibleColumn );
  65
  66     //-------------------------------------------------------------------------
  67
  68     /** returns the first row that is visible in the pane.
  69      */
  70     long getFirstVisibleRow();
  71
  72     //-------------------------------------------------------------------------
  73
  74     /** sets the first row that is visible in the pane.
  75      */
  76     void setFirstVisibleRow( [in] long nFirstVisibleRow );
  77
  78     //-------------------------------------------------------------------------
  79
  80     /** returns the address of the cell range that consists of
  81         the cells which are visible in the pane.
  82      */
  83     com::sun::star::table::CellRangeAddress getVisibleRange();
  84
  85 };
  86
  87 //=============================================================================
  88
  89 }; }; }; };
  90
  91 #endif
  92