office-gobmx/offapi/com/sun/star/sheet/XViewPane.idl

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_sheet_XViewPane_idl__
#define __com_sun_star_sheet_XViewPane_idl__

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

#ifndef __com_sun_star_table_CellRangeAddress_idl__
#include <com/sun/star/table/CellRangeAddress.idl>
#endif


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

 module com {  module sun {  module star {  module sheet {

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

/** represents a pane in a view of a spreadsheet document.

    @see com::sun::star::sheet::SpreadsheetViewPane
 */
published interface XViewPane: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** returns the first column that is visible in the pane.
     */
    long getFirstVisibleColumn();

    //-------------------------------------------------------------------------

    /** sets the first column that is visible in the pane.
     */
    void setFirstVisibleColumn( [in] long nFirstVisibleColumn );

    //-------------------------------------------------------------------------

    /** returns the first row that is visible in the pane.
     */
    long getFirstVisibleRow();

    //-------------------------------------------------------------------------

    /** sets the first row that is visible in the pane.
     */
    void setFirstVisibleRow( [in] long nFirstVisibleRow );

    //-------------------------------------------------------------------------

    /** returns the address of the cell range that consists of
        the cells which are visible in the pane.
     */
    com::sun::star::table::CellRangeAddress getVisibleRange();

};

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

}; }; }; };

#endif