offapi/com/sun/star/text/MailMerge.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_text_MailMerge_idl__
  20 #define __com_sun_star_text_MailMerge_idl__
  21
  22 #include <com/sun/star/task/XJob.idl>
  23 #include <com/sun/star/sdbc/XResultSet.idl>
  24 #include <com/sun/star/sdbc/XConnection.idl>
  25 #include <com/sun/star/frame/XModel.idl>
  26 #include <com/sun/star/beans/XPropertySet.idl>
  27 #include <com/sun/star/text/XMailMergeBroadcaster.idl>
  28 #include <com/sun/star/sdb/DataAccessDescriptor.idl>
  29 #include <com/sun/star/util/XCancellable.idl>
  30
  31
  32  module com {  module sun {  module star {  module text {
  33
  34
  35 /** Gives access to mail merge functionality.
  36
  37     @since OOo 1.1.2
  38  */
  39 published service MailMerge
  40 {
  41     /** interface to execute the mail merge action.
  42
  43         <p>The com::sun::star::task::XJob::execute()
  44         method of the interface accepts exactly the same properties
  45         as provided by this service in its argument sequence.</p>
  46
  47         <p>The default values for the properties to be used in the method
  48         call are those given by this service. If a property is also listed
  49         in the argument sequence that value will be used for the call.
  50         The value of the property in this service will remain unchanged
  51         by that.</p>
  52      */
  53     interface com::sun::star::task::XJob;
  54
  55     /** interface to cancel the current mail merge job.
  56
  57         @since LibreOffice 4.3
  58      */
  59     [optional] interface com::sun::star::util::XCancellable;
  60
  61     /** interface to access the services properties.
  62      */
  63     interface com::sun::star::beans::XPropertySet;
  64
  65     /** interface to notify mail merge listeners.
  66      */
  67     [optional] interface com::sun::star::text::XMailMergeBroadcaster;
  68
  69
  70     /* database properties */
  71
  72     /** allows to specify the data which the mail merge should be based on.
  73
  74         <p>This service describe the interaction between all data access related properties,
  75         namely #DataSourceName, #Command, #CommandType,
  76         #ActiveConnection, #Selection, #ResultSet,
  77         #Filter and #EscapeProcessing
  78     */
  79     service com::sun::star::sdb::DataAccessDescriptor;
  80
  81     /** contains the name of the data source that is to be used for merging.
  82
  83         <p>For the interaction of this property with other data access relevant properties, see
  84         the com::sun::star::sdb::DataAccessDescriptor service.</p>
  85      */
  86     [property] string DataSourceName;
  87
  88
  89     /** determines the type of the database command as
  90         described in com::sun::star::sdb::CommandType
  91
  92         <p>For the interaction of this property with other data access relevant properties, see
  93         the com::sun::star::sdb::DataAccessDescriptor service.</p>
  94      */
  95     [property] long CommandType;
  96
  97
  98     /** contains the database command.
  99
 100         <p>For the interaction of this property with other data access relevant properties, see
 101         the com::sun::star::sdb::DataAccessDescriptor service.</p>
 102      */
 103     [property] string Command;
 104
 105
 106     /** provides access to a
 107         com::sun::star::sdbc::XResultSet of
 108         a com::sun::star::sdbc::ResultSet service.
 109
 110         <p>Note that any superservices of com::sun::star::sdbc::ResultSet
 111         are also allowed. Especially, this member can denote an instance of the
 112         com::sun::star::sdb::RowSet, or an instance obtained
 113         by calling com::sun::star::sdb::XResultSetAccess::createResultSet()
 114         on such a com::sun::star::sdb::RowSet. This becomes important in
 115         conjunction with the #Selection property.</p>
 116
 117         <p>For the interaction of this property with other data access relevant properties, see
 118         the com::sun::star::sdb::DataAccessDescriptor service.</p>
 119      */
 120     [property] com::sun::star::sdbc::XResultSet ResultSet;
 121
 122
 123     /** contains the connection to the database.
 124
 125         <p>For the interaction of this property with other data access relevant properties, see
 126         the com::sun::star::sdb::DataAccessDescriptor service.</p>
 127      */
 128     [property] com::sun::star::sdbc::XConnection ActiveConnection;
 129
 130
 131     /** contains a selection that refers to bookmarks of the ResultSet.
 132
 133         <p>This property is relevant in conjunction with the #ResultSet
 134         only. A single element of this array describes a bookmark relative to the result set.<br/>
 135         Note that this implies that the #ResultSet needs to support the
 136         com::sun::star::sdbcx::XRowLocate interface.</p>
 137
 138         <p>If this array is empty, the whole result set, as described by #ResultSet
 139         respectively the triple (#DataSourceName, #CommandType,
 140         #Command).</p>
 141
 142         <p>For the interaction of this property with other data access relevant properties, see
 143         the com::sun::star::sdb::DataAccessDescriptor service.</p>
 144      */
 145     [property] sequence< any > Selection;
 146
 147
 148     /** returns if escape processing is on or off.
 149
 150         <p>For the interaction of this property with other data access relevant properties, see
 151         the com::sun::star::sdb::DataAccessDescriptor service.</p>
 152      */
 153     [property] boolean EscapeProcessing;
 154
 155
 156     /** contains a filter expression for an SQL statement.
 157
 158         <p>For the interaction of this property with other data access relevant properties, see
 159         the com::sun::star::sdb::DataAccessDescriptor service.</p>
 160      */
 161     [property] string Filter;
 162
 163
 164     /* input properties */
 165
 166
 167     /** contains the URL of a text document that is to be processed.
 168
 169         <p>If this property is not set an empty document is created.</p>
 170      */
 171     [property] string DocumentURL;
 172
 173
 174     /** provides access to the model of the document to be processed.
 175
 176         <p>This property will automatically be set to the documents model
 177         if a document URL was set.</p>
 178      */
 179     [property, readonly] com::sun::star::frame::XModel Model;
 180
 181
 182     /* output properties */
 183
 184
 185     /** determines the destination of the mail merge action.
 186
 187         @see com::sun::star::text::MailMergeType
 188      */
 189     [property] short OutputType;
 190
 191
 192     /** determines whether single print jobs will be generated per output document.
 193
 194         <p>This property is only evaluated for printer output.</p>
 195      */
 196     [property] boolean SinglePrintJobs;
 197
 198
 199     /** contains the path where generated files are created.
 200
 201         <p>If "OutputURL" or "FileNamePrefix" are empty the missing value is
 202         generated from the location or title of the source documents.</p>
 203
 204         <p>This property is only evaluated for file output.</p>
 205      */
 206     [property] string OutputURL;
 207
 208
 209     /** determines whether file names of created files are generated using
 210         the content of a database column.
 211
 212         <p>This property is only evaluated for file output.</p>
 213      */
 214     [property] boolean FileNameFromColumn;
 215
 216
 217     /** contains the name of the column to generate the output file names.
 218
 219         <p>If FileNameFromColumn is true the content of the related column
 220         is added to the OutputURL.</p>
 221         <p>If "OutputURL" or "FileNamePrefix" are empty the missing value is
 222         generated from the location or title of the source documents.</p>
 223
 224         <p>This property is only evaluated for file output.</p>
 225      */
 226     [property] string FileNamePrefix;
 227
 228
 229     /** Contains the password of the outgoing mail server. It is necessary to set this
 230         if the password is not already stored in the configuration for security reasons.
 231
 232         <p>This property is only evaluated for e-Mail output.</p>
 233
 234         @since OOo 2.0
 235     */
 236     [property, optional] string OutServerPassword;
 237
 238     /** Contains the password of the incoming mail server. It is necessary to set this
 239         if the mail server configuration is set to "SMTP after POP" authentication and
 240         the password is not already stored in the configuration for security reasons.
 241
 242         <p>This property is only evaluated for e-Mail output.</p>
 243
 244         @since OOo 2.0
 245     */
 246     [property, optional] string InServerPassword;
 247
 248     /** contains the subject of the e-Mail message.
 249
 250         <p>This property is only evaluated for e-Mail output.</p>
 251         @since OOo 2.0
 252     */
 253     [property, optional] string Subject;
 254
 255
 256     /** contains the name of the data base column that contains the e-Mail address
 257         to the e-Mail to.
 258
 259         <p>This property is only evaluated for e-Mail output.</p>
 260
 261         @since OOo 2.0
 262     */
 263     [property, optional] string AddressFromColumn;
 264
 265
 266     /** determines that the created mail merge document is sent as body in HTML format.
 267         This property is only valid if the property "SendAsAttachment" is set to `FALSE`.
 268
 269         <p>This property is only evaluated for e-Mail output.</p>
 270
 271         @since OOo 2.0
 272     */
 273     [property, optional] boolean SendAsHTML;
 274
 275
 276
 277     /** determines that the created mail merge document is sent as attachment.
 278
 279         <p>This property is only evaluated for e-Mail output.</p>
 280
 281         @since OOo 2.0
 282     */
 283     [property, optional] boolean SendAsAttachment;
 284
 285
 286     /** contains the text of the mail body.
 287         This property is only valid if the property "SendAsAttachment" is set to `TRUE`
 288         <p>This property is only evaluated for e-Mail output.</p>
 289
 290         @since OOo 2.0
 291     */
 292     [property, optional] string MailBody;
 293
 294
 295     /** contains the name of the attachment.
 296         This property is only valid if "SendAsAttachment" is set to `TRUE`.
 297
 298         <p>This property is only evaluated for e-Mail output.</p>
 299
 300         @since OOo 2.0
 301     */
 302     [property, optional] string AttachmentName;
 303
 304
 305     /** contains the name of the document filter to save the attached mail merge document.
 306         This property is only valid if "SendAsAttachment" is set to `TRUE`.
 307
 308         <p>This property is only evaluated for e-Mail output.</p>
 309
 310         @since OOo 2.0
 311     */
 312     [property, optional] string AttachmentFilter;
 313
 314
 315     /** contains a list of e-Mail addresses to
 316         <p>This property is only evaluated for e-Mail output.</p>
 317
 318         @since OOo 2.0
 319     */
 320     [property, optional] sequence< string > CopiesTo;
 321
 322
 323     /**
 324         <p>This property is only evaluated for e-Mail output.</p>
 325
 326         @since OOo 2.0
 327     */
 328     [property, optional] sequence< string > BlindCopiesTo;
 329
 330
 331
 332     /** determines that the output of the mail merge is save in one single file.
 333         <p>This property is only evaluated for file output.</p>
 334
 335         @since OOo 2.0
 336     */
 337     [property, optional] boolean SaveAsSingleFile;
 338
 339
 340     /** contains the name of the document filter to save the output file(s).
 341         <p>This property is only evaluated for file output.</p>
 342
 343         @since OOo 2.0
 344     */
 345     [property, optional] string SaveFilter;
 346
 347
 348     /** contains the properties that are defined in <com::sun::star::view::PrintOptions>.
 349
 350         <p>This property is only evaluated for printer output.</p>
 351
 352         @since OOo 2.0
 353     */
 354     [property, optional] sequence< com::sun::star::beans::PropertyValue > PrintOptions;
 355
 356 };
 357
 358
 359
 360 }; }; }; };
 361
 362 #endif
 363
 364 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */