Line data    Source code

       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 INCLUDED_SVTOOLS_TABLE_TABLESORT_HXX
      21             : #define INCLUDED_SVTOOLS_TABLE_TABLESORT_HXX
      22             : 
      23             : #include <svtools/table/tabletypes.hxx>
      24             : 
      25             : 
      26             : namespace svt { namespace table
      27             : {
      28             : 
      29             : 
      30             : 
      31             :     //= ColumnSortDirection
      32             : 
      33             :     enum ColumnSortDirection
      34             :     {
      35             :         ColumnSortAscending,
      36             :         ColumnSortDescending
      37             :     };
      38             : 
      39             : 
      40             :     //= ColumnSort
      41             : 
      42             :     struct ColumnSort
      43             :     {
      44             :         ColPos              nColumnPos;
      45             :         ColumnSortDirection eSortDirection;
      46             : 
      47           0 :         ColumnSort()
      48             :             :nColumnPos( COL_INVALID )
      49           0 :             ,eSortDirection( ColumnSortAscending )
      50             :         {
      51           0 :         }
      52             : 
      53             :         ColumnSort( ColPos const i_columnPos, ColumnSortDirection const i_sortDirection )
      54             :             :nColumnPos( i_columnPos )
      55             :             ,eSortDirection( i_sortDirection )
      56             :         {
      57             :         }
      58             :     };
      59             : 
      60             : 
      61             :     //= ITableDataSort
      62             : 
      63             :     /** provides sorting functionality for the datta underlying an ITableModel
      64             :     */
      65           2 :     class SAL_NO_VTABLE ITableDataSort
      66             :     {
      67             :     public:
      68             :         /** sorts the rows in the model by the given column's data, in the given direction.
      69             :         */
      70             :         virtual void        sortByColumn( ColPos const i_column, ColumnSortDirection const i_sortDirection ) = 0;
      71             : 
      72             :         /** retrieves the current sort order of the data
      73             : 
      74             :             If the <code>nColumnIndex</code> member of the returned srtructure is <code>COL_INVALID</code>, then
      75             :             the data is currently not sorted.
      76             :         */
      77             :         virtual ColumnSort  getCurrentSortOrder() const = 0;
      78             : 
      79             :     protected:
      80           2 :         ~ITableDataSort() {}
      81             :     };
      82             : 
      83             : 
      84             : } } // namespace svt::table
      85             : 
      86             : 
      87             : #endif // INCLUDED_SVTOOLS_TABLE_TABLESORT_HXX
      88             : 
      89             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */