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