]> git.saurik.com Git - iphone-api.git/blame - WebCore/visible_units.h
Add support for new WinterBoard Settings features.
[iphone-api.git] / WebCore / visible_units.h
CommitLineData
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
32namespace WebCore {
33
34class VisiblePosition;
35
36enum EWordSide { RightWordIfOnBoundary = false, LeftWordIfOnBoundary = true };
37
38// words
39VisiblePosition startOfWord(const VisiblePosition &, EWordSide = RightWordIfOnBoundary);
40VisiblePosition endOfWord(const VisiblePosition &, EWordSide = RightWordIfOnBoundary);
41VisiblePosition previousWordPosition(const VisiblePosition &);
42VisiblePosition nextWordPosition(const VisiblePosition &);
43
44// sentences
45VisiblePosition startOfSentence(const VisiblePosition &);
46VisiblePosition endOfSentence(const VisiblePosition &);
47VisiblePosition previousSentencePosition(const VisiblePosition &);
48VisiblePosition nextSentencePosition(const VisiblePosition &);
49
50// lines
51VisiblePosition startOfLine(const VisiblePosition &);
52VisiblePosition endOfLine(const VisiblePosition &);
53VisiblePosition previousLinePosition(const VisiblePosition &, int x);
54VisiblePosition nextLinePosition(const VisiblePosition &, int x);
55bool inSameLine(const VisiblePosition &, const VisiblePosition &);
56bool isStartOfLine(const VisiblePosition &);
57bool isEndOfLine(const VisiblePosition &);
58
59// paragraphs (perhaps a misnomer, can be divided by line break elements)
60VisiblePosition startOfParagraph(const VisiblePosition&);
61VisiblePosition endOfParagraph(const VisiblePosition&);
62VisiblePosition startOfNextParagraph(const VisiblePosition&);
63VisiblePosition previousParagraphPosition(const VisiblePosition &, int x);
64VisiblePosition nextParagraphPosition(const VisiblePosition &, int x);
65bool inSameParagraph(const VisiblePosition &, const VisiblePosition &);
66bool isStartOfParagraph(const VisiblePosition &);
67bool isEndOfParagraph(const VisiblePosition &);
68
69// blocks (true paragraphs; line break elements don't break blocks)
70VisiblePosition startOfBlock(const VisiblePosition &);
71VisiblePosition endOfBlock(const VisiblePosition &);
72bool inSameBlock(const VisiblePosition &, const VisiblePosition &);
73bool isStartOfBlock(const VisiblePosition &);
74bool isEndOfBlock(const VisiblePosition &);
75
76// document
77VisiblePosition startOfDocument(const Node*);
78VisiblePosition endOfDocument(const Node*);
79VisiblePosition startOfDocument(const VisiblePosition &);
80VisiblePosition endOfDocument(const VisiblePosition &);
81bool inSameDocument(const VisiblePosition &, const VisiblePosition &);
82bool isStartOfDocument(const VisiblePosition &);
83bool isEndOfDocument(const VisiblePosition &);
84
85// editable content
86VisiblePosition startOfEditableContent(const VisiblePosition&);
87VisiblePosition endOfEditableContent(const VisiblePosition&);
88
89} // namespace WebCore
90
91#endif // VisiblePosition_h