offapi/com/sun/star/drawing/GenericDrawingDocument.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: GenericDrawingDocument.idl,v $
  10  * $Revision: 1.4 $
  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_GenericDrawingDocument_idl__
  31 #define __com_sun_star_drawing_GenericDrawingDocument_idl__
  32
  33 #ifndef __com_sun_star_drawing_XDrawPageDuplicator_idl__
  34 #include <com/sun/star/drawing/XDrawPageDuplicator.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_drawing_XDrawPagesSupplier_idl__
  38 #include <com/sun/star/drawing/XDrawPagesSupplier.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_drawing_XMasterPagesSupplier_idl__
  42 #include <com/sun/star/drawing/XMasterPagesSupplier.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_drawing_XLayerSupplier_idl__
  46 #include <com/sun/star/drawing/XLayerSupplier.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_lang_XMultiServiceFactory_idl__
  50 #include <com/sun/star/lang/XMultiServiceFactory.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_beans_XPropertySet_idl__
  54 #include <com/sun/star/beans/XPropertySet.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_style_XStyleFamiliesSupplier_idl__
  58 #include <com/sun/star/style/XStyleFamiliesSupplier.idl>
  59 #endif
  60
  61 #ifndef __com_sun_star_lang_Locale_idl__
  62 #include <com/sun/star/lang/Locale.idl>
  63 #endif
  64
  65 #ifndef __com_sun_star_awt_Rectangle_idl__
  66 #include <com/sun/star/awt/Rectangle.idl>
  67 #endif
  68
  69 #ifndef __com_sun_star_i18n_XForbiddenCharacters_idl__
  70 #include <com/sun/star/i18n/XForbiddenCharacters.idl>
  71 #endif
  72
  73 #ifndef __com_sun_star_document_OfficeDocument_idl__
  74 #include <com/sun/star/document/OfficeDocument.idl>
  75 #endif
  76
  77 //=============================================================================
  78
  79  module com {  module sun {  module star {  module drawing {
  80
  81 //=============================================================================
  82
  83 /** specifies a document which consists of multiple pages
  84     with drawings.
  85
  86     <p>Because its function is needed more then once, its defined as generic one.</p>
  87  */
  88 service GenericDrawingDocument
  89 {
  90     /** this base service describes storing and printing */
  91     service com::sun::star::document::OfficeDocument;
  92
  93     /** this factory lets you create various services that are
  94         used inside a drawing document
  95
  96         <p>The following services are <type>Shape</type>s.
  97         They are created by the documents factory and must
  98         be inserted into a <type>DrawPage</type> or <type>MasterPage</type>
  99         of this document.
 100
 101         <ul>
 102             <li><type>RectangleShape</type></li>
 103             <li><type>EllipseShape</type></li>
 104             <li><type>ControlShape</type></li>
 105             <li><type>ConnectorShape</type></li>
 106             <li><type>MeasureShape</type></li>
 107             <li><type>LineShape</type></li>
 108             <li><type>PolyPolygonShape</type></li>
 109             <li><type>PolyLineShape</type></li>
 110             <li><type>OpenBezierShape</type></li>
 111             <li><type>ClosedBezierShape</type></li>
 112             <li><type>GraphicObjectShape</type></li>
 113             <li><type>GroupShape</type></li>
 114             <li><type>TextShape</type></li>
 115             <li><type>OLE2Shape</type></li>
 116             <li><type>PageShape</type></li>
 117             <li><type>CaptionShape</type></li>
 118             <li><type>PluginShape</type></li>
 119             <li><type>AppletShape</type></li>
 120         </ul>
 121
 122         <p>The following services are all <type scope="com::sun::star::text">TextField</type>
 123         and can be inserted into text as <type scope="com::sun::star::text">TextContent</type>.
 124
 125         <ul>
 126             <li><member scope="com::sun::star::text">TextField::DateTime</member></li>
 127             <li><member scope="com::sun::star::text">TextField::URL</member></li>
 128             <li><member scope="com::sun::star::text">TextField::PageNumber</member></li>
 129             <li><member scope="com::sun::star::text">TextField::PageCount</member></li>
 130             <li><member scope="com::sun::star::text">TextField::SheetName</member></li>
 131             <li><member scope="com::sun::star::text">TextField::FileName</member></li>
 132             <li><member scope="com::sun::star::text">TextField::DocInfo.Title</member></li>
 133             <li><member scope="com::sun::star::text">TextField::Author</member></li>
 134             <li><member scope="com::sun::star::text">TextField::Measure</member></li>
 135         </ul>
 136
 137         <p>The following services gives access to resources used inside the document
 138         and let you add new resources.
 139
 140         <ul>
 141             <li><type scope="com::sun::star::drawing">DashTable</type></li>
 142             <li><type scope="com::sun::star::drawing">GradientTable</type></li>
 143             <li><type scope="com::sun::star::drawing">HatchTable</type></li>
 144             <li><type scope="com::sun::star::drawing">BitmapTable</type></li>
 145             <li><type scope="com::sun::star::drawing">TransparencyGradientTable</type></li>
 146             <li><type scope="com::sun::star::drawing">MarkerTable</type></li>
 147         </ul>
 148
 149         <p>The following service can be set at the <code>Numbering</code> property
 150         inside a <type scope="com::sun::star::style">ParagraphProperties</type>
 151
 152         <ul>
 153             <li><type scope="com::sun::star::text">NumberingRules</type></li>
 154         </ul>
 155
 156         <p>The following services can be used for a <type scope="com::sun::star::image">ImageMap</type>
 157         inside the document.
 158
 159         <br>A <type scope="com::sun::star::image">ImageMap</type> can be obtained from a
 160         <type>GraphicObjectShape</type>
 161
 162         <ul>
 163             <li><type scope="com::sun::star::image">ImageMapRectangleObject</type></li>
 164             <li><type scope="com::sun::star::image">ImageMapCircleObject</type></li>
 165             <li><type scope="com::sun::star::image">ImageMapPolygonObject</type></li>
 166         </ul>
 167
 168         <p>The following services lets you access the drawing property defaults
 169         of a document.
 170
 171         <ul>
 172             <li><type scope="com::sun::star::drawing">Defaults</type></li>
 173         </ul>
 174     */
 175     interface com::sun::star::lang::XMultiServiceFactory;
 176
 177     /** lets you access the properties of this service.
 178      */
 179     interface com::sun::star::beans::XPropertySet;
 180
 181     /** lets you duplicate pages inside this document.
 182      */
 183     interface com::sun::star::drawing::XDrawPageDuplicator;
 184
 185
 186     /** provides an object that is implementing the service
 187                 <type>DrawPage</type>s. With this service you have access to the
 188                 <type>DrawPage</type>s inside a document.
 189      */
 190     interface com::sun::star::drawing::XDrawPagesSupplier;
 191
 192
 193     /** returns an object that is implementing the service
 194                 <type>MasterPages</type>. With this service you have access to the
 195                 <type>MasterPage</type>s inside a document.
 196      */
 197     interface com::sun::star::drawing::XMasterPagesSupplier;
 198
 199
 200     /** returns an object that is implementing the service
 201                 <type>LayerManager</type>. This service lets you manipulate the
 202                 <type>Layer</type>s of this document.
 203      */
 204     interface com::sun::star::drawing::XLayerSupplier;
 205
 206     /** This interface lets you access the styles contained in this document
 207      */
 208     interface com::sun::star::style::XStyleFamiliesSupplier;
 209
 210     //-------------------------------------------------------------------------
 211
 212     /** This property specifies the length between the default tab stops
 213         inside text in this document in 1/100th mm.
 214      */
 215     [property] long TabStop;
 216
 217     //-------------------------------------------------------------------------
 218
 219     /** contains the identifier of the default locale of the document.
 220      */
 221     [property] com::sun::star::lang::Locale CharLocale;
 222
 223     //-------------------------------------------------------------------------
 224
 225     /** if this document is an ole client, this is the current visible area
 226         in 100th mm
 227     */
 228     [property] com::sun::star::awt::Rectangle VisibleArea;
 229
 230     //-------------------------------------------------------------------------
 231
 232     /** This property gives the XForbiddenCharacters.
 233      */
 234     [readonly, property] com::sun::star::i18n::XForbiddenCharacters ForbiddenCharacters;
 235
 236 };
 237
 238 //=============================================================================
 239
 240 }; }; }; };
 241
 242 #endif
 243