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

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