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