sw/inc/IDocumentStylePoolAccess.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 #ifndef INCLUDED_SW_INC_IDOCUMENTSTYLEPOOLACCESS_HXX
  21 #define INCLUDED_SW_INC_IDOCUMENTSTYLEPOOLACCESS_HXX
  22
  23 #include <sal/types.h>
  24
  25 class SwTextFormatColl;
  26 class SwCharFormat;
  27 class SwFormat;
  28 class SwFrameFormat;
  29 class SwNumRule;
  30 class SwPageDesc;
  31
  32 /** Access to the style pool
  33  */
  34 class IDocumentStylePoolAccess
  35 {
  36 public:
  37     /** Return "Auto-Collection with ID.
  38         Create, if it does not yet exist.
  39         If string pointer is defined request only description
  40         of attributes, do not create style sheet!
  41     */
  42     virtual SwTextFormatColl* GetTextCollFromPool(sal_uInt16 nId, bool bRegardLanguage = true) = 0;
  43
  44     /** Return required automatic format base class.
  45     */
  46     virtual SwFormat* GetFormatFromPool(sal_uInt16 nId) = 0;
  47
  48     /** Return required automatic format.
  49      */
  50     virtual SwFrameFormat* GetFrameFormatFromPool(sal_uInt16 nId) = 0;
  51
  52     virtual SwCharFormat* GetCharFormatFromPool(sal_uInt16 nId) = 0;
  53
  54     /** Return required automatic page style.
  55      */
  56     virtual SwPageDesc* GetPageDescFromPool(sal_uInt16 nId, bool bRegardLanguage = true) = 0;
  57
  58     virtual SwNumRule* GetNumRuleFromPool(sal_uInt16 nId) = 0;
  59
  60     /** Check whether this "auto-collection" is used in document.
  61      */
  62     virtual bool IsPoolTextCollUsed(sal_uInt16 nId) const = 0;
  63     virtual bool IsPoolFormatUsed(sal_uInt16 nId) const = 0;
  64     virtual bool IsPoolPageDescUsed(sal_uInt16 nId) const = 0;
  65
  66 protected:
  67     virtual ~IDocumentStylePoolAccess(){};
  68 };
  69
  70 #endif // INCLUDED_SW_INC_IDOCUMENTSTYLEPOOLACCESS_HXX
  71
  72 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */