office-gobmx/sw/inc/IDocumentListItems.hxx
Michael Meeks b9042fad7c re-base on ALv2 code.
Change-Id: I6c145e984c885c7e06caa1c27bfb354ea49ad9ce
2012-06-21 15:00:05 +01:00

55 lines
1.9 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef IDOCUMENTLISTITEMS_HXX_INCLUDED
#define IDOCUMENTLISTITEMS_HXX_INCLUDED
#include <vector>
#include <tools/string.hxx>
class SwNodeNum;
/** Provides numbered items of a document.
*/
class IDocumentListItems
{
public:
typedef ::std::vector< const SwNodeNum* > tSortedNodeNumList;
virtual void addListItem( const SwNodeNum& rNodeNum ) = 0;
virtual void removeListItem( const SwNodeNum& rNodeNum ) = 0;
virtual String getListItemText( const SwNodeNum& rNodeNum,
const bool bWithNumber = true,
const bool bWithSpacesForLevel = false ) const = 0;
/** get vector of all list items
*/
virtual void getListItems( IDocumentListItems::tSortedNodeNumList& orNodeNumList ) const = 0;
/** get vector of all list items, which are numbered
*/
virtual void getNumItems( IDocumentListItems::tSortedNodeNumList& orNodeNumList ) const = 0;
protected:
virtual ~IDocumentListItems() {};
};
#endif // IDOCUMENTLISTITEMS_HXX_INCLUDED
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */