sw/inc/fmtcolfunc.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: fmtcolfunc.hxx,v $
  10  * $Revision: 1.5 $
  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 #ifndef _FMTCOLFUNC_HXX
  31 #define _FMTCOLFUNC_HXX
  32
  33 class SwFmt;
  34 class SwNumRuleItem;
  35
  36 // namespace <TxtFmtCollFunc> for functions and procedures working on
  37 // paragraph styles (instances of <SwTxtFmtColl>
  38 namespace TxtFmtCollFunc
  39 {
  40     /** Checks, if assignment of paragraph style to list level of outline style
  41         has to be deleted, and deletes the assignment, if needed.
  42
  43         OD 2006-11-22 #i71574#
  44         The assignment of a paragraph style to a list level of the outline style
  45         has to be deleted, if the numbering rule, which is set at the paragraph
  46         style isn't the outline style.
  47
  48         @author OD
  49     */
  50     void CheckTxtFmtCollForDeletionOfAssignmentToOutlineStyle(
  51                                     SwFmt* pFmt,
  52                                     const SwNumRuleItem* pNewNumRuleItem = 0L );
  53
  54     /** determines the list style, which directly set at the given paragraph style
  55
  56         OD 2008-03-04 #refactorlists#
  57
  58         @author OD
  59
  60         @param rTxtFmtColl
  61         input parameter - paragraph style for which the list style should be retrieved
  62
  63         @return pointer to <SwNumRule> instance, if the given paragraph style
  64         has directly set a list style, 0 otherwise
  65     */
  66     SwNumRule* GetNumRule( SwTxtFmtColl& rTxtFmtColl );
  67
  68     /** adds the given paragraph style at the directly set list style
  69
  70         OD 2008-03-04 #refactorlists#
  71         Note: If the given paragraph style has no directly set list style, nothing happens
  72
  73         @param rTxtFmtColl
  74         input parameter - paragraph style which is added to its directly set list style
  75
  76         @author OD
  77     */
  78     void AddToNumRule( SwTxtFmtColl& rTxtFmtColl );
  79
  80     /** removes te given paragraph style from the directly set list style
  81
  82         OD 2008-03-04 #refactorlists#
  83         Note: If the given paragraph style has no directly set list style, nothing happens
  84
  85         @param rTxtFmtColl
  86         input parameter - paragraph style which is removed from its directly set list style
  87
  88         @author OD
  89     */
  90     void RemoveFromNumRule( SwTxtFmtColl& rTxtFmtColl );
  91 }
  92 #endif