offapi/com/sun/star/drawing/GenericDrawingDocument.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_GenericDrawingDocument_idl__
  20 #define __com_sun_star_drawing_GenericDrawingDocument_idl__
  21
  22 #include <com/sun/star/drawing/XDrawPageDuplicator.idl>
  23 #include <com/sun/star/drawing/XDrawPagesSupplier.idl>
  24 #include <com/sun/star/drawing/XMasterPagesSupplier.idl>
  25 #include <com/sun/star/drawing/XLayerSupplier.idl>
  26 #include <com/sun/star/lang/XMultiServiceFactory.idl>
  27 #include <com/sun/star/beans/XPropertySet.idl>
  28 #include <com/sun/star/style/XStyleFamiliesSupplier.idl>
  29 #include <com/sun/star/lang/Locale.idl>
  30 #include <com/sun/star/awt/Rectangle.idl>
  31 #include <com/sun/star/i18n/XForbiddenCharacters.idl>
  32 #include <com/sun/star/document/OfficeDocument.idl>
  33
  34
  35  module com {  module sun {  module star {  module drawing {
  36
  37
  38 /** specifies a document which consists of multiple pages
  39     with drawings.
  40
  41     <p>Because its function is needed more than once, its defined as generic one.</p>
  42  */
  43 service GenericDrawingDocument
  44 {
  45     /** this base service describes storing and printing */
  46     service com::sun::star::document::OfficeDocument;
  47
  48     /** this factory lets you create various services that are
  49         used inside a drawing document
  50
  51         <p>The following services are Shapes.
  52         They are created by the documents factory and must
  53         be inserted into a DrawPage or MasterPage
  54         of this document.
  55
  56         <ul>
  57             <li>RectangleShape</li>
  58             <li>EllipseShape</li>
  59             <li>ControlShape</li>
  60             <li>ConnectorShape</li>
  61             <li>MeasureShape</li>
  62             <li>LineShape</li>
  63             <li>PolyPolygonShape</li>
  64             <li>PolyLineShape</li>
  65             <li>OpenBezierShape</li>
  66             <li>ClosedBezierShape</li>
  67             <li>GraphicObjectShape</li>
  68             <li>GroupShape</li>
  69             <li>TextShape</li>
  70             <li>OLE2Shape</li>
  71             <li>PageShape</li>
  72             <li>CaptionShape</li>
  73             <li>PluginShape</li>
  74             <li>AppletShape</li>
  75         </ul>
  76
  77         <p>The following services are all com::sun::star::text::TextField
  78         and can be inserted into text as com::sun::star::text::TextContent.
  79
  80         <ul>
  81             <li>com::sun::star::text::TextField::DateTime</li>
  82             <li>com::sun::star::text::TextField::URL</li>
  83             <li>com::sun::star::text::TextField::PageNumber</li>
  84             <li>com::sun::star::text::TextField::PageCount</li>
  85             <li>com::sun::star::text::TextField::SheetName</li>
  86             <li>com::sun::star::text::TextField::FileName</li>
  87             <li>com::sun::star::text::TextField::DocInfo.Title</li>
  88             <li>com::sun::star::text::TextField::Author</li>
  89             <li>com::sun::star::text::TextField::Measure</li>
  90         </ul>
  91
  92         <p>The following services gives access to resources used inside the document
  93         and let you add new resources.
  94
  95         <ul>
  96             <li>com::sun::star::drawing::DashTable</li>
  97             <li>com::sun::star::drawing::GradientTable</li>
  98             <li>com::sun::star::drawing::HatchTable</li>
  99             <li>com::sun::star::drawing::BitmapTable</li>
 100             <li>com::sun::star::drawing::TransparencyGradientTable</li>
 101             <li>com::sun::star::drawing::MarkerTable</li>
 102         </ul>
 103
 104         <p>The following service can be set at the <code>Numbering</code> property
 105         inside a com::sun::star::style::ParagraphProperties
 106
 107         <ul>
 108             <li>com::sun::star::text::NumberingRules</li>
 109         </ul>
 110
 111         <p>The following services can be used for a com::sun::star::image::ImageMap
 112         inside the document.
 113
 114         <br>A com::sun::star::image::ImageMap can be obtained from a
 115         GraphicObjectShape
 116
 117         <ul>
 118             <li>com::sun::star::image::ImageMapRectangleObject</li>
 119             <li>com::sun::star::image::ImageMapCircleObject</li>
 120             <li>com::sun::star::image::ImageMapPolygonObject</li>
 121         </ul>
 122
 123         <p>The following services lets you access the drawing property defaults
 124         of a document.
 125
 126         <ul>
 127             <li>com::sun::star::drawing::Defaults</li>
 128         </ul>
 129     */
 130     interface com::sun::star::lang::XMultiServiceFactory;
 131
 132     /** lets you access the properties of this service.
 133      */
 134     interface com::sun::star::beans::XPropertySet;
 135
 136     /** lets you duplicate pages inside this document.
 137      */
 138     interface com::sun::star::drawing::XDrawPageDuplicator;
 139
 140
 141     /** provides an object that is implementing the service
 142                 DrawPages. With this service you have access to the
 143                 DrawPages inside a document.
 144      */
 145     interface com::sun::star::drawing::XDrawPagesSupplier;
 146
 147
 148     /** returns an object that is implementing the service
 149                 MasterPages. With this service you have access to the
 150                 MasterPages inside a document.
 151      */
 152     interface com::sun::star::drawing::XMasterPagesSupplier;
 153
 154
 155     /** returns an object that is implementing the service
 156                 LayerManager. This service lets you manipulate the
 157                 Layers of this document.
 158      */
 159     interface com::sun::star::drawing::XLayerSupplier;
 160
 161     /** This interface lets you access the styles contained in this document
 162      */
 163     interface com::sun::star::style::XStyleFamiliesSupplier;
 164
 165
 166     /** This property specifies the length between the default tab stops
 167         inside text in this document in 1/100th mm.
 168      */
 169     [property] long TabStop;
 170
 171
 172     /** contains the identifier of the default locale of the document.
 173      */
 174     [property] com::sun::star::lang::Locale CharLocale;
 175
 176
 177     /** if this document is an OLE client, this is the current visible area
 178         in 100th mm
 179     */
 180     [property] com::sun::star::awt::Rectangle VisibleArea;
 181
 182
 183     /** This property gives the XForbiddenCharacters.
 184      */
 185     [readonly, property] com::sun::star::i18n::XForbiddenCharacters ForbiddenCharacters;
 186
 187 };
 188
 189
 190 }; }; }; };
 191
 192 #endif
 193
 194 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */