offapi/com/sun/star/sheet/XViewFreezable.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: XViewFreezable.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_XViewFreezable_idl__
  31 #define __com_sun_star_sheet_XViewFreezable_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module sheet {
  41
  42 //=============================================================================
  43
  44 /** enables a <type>SpreadsheetView</type> to freeze
  45     columns and rows of the view.
  46  */
  47 published interface XViewFreezable: com::sun::star::uno::XInterface
  48 {
  49     //-------------------------------------------------------------------------
  50
  51     /** returns <TRUE/> if the view has frozen panes.
  52
  53         <p>Only one of
  54         <member>XViewSplitable::getIsWindowSplit()</member> and
  55         <member>XViewFreezable::hasFrozenPanes()</member>
  56         can be <TRUE/>.</p>
  57      */
  58     boolean hasFrozenPanes();
  59
  60     //-------------------------------------------------------------------------
  61
  62     /** freezes panes with the specified number of
  63         columns and rows.
  64
  65         <p>To freeze only horizontally, specify nRows as 0.
  66         To freeze only vertically, specify nColumns as 0.</p>
  67      */
  68     void freezeAtPosition( [in] long nColumns,
  69              [in] long nRows );
  70
  71 };
  72
  73 //=============================================================================
  74
  75 }; }; }; };
  76
  77 #endif
  78