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