]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/richtextrange.tex
fix typo
[wxWidgets.git] / docs / latex / wx / richtextrange.tex
CommitLineData
5f35b46a
JS
1\section{\class{wxRichTextRange}}\label{wxrichtextrange}
2
3This class stores beginning and end positions for a range of data.
4
5\wxheading{Derived from}
6
7No base class
8
9\wxheading{Include files}
10
11<wx/richtext/richtextbuffer.h>
12
13\wxheading{Data structures}
14
15\latexignore{\rtfignore{\wxheading{Members}}}
16
17\membersection{wxRichTextRange::wxRichTextRange}\label{wxrichtextrangewxrichtextrange}
18
19\func{}{wxRichTextRange}{\param{long }{start}, \param{long }{end}}
20
21\func{}{wxRichTextRange}{\param{const wxRichTextRange\& }{range}}
22
23\func{}{wxRichTextRange}{\void}
24
25Constructors.
26
27\membersection{wxRichTextRange::\destruct{wxRichTextRange}}\label{wxrichtextrangedtor}
28
29\func{}{\destruct{wxRichTextRange}}{\void}
30
31Destructor.
32
33\membersection{wxRichTextRange::Contains}\label{wxrichtextrangecontains}
34
35\constfunc{bool}{Contains}{\param{long }{pos}}
36
37Returns \true if the given position is within this range. Does not
38match if the range is empty.
39
40\membersection{wxRichTextRange::GetEnd}\label{wxrichtextrangegetend}
41
42\constfunc{long}{GetEnd}{\void}
43
44Returns the end position.
45
46\membersection{wxRichTextRange::GetLength}\label{wxrichtextrangegetlength}
47
48\constfunc{long}{GetLength}{\void}
49
50Returns the length of the range.
51
52\membersection{wxRichTextRange::GetStart}\label{wxrichtextrangegetstart}
53
54\constfunc{long}{GetStart}{\void}
55
56Returns the start of the range.
57
62a268cc
JS
58\membersection{wxRichTextRange::FromInternal}\label{wxrichtextrangefrominternal}
59
60\constfunc{wxRichTextRange}{FromInternal}{\void}
61
62Converts the internal range, which uses the first and last character positions of the range,
63to the API-standard range, whose end is one past the last character in the range.
64In other words, one is added to the end position.
65
5f35b46a
JS
66\membersection{wxRichTextRange::IsOutside}\label{wxrichtextrangeisoutside}
67
68\constfunc{bool}{IsOutside}{\param{const wxRichTextRange\& }{range}}
69
70Returns \true if this range is completely outside {\it range}.
71
72\membersection{wxRichTextRange::IsWithin}\label{wxrichtextrangeiswithin}
73
74\constfunc{bool}{IsWithin}{\param{const wxRichTextRange\& }{range}}
75
76Returns \true if this range is completely within {\it range}.
77
78\membersection{wxRichTextRange::LimitTo}\label{wxrichtextrangelimitto}
79
80\func{bool}{LimitTo}{\param{const wxRichTextRange\& }{range}}
81
82Limits this range to be within {\it range}.
83
84\membersection{wxRichTextRange::SetEnd}\label{wxrichtextrangesetend}
85
86\func{void}{SetEnd}{\param{long }{end}}
87
88Sets the end of the range.
89
90\membersection{wxRichTextRange::SetRange}\label{wxrichtextrangesetrange}
91
92\func{void}{SetRange}{\param{long }{start}, \param{long }{end}}
93
94Sets the range.
95
96\membersection{wxRichTextRange::SetStart}\label{wxrichtextrangesetstart}
97
98\func{void}{SetStart}{\param{long }{start}}
99
100Sets the start of the range.
101
102\membersection{wxRichTextRange::Swap}\label{wxrichtextrangeswap}
103
104\func{void}{Swap}{\void}
105
106Swaps the start and end.
107
62a268cc
JS
108\membersection{wxRichTextRange::ToInternal}\label{wxrichtextrangetointernal}
109
110\constfunc{wxRichTextRange}{ToInternal}{\void}
111
112Converts the API-standard range, whose end is one past the last character in the range,
113to the internal form, which uses the first and last character positions of the range.
114In other words, one is subtracted from the end position.
115
5f35b46a
JS
116\membersection{wxRichTextRange::operator+}\label{wxrichtextrangeoperatorplus}
117
118\constfunc{wxRichTextRange}{operator+}{\param{const wxRichTextRange\& }{range}}
119
120Adds {\it range} to this range.
121
122\membersection{wxRichTextRange::operator-}\label{wxrichtextrangeoperatorminus}
123
124\constfunc{wxRichTextRange}{operator-}{\param{const wxRichTextRange\& }{range}}
125
62a268cc 126Subtracts {\it range} from this range.
5f35b46a
JS
127
128\membersection{wxRichTextRange::operator=}\label{wxrichtextrangeoperatorassign}
129
130\func{void}{operator=}{\param{const wxRichTextRange\& }{range}}
131
132Assigns {\it range} to this range.
133
134\membersection{wxRichTextRange::operator==}\label{wxrichtextrangeoperatorequal}
135
136\constfunc{bool}{operator==}{\param{const wxRichTextRange\& }{range}}
137
138Returns \true if {\it range} is the same as this range.
62a268cc 139