offapi/com/sun/star/sheet/XViewSplitable.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: XViewSplitable.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_XViewSplitable_idl__
  31 #define __com_sun_star_sheet_XViewSplitable_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 split the view.
  45
  46     @deprecated
  47  */
  48 published interface XViewSplitable: com::sun::star::uno::XInterface
  49 {
  50     //-------------------------------------------------------------------------
  51
  52     /** returns <TRUE/> if the view is split
  53         into individual panes.
  54
  55         <p>Only one of
  56         <member>XViewSplitable::getIsWindowSplit()</member> and
  57         <member>XViewFreezable::hasFrozenPanes()</member>
  58         can be <TRUE/>.</p>
  59      */
  60     boolean getIsWindowSplit();
  61
  62     //-------------------------------------------------------------------------
  63
  64     /** returns the horizontal position in pixels where
  65         the view is split.
  66      */
  67     long getSplitHorizontal();
  68
  69     //-------------------------------------------------------------------------
  70
  71     /** returns the vertical position in pixels where
  72         the view is split.
  73      */
  74     long getSplitVertical();
  75
  76     //-------------------------------------------------------------------------
  77
  78     /** returns the column before which the view is split.
  79      */
  80     long getSplitColumn();
  81
  82     //-------------------------------------------------------------------------
  83
  84     /** returns the row before which the view is split.
  85      */
  86     long getSplitRow();
  87
  88     //-------------------------------------------------------------------------
  89
  90     /** splits the view at the specified position.
  91
  92         <p>To split only horizontally, specify <var>nPixelY</var> as 0.
  93         To split only vertically, specify <var>nPixelX</var> as 0.</p>
  94      */
  95     void splitAtPosition( [in] long nPixelX,
  96              [in] long nPixelY );
  97
  98 };
  99
 100 //=============================================================================
 101
 102 }; }; }; };
 103
 104 #endif
 105