62a268cc71
Added rich text control formatting and symbol dialogs API changes for wxRichTextCtrl git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@41898 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
140 lines
3.9 KiB
TeX
140 lines
3.9 KiB
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.
|
|
|