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

   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 __com_sun_star_sheet_XViewPane_idl__
  28 #define __com_sun_star_sheet_XViewPane_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_table_CellRangeAddress_idl__
  35 #include <com/sun/star/table/CellRangeAddress.idl>
  36 #endif
  37
  38
  39 //=============================================================================
  40
  41  module com {  module sun {  module star {  module sheet {
  42
  43 //=============================================================================
  44
  45 /** represents a pane in a view of a spreadsheet document.
  46
  47     @see com::sun::star::sheet::SpreadsheetViewPane
  48  */
  49 published interface XViewPane: com::sun::star::uno::XInterface
  50 {
  51     //-------------------------------------------------------------------------
  52
  53     /** returns the first column that is visible in the pane.
  54      */
  55     long getFirstVisibleColumn();
  56
  57     //-------------------------------------------------------------------------
  58
  59     /** sets the first column that is visible in the pane.
  60      */
  61     void setFirstVisibleColumn( [in] long nFirstVisibleColumn );
  62
  63     //-------------------------------------------------------------------------
  64
  65     /** returns the first row that is visible in the pane.
  66      */
  67     long getFirstVisibleRow();
  68
  69     //-------------------------------------------------------------------------
  70
  71     /** sets the first row that is visible in the pane.
  72      */
  73     void setFirstVisibleRow( [in] long nFirstVisibleRow );
  74
  75     //-------------------------------------------------------------------------
  76
  77     /** returns the address of the cell range that consists of
  78         the cells which are visible in the pane.
  79      */
  80     com::sun::star::table::CellRangeAddress getVisibleRange();
  81
  82 };
  83
  84 //=============================================================================
  85
  86 }; }; }; };
  87
  88 #endif
  89