Line data    Source code

       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             : class SwNodeNum;
      26             : 
      27             : /** Provides numbered items of a document.
      28             : */
      29           0 : class IDocumentListItems
      30             : {
      31             : public:
      32             :     typedef ::std::vector< const SwNodeNum* > tSortedNodeNumList;
      33             : 
      34             :     virtual void addListItem( const SwNodeNum& rNodeNum ) = 0;
      35             :     virtual void removeListItem( const SwNodeNum& rNodeNum ) = 0;
      36             : 
      37             :     virtual OUString getListItemText( const SwNodeNum& rNodeNum,
      38             :                                     const bool bWithNumber = true,
      39             :                                     const bool bWithSpacesForLevel = false ) const = 0;
      40             : 
      41             :     /** get vector of all list items
      42             :     */
      43             :     virtual void getListItems( IDocumentListItems::tSortedNodeNumList& orNodeNumList ) 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:
      50           0 :     virtual ~IDocumentListItems() {};
      51             : };
      52             : 
      53             :  #endif // INCLUDED_SW_INC_IDOCUMENTLISTITEMS_HXX
      54             : 
      55             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */