sw/inc/IDocumentListsAccess.hxx

   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 #pragma once
  21
  22 #include <rtl/ustring.hxx>
  23
  24 class SwList;
  25
  26 /** Provides access to the lists of a document.
  27 */
  28 class IDocumentListsAccess
  29 {
  30     public:
  31         virtual SwList* createList( const OUString& rListId,
  32                                     const OUString& rDefaultListStyleName ) = 0;
  33         virtual SwList* getListByName( const OUString& rListId ) const = 0;
  34
  35         virtual void createListForListStyle( const OUString& rListStyleName ) = 0;
  36         virtual SwList* getListForListStyle( const OUString& rListStyleName ) const = 0;
  37         virtual void deleteListForListStyle( const OUString& rListStyleName ) = 0;
  38         virtual void deleteListsByDefaultListStyle( const OUString& rListStyleName ) = 0;
  39         // #i91400#
  40         virtual void trackChangeOfListStyleName( const OUString& rListStyleName,
  41                                                  const OUString& rNewListStyleName ) = 0;
  42     protected:
  43         virtual ~IDocumentListsAccess() {};
  44 };
  45
  46 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */