xref: /AOO41X/main/offapi/com/sun/star/sheet/XViewSplitable.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_sheet_XViewSplitable_idl__
24#define __com_sun_star_sheet_XViewSplitable_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30
31//=============================================================================
32
33 module com {  module sun {  module star {  module sheet {
34
35//=============================================================================
36
37/** enables a <type>SpreadsheetView</type> to split the view.
38
39    @deprecated
40 */
41published interface XViewSplitable: com::sun::star::uno::XInterface
42{
43    //-------------------------------------------------------------------------
44
45    /** returns <TRUE/> if the view is split
46        into individual panes.
47
48        <p>Only one of
49        <member>XViewSplitable::getIsWindowSplit()</member> and
50        <member>XViewFreezable::hasFrozenPanes()</member>
51        can be <TRUE/>.</p>
52     */
53    boolean getIsWindowSplit();
54
55    //-------------------------------------------------------------------------
56
57    /** returns the horizontal position in pixels where
58        the view is split.
59     */
60    long getSplitHorizontal();
61
62    //-------------------------------------------------------------------------
63
64    /** returns the vertical position in pixels where
65        the view is split.
66     */
67    long getSplitVertical();
68
69    //-------------------------------------------------------------------------
70
71    /** returns the column before which the view is split.
72     */
73    long getSplitColumn();
74
75    //-------------------------------------------------------------------------
76
77    /** returns the row before which the view is split.
78     */
79    long getSplitRow();
80
81    //-------------------------------------------------------------------------
82
83    /** splits the view at the specified position.
84
85        <p>To split only horizontally, specify <var>nPixelY</var> as 0.
86        To split only vertically, specify <var>nPixelX</var> as 0.</p>
87     */
88    void splitAtPosition( [in] long nPixelX,
89             [in] long nPixelY );
90
91};
92
93//=============================================================================
94
95}; }; }; };
96
97#endif
98
99