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
  20
  21
  22  module com {  module sun {  module star {  module sheet {
  23
  24
  25 /** enables a SpreadsheetView to freeze
  26     columns and rows of the view.
  27  */
  28 published interface XViewFreezable: com::sun::star::uno::XInterface
  29 {
  30
  31     /** returns `TRUE` if the view has frozen panes.
  32
  33         <p>Only one of
  34         XViewSplitable::getIsWindowSplit() and
  35         XViewFreezable::hasFrozenPanes()
  36         can be `TRUE`.</p>
  37      */
  38     boolean hasFrozenPanes();
  39
  40
  41     /** freezes panes with the specified number of
  42         columns and rows.
  43
  44         <p>To freeze only horizontally, specify nRows as 0.
  45         To freeze only vertically, specify nColumns as 0.</p>
  46      */
  47     void freezeAtPosition( [in] long nColumns,
  48              [in] long nRows );
  49
  50 };
  51
  52
  53 }; }; }; };
  54
  55 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */