offapi/com/sun/star/sdb/DataSettings.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_sdb_DataSettings_idl__
  28 #define __com_sun_star_sdb_DataSettings_idl__
  29
  30 #ifndef __com_sun_star_beans_XPropertySet_idl__
  31 #include <com/sun/star/beans/XPropertySet.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_util_Color_idl__
  35 #include <com/sun/star/util/Color.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_awt_FontDescriptor_idl__
  39 #include <com/sun/star/awt/FontDescriptor.idl>
  40 #endif
  41
  42  module com {  module sun {  module star {  module sdb {
  43
  44
  45 /** extends the
  46     <type scope="com::sun::star::sdbcx">Table</type>
  47     with additional display information, sorting and filtering criterias.
  48
  49     */
  50 published service DataSettings
  51 {
  52
  53     /** additional filter for the data object.
  54      */
  55     [property] string Filter;
  56
  57
  58     /** indicates whether the filter should be applied or not,
  59         default is <FALSE/>.
  60      */
  61     [property] boolean ApplyFilter;
  62
  63
  64     /** is an additional sort order definition.
  65      */
  66     [property] string Order;
  67
  68
  69     /** specifies the font attributes for data displaying.
  70      */
  71     [property] com::sun::star::awt::FontDescriptor FontDescriptor;
  72
  73
  74     /** specifies the height of a data row.
  75      */
  76     [property] long RowHeight;
  77
  78
  79     /** specifies the text color (RGB) for displaying text.
  80      */
  81     [property] com::sun::star::util::Color TextColor;
  82
  83     /** additional having clause for the data object.
  84      */
  85     [optional,property] string HavingClause;
  86
  87     /** additional group by for the data object.
  88      */
  89     [optional,property] string GroupBy;
  90 };
  91
  92 //=============================================================================
  93
  94 }; }; }; };
  95
  96 /*===========================================================================
  97 ===========================================================================*/
  98 #endif