[wxWidgets.git] / docs / latex / wx / richtextrange.tex

\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.
Commit	Line	Data
5f35b46a JS	1	\section{\class{wxRichTextRange}}\label{wxrichtextrange}
	2
	3	This class stores beginning and end positions for a range of data.
	4
	5	\wxheading{Derived from}
	6
	7	No 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
	25	Constructors.
	26
	27	\membersection{wxRichTextRange::\destruct{wxRichTextRange}}\label{wxrichtextrangedtor}
	28
	29	\func{}{\destruct{wxRichTextRange}}{\void}
	30
	31	Destructor.
	32
	33	\membersection{wxRichTextRange::Contains}\label{wxrichtextrangecontains}
	34
	35	\constfunc{bool}{Contains}{\param{long }{pos}}
	36
	37	Returns \true if the given position is within this range. Does not
	38	match if the range is empty.
	39
	40	\membersection{wxRichTextRange::GetEnd}\label{wxrichtextrangegetend}
	41
	42	\constfunc{long}{GetEnd}{\void}
	43
	44	Returns the end position.
	45
	46	\membersection{wxRichTextRange::GetLength}\label{wxrichtextrangegetlength}
	47
	48	\constfunc{long}{GetLength}{\void}
	49
	50	Returns the length of the range.
	51
	52	\membersection{wxRichTextRange::GetStart}\label{wxrichtextrangegetstart}
	53
	54	\constfunc{long}{GetStart}{\void}
	55
	56	Returns the start of the range.
	57
62a268cc JS	58	\membersection{wxRichTextRange::FromInternal}\label{wxrichtextrangefrominternal}
	59
	60	\constfunc{wxRichTextRange}{FromInternal}{\void}
	61
	62	Converts the internal range, which uses the first and last character positions of the range,
	63	to the API-standard range, whose end is one past the last character in the range.
	64	In 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
	70	Returns \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
	76	Returns \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
	82	Limits this range to be within {\it range}.
	83
	84	\membersection{wxRichTextRange::SetEnd}\label{wxrichtextrangesetend}
	85
	86	\func{void}{SetEnd}{\param{long }{end}}
	87
	88	Sets the end of the range.
	89
	90	\membersection{wxRichTextRange::SetRange}\label{wxrichtextrangesetrange}
	91
	92	\func{void}{SetRange}{\param{long }{start}, \param{long }{end}}
	93
	94	Sets the range.
	95
	96	\membersection{wxRichTextRange::SetStart}\label{wxrichtextrangesetstart}
	97
	98	\func{void}{SetStart}{\param{long }{start}}
	99
	100	Sets the start of the range.
	101
	102	\membersection{wxRichTextRange::Swap}\label{wxrichtextrangeswap}
	103
	104	\func{void}{Swap}{\void}
	105
	106	Swaps the start and end.
	107
62a268cc JS	108	\membersection{wxRichTextRange::ToInternal}\label{wxrichtextrangetointernal}
	109
	110	\constfunc{wxRichTextRange}{ToInternal}{\void}
	111
	112	Converts the API-standard range, whose end is one past the last character in the range,
	113	to the internal form, which uses the first and last character positions of the range.
	114	In 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
	120	Adds {\it range} to this range.
	121
	122	\membersection{wxRichTextRange::operator-}\label{wxrichtextrangeoperatorminus}
	123
	124	\constfunc{wxRichTextRange}{operator-}{\param{const wxRichTextRange\& }{range}}
	125
62a268cc	126	Subtracts {\it range} from this range.
5f35b46a JS	127
	128	\membersection{wxRichTextRange::operator=}\label{wxrichtextrangeoperatorassign}
	129
	130	\func{void}{operator=}{\param{const wxRichTextRange\& }{range}}
	131
	132	Assigns {\it range} to this range.
	133
	134	\membersection{wxRichTextRange::operator==}\label{wxrichtextrangeoperatorequal}
	135
	136	\constfunc{bool}{operator==}{\param{const wxRichTextRange\& }{range}}
	137
	138	Returns \true if {\it range} is the same as this range.
62a268cc	139