offapi/com/sun/star/text/fieldmaster/Database.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 #ifndef __com_sun_star_text_fieldmaster_Database_idl_
  21 #define __com_sun_star_text_fieldmaster_Database_idl_
  22
  23 #include <com/sun/star/text/TextFieldMaster.idl>
  24 #include <com/sun/star/beans/PropertyValues.idl>
  25
  26
  27 module com { module sun { module star { module text { module fieldmaster {
  28
  29 /** specifies service of a Database field master.
  30     @see com::sun::star::text::TextField
  31
  32     Only one of the properties #DataBaseName,
  33     #DataBaseURL and #DataBaseResource
  34     should be set. If more than one are set the last one will be used.
  35 */
  36 published service Database
  37 {
  38     service  com::sun::star::text::TextFieldMaster;
  39
  40     /** specifies the database name.
  41      */
  42     [property] string DataBaseName;
  43
  44     /** contains the CommandType this
  45      can be the name of a data base table, a data query or a statement.
  46      (0 = table, 1 = query, 2 = statement)
  47      */
  48     [property] long CommandType;
  49     /** contains the command string. Depending on the CommandType property this
  50      can be the name of a data base table, a data query or a statement.
  51      */
  52     [property] string DataTableName;
  53     /** contains the name of the data base table.
  54      */
  55     [property] string DataColumnName;
  56
  57     /** indicates the URL of a database file.
  58         @since OOo 2.0
  59      */
  60     [optional, property] string DataBaseURL;
  61
  62     /** indicates a connection URL, which locates a database driver.
  63         @since OOo 2.0
  64      */
  65     [optional, property] string DataBaseResource;
  66     /** contains the DataColumnName but it enables the fieldmaster and its
  67         depending fields to work without setting DataSourceName, DataTableName and CommandType
  68         @since OOo 2.3
  69      */
  70     [optional, property] string Name;
  71
  72 };
  73
  74
  75 }; }; }; }; };
  76
  77 #endif
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */