sw/inc/fmtcolfunc.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 #ifndef INCLUDED_SW_INC_FMTCOLFUNC_HXX
  20 #define INCLUDED_SW_INC_FMTCOLFUNC_HXX
  21
  22 class SwFormat;
  23 class SwNumRuleItem;
  24
  25 // namespace <TextFormatCollFunc> for functions and procedures working on
  26 // paragraph styles (instances of <SwTextFormatColl>
  27 namespace TextFormatCollFunc
  28 {
  29     /** Checks, if assignment of paragraph style to list level of outline style
  30         has to be deleted, and deletes the assignment, if needed.
  31
  32         #i71574#
  33         The assignment of a paragraph style to a list level of the outline style
  34         has to be deleted, if the numbering rule, which is set at the paragraph
  35         style isn't the outline style.
  36
  37         @author OD
  38     */
  39     void CheckTextFormatCollForDeletionOfAssignmentToOutlineStyle(
  40                                     SwFormat* pFormat,
  41                                     const SwNumRuleItem* pNewNumRuleItem = 0L );
  42
  43     /** determines the list style, which directly set at the given paragraph style
  44
  45         @author OD
  46
  47         @param rTextFormatColl
  48         input parameter - paragraph style for which the list style should be retrieved
  49
  50         @return pointer to <SwNumRule> instance, if the given paragraph style
  51         has directly set a list style, 0 otherwise
  52     */
  53     SwNumRule* GetNumRule( SwTextFormatColl& rTextFormatColl );
  54
  55     /** adds the given paragraph style at the directly set list style
  56
  57         Note: If the given paragraph style has no directly set list style, nothing happens
  58
  59         @param rTextFormatColl
  60         input parameter - paragraph style which is added to its directly set list style
  61
  62         @author OD
  63     */
  64     void AddToNumRule( SwTextFormatColl& rTextFormatColl );
  65
  66     /** removes te given paragraph style from the directly set list style
  67
  68         Note: If the given paragraph style has no directly set list style, nothing happens
  69
  70         @param rTextFormatColl
  71         input parameter - paragraph style which is removed from its directly set list style
  72
  73         @author OD
  74     */
  75     void RemoveFromNumRule( SwTextFormatColl& rTextFormatColl );
  76 }
  77 #endif
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */