xref: /aoo41x/main/sw/inc/fmtcolfunc.hxx (revision 1d2dbeb0)
1*1d2dbeb0SAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*1d2dbeb0SAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*1d2dbeb0SAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*1d2dbeb0SAndrew Rist  * distributed with this work for additional information
6*1d2dbeb0SAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*1d2dbeb0SAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*1d2dbeb0SAndrew Rist  * "License"); you may not use this file except in compliance
9*1d2dbeb0SAndrew Rist  * with the License.  You may obtain a copy of the License at
10*1d2dbeb0SAndrew Rist  *
11*1d2dbeb0SAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12*1d2dbeb0SAndrew Rist  *
13*1d2dbeb0SAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*1d2dbeb0SAndrew Rist  * software distributed under the License is distributed on an
15*1d2dbeb0SAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*1d2dbeb0SAndrew Rist  * KIND, either express or implied.  See the License for the
17*1d2dbeb0SAndrew Rist  * specific language governing permissions and limitations
18*1d2dbeb0SAndrew Rist  * under the License.
19*1d2dbeb0SAndrew Rist  *
20*1d2dbeb0SAndrew Rist  *************************************************************/
21*1d2dbeb0SAndrew Rist 
22*1d2dbeb0SAndrew Rist 
23cdf0e10cSrcweir #ifndef _FMTCOLFUNC_HXX
24cdf0e10cSrcweir #define _FMTCOLFUNC_HXX
25cdf0e10cSrcweir 
26cdf0e10cSrcweir class SwFmt;
27cdf0e10cSrcweir class SwNumRuleItem;
28cdf0e10cSrcweir 
29cdf0e10cSrcweir // namespace <TxtFmtCollFunc> for functions and procedures working on
30cdf0e10cSrcweir // paragraph styles (instances of <SwTxtFmtColl>
31cdf0e10cSrcweir namespace TxtFmtCollFunc
32cdf0e10cSrcweir {
33cdf0e10cSrcweir     /** Checks, if assignment of paragraph style to list level of outline style
34cdf0e10cSrcweir         has to be deleted, and deletes the assignment, if needed.
35cdf0e10cSrcweir 
36cdf0e10cSrcweir         OD 2006-11-22 #i71574#
37cdf0e10cSrcweir         The assignment of a paragraph style to a list level of the outline style
38cdf0e10cSrcweir         has to be deleted, if the numbering rule, which is set at the paragraph
39cdf0e10cSrcweir         style isn't the outline style.
40cdf0e10cSrcweir 
41cdf0e10cSrcweir         @author OD
42cdf0e10cSrcweir     */
43cdf0e10cSrcweir     void CheckTxtFmtCollForDeletionOfAssignmentToOutlineStyle(
44cdf0e10cSrcweir                                     SwFmt* pFmt,
45cdf0e10cSrcweir                                     const SwNumRuleItem* pNewNumRuleItem = 0L );
46cdf0e10cSrcweir 
47cdf0e10cSrcweir     /** determines the list style, which directly set at the given paragraph style
48cdf0e10cSrcweir 
49cdf0e10cSrcweir         OD 2008-03-04 #refactorlists#
50cdf0e10cSrcweir 
51cdf0e10cSrcweir         @author OD
52cdf0e10cSrcweir 
53cdf0e10cSrcweir         @param rTxtFmtColl
54cdf0e10cSrcweir         input parameter - paragraph style for which the list style should be retrieved
55cdf0e10cSrcweir 
56cdf0e10cSrcweir         @return pointer to <SwNumRule> instance, if the given paragraph style
57cdf0e10cSrcweir         has directly set a list style, 0 otherwise
58cdf0e10cSrcweir     */
59cdf0e10cSrcweir     SwNumRule* GetNumRule( SwTxtFmtColl& rTxtFmtColl );
60cdf0e10cSrcweir 
61cdf0e10cSrcweir     /** adds the given paragraph style at the directly set list style
62cdf0e10cSrcweir 
63cdf0e10cSrcweir         OD 2008-03-04 #refactorlists#
64cdf0e10cSrcweir         Note: If the given paragraph style has no directly set list style, nothing happens
65cdf0e10cSrcweir 
66cdf0e10cSrcweir         @param rTxtFmtColl
67cdf0e10cSrcweir         input parameter - paragraph style which is added to its directly set list style
68cdf0e10cSrcweir 
69cdf0e10cSrcweir         @author OD
70cdf0e10cSrcweir     */
71cdf0e10cSrcweir     void AddToNumRule( SwTxtFmtColl& rTxtFmtColl );
72cdf0e10cSrcweir 
73cdf0e10cSrcweir     /** removes te given paragraph style from the directly set list style
74cdf0e10cSrcweir 
75cdf0e10cSrcweir         OD 2008-03-04 #refactorlists#
76cdf0e10cSrcweir         Note: If the given paragraph style has no directly set list style, nothing happens
77cdf0e10cSrcweir 
78cdf0e10cSrcweir         @param rTxtFmtColl
79cdf0e10cSrcweir         input parameter - paragraph style which is removed from its directly set list style
80cdf0e10cSrcweir 
81cdf0e10cSrcweir         @author OD
82cdf0e10cSrcweir     */
83cdf0e10cSrcweir     void RemoveFromNumRule( SwTxtFmtColl& rTxtFmtColl );
84cdf0e10cSrcweir }
85cdf0e10cSrcweir #endif
86