offapi/com/sun/star/drawing/DrawingDocumentDrawView.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: DrawingDocumentDrawView.idl,v $
  10  * $Revision: 1.16 $
  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_drawing_DrawingDocumentDrawView_idl__
  31 #define __com_sun_star_drawing_DrawingDocumentDrawView_idl__
  32
  33 #ifndef __com_sun_star_drawing_XDrawView_idl__
  34 #include <com/sun/star/drawing/XDrawView.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_XPropertySet_idl__
  38 #include <com/sun/star/beans/XPropertySet.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_frame_Controller_idl__
  42 #include <com/sun/star/frame/Controller.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_view_XSelectionSupplier_idl__
  46 #include <com/sun/star/view/XSelectionSupplier.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_lang_XServiceInfo_idl__
  50 #include <com/sun/star/lang/XServiceInfo.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_drawing_XDrawPage_idl__
  54 #include <com/sun/star/drawing/XDrawPage.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_awt_XWindow_idl__
  58 #include <com/sun/star/awt/XWindow.idl>
  59 #endif
  60
  61 #ifndef __com_sun_star_awt_Point_idl__
  62 #include <com/sun/star/awt/Point.idl>
  63 #endif
  64
  65 //=============================================================================
  66 module com {  module sun {  module star {  module view {
  67     published interface XFormLayerAccess;
  68 }; }; }; };
  69
  70 //=============================================================================
  71
  72  module com {  module sun {  module star {  module drawing {
  73
  74 //=============================================================================
  75
  76 /** This componend integrates a view to a <type>DrawPage</type>s or
  77     <type>MasterPage</type> from a <type>DrawingDocument</type>.
  78  */
  79 published service DrawingDocumentDrawView
  80 {
  81     //-------------------------------------------------------------------------
  82
  83     /** this services offers the  integration of this component into the
  84         desktop.
  85     */
  86     service com::sun::star::frame::Controller;
  87
  88     //-------------------------------------------------------------------------
  89
  90     /** lets you access the window for this view
  91
  92         @since OOo 1.1.2
  93     */
  94     [optional] interface com::sun::star::awt::XWindow;
  95
  96     /** let's you access the view part of the form layer contained in the document's view
  97     */
  98     [optional] interface com::sun::star::view::XFormLayerAccess;
  99
 100     //-------------------------------------------------------------------------
 101
 102     /** lets you set/get the current page displayed by this
 103         view.
 104      */
 105     interface com::sun::star::drawing::XDrawView;
 106
 107     //-------------------------------------------------------------------------
 108
 109
 110     /** lets you access the properties of this service.
 111      */
 112     interface com::sun::star::beans::XPropertySet;
 113
 114     //-------------------------------------------------------------------------
 115
 116
 117     /** gives you access to the selected entities of this
 118                 view.
 119      */
 120     interface com::sun::star::view::XSelectionSupplier;
 121
 122
 123     //-------------------------------------------------------------------------
 124
 125     /** provides the names of the services implemented by
 126                 this instance.
 127      */
 128     interface com::sun::star::lang::XServiceInfo;
 129
 130     //-------------------------------------------------------------------------
 131
 132     /** If the view is in masterpage mode, the view shows the masterpages
 133         of this model.
 134      */
 135     [property] boolean IsMasterPageMode;
 136
 137     //-------------------------------------------------------------------------
 138
 139     /** If the view is in layer mode, the user can modify the layer of the
 140         model of this view in the user interface.
 141      */
 142     [property] boolean IsLayerMode;
 143
 144
 145     //-------------------------------------------------------------------------
 146
 147     /** This is the drawing page that is currently visible.
 148      */
 149     [property] XDrawPage CurrentPage;
 150
 151     //-------------------------------------------------------------------------
 152
 153     /** This is the area that is currently visible.
 154      */
 155     [readonly, property] com::sun::star::awt::Rectangle VisibleArea;
 156
 157     //-------------------------------------------------------------------------
 158
 159     /** This property defines the zoom type for the document.
 160         @see com::sun::star::view::DocumentZoomType
 161
 162         Note: After setting other types then
 163         <member scope="com::sun::star::view::DocumentZoomType">BY_VALUE</member>,
 164         implementations may calculate the required zoom value and set the type
 165         to <member scope="com::sun::star::view::DocumentZoomType">BY_VALUE</member>
 166         afterwards.
 167
 168         @since OOo 1.1.2
 169     */
 170        [optional, property] short ZoomType;
 171
 172        //-------------------------------------------------------------------------
 173
 174        /** Defines the zoom value to use.
 175         Valid only if the ZoomType is set to
 176         <member scope="com::sun::star::view::DocumentZoomType">BY_VALUE</member>.
 177
 178         @since OOo 1.1.2
 179     */
 180        [optional, property] short ZoomValue;
 181
 182        //-------------------------------------------------------------------------
 183
 184     /** defines the offset from the top left position of the displayed page
 185         to the top left position of the view area in 100th/mm.
 186
 187         @since OOo 1.1.2
 188     */
 189     [optional, property] com::sun::star::awt::Point ViewOffset;
 190
 191     /** The sub controller takes over view specific handling of properties,
 192         the selection, and the current page/slide.
 193
 194         The following line is commented because XDrawSubController is not
 195         (yet) published and the IDL compiler does not allow that.
 196
 197         [optional, property] ::com::sun::star::drawing::XDrawSubController SubController;
 198     */
 199 };
 200
 201 //=============================================================================
 202
 203 }; }; }; };
 204
 205 #endif
 206