xref: /AOO41X/main/offapi/com/sun/star/text/textfield/DatabaseSetNumber.idl (revision 2a413f170de95afb9972effe5557e28dd83e2121)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#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 <member>DataBaseName</member>,
    <member>DataBaseURL</member> and <member>DataBaseResource</member>
    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
        <type scope="com::sun::star::style">NumberingType</type>
     */
    [property] short NumberingType;

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

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

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

};

//=============================================================================

}; }; }; }; };

#endif