offapi/com/sun/star/drawing/DrawingDocumentDrawView.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_drawing_DrawingDocumentDrawView_idl__
  20 #define __com_sun_star_drawing_DrawingDocumentDrawView_idl__
  21
  22 #include <com/sun/star/drawing/XDrawView.idl>
  23
  24 #include <com/sun/star/beans/XPropertySet.idl>
  25
  26 #include <com/sun/star/frame/Controller.idl>
  27
  28 #include <com/sun/star/view/XSelectionSupplier.idl>
  29
  30 #include <com/sun/star/drawing/XDrawPage.idl>
  31 #include <com/sun/star/awt/XWindow.idl>
  32 #include <com/sun/star/awt/Point.idl>
  33
  34 module com {  module sun {  module star {  module view {
  35     published interface XFormLayerAccess;
  36 }; }; }; };
  37
  38
  39  module com {  module sun {  module star {  module drawing {
  40
  41
  42 /** This component integrates a view to a DrawPages or
  43     MasterPage from a DrawingDocument.
  44  */
  45 published service DrawingDocumentDrawView
  46 {
  47
  48     /** this services offers the  integration of this component into the
  49         desktop.
  50     */
  51     service com::sun::star::frame::Controller;
  52
  53
  54     /** lets you access the window for this view
  55
  56         @since OOo 1.1.2
  57     */
  58     [optional] interface com::sun::star::awt::XWindow;
  59
  60     /** let's you access the view part of the form layer contained in the document's view
  61     */
  62     [optional] interface com::sun::star::view::XFormLayerAccess;
  63
  64
  65     /** lets you set/get the current page displayed by this
  66         view.
  67      */
  68     interface com::sun::star::drawing::XDrawView;
  69
  70
  71
  72     /** lets you access the properties of this service.
  73      */
  74     interface com::sun::star::beans::XPropertySet;
  75
  76
  77
  78     /** gives you access to the selected entities of this
  79                 view.
  80      */
  81     interface com::sun::star::view::XSelectionSupplier;
  82
  83
  84     /** If the view is in master page mode, the view shows the master pages
  85         of this model.
  86      */
  87     [property] boolean IsMasterPageMode;
  88
  89
  90     /** If the view is in layer mode, the user can modify the layer of the
  91         model of this view in the user interface.
  92      */
  93     [property] boolean IsLayerMode;
  94
  95
  96
  97     /** This is the drawing page that is currently visible.
  98      */
  99     [property] XDrawPage CurrentPage;
 100
 101
 102     /** This is the area that is currently visible.
 103      */
 104     [readonly, property] com::sun::star::awt::Rectangle VisibleArea;
 105
 106
 107     /** This property defines the zoom type for the document.
 108         @see com::sun::star::view::DocumentZoomType
 109
 110         Note: After setting other types then
 111         com::sun::star::view::DocumentZoomType::BY_VALUE,
 112         implementations may calculate the required zoom value and set the type
 113         to com::sun::star::view::DocumentZoomType::BY_VALUE
 114         afterwards.
 115
 116         @since OOo 1.1.2
 117     */
 118        [optional, property] short ZoomType;
 119
 120
 121        /** Defines the zoom value to use.
 122         Valid only if the ZoomType is set to
 123         com::sun::star::view::DocumentZoomType::BY_VALUE.
 124
 125         @since OOo 1.1.2
 126     */
 127        [optional, property] short ZoomValue;
 128
 129
 130     /** defines the offset from the top left position of the displayed page
 131         to the top left position of the view area in 100th/mm.
 132
 133         @since OOo 1.1.2
 134     */
 135     [optional, property] com::sun::star::awt::Point ViewOffset;
 136
 137     /** The sub controller takes over view specific handling of properties,
 138         the selection, and the current page/slide.
 139
 140         The following line is commented because XDrawSubController is not
 141         (yet) published and the IDL compiler does not allow that.
 142
 143         [optional, property] ::com::sun::star::drawing::XDrawSubController SubController;
 144     */
 145 };
 146
 147
 148 }; }; }; };
 149
 150 #endif
 151
 152 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */