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 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: Database.idl,v $
  10  * $Revision: 1.9 $
  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
  31 #ifndef __com_sun_star_text_fieldmaster_Database_idl_
  32 #define __com_sun_star_text_fieldmaster_Database_idl_
  33
  34 #include <com/sun/star/text/TextFieldMaster.idl>
  35 #include <com/sun/star/beans/PropertyValues.idl>
  36
  37 //=============================================================================
  38
  39 module com { module sun { module star { module text { module fieldmaster {
  40
  41 //=============================================================================
  42 /** specifies service of a Database field master.
  43     @see com::sun::star::text::TextField
  44
  45     Only one of the properties <member>DataBaseName</member>,
  46     <member>DataBaseURL</member> and <member>DataBaseResource</member>
  47     should be set. If more than one are set the last one will be used.
  48 */
  49 published service Database
  50 {
  51     service  com::sun::star::text::TextFieldMaster;
  52
  53     //------------------------------------------------------------------------
  54     /** specifies the database name.
  55      */
  56     [property] string DataBaseName;
  57
  58     //------------------------------------------------------------------------
  59     /** contains the CommandType this
  60      can be the name of a data base table, a data query or a statement.
  61      (0 = table, 1 = query, 2 = statement)
  62      */
  63     [property] long CommandType;
  64     //------------------------------------------------------------------------
  65     /** contains the command string. Depending on the CommandType property this
  66      can be the name of a data base table, a data query or a statement.
  67      */
  68     [property] string DataTableName;
  69     //------------------------------------------------------------------------
  70     /** contains the name of the data base table.
  71      */
  72     [property] string DataColumnName;
  73
  74     //------------------------------------------------------------------------
  75     /** indicates the URL of a database file.
  76         @since OOo 2.0.0
  77      */
  78     [optional, property] string DataBaseURL;
  79
  80     //------------------------------------------------------------------------
  81     /** indicates a connection URL, which locates a database driver.
  82         @since OOo 2.0.0
  83      */
  84     [optional, property] string DataBaseResource;
  85     //------------------------------------------------------------------------
  86     /** contains the DataColumnName but it enables the fieldmaster and its
  87         depending fields to work without setting DataSourceName, DataTableName and CommandType
  88         @since OOo 2.3
  89      */
  90     [optional, property] string Name;
  91
  92 };
  93
  94 //=============================================================================
  95
  96 }; }; }; }; };
  97
  98 #endif
  99