offapi/com/sun/star/text/textfield/DatabaseSetNumber.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_text_textfield_DatabaseSetNumber_idl__
  21 #define __com_sun_star_text_textfield_DatabaseSetNumber_idl_
  22
  23 #include <com/sun/star/text/TextField.idl>
  24 #include <com/sun/star/text/DependentTextField.idl>
  25
  26
  27 module com { module sun { module star { module text { module textfield {
  28
  29 /** specifies service of a text field that displays the current set number of
  30  a database.
  31     @see com::sun::star::text::TextField
  32
  33     Only one of the properties #DataBaseName,
  34     #DataBaseURL and #DataBaseResource
  35     should be set. If more than one are set the last one will be used.
  36 */
  37 published service DatabaseSetNumber
  38 {
  39     service  com::sun::star::text::DependentTextField;
  40
  41     /** specifies the database name.
  42      */
  43     [property] string DataBaseName;
  44
  45     /** determines the interpretation of the property DataTableName.
  46         @see com::sun::star::sdb::CommandType
  47      */
  48     [property] long DataCommandType;
  49
  50     /** contains the name of the database table, query or a statement depending
  51      on the DataCommandType property.
  52      */
  53     [property] string DataTableName;
  54
  55     /** specifies the type of the numbering as
  56         com::sun::star::style::NumberingType
  57      */
  58     [property] short NumberingType;
  59
  60     /** contains the number of the database set.
  61      */
  62     [property] long SetNumber;
  63
  64     /** indicates the URL of a database file.
  65         @since OOo 2.0
  66      */
  67     [optional, property] string DataBaseURL;
  68
  69     /** indicates a connection URL, which locates a database driver.
  70         @since OOo 2.0
  71      */
  72     [optional, property] string DataBaseResource;
  73
  74 };
  75
  76
  77 }; }; }; }; };
  78
  79 #endif
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */