summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/text/textfield/DatabaseSetNumber.idl
blob: a10f9cf976ba001a8fb4af1a318e42b0f7fd463d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef __com_sun_star_text_textfield_DatabaseSetNumber_idl__
#define __com_sun_star_text_textfield_DatabaseSetNumber_idl_

#include <com/sun/star/text/TextField.idl>
#include <com/sun/star/text/DependentTextField.idl>


module com { module sun { module star { module text { module textfield {

/** specifies service of a text field that displays the current set number of
 a database.
    @see com::sun::star::text::TextField

    Only one of the properties #DataBaseName,
    #DataBaseURL and #DataBaseResource
    should be set. If more than one are set the last one will be used.
*/
published service DatabaseSetNumber
{
    service  com::sun::star::text::DependentTextField;

    /** specifies the database name.
     */
    [property] string DataBaseName;

    /** determines the interpretation of the property DataTableName.
        @see com::sun::star::sdb::CommandType
     */
    [property] long DataCommandType;

    /** contains the name of the database table, query or a statement depending
     on the DataCommandType property.
     */
    [property] string DataTableName;

    /** specifies the type of the numbering as
        com::sun::star::style::NumberingType
     */
    [property] short NumberingType;

    /** contains the number of the database set.
     */
    [property] long SetNumber;

    /** indicates the URL of a database file.
        @since OOo 2.0
     */
    [optional, property] string DataBaseURL;

    /** indicates a connection URL, which locates a database driver.
        @since OOo 2.0
     */
    [optional, property] string DataBaseResource;

};


}; }; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */