offapi/com/sun/star/sheet/XDatabaseRange.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: XDatabaseRange.idl,v $
  10  * $Revision: 1.10 $
  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
  31 #ifndef __com_sun_star_sheet_XDatabaseRange_idl__
  32 #define __com_sun_star_sheet_XDatabaseRange_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_table_CellRangeAddress_idl__
  39 #include <com/sun/star/table/CellRangeAddress.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_beans_PropertyValue_idl__
  43 #include <com/sun/star/beans/PropertyValue.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_sheet_XSheetFilterDescriptor_idl__
  47 #include <com/sun/star/sheet/XSheetFilterDescriptor.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_sheet_XSubTotalDescriptor_idl__
  51 #include <com/sun/star/sheet/XSubTotalDescriptor.idl>
  52 #endif
  53
  54 //=============================================================================
  55
  56 module com {  module sun {  module star {  module sheet {
  57
  58 //=============================================================================
  59
  60 /** provides access to the settings and options of a database range.
  61
  62     @see com::sun::star::sheet::DatabaseRange
  63  */
  64 published interface XDatabaseRange: com::sun::star::uno::XInterface
  65 {
  66     //-------------------------------------------------------------------------
  67
  68     /** returns the data area of the database range in the
  69         spreadsheet document.
  70      */
  71     com::sun::star::table::CellRangeAddress getDataArea();
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** sets the data area of the database range.
  76      */
  77     void setDataArea( [in] com::sun::star::table::CellRangeAddress aDataArea );
  78
  79     //-------------------------------------------------------------------------
  80
  81     /** returns the sort descriptor stored with the database range.
  82
  83         @see com::sun::star::sheet::SheetSortDescriptor2
  84      */
  85     sequence< com::sun::star::beans::PropertyValue > getSortDescriptor();
  86
  87     //-------------------------------------------------------------------------
  88
  89     /** returns the filter descriptor stored with the database range.
  90
  91         <p>If the filter descriptor is modified, the new filtering is
  92         carried out when <member>XDatabaseRange::refresh()</member> is
  93         called.</p>
  94      */
  95     com::sun::star::sheet::XSheetFilterDescriptor getFilterDescriptor();
  96
  97     //-------------------------------------------------------------------------
  98
  99     /** returns the subtotal descriptor stored with the database range.
 100
 101         <p>If the subtotal descriptor is modified, the new subtotals are
 102         inserted when <member>XDatabaseRange::refresh()</member> is
 103         called.</p>
 104      */
 105     com::sun::star::sheet::XSubTotalDescriptor getSubTotalDescriptor();
 106
 107     //-------------------------------------------------------------------------
 108
 109     /** returns the database import descriptor stored with this database
 110         range.
 111
 112         @see com::sun::star::sheet::DatabaseImportDescriptor
 113      */
 114     sequence< com::sun::star::beans::PropertyValue > getImportDescriptor();
 115
 116     //-------------------------------------------------------------------------
 117
 118     /** executes the stored import, filter, sorting, and subtotals
 119         descriptors again.
 120      */
 121     void refresh();
 122
 123 };
 124
 125 //=============================================================================
 126
 127 }; }; }; };
 128
 129 #endif
 130