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
  20 module com {  module sun {  module star {  module view {
  21     published interface XFormLayerAccess;
  22 }; }; }; };
  23
  24
  25  module com {  module sun {  module star {  module drawing {
  26
  27
  28 /** This component integrates a view to a DrawPages or
  29     MasterPage from a DrawingDocument.
  30  */
  31 published service DrawingDocumentDrawView
  32 {
  33
  34     /** this services offers the  integration of this component into the
  35         desktop.
  36     */
  37     service com::sun::star::frame::Controller;
  38
  39
  40     /** lets you access the window for this view
  41
  42         @since OOo 1.1.2
  43     */
  44     [optional] interface com::sun::star::awt::XWindow;
  45
  46     /** let's you access the view part of the form layer contained in the document's view
  47     */
  48     [optional] interface com::sun::star::view::XFormLayerAccess;
  49
  50
  51     /** lets you set/get the current page displayed by this
  52         view.
  53      */
  54     interface com::sun::star::drawing::XDrawView;
  55
  56
  57
  58     /** lets you access the properties of this service.
  59      */
  60     interface com::sun::star::beans::XPropertySet;
  61
  62
  63
  64     /** gives you access to the selected entities of this
  65                 view.
  66      */
  67     interface com::sun::star::view::XSelectionSupplier;
  68
  69
  70     /** If the view is in master page mode, the view shows the master pages
  71         of this model.
  72      */
  73     [property] boolean IsMasterPageMode;
  74
  75
  76     /** If the view is in layer mode, the user can modify the layer of the
  77         model of this view in the user interface.
  78      */
  79     [property] boolean IsLayerMode;
  80
  81
  82
  83     /** This is the drawing page that is currently visible.
  84      */
  85     [property] XDrawPage CurrentPage;
  86
  87
  88     /** This is the area that is currently visible.
  89      */
  90     [readonly, property] com::sun::star::awt::Rectangle VisibleArea;
  91
  92
  93     /** This property defines the zoom type for the document.
  94         @see com::sun::star::view::DocumentZoomType
  95
  96         Note: After setting other types then
  97         com::sun::star::view::DocumentZoomType::BY_VALUE,
  98         implementations may calculate the required zoom value and set the type
  99         to com::sun::star::view::DocumentZoomType::BY_VALUE
 100         afterwards.
 101
 102         @since OOo 1.1.2
 103     */
 104        [optional, property] short ZoomType;
 105
 106
 107        /** Defines the zoom value to use.
 108         Valid only if the ZoomType is set to
 109         com::sun::star::view::DocumentZoomType::BY_VALUE.
 110
 111         @since OOo 1.1.2
 112     */
 113        [optional, property] short ZoomValue;
 114
 115
 116     /** defines the offset from the top left position of the displayed page
 117         to the top left position of the view area in 100th/mm.
 118
 119         @since OOo 1.1.2
 120     */
 121     [optional, property] com::sun::star::awt::Point ViewOffset;
 122
 123     /** The sub controller takes over view specific handling of properties,
 124         the selection, and the current page/slide.
 125
 126         The following line is commented because XDrawSubController is not
 127         (yet) published and the IDL compiler does not allow that.
 128
 129         [optional, property] ::com::sun::star::drawing::XDrawSubController SubController;
 130     */
 131 };
 132
 133
 134 }; }; }; };
 135
 136 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */