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