xref: /AOO41X/main/offapi/com/sun/star/text/fieldmaster/Database.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_fieldmaster_Database_idl_
#define __com_sun_star_text_fieldmaster_Database_idl_

#include <com/sun/star/text/TextFieldMaster.idl>
#include <com/sun/star/beans/PropertyValues.idl>

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

module com { module sun { module star { module text { module fieldmaster {

//=============================================================================
/** specifies service of a Database field master.
	@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 Database
{
	service  com::sun::star::text::TextFieldMaster;

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

    //------------------------------------------------------------------------
    /** contains the CommandType this
     can be the name of a data base table, a data query or a statement.
     (0 = table, 1 = query, 2 = statement)
	 */
    [property] long CommandType;
    //------------------------------------------------------------------------
    /** contains the command string. Depending on the CommandType property this
     can be the name of a data base table, a data query or a statement.
	 */
    [property] string DataTableName;
    //------------------------------------------------------------------------
    /** contains the name of the data base table.
	 */
    [property] string DataColumnName;

    //------------------------------------------------------------------------
    /** 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;
    //------------------------------------------------------------------------
    /** contains the DataColumnName but it enables the fieldmaster and its
        depending fields to work without setting DataSourceName, DataTableName and CommandType
        @since OpenOffice 2.3
     */
    [optional, property] string Name;

};

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

}; }; }; }; };

#endif