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