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