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