sw/inc/IDocumentStylePoolAccess.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: IDocumentStylePoolAccess.hxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31  #ifndef IDOCUMENTSTYLEPOOLACCESS_HXX_INCLUDED
  32  #define IDOCUMENTSTYLEPOOLACCESS_HXX_INCLUDED
  33
  34  #ifndef _SAL_TYPES_H_
  35  #include <sal/types.h>
  36  #endif
  37
  38  class SwTxtFmtColl;
  39  class SwCharFmt;
  40  class SwFmt;
  41  class SwFrmFmt;
  42  class String;
  43  class SwNumRule;
  44  class SwPageDesc;
  45
  46  /** Access to the style pool
  47  */
  48  class IDocumentStylePoolAccess
  49  {
  50  public:
  51
  52     /** Gebe die "Auto-Collection" mit der Id zurueck. Existiert
  53         sie noch nicht, dann erzuege sie
  54         Ist der String-Pointer definiert, dann erfrage nur die
  55         Beschreibung der Attribute, !! es legt keine Vorlage an !!
  56     */
  57     virtual SwTxtFmtColl* GetTxtCollFromPool( sal_uInt16 nId, bool bRegardLanguage = true ) = 0;
  58
  59     /** return das geforderte automatische  Format - Basis-Klasse !
  60     */
  61     virtual SwFmt* GetFmtFromPool( sal_uInt16 nId ) = 0;
  62
  63     /** returne das geforderte automatische Format
  64      */
  65     virtual SwFrmFmt* GetFrmFmtFromPool( sal_uInt16 nId ) = 0;
  66
  67     /**
  68      */
  69     virtual SwCharFmt* GetCharFmtFromPool( sal_uInt16 nId ) = 0;
  70
  71     /** returne die geforderte automatische Seiten-Vorlage
  72      */
  73     virtual SwPageDesc* GetPageDescFromPool( sal_uInt16 nId, bool bRegardLanguage = true ) = 0;
  74
  75     /**
  76      */
  77     virtual SwNumRule* GetNumRuleFromPool( sal_uInt16 nId ) = 0;
  78
  79     /** pruefe, ob diese "Auto-Collection" in Dokument schon/noch benutzt wird
  80      */
  81     virtual bool IsPoolTxtCollUsed( sal_uInt16 nId ) const = 0;
  82     virtual bool IsPoolFmtUsed( sal_uInt16 nId ) const = 0;
  83     virtual bool IsPoolPageDescUsed( sal_uInt16 nId ) const = 0;
  84
  85  protected:
  86     virtual ~IDocumentStylePoolAccess() {};
  87 };
  88
  89 #endif // IDOCUMENTSTYLEPOOLACCESS_HXX_INCLUDED
  90