offapi/com/sun/star/awt/grid/XSortableGridData.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   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
  28 #ifndef __com_sun_star_awt_grid_XSortableGridData_idl__
  29 #define __com_sun_star_awt_grid_XSortableGridData_idl__
  30
  31 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  32 #include <com/sun/star/beans/Pair.idl>
  33
  34 //==================================================================================================================
  35
  36 module com { module sun { module star { module awt { module grid {
  37
  38 //==================================================================================================================
  39
  40 /** allows to sort the data represented by a <type>XGridDataModel</type>
  41  */
  42 interface XSortableGridData
  43 {
  44     /** sorts the rows represented by the model by a given column's data.
  45
  46         @param ColumnIndex
  47             the index of the column whose data should be used as sort key
  48         @param SortAscending
  49             is <TRUE/> if the data should be sorted ascending, <FALSE/> otherwise.
  50         @throws ::com::sun::star::lang::IndexOutOfBoundsException
  51             if <code>ColumnIndex</code> does not denote a valid column.
  52     */
  53     void    sortByColumn( [in] long ColumnIndex, [in] boolean SortAscending )
  54         raises ( ::com::sun::star::lang::IndexOutOfBoundsException );
  55
  56     /** removes any possibly present sorting of the grid data
  57     */
  58     void    removeColumnSort();
  59
  60     /** returns the current sort order.
  61
  62         @return
  63             a structure describing the current sort order. <member scope="::com::sun::star::beans">Pair::First</member>
  64             denotes the column by which the data is sorted, or -1 if the data is currently unsorted.
  65             <member scope="::com::sun::star::beans">Pair::Second</member> is <TRUE/> if the data is sorted ascending,
  66             <FALSE/> otherwise.
  67     */
  68     ::com::sun::star::beans::Pair< long, boolean >
  69             getCurrentSortOrder();
  70 };
  71
  72 //==================================================================================================================
  73
  74 }; }; }; }; };
  75
  76 //==================================================================================================================
  77
  78 #endif
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */