docs/latex/wx/richtextrange.tex

   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
  58 \membersection{wxRichTextRange::IsOutside}\label{wxrichtextrangeisoutside}
  59
  60 \constfunc{bool}{IsOutside}{\param{const wxRichTextRange\& }{range}}
  61
  62 Returns \true if this range is completely outside {\it range}.
  63
  64 \membersection{wxRichTextRange::IsWithin}\label{wxrichtextrangeiswithin}
  65
  66 \constfunc{bool}{IsWithin}{\param{const wxRichTextRange\& }{range}}
  67
  68 Returns \true if this range is completely within {\it range}.
  69
  70 \membersection{wxRichTextRange::LimitTo}\label{wxrichtextrangelimitto}
  71
  72 \func{bool}{LimitTo}{\param{const wxRichTextRange\& }{range}}
  73
  74 Limits this range to be within {\it range}.
  75
  76 \membersection{wxRichTextRange::SetEnd}\label{wxrichtextrangesetend}
  77
  78 \func{void}{SetEnd}{\param{long }{end}}
  79
  80 Sets the end of the range.
  81
  82 \membersection{wxRichTextRange::SetRange}\label{wxrichtextrangesetrange}
  83
  84 \func{void}{SetRange}{\param{long }{start}, \param{long }{end}}
  85
  86 Sets the range.
  87
  88 \membersection{wxRichTextRange::SetStart}\label{wxrichtextrangesetstart}
  89
  90 \func{void}{SetStart}{\param{long }{start}}
  91
  92 Sets the start of the range.
  93
  94 \membersection{wxRichTextRange::Swap}\label{wxrichtextrangeswap}
  95
  96 \func{void}{Swap}{\void}
  97
  98 Swaps the start and end.
  99
 100 \membersection{wxRichTextRange::operator+}\label{wxrichtextrangeoperatorplus}
 101
 102 \constfunc{wxRichTextRange}{operator+}{\param{const wxRichTextRange\& }{range}}
 103
 104 Adds {\it range} to this range.
 105
 106 \membersection{wxRichTextRange::operator-}\label{wxrichtextrangeoperatorminus}
 107
 108 \constfunc{wxRichTextRange}{operator-}{\param{const wxRichTextRange\& }{range}}
 109
 110 Subtracs {\it range} from this range.
 111
 112 \membersection{wxRichTextRange::operator=}\label{wxrichtextrangeoperatorassign}
 113
 114 \func{void}{operator=}{\param{const wxRichTextRange\& }{range}}
 115
 116 Assigns {\it range} to this range.
 117
 118 \membersection{wxRichTextRange::operator==}\label{wxrichtextrangeoperatorequal}
 119
 120 \constfunc{bool}{operator==}{\param{const wxRichTextRange\& }{range}}
 121
 122 Returns \true if {\it range} is the same as this range.