sw/inc/istyleaccess.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 #ifndef INCLUDED_SW_INC_ISTYLEACCESS_HXX
  20 #define INCLUDED_SW_INC_ISTYLEACCESS_HXX
  21
  22 #include <svl/itemset.hxx>
  23 #include <memory>
  24 #include <vector>
  25
  26 // Management of (automatic) styles
  27 class IStyleAccess
  28 {
  29 public:
  30     enum SwAutoStyleFamily
  31     {
  32         AUTO_STYLE_CHAR,
  33         AUTO_STYLE_RUBY,
  34         AUTO_STYLE_PARA,
  35         AUTO_STYLE_NOTXT
  36     };
  37
  38     virtual ~IStyleAccess() {}
  39
  40     virtual std::shared_ptr<SfxItemSet> getAutomaticStyle( const SfxItemSet& rSet,
  41                                                                SwAutoStyleFamily eFamily,
  42                                                                const OUString* pParentName = nullptr ) = 0;
  43     virtual void getAllStyles( std::vector<std::shared_ptr<SfxItemSet>> &rStyles,
  44                                                                SwAutoStyleFamily eFamily ) = 0;
  45     /** It's slow to iterate through a stylepool looking for a special name, but if
  46      the style has been inserted via "cacheAutomaticStyle" instead of "getAutomaticStyle",
  47      it's faster */
  48     virtual std::shared_ptr<SfxItemSet> getByName( const OUString& rName,
  49                                                                SwAutoStyleFamily eFamily ) = 0;
  50     /// insert the style to the pool and the cache (used during import)
  51     virtual std::shared_ptr<SfxItemSet> cacheAutomaticStyle( const SfxItemSet& rSet,
  52                                                                SwAutoStyleFamily eFamily ) = 0;
  53     /// To release the cached styles (shared_pointer!)
  54     virtual void clearCaches() = 0;
  55 };
  56
  57 #endif // INCLUDED_SW_INC_ISTYLEACCESS_HXX
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */