include/svtools/table/tablesort.hxx

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