blob: de5acd28ea7d3cb9bb111e5ad920e30ae5c263ec (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: swselectionlist.hxx,v $
* $Revision: 1.3 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef _SWSELECTIONLIST_HXX
#define _SWSELECTIONLIST_HXX
#include <list>
class SwPaM;
class SwFrm;
/** This class is used as parameter for creation of a block cursor selection
This class will be created by a block cursor. Its responsibility is
to collect a group of selected text portions which are part of a common
context.
Definition of context:
A page header is a context.
A page footer is a context.
A footnote is a context.
Every fly frame builds a context together with its linked colleagues.
The content of the page bodies builds a context.
*/
class SwSelectionList
{
std::list< SwPaM* > aList; // container for the selected text portions
const SwFrm* pContext; // the context of these text portions
public:
/** Ctor to create an empty list for a given context
@param pInitCxt
The frame (normally a SwTxtFrm) where the block cursor selection starts,
it will be used to get the allowed context for the text selections.
*/
explicit SwSelectionList( const SwFrm* pInitCxt );
/** Start of the container for the selected text portions
*/
std::list<SwPaM*>::iterator getStart() { return aList.begin(); }
/** End of the container for the selected text portions
*/
std::list<SwPaM*>::iterator getEnd() { return aList.end(); }
/** Adds a text portion to the selection list
@param pPam
represents a text portion to select
*/
void insertPaM( SwPaM* pPam ) { aList.push_front( pPam ); }
/** Reports if the list does not contain any text portion
@return true, if list is empty
*/
bool isEmpty() const { return aList.empty(); }
/** Checks if the context of the list is equal to the context of the frame
If the list does not have already a context, the context of the frame
will define the list's context.
If the list has already a context, it will be compared to the context of
the given frame.
@param pCheck
The frame to check
@return true, if the context of the frame is equal to the one of the list
*/
bool checkContext( const SwFrm* pCheck );
};
#endif //_SWSELECTIONLIST_HXX
|
