diff options
Diffstat (limited to 'sw/inc/IDocumentListItems.hxx')
-rw-r--r-- | sw/inc/IDocumentListItems.hxx | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/sw/inc/IDocumentListItems.hxx b/sw/inc/IDocumentListItems.hxx new file mode 100644 index 000000000000..0232fc86f104 --- /dev/null +++ b/sw/inc/IDocumentListItems.hxx @@ -0,0 +1,61 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#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 |