sw/inc/IDocumentListsAccess.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: IDocumentListsAccess.hxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef IDOCUMENTLISTSACCESS_HXX_INCLUDED
  32 #define IDOCUMENTLISTSACCESS_HXX_INCLUDED
  33
  34 #include <tools/string.hxx>
  35
  36 class SwList;
  37
  38 /** Provides access to the lists of a document.
  39 */
  40 class IDocumentListsAccess
  41 {
  42     public:
  43         virtual SwList* createList( String sListId,
  44                                     const String sDefaultListStyleName ) = 0;
  45         virtual void deleteList( const String sListId ) = 0;
  46         virtual SwList* getListByName( const String sListId ) const = 0;
  47
  48         virtual SwList* createListForListStyle( const String sListStyleName ) = 0;
  49         virtual SwList* getListForListStyle( const String sListStyleName ) const = 0;
  50         virtual void deleteListForListStyle( const String sListStyleName ) = 0;
  51         // --> OD 2008-07-08 #i91400#
  52         virtual void trackChangeOfListStyleName( const String sListStyleName,
  53                                                  const String sNewListStyleName ) = 0;
  54         // <--
  55
  56     protected:
  57         virtual ~IDocumentListsAccess() {};
  58 };
  59
  60 #endif // IDOCUMENTLISTSACCESS_HXX_INCLUDED