File: richtextrange.tex

package info (click to toggle)
wxwidgets2.8 2.8.10.1-3
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 239,052 kB
  • ctags: 289,550
  • sloc: cpp: 1,838,857; xml: 396,717; python: 282,506; ansic: 126,171; makefile: 51,406; sh: 14,581; asm: 299; sql: 258; lex: 194; perl: 139; yacc: 128; pascal: 95; php: 39; lisp: 38; tcl: 24; haskell: 20; java: 18; cs: 18; erlang: 17; ruby: 16; ada: 9; ml: 9; csh: 9
file content (139 lines) | stat: -rw-r--r-- 4,014 bytes parent folder | download | duplicates (3)
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
\section{\class{wxRichTextRange}}\label{wxrichtextrange}

This class stores beginning and end positions for a range of data.

\wxheading{Derived from}

No base class

\wxheading{Include files}

<wx/richtext/richtextbuffer.h>

\wxheading{Data structures}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxRichTextRange::wxRichTextRange}\label{wxrichtextrangewxrichtextrange}

\func{}{wxRichTextRange}{\param{long }{start}, \param{long }{end}}

\func{}{wxRichTextRange}{\param{const wxRichTextRange\& }{range}}

\func{}{wxRichTextRange}{\void}

Constructors.

\membersection{wxRichTextRange::\destruct{wxRichTextRange}}\label{wxrichtextrangedtor}

\func{}{\destruct{wxRichTextRange}}{\void}

Destructor.

\membersection{wxRichTextRange::Contains}\label{wxrichtextrangecontains}

\constfunc{bool}{Contains}{\param{long }{pos}}

Returns \true if the given position is within this range. Does not
match if the range is empty.

\membersection{wxRichTextRange::GetEnd}\label{wxrichtextrangegetend}

\constfunc{long}{GetEnd}{\void}

Returns the end position.

\membersection{wxRichTextRange::GetLength}\label{wxrichtextrangegetlength}

\constfunc{long}{GetLength}{\void}

Returns the length of the range.

\membersection{wxRichTextRange::GetStart}\label{wxrichtextrangegetstart}

\constfunc{long}{GetStart}{\void}

Returns the start of the range.

\membersection{wxRichTextRange::FromInternal}\label{wxrichtextrangefrominternal}

\constfunc{wxRichTextRange}{FromInternal}{\void}

Converts the internal range, which uses the first and last character positions of the range,
to the API-standard range, whose end is one past the last character in the range.
In other words, one is added to the end position.

\membersection{wxRichTextRange::IsOutside}\label{wxrichtextrangeisoutside}

\constfunc{bool}{IsOutside}{\param{const wxRichTextRange\& }{range}}

Returns \true if this range is completely outside {\it range}.

\membersection{wxRichTextRange::IsWithin}\label{wxrichtextrangeiswithin}

\constfunc{bool}{IsWithin}{\param{const wxRichTextRange\& }{range}}

Returns \true if this range is completely within {\it range}.

\membersection{wxRichTextRange::LimitTo}\label{wxrichtextrangelimitto}

\func{bool}{LimitTo}{\param{const wxRichTextRange\& }{range}}

Limits this range to be within {\it range}.

\membersection{wxRichTextRange::SetEnd}\label{wxrichtextrangesetend}

\func{void}{SetEnd}{\param{long }{end}}

Sets the end of the range.

\membersection{wxRichTextRange::SetRange}\label{wxrichtextrangesetrange}

\func{void}{SetRange}{\param{long }{start}, \param{long }{end}}

Sets the range.

\membersection{wxRichTextRange::SetStart}\label{wxrichtextrangesetstart}

\func{void}{SetStart}{\param{long }{start}}

Sets the start of the range.

\membersection{wxRichTextRange::Swap}\label{wxrichtextrangeswap}

\func{void}{Swap}{\void}

Swaps the start and end.

\membersection{wxRichTextRange::ToInternal}\label{wxrichtextrangetointernal}

\constfunc{wxRichTextRange}{ToInternal}{\void}

Converts the API-standard range, whose end is one past the last character in the range,
to the internal form, which uses the first and last character positions of the range.
In other words, one is subtracted from the end position.

\membersection{wxRichTextRange::operator+}\label{wxrichtextrangeoperatorplus}

\constfunc{wxRichTextRange}{operator+}{\param{const wxRichTextRange\& }{range}}

Adds {\it range} to this range.

\membersection{wxRichTextRange::operator-}\label{wxrichtextrangeoperatorminus}

\constfunc{wxRichTextRange}{operator-}{\param{const wxRichTextRange\& }{range}}

Subtracts {\it range} from this range.

\membersection{wxRichTextRange::operator=}\label{wxrichtextrangeoperatorassign}

\func{void}{operator=}{\param{const wxRichTextRange\& }{range}}

Assigns {\it range} to this range.

\membersection{wxRichTextRange::operator==}\label{wxrichtextrangeoperatorequal}

\constfunc{bool}{operator==}{\param{const wxRichTextRange\& }{range}}

Returns \true if {\it range} is the same as this range.