xref: /AOO41X/main/offapi/com/sun/star/sdb/DataSettings.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_sdb_DataSettings_idl__
24#define __com_sun_star_sdb_DataSettings_idl__
25
26#ifndef __com_sun_star_beans_XPropertySet_idl__
27#include <com/sun/star/beans/XPropertySet.idl>
28#endif
29
30#ifndef __com_sun_star_util_Color_idl__
31#include <com/sun/star/util/Color.idl>
32#endif
33
34#ifndef __com_sun_star_awt_FontDescriptor_idl__
35#include <com/sun/star/awt/FontDescriptor.idl>
36#endif
37
38 module com {  module sun {  module star {  module sdb {
39
40
41/** extends the
42    <type scope="com::sun::star::sdbcx">Table</type>
43    with additional display information, sorting and filtering criterias.
44
45    */
46published service DataSettings
47{
48
49    /** additional filter for the data object.
50     */
51    [property] string Filter;
52
53
54    /** indicates whether the filter should be applied or not,
55        default is <FALSE/>.
56     */
57    [property] boolean ApplyFilter;
58
59
60    /** is an additional sort order definition.
61     */
62    [property] string Order;
63
64
65    /** specifies the font attributes for data displaying.
66     */
67    [property] com::sun::star::awt::FontDescriptor FontDescriptor;
68
69
70    /** specifies the height of a data row.
71     */
72    [property] long RowHeight;
73
74
75    /** specifies the text color (RGB) for displaying text.
76     */
77    [property] com::sun::star::util::Color TextColor;
78
79    /** additional having clause for the data object.
80     */
81    [optional,property] string HavingClause;
82
83    /** additional group by for the data object.
84     */
85    [optional,property] string GroupBy;
86};
87
88//=============================================================================
89
90}; }; }; };
91
92/*===========================================================================
93===========================================================================*/
94#endif
95