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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_sheet_XViewSplitable_idl__
  20 #define __com_sun_star_sheet_XViewSplitable_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24
  25
  26  module com {  module sun {  module star {  module sheet {
  27
  28
  29 /** enables a SpreadsheetView to split the view.
  30
  31     @deprecated
  32  */
  33 published interface XViewSplitable: com::sun::star::uno::XInterface
  34 {
  35
  36     /** returns `TRUE` if the view is split
  37         into individual panes.
  38
  39         <p>Only one of
  40         XViewSplitable::getIsWindowSplit() and
  41         XViewFreezable::hasFrozenPanes()
  42         can be `TRUE`.</p>
  43      */
  44     boolean getIsWindowSplit();
  45
  46
  47     /** returns the horizontal position in pixels where
  48         the view is split.
  49      */
  50     long getSplitHorizontal();
  51
  52
  53     /** returns the vertical position in pixels where
  54         the view is split.
  55      */
  56     long getSplitVertical();
  57
  58
  59     /** returns the column before which the view is split.
  60      */
  61     long getSplitColumn();
  62
  63
  64     /** returns the row before which the view is split.
  65      */
  66     long getSplitRow();
  67
  68
  69     /** splits the view at the specified position.
  70
  71         <p>To split only horizontally, specify <var>nPixelY</var> as 0.
  72         To split only vertically, specify <var>nPixelX</var> as 0.</p>
  73      */
  74     void splitAtPosition( [in] long nPixelX,
  75              [in] long nPixelY );
  76
  77 };
  78
  79
  80 }; }; }; };
  81
  82 #endif
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */