summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/SpreadsheetView.idl
blob: 280f911ebef894374c58ebbb88d2058e75ec8f09 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_sheet_SpreadsheetView_idl__
#define __com_sun_star_sheet_SpreadsheetView_idl__

#include <com/sun/star/frame/Controller.idl>
#include <com/sun/star/sheet/SpreadsheetViewSettings.idl>
#include <com/sun/star/sheet/SpreadsheetViewPane.idl>
#include <com/sun/star/sheet/XSpreadsheetView.idl>
#include <com/sun/star/container/XIndexAccess.idl>
#include <com/sun/star/view/XSelectionSupplier.idl>
#include <com/sun/star/sheet/XViewSplitable.idl>
#include <com/sun/star/sheet/XViewFreezable.idl>
#include <com/sun/star/sheet/XRangeSelection.idl>
#include <com/sun/star/container/XEnumerationAccess.idl>
#include <com/sun/star/sheet/XActivationBroadcaster.idl>
#include <com/sun/star/sheet/XEnhancedMouseClickBroadcaster.idl>

//=============================================================================

 module com {  module sun {  module star {  module sheet {

//=============================================================================

/** represents a view of a spreadsheet document.
 */
published service SpreadsheetView
{
    /** provides the integration into the framework.
     */
    service com::sun::star::frame::Controller;

    /** provides the view's settings.
     */
    service com::sun::star::sheet::SpreadsheetViewSettings;

    /** provides direct access to the view's active pane.
     */
    service com::sun::star::sheet::SpreadsheetViewPane;

    /** provides access to the active sheet in the view.
     */
    interface com::sun::star::sheet::XSpreadsheetView;

    /** provides access to the collection of view panes.
     */
    interface com::sun::star::container::XIndexAccess;

    /** creates an enumeration of view panes.

        @see com::sun::star::sheet::SpreadsheetViewPanesEnumeration

     */
    interface com::sun::star::container::XEnumerationAccess;

    /** provides access to the view's selection.
    <p>The selection in a spreadsheet view can be a
        <type scope="com::sun::star::sheet">SheetCell</type>,
        <type scope="com::sun::star::sheet">SheetCellRange</type>,
        <type scope="com::sun::star::sheet">SheetCellRanges</type>,
        <type scope="com::sun::star::drawing">Shape</type> or
        <type scope="com::sun::star::drawing">Shapes</type> object.
    </p>
     */
    interface com::sun::star::view::XSelectionSupplier;

    /** allows to split the view.
     */
    interface com::sun::star::sheet::XViewSplitable;

    /** allows to freeze columns and rows of the view.
     */
    interface com::sun::star::sheet::XViewFreezable;

    /** allows to let the user interactively select a cell range.
     */
    interface com::sun::star::sheet::XRangeSelection;

    [optional] interface com::sun::star::sheet::XEnhancedMouseClickBroadcaster;

    [optional] interface com::sun::star::sheet::XActivationBroadcaster;
};

//=============================================================================

}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */