offapi/com/sun/star/text/textfield/DatabaseSetNumber.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: DatabaseSetNumber.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_DatabaseSetNumber_idl__
  32 #define __com_sun_star_text_textfield_DatabaseSetNumber_idl_
  33
  34 #include <com/sun/star/text/TextField.idl>
  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 a text field that displays the current set number of
  43  a database.
  44     @see com::sun::star::text::TextField
  45
  46     Only one of the properties <member>DataBaseName</member>,
  47     <member>DataBaseURL</member> and <member>DataBaseResource</member>
  48     should be set. If more than one are set the last one will be used.
  49 */
  50 published service DatabaseSetNumber
  51 {
  52     service  com::sun::star::text::DependentTextField;
  53
  54     /** specifies the database name.
  55      */
  56     [property] string DataBaseName;
  57
  58     /** determines the interpretation of the property DataTableName.
  59         @see com::sun::star::sdb::CommandType
  60      */
  61     [property] long DataCommandType;
  62
  63     /** contains the name of the database table, query or a statement depending
  64      on the DataCommandType property.
  65      */
  66     [property] string DataTableName;
  67
  68     /** specifies the type of the numbering as
  69         <type scope="com::sun::star::style">NumberingType</type>
  70      */
  71     [property] short NumberingType;
  72
  73     /** contains the number of the database set.
  74      */
  75     [property] long SetNumber;
  76
  77     /** indicates the URL of a database file.
  78         @since OOo 2.0.0
  79      */
  80     [optional, property] string DataBaseURL;
  81
  82     /** indicates a connection URL, which locates a database driver.
  83         @since OOo 2.0.0
  84      */
  85     [optional, property] string DataBaseResource;
  86
  87 };
  88
  89 //=============================================================================
  90
  91 }; }; }; }; };
  92
  93 #endif
  94