offapi/com/sun/star/sheet/XDatabaseRange.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_sheet_XDatabaseRange_idl__
  21 #define __com_sun_star_sheet_XDatabaseRange_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/table/CellRangeAddress.idl>
  25 #include <com/sun/star/beans/PropertyValue.idl>
  26 #include <com/sun/star/sheet/XSheetFilterDescriptor.idl>
  27 #include <com/sun/star/sheet/XSubTotalDescriptor.idl>
  28
  29
  30 module com {  module sun {  module star {  module sheet {
  31
  32
  33 /** provides access to the settings and options of a database range.
  34
  35     @see com::sun::star::sheet::DatabaseRange
  36  */
  37 published interface XDatabaseRange: com::sun::star::uno::XInterface
  38 {
  39
  40     /** returns the data area of the database range in the
  41         spreadsheet document.
  42      */
  43     com::sun::star::table::CellRangeAddress getDataArea();
  44
  45
  46     /** sets the data area of the database range.
  47      */
  48     void setDataArea( [in] com::sun::star::table::CellRangeAddress aDataArea );
  49
  50
  51     /** returns the sort descriptor stored with the database range.
  52
  53         @see SheetSortDescriptor2
  54      */
  55     sequence< com::sun::star::beans::PropertyValue > getSortDescriptor();
  56
  57
  58     /** returns the filter descriptor stored with the database range.
  59
  60         <p>If the filter descriptor is modified, the new filtering is
  61         carried out when XDatabaseRange::refresh() is
  62         called.</p>
  63
  64         @see SheetFilterDescriptor
  65      */
  66     XSheetFilterDescriptor getFilterDescriptor();
  67
  68
  69     /** returns the subtotal descriptor stored with the database range.
  70
  71         <p>If the subtotal descriptor is modified, the new subtotals are
  72         inserted when XDatabaseRange::refresh() is
  73         called.</p>
  74
  75         @see SubTotalDescriptor
  76      */
  77     XSubTotalDescriptor getSubTotalDescriptor();
  78
  79
  80     /** returns the database import descriptor stored with this database
  81         range.
  82
  83         @see DatabaseImportDescriptor
  84      */
  85     sequence< com::sun::star::beans::PropertyValue > getImportDescriptor();
  86
  87
  88     /** executes the stored import, filter, sorting, and subtotals
  89         descriptors again.
  90      */
  91     void refresh();
  92
  93 };
  94
  95
  96 }; }; }; };
  97
  98 #endif
  99
 100 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */