xref: /trunk/main/sw/source/core/inc/frminf.hxx (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 #ifndef _FRMINF_HXX
28 #define _FRMINF_HXX
29 
30 #include "swtypes.hxx"
31 
32 class SwTxtFrm;     // SwTxtFrmInfo
33 class SwPaM;        // SwTxtFrmInfo
34 class SwTxtCursor;  // SwTxtFrmInfo
35 
36 
37 /*************************************************************************
38  *                      class SwTxtFrmInfo
39  *************************************************************************/
40 
41 class SwTxtFrmInfo
42 {
43     const SwTxtFrm *pFrm;
44 
45     // Wo beginnt der Text (ohne whitespaces)? (Dokument global !!)
46     SwTwips GetLineStart( const SwTxtCursor &rLine ) const;
47 
48 public:
49     inline SwTxtFrmInfo( const SwTxtFrm *pTxtFrm ) : pFrm(pTxtFrm) { }
50 
51     // Passt der Absatz in eine Zeile?
52     sal_Bool IsOneLine() const;
53 
54     // Ist die Zeile zu X% gefuellt?
55     sal_Bool IsFilled( const sal_uInt8 nPercent ) const;
56 
57     // Wo beginnt der Text (ohne whitespaces)? (rel. im Frame !!)
58     SwTwips GetLineStart() const;
59 
60     //returne die mittel Position des n. Charakters
61     SwTwips GetCharPos( xub_StrLen nChar, sal_Bool bCenter = sal_True ) const;
62 
63     // Sammelt die whitespaces am Zeilenbeginn und -ende im Pam
64     void GetSpaces( SwPaM &rPam, sal_Bool bWithLineBreak ) const;
65 
66     // Ist an der ersten Textposition ein Bullet/Symbol etc?
67     sal_Bool IsBullet( xub_StrLen nTxtPos ) const;
68 
69     // Ermittelt Erstzeileneinzug
70     SwTwips GetFirstIndent() const;
71 
72     // setze und erfrage den Frame;
73     const SwTxtFrm* GetFrm() const { return pFrm; }
74     SwTxtFrmInfo& SetFrm( const SwTxtFrm* pNew )
75         { pFrm = pNew; return *this; }
76 
77     // liegt eine Gegenueberstellung vor? (returnt Pos im Frame)
78     sal_uInt16 GetBigIndent( xub_StrLen& rFndPos,
79                         const SwTxtFrm *pNextFrm = 0 ) const;
80 };
81 
82 
83 
84 #endif
85 
86