sw/inc/istyleaccess.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef _ISTYLEACCESS_HXX
  28 #define _ISTYLEACCESS_HXX
  29
  30 #include <vector>
  31 #include <svl/stylepool.hxx>
  32
  33 /*--------------------------------------------------------------------
  34     Management of (automatic) styles
  35  --------------------------------------------------------------------*/
  36
  37 class SwStyleHandle;
  38
  39 class IStyleAccess
  40 {
  41 public:
  42
  43     enum SwAutoStyleFamily
  44     {
  45         AUTO_STYLE_CHAR,
  46         AUTO_STYLE_RUBY,
  47         AUTO_STYLE_PARA,
  48         AUTO_STYLE_NOTXT
  49     };
  50
  51     virtual ~IStyleAccess() {}
  52
  53     virtual StylePool::SfxItemSet_Pointer_t getAutomaticStyle( const SfxItemSet& rSet,
  54                                                                SwAutoStyleFamily eFamily ) = 0;
  55     virtual void getAllStyles( std::vector<StylePool::SfxItemSet_Pointer_t> &rStyles,
  56                                                                SwAutoStyleFamily eFamily ) = 0;
  57     // It's slow to iterate through a stylepool looking for a special name, but if
  58     // the style has been inserted via "cacheAutomaticStyle" instead of "getAutomaticStyle",
  59     // it's faster
  60     virtual StylePool::SfxItemSet_Pointer_t getByName( const rtl::OUString& rName,
  61                                                                SwAutoStyleFamily eFamily ) = 0;
  62     // insert the style to the pool and the cache (used during import)
  63     virtual StylePool::SfxItemSet_Pointer_t cacheAutomaticStyle( const SfxItemSet& rSet,
  64                                                                SwAutoStyleFamily eFamily ) = 0;
  65     // To release the cached styles (shared_pointer!)
  66     virtual void clearCaches() = 0;
  67 };
  68
  69 #endif // _ISTYLEACCESS_HXX