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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_sheet_SpreadsheetView_idl__
  28 #define __com_sun_star_sheet_SpreadsheetView_idl__
  29
  30 #ifndef __com_sun_star_frame_Controller_idl__
  31 #include <com/sun/star/frame/Controller.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_sheet_SpreadsheetViewSettings_idl__
  35 #include <com/sun/star/sheet/SpreadsheetViewSettings.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_sheet_SpreadsheetViewPane_idl__
  39 #include <com/sun/star/sheet/SpreadsheetViewPane.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_sheet_XSpreadsheetView_idl__
  43 #include <com/sun/star/sheet/XSpreadsheetView.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_container_XIndexAccess_idl__
  47 #include <com/sun/star/container/XIndexAccess.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_view_XSelectionSupplier_idl__
  51 #include <com/sun/star/view/XSelectionSupplier.idl>
  52 #endif
  53
  54 #ifndef __com_sun_star_sheet_XViewSplitable_idl__
  55 #include <com/sun/star/sheet/XViewSplitable.idl>
  56 #endif
  57
  58 #ifndef __com_sun_star_sheet_XViewFreezable_idl__
  59 #include <com/sun/star/sheet/XViewFreezable.idl>
  60 #endif
  61
  62 #ifndef __com_sun_star_sheet_XRangeSelection_idl__
  63 #include <com/sun/star/sheet/XRangeSelection.idl>
  64 #endif
  65
  66 #ifndef __com_sun_star_container_XEnumerationAccess_idl__
  67 #include <com/sun/star/container/XEnumerationAccess.idl>
  68 #endif
  69
  70 #ifndef __com_sun_star_sheet_XActivationBroadcaster_idl__
  71 #include <com/sun/star/sheet/XActivationBroadcaster.idl>
  72 #endif
  73
  74 #ifndef __com_sun_star_sheet_XEnhancedMouseClickBroadcaster_idl__
  75 #include <com/sun/star/sheet/XEnhancedMouseClickBroadcaster.idl>
  76 #endif
  77
  78 //=============================================================================
  79
  80  module com {  module sun {  module star {  module sheet {
  81
  82 //=============================================================================
  83
  84 /** represents a view of a spreadsheet document.
  85  */
  86 published service SpreadsheetView
  87 {
  88     /** provides the integration into the framework.
  89      */
  90     service com::sun::star::frame::Controller;
  91
  92     /** provides the view's settings.
  93      */
  94     service com::sun::star::sheet::SpreadsheetViewSettings;
  95
  96     /** provides direct access to the view's active pane.
  97      */
  98     service com::sun::star::sheet::SpreadsheetViewPane;
  99
 100     /** provides access to the active sheet in the view.
 101      */
 102     interface com::sun::star::sheet::XSpreadsheetView;
 103
 104     /** provides access to the collection of view panes.
 105      */
 106     interface com::sun::star::container::XIndexAccess;
 107
 108     /** creates an enumeration of view panes.
 109
 110         @see com::sun::star::sheet::SpreadsheetViewPanesEnumeration
 111
 112      */
 113     interface com::sun::star::container::XEnumerationAccess;
 114
 115     /** provides access to the view's selection.
 116     <p>The selection in a spreadsheet view can be a
 117         <type scope="com::sun::star::sheet">SheetCell</type>,
 118         <type scope="com::sun::star::sheet">SheetCellRange</type>,
 119         <type scope="com::sun::star::sheet">SheetCellRanges</type>,
 120         <type scope="com::sun::star::drawing">Shape</type> or
 121         <type scope="com::sun::star::drawing">Shapes</type> object.
 122     </p>
 123      */
 124     interface com::sun::star::view::XSelectionSupplier;
 125
 126     /** allows to split the view.
 127      */
 128     interface com::sun::star::sheet::XViewSplitable;
 129
 130     /** allows to freeze columns and rows of the view.
 131      */
 132     interface com::sun::star::sheet::XViewFreezable;
 133
 134     /** allows to let the user interactively select a cell range.
 135      */
 136     interface com::sun::star::sheet::XRangeSelection;
 137
 138     [optional] interface com::sun::star::sheet::XEnhancedMouseClickBroadcaster;
 139
 140     [optional] interface com::sun::star::sheet::XActivationBroadcaster;
 141 };
 142
 143 //=============================================================================
 144
 145 }; }; }; };
 146
 147 #endif
 148