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