summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/drawing/DrawingDocumentDrawView.idl
blob: 2cbf24e11880abfda922677efa33cdf98895304c (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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_drawing_DrawingDocumentDrawView_idl__
#define __com_sun_star_drawing_DrawingDocumentDrawView_idl__

#include <com/sun/star/drawing/XDrawView.idl>

#include <com/sun/star/beans/XPropertySet.idl>

#include <com/sun/star/frame/Controller.idl>

#include <com/sun/star/view/XSelectionSupplier.idl>

#include <com/sun/star/lang/XServiceInfo.idl>
#include <com/sun/star/drawing/XDrawPage.idl>
#include <com/sun/star/awt/XWindow.idl>
#include <com/sun/star/awt/Point.idl>

//=============================================================================
module com {  module sun {  module star {  module view {
    published interface XFormLayerAccess;
}; }; }; };

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

 module com {  module sun {  module star {  module drawing {

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

/** This component integrates a view to a <type>DrawPage</type>s or
    <type>MasterPage</type> from a <type>DrawingDocument</type>.
 */
published service DrawingDocumentDrawView
{
    //-------------------------------------------------------------------------

    /** this services offers the  integration of this component into the
        desktop.
    */
    service com::sun::star::frame::Controller;

    //-------------------------------------------------------------------------

    /** lets you access the window for this view

        @since OOo 1.1.2
    */
    [optional] interface com::sun::star::awt::XWindow;

    /** let's you access the view part of the form layer contained in the document's view
    */
    [optional] interface com::sun::star::view::XFormLayerAccess;

    //-------------------------------------------------------------------------

    /** lets you set/get the current page displayed by this
        view.
     */
    interface com::sun::star::drawing::XDrawView;

    //-------------------------------------------------------------------------


    /** lets you access the properties of this service.
     */
    interface com::sun::star::beans::XPropertySet;

    //-------------------------------------------------------------------------


    /** gives you access to the selected entities of this
                view.
     */
    interface com::sun::star::view::XSelectionSupplier;


    //-------------------------------------------------------------------------

    /** provides the names of the services implemented by
                this instance.
     */
    interface com::sun::star::lang::XServiceInfo;

    //-------------------------------------------------------------------------

    /** If the view is in master page mode, the view shows the master pages
        of this model.
     */
    [property] boolean IsMasterPageMode;

    //-------------------------------------------------------------------------

    /** If the view is in layer mode, the user can modify the layer of the
        model of this view in the user interface.
     */
    [property] boolean IsLayerMode;


    //-------------------------------------------------------------------------

    /** This is the drawing page that is currently visible.
     */
    [property] XDrawPage CurrentPage;

    //-------------------------------------------------------------------------

    /** This is the area that is currently visible.
     */
    [readonly, property] com::sun::star::awt::Rectangle VisibleArea;

    //-------------------------------------------------------------------------

    /** This property defines the zoom type for the document.
        @see com::sun::star::view::DocumentZoomType

        Note: After setting other types then
        <member scope="com::sun::star::view::DocumentZoomType">BY_VALUE</member>,
        implementations may calculate the required zoom value and set the type
        to <member scope="com::sun::star::view::DocumentZoomType">BY_VALUE</member>
        afterwards.

        @since OOo 1.1.2
    */
       [optional, property] short ZoomType;

       //-------------------------------------------------------------------------

       /** Defines the zoom value to use.
        Valid only if the ZoomType is set to
        <member scope="com::sun::star::view::DocumentZoomType">BY_VALUE</member>.

        @since OOo 1.1.2
    */
       [optional, property] short ZoomValue;

       //-------------------------------------------------------------------------

    /** defines the offset from the top left position of the displayed page
        to the top left position of the view area in 100th/mm.

        @since OOo 1.1.2
    */
    [optional, property] com::sun::star::awt::Point ViewOffset;

    /** The sub controller takes over view specific handling of properties,
        the selection, and the current page/slide.

        The following line is commented because XDrawSubController is not
        (yet) published and the IDL compiler does not allow that.

        [optional, property] ::com::sun::star::drawing::XDrawSubController SubController;
    */
};

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

}; }; }; };

#endif