xref: /trunk/main/offapi/com/sun/star/sdb/DataSettings.idl (revision ffd38472365e95f6a578737bc9a5eb0fac624a86)

/**************************************************************
 *
 * 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_sdb_DataSettings_idl__
#define __com_sun_star_sdb_DataSettings_idl__

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

#ifndef __com_sun_star_util_Color_idl__
#include <com/sun/star/util/Color.idl>
#endif

#ifndef __com_sun_star_awt_FontDescriptor_idl__
#include <com/sun/star/awt/FontDescriptor.idl>
#endif

 module com {  module sun {  module star {  module sdb {


/** extends the
    <type scope="com::sun::star::sdbcx">Table</type>
    with additional display information, sorting and filtering criteria.

    */
published service DataSettings
{

    /** additional filter for the data object.
     */
    [property] string Filter;


    /** indicates whether the filter should be applied or not,
        default is <FALSE/>.
     */
    [property] boolean ApplyFilter;


    /** is an additional sort order definition.
     */
    [property] string Order;


    /** specifies the font attributes for data displaying.
     */
    [property] com::sun::star::awt::FontDescriptor FontDescriptor;


    /** specifies the height of a data row.
     */
    [property] long RowHeight;


    /** specifies the text color (RGB) for displaying text.
     */
    [property] com::sun::star::util::Color TextColor;

    /** additional having clause for the data object.
     */
    [optional,property] string HavingClause;

    /** additional group by for the data object.
     */
    [optional,property] string GroupBy;
};

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

}; }; }; };

/*===========================================================================
===========================================================================*/
#endif