]>
Commit | Line | Data |
---|---|---|
a90939db JF |
1 | /* |
2 | * Copyright (C) 2004 Apple Computer, Inc. All rights reserved. | |
3 | * | |
4 | * Redistribution and use in source and binary forms, with or without | |
5 | * modification, are permitted provided that the following conditions | |
6 | * are met: | |
7 | * 1. Redistributions of source code must retain the above copyright | |
8 | * notice, this list of conditions and the following disclaimer. | |
9 | * 2. Redistributions in binary form must reproduce the above copyright | |
10 | * notice, this list of conditions and the following disclaimer in the | |
11 | * documentation and/or other materials provided with the distribution. | |
12 | * | |
13 | * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY | |
14 | * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
15 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | |
16 | * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR | |
17 | * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, | |
18 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, | |
19 | * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
20 | * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY | |
21 | * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
22 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
23 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
24 | */ | |
25 | ||
26 | #ifndef visible_units_h | |
27 | #define visible_units_h | |
28 | ||
29 | #include "Document.h" | |
30 | #include "TextAffinity.h" | |
31 | ||
32 | namespace WebCore { | |
33 | ||
34 | class VisiblePosition; | |
35 | ||
36 | enum EWordSide { RightWordIfOnBoundary = false, LeftWordIfOnBoundary = true }; | |
37 | ||
38 | // words | |
39 | VisiblePosition startOfWord(const VisiblePosition &, EWordSide = RightWordIfOnBoundary); | |
40 | VisiblePosition endOfWord(const VisiblePosition &, EWordSide = RightWordIfOnBoundary); | |
41 | VisiblePosition previousWordPosition(const VisiblePosition &); | |
42 | VisiblePosition nextWordPosition(const VisiblePosition &); | |
43 | ||
44 | // sentences | |
45 | VisiblePosition startOfSentence(const VisiblePosition &); | |
46 | VisiblePosition endOfSentence(const VisiblePosition &); | |
47 | VisiblePosition previousSentencePosition(const VisiblePosition &); | |
48 | VisiblePosition nextSentencePosition(const VisiblePosition &); | |
49 | ||
50 | // lines | |
51 | VisiblePosition startOfLine(const VisiblePosition &); | |
52 | VisiblePosition endOfLine(const VisiblePosition &); | |
53 | VisiblePosition previousLinePosition(const VisiblePosition &, int x); | |
54 | VisiblePosition nextLinePosition(const VisiblePosition &, int x); | |
55 | bool inSameLine(const VisiblePosition &, const VisiblePosition &); | |
56 | bool isStartOfLine(const VisiblePosition &); | |
57 | bool isEndOfLine(const VisiblePosition &); | |
58 | ||
59 | // paragraphs (perhaps a misnomer, can be divided by line break elements) | |
60 | VisiblePosition startOfParagraph(const VisiblePosition&); | |
61 | VisiblePosition endOfParagraph(const VisiblePosition&); | |
62 | VisiblePosition startOfNextParagraph(const VisiblePosition&); | |
63 | VisiblePosition previousParagraphPosition(const VisiblePosition &, int x); | |
64 | VisiblePosition nextParagraphPosition(const VisiblePosition &, int x); | |
65 | bool inSameParagraph(const VisiblePosition &, const VisiblePosition &); | |
66 | bool isStartOfParagraph(const VisiblePosition &); | |
67 | bool isEndOfParagraph(const VisiblePosition &); | |
68 | ||
69 | // blocks (true paragraphs; line break elements don't break blocks) | |
70 | VisiblePosition startOfBlock(const VisiblePosition &); | |
71 | VisiblePosition endOfBlock(const VisiblePosition &); | |
72 | bool inSameBlock(const VisiblePosition &, const VisiblePosition &); | |
73 | bool isStartOfBlock(const VisiblePosition &); | |
74 | bool isEndOfBlock(const VisiblePosition &); | |
75 | ||
76 | // document | |
77 | VisiblePosition startOfDocument(const Node*); | |
78 | VisiblePosition endOfDocument(const Node*); | |
79 | VisiblePosition startOfDocument(const VisiblePosition &); | |
80 | VisiblePosition endOfDocument(const VisiblePosition &); | |
81 | bool inSameDocument(const VisiblePosition &, const VisiblePosition &); | |
82 | bool isStartOfDocument(const VisiblePosition &); | |
83 | bool isEndOfDocument(const VisiblePosition &); | |
84 | ||
85 | // editable content | |
86 | VisiblePosition startOfEditableContent(const VisiblePosition&); | |
87 | VisiblePosition endOfEditableContent(const VisiblePosition&); | |
88 | ||
89 | } // namespace WebCore | |
90 | ||
91 | #endif // VisiblePosition_h |