wxWidgets/docs/latex/wx/richtextrange.tex
Julian Smart 5f35b46aab First cut at wxRichTextCtrl documentation
Put wxTextAttr into separate file to allow correct ordering


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@39924 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2006-07-01 20:30:58 +00:00

123 lines
3.2 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::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::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}}
Subtracs {\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.