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