offapi/com/sun/star/awt/grid/XSortableGridData.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
  21 module com { module sun { module star { module awt { module grid {
  22
  23
  24 /** allows to sort the data represented by a XGridDataModel
  25  */
  26 interface XSortableGridData
  27 {
  28     /** sorts the rows represented by the model by a given column's data.
  29
  30         @param ColumnIndex
  31             the index of the column whose data should be used as sort key
  32         @param SortAscending
  33             is `TRUE` if the data should be sorted ascending, `FALSE` otherwise.
  34         @throws ::com::sun::star::lang::IndexOutOfBoundsException
  35             if <code>ColumnIndex</code> does not denote a valid column.
  36     */
  37     void    sortByColumn( [in] long ColumnIndex, [in] boolean SortAscending )
  38         raises ( ::com::sun::star::lang::IndexOutOfBoundsException );
  39
  40     /** removes any possibly present sorting of the grid data
  41     */
  42     void    removeColumnSort();
  43
  44     /** returns the current sort order.
  45
  46         @return
  47             a structure describing the current sort order.
  48             com::sun::star::beans::Pair::First
  49             denotes the column by which the data is sorted, or -1 if
  50             the data is currently unsorted.
  51             com::sun::star::beans::Pair::Second
  52             is `TRUE` if the data is sorted ascending, `FALSE` otherwise.
  53     */
  54     ::com::sun::star::beans::Pair< long, boolean >
  55             getCurrentSortOrder();
  56 };
  57
  58
  59 }; }; }; }; };
  60
  61
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */