offapi/com/sun/star/sheet/SpreadsheetView.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  module com {  module sun {  module star {  module sheet {
  22
  23
  24 /** represents a view of a spreadsheet document.
  25  */
  26 published service SpreadsheetView
  27 {
  28     /** provides the integration into the framework.
  29      */
  30     service com::sun::star::frame::Controller;
  31
  32     /** provides the view's settings.
  33      */
  34     service com::sun::star::sheet::SpreadsheetViewSettings;
  35
  36     /** provides direct access to the view's active pane.
  37      */
  38     service com::sun::star::sheet::SpreadsheetViewPane;
  39
  40     /** provides access to the active sheet in the view.
  41      */
  42     interface com::sun::star::sheet::XSpreadsheetView;
  43
  44     /** provides access to the collection of view panes.
  45      */
  46     interface com::sun::star::container::XIndexAccess;
  47
  48     /** creates an enumeration of view panes.
  49
  50         @see com::sun::star::sheet::SpreadsheetViewPanesEnumeration
  51
  52      */
  53     interface com::sun::star::container::XEnumerationAccess;
  54
  55     /** provides access to the view's selection.
  56     <p>The selection in a spreadsheet view can be a
  57         com::sun::star::sheet::SheetCell,
  58         com::sun::star::sheet::SheetCellRange,
  59         com::sun::star::sheet::SheetCellRanges,
  60         com::sun::star::drawing::Shape or
  61         com::sun::star::drawing::Shapes object.
  62     </p>
  63      */
  64     interface com::sun::star::view::XSelectionSupplier;
  65
  66     /** allows to split the view.
  67      */
  68     interface com::sun::star::sheet::XViewSplitable;
  69
  70     /** allows to freeze columns and rows of the view.
  71      */
  72     interface com::sun::star::sheet::XViewFreezable;
  73
  74     /** allows to let the user interactively select a cell range.
  75      */
  76     interface com::sun::star::sheet::XRangeSelection;
  77
  78     [optional] interface com::sun::star::sheet::XEnhancedMouseClickBroadcaster;
  79
  80     [optional] interface com::sun::star::sheet::XActivationBroadcaster;
  81 };
  82
  83
  84 }; }; }; };
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */