offapi/com/sun/star/text/fieldmaster/Database.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_text_fieldmaster_Database_idl_
  29 #define __com_sun_star_text_fieldmaster_Database_idl_
  30
  31 #include <com/sun/star/text/TextFieldMaster.idl>
  32 #include <com/sun/star/beans/PropertyValues.idl>
  33
  34 //=============================================================================
  35
  36 module com { module sun { module star { module text { module fieldmaster {
  37
  38 //=============================================================================
  39 /** specifies service of a Database field master.
  40     @see com::sun::star::text::TextField
  41
  42     Only one of the properties <member>DataBaseName</member>,
  43     <member>DataBaseURL</member> and <member>DataBaseResource</member>
  44     should be set. If more than one are set the last one will be used.
  45 */
  46 published service Database
  47 {
  48     service  com::sun::star::text::TextFieldMaster;
  49
  50     //------------------------------------------------------------------------
  51     /** specifies the database name.
  52      */
  53     [property] string DataBaseName;
  54
  55     //------------------------------------------------------------------------
  56     /** contains the CommandType this
  57      can be the name of a data base table, a data query or a statement.
  58      (0 = table, 1 = query, 2 = statement)
  59      */
  60     [property] long CommandType;
  61     //------------------------------------------------------------------------
  62     /** contains the command string. Depending on the CommandType property this
  63      can be the name of a data base table, a data query or a statement.
  64      */
  65     [property] string DataTableName;
  66     //------------------------------------------------------------------------
  67     /** contains the name of the data base table.
  68      */
  69     [property] string DataColumnName;
  70
  71     //------------------------------------------------------------------------
  72     /** indicates the URL of a database file.
  73         @since OOo 2.0.0
  74      */
  75     [optional, property] string DataBaseURL;
  76
  77     //------------------------------------------------------------------------
  78     /** indicates a connection URL, which locates a database driver.
  79         @since OOo 2.0.0
  80      */
  81     [optional, property] string DataBaseResource;
  82     //------------------------------------------------------------------------
  83     /** contains the DataColumnName but it enables the fieldmaster and its
  84         depending fields to work without setting DataSourceName, DataTableName and CommandType
  85         @since OOo 2.3
  86      */
  87     [optional, property] string Name;
  88
  89 };
  90
  91 //=============================================================================
  92
  93 }; }; }; }; };
  94
  95 #endif
  96