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