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

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