sc/source/ui/inc/csvsplits.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 <sal/types.h>
  23
  24 #include <vector>
  25
  26 /** Constant for an invalid vector index. */
  27 const sal_uInt32 CSV_VEC_NOTFOUND   = SAL_MAX_UINT32;
  28 /** Constant for an invalid ruler position. */
  29 const sal_Int32 CSV_POS_INVALID     = -1;
  30
  31 /** A vector of column splits that supports inserting, removing and moving splits. */
  32 class ScCsvSplits
  33 {
  34 private:
  35     typedef ::std::vector< sal_Int32 >      ScSplitVector;
  36     typedef ScSplitVector::const_iterator   const_iterator;
  37
  38     ScSplitVector               maVec;          /// The split container.
  39
  40 public:
  41     // *** access by position *** ---------------------------------------------
  42
  43     /** Inserts a new split at position nPos into the vector.
  44         @return  true = split inserted (nPos was valid and empty). */
  45     bool                        Insert( sal_Int32 nPos );
  46     /** Removes a split by position.
  47         @return  true = split found and removed. */
  48     bool                        Remove( sal_Int32 nPos );
  49     /** Removes a range of splits in the given position range. */
  50     void                        RemoveRange( sal_Int32 nPosStart, sal_Int32 nPosEnd );
  51     /** Removes all elements from the vector. */
  52     void                        Clear();
  53
  54     /** Returns true if at position nPos is a split. */
  55     bool                        HasSplit( sal_Int32 nPos ) const;
  56
  57     // *** access by index *** ------------------------------------------------
  58
  59     /** Searches for a split at position nPos.
  60         @return  the vector index of the split. */
  61     sal_uInt32                  GetIndex( sal_Int32 nPos ) const;
  62     /** Returns index of the first split greater than or equal to nPos. */
  63     sal_uInt32                  LowerBound( sal_Int32 nPos ) const;
  64     /** Returns index of the last split less than or equal to nPos. */
  65     sal_uInt32                  UpperBound( sal_Int32 nPos ) const;
  66
  67     /** Returns the number of splits. */
  68     sal_uInt32                  Count() const
  69                                     { return static_cast<sal_uInt32>(maVec.size()); }
  70     /** Returns the position of the specified split. */
  71     sal_Int32                   GetPos( sal_uInt32 nIndex ) const;
  72     /** Returns the position of the specified split. */
  73     sal_Int32                   operator[]( sal_uInt32 nIndex ) const
  74                                     { return GetPos( nIndex ); }
  75
  76 private:
  77     /** Returns the vector index of an iterator. */
  78     sal_uInt32                  GetIterIndex( const_iterator const &  aIter ) const;
  79 };
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */