sw/inc/IDocumentListItems.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 <vector>
  23 #include <rtl/ustring.hxx>
  24
  25 class SwRootFrame;
  26 class SwNodeNum;
  27
  28 /** Provides numbered items of a document.
  29 */
  30 class IDocumentListItems
  31 {
  32 public:
  33     typedef std::vector< const SwNodeNum* > tSortedNodeNumList;
  34
  35     virtual void addListItem( const SwNodeNum& rNodeNum ) = 0;
  36     virtual void removeListItem( const SwNodeNum& rNodeNum ) = 0;
  37
  38     virtual OUString getListItemText(const SwNodeNum& rNodeNum,
  39                                      SwRootFrame const& rLayout) const = 0;
  40
  41     virtual bool isNumberedInLayout(SwNodeNum const& rNodeNum,
  42             SwRootFrame const& rLayout) const = 0;
  43
  44     /** get vector of all list items, which are numbered
  45     */
  46     virtual void getNumItems( IDocumentListItems::tSortedNodeNumList& orNodeNumList ) const = 0;
  47
  48 protected:
  49     virtual ~IDocumentListItems() {};
  50 };
  51
  52 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */