offapi/com/sun/star/sheet/XViewFreezable.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_XViewFreezable_idl__
  20 #define __com_sun_star_sheet_XViewFreezable_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 freeze
  30     columns and rows of the view.
  31  */
  32 published interface XViewFreezable: com::sun::star::uno::XInterface
  33 {
  34
  35     /** returns `TRUE` if the view has frozen panes.
  36
  37         <p>Only one of
  38         XViewSplitable::getIsWindowSplit() and
  39         XViewFreezable::hasFrozenPanes()
  40         can be `TRUE`.</p>
  41      */
  42     boolean hasFrozenPanes();
  43
  44
  45     /** freezes panes with the specified number of
  46         columns and rows.
  47
  48         <p>To freeze only horizontally, specify nRows as 0.
  49         To freeze only vertically, specify nColumns as 0.</p>
  50      */
  51     void freezeAtPosition( [in] long nColumns,
  52              [in] long nRows );
  53
  54 };
  55
  56
  57 }; }; }; };
  58
  59 #endif
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */