sw/inc/IDocumentStylePoolAccess.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
  28  #ifndef IDOCUMENTSTYLEPOOLACCESS_HXX_INCLUDED
  29  #define IDOCUMENTSTYLEPOOLACCESS_HXX_INCLUDED
  30
  31  #ifndef _SAL_TYPES_H_
  32  #include <sal/types.h>
  33  #endif
  34
  35  class SwTxtFmtColl;
  36  class SwCharFmt;
  37  class SwFmt;
  38  class SwFrmFmt;
  39  class String;
  40  class SwNumRule;
  41  class SwPageDesc;
  42
  43  /** Access to the style pool
  44  */
  45  class IDocumentStylePoolAccess
  46  {
  47  public:
  48
  49     /** Gebe die "Auto-Collection" mit der Id zurueck. Existiert
  50         sie noch nicht, dann erzuege sie
  51         Ist der String-Pointer definiert, dann erfrage nur die
  52         Beschreibung der Attribute, !! es legt keine Vorlage an !!
  53     */
  54     virtual SwTxtFmtColl* GetTxtCollFromPool( sal_uInt16 nId, bool bRegardLanguage = true ) = 0;
  55
  56     /** return das geforderte automatische  Format - Basis-Klasse !
  57     */
  58     virtual SwFmt* GetFmtFromPool( sal_uInt16 nId ) = 0;
  59
  60     /** returne das geforderte automatische Format
  61      */
  62     virtual SwFrmFmt* GetFrmFmtFromPool( sal_uInt16 nId ) = 0;
  63
  64     /**
  65      */
  66     virtual SwCharFmt* GetCharFmtFromPool( sal_uInt16 nId ) = 0;
  67
  68     /** returne die geforderte automatische Seiten-Vorlage
  69      */
  70     virtual SwPageDesc* GetPageDescFromPool( sal_uInt16 nId, bool bRegardLanguage = true ) = 0;
  71
  72     /**
  73      */
  74     virtual SwNumRule* GetNumRuleFromPool( sal_uInt16 nId ) = 0;
  75
  76     /** pruefe, ob diese "Auto-Collection" in Dokument schon/noch benutzt wird
  77      */
  78     virtual bool IsPoolTxtCollUsed( sal_uInt16 nId ) const = 0;
  79     virtual bool IsPoolFmtUsed( sal_uInt16 nId ) const = 0;
  80     virtual bool IsPoolPageDescUsed( sal_uInt16 nId ) const = 0;
  81
  82  protected:
  83     virtual ~IDocumentStylePoolAccess() {};
  84 };
  85
  86 #endif // IDOCUMENTSTYLEPOOLACCESS_HXX_INCLUDED
  87