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
  21 module com { module sun { module star { module text { module textfield {
  22
  23 /** specifies service of a text field that displays the current set number of
  24  a database.
  25     @see com::sun::star::text::TextField
  26
  27     Only one of the properties #DataBaseName,
  28     #DataBaseURL and #DataBaseResource
  29     should be set. If more than one are set the last one will be used.
  30 */
  31 published service DatabaseSetNumber
  32 {
  33     service  com::sun::star::text::DependentTextField;
  34
  35     /** specifies the database name.
  36      */
  37     [property] string DataBaseName;
  38
  39     /** determines the interpretation of the property DataTableName.
  40         @see com::sun::star::sdb::CommandType
  41      */
  42     [property] long DataCommandType;
  43
  44     /** contains the name of the database table, query or a statement depending
  45      on the DataCommandType property.
  46      */
  47     [property] string DataTableName;
  48
  49     /** specifies the type of the numbering as
  50         com::sun::star::style::NumberingType
  51      */
  52     [property] short NumberingType;
  53
  54     /** contains the number of the database set.
  55      */
  56     [property] long SetNumber;
  57
  58     /** indicates the URL of a database file.
  59         @since OOo 2.0
  60      */
  61     [optional, property] string DataBaseURL;
  62
  63     /** indicates a connection URL, which locates a database driver.
  64         @since OOo 2.0
  65      */
  66     [optional, property] string DataBaseResource;
  67
  68 };
  69
  70
  71 }; }; }; }; };
  72
  73 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */