offapi/com/sun/star/text/textfield/DatabaseName.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: DatabaseName.idl,v $
  10  * $Revision: 1.8 $
  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_textfield_DatabaseName_idl__
  32 #define __com_sun_star_text_textfield_DatabaseName_idl_
  33
  34
  35 #include <com/sun/star/text/DependentTextField.idl>
  36
  37 //=============================================================================
  38
  39 module com { module sun { module star { module text { module textfield {
  40
  41 //=============================================================================
  42 /** specifies service of text field that displayes the name of a database.
  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 DatabaseName
  50 {
  51     service  com::sun::star::text::DependentTextField;
  52
  53     /** specifies the database name.
  54      */
  55     [property] string DataBaseName;
  56
  57     /** determines the interpretation of the property DataTableName.
  58         @see com::sun::star::sdb::CommandType
  59      */
  60     [property] long DataCommandType;
  61
  62     /** contains the name of the database table, query or a statement depending
  63      on the DataCommandType property.
  64      */
  65     [property] string DataTableName;
  66
  67     /** indicates the URL of a database file.
  68         @since OOo 2.0.0
  69      */
  70     [optional, property] string DataBaseURL;
  71
  72     /** indicates a connection URL, which locates a database driver.
  73         @since OOo 2.0.0
  74      */
  75     [optional, property] string DataBaseResource;
  76
  77 };
  78
  79 //=============================================================================
  80
  81 }; }; }; }; };
  82
  83 #endif
  84