Reviewed by Kevin.
[WebKit.git] / WebCore / khtml / editing / visible_units.h
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 KHTML_EDITING_VISIBLE_UNITS_H
27 #define KHTML_EDITING_VISIBLE_UNITS_H
28
29 #include "text_affinity.h"
30
31 namespace khtml {
32
33 class VisiblePosition;
34
35 enum EWordSide { RightWordIfOnBoundary = false, LeftWordIfOnBoundary = true };
36 enum EIncludeLineBreak { DoNotIncludeLineBreak = false, IncludeLineBreak = 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 // lines
45 VisiblePosition startOfLine(const VisiblePosition &);
46 VisiblePosition endOfLine(const VisiblePosition &, EIncludeLineBreak = DoNotIncludeLineBreak);
47 VisiblePosition previousLinePosition(const VisiblePosition &, int x);
48 VisiblePosition nextLinePosition(const VisiblePosition &, int x);
49 bool inSameLine(const VisiblePosition &, const VisiblePosition &);
50 bool isStartOfLine(const VisiblePosition &);
51 bool isEndOfLine(const VisiblePosition &);
52
53 // sentences
54 VisiblePosition startOfSentence(const VisiblePosition &);
55 VisiblePosition endOfSentence(const VisiblePosition &);
56 VisiblePosition previousSentencePosition(const VisiblePosition &);
57 VisiblePosition nextSentencePosition(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 &, EIncludeLineBreak = DoNotIncludeLineBreak);
62 VisiblePosition previousParagraphPosition(const VisiblePosition &, int x);
63 VisiblePosition nextParagraphPosition(const VisiblePosition &, int x);
64 bool inSameParagraph(const VisiblePosition &, const VisiblePosition &);
65 bool isStartOfParagraph(const VisiblePosition &);
66 bool isEndOfParagraph(const VisiblePosition &);
67
68 // blocks (true paragraphs; line break elements don't break blocks)
69 VisiblePosition startOfBlock(const VisiblePosition &);
70 VisiblePosition endOfBlock(const VisiblePosition &);
71 bool inSameBlock(const VisiblePosition &, const VisiblePosition &);
72 bool isStartOfBlock(const VisiblePosition &);
73 bool isEndOfBlock(const VisiblePosition &);
74
75 // document
76 VisiblePosition startOfDocument(const VisiblePosition &);
77 VisiblePosition endOfDocument(const VisiblePosition &);
78 bool inSameDocument(const VisiblePosition &, const VisiblePosition &);
79 bool isStartOfDocument(const VisiblePosition &);
80 bool isEndOfDocument(const VisiblePosition &);
81
82 // editable content
83 VisiblePosition startOfEditableContent(const VisiblePosition &);
84 VisiblePosition endOfEditableContent(const VisiblePosition &);
85 bool inSameEditableContent(const VisiblePosition &, const VisiblePosition &);
86 bool isStartOfEditableContent(const VisiblePosition &);
87 bool isEndOfEditableContent(const VisiblePosition &);
88
89 } // namespace DOM
90
91 #endif // KHTML_EDITING_VISIBLE_POSITION_H