]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/richtextbuffer.tex
more LaTeX error fixes
[wxWidgets.git] / docs / latex / wx / richtextbuffer.tex
index b0a57a1313918698c3fdeaa7634e5196c9076c73..76b48fc6d3be8ceeb37dbf2dd760011dcd395b47 100644 (file)
@@ -10,11 +10,15 @@ wxRichTextParagraphLayoutBox
 
 <wx/richtext/richtextbuffer.h>
 
 
 <wx/richtext/richtextbuffer.h>
 
+\wxheading{Library}
+
+\helpref{wxRichtext}{librarieslist}
+
 \wxheading{Data structures}
 
 \wxheading{See also}
 
 \wxheading{Data structures}
 
 \wxheading{See also}
 
-\helpref{wxTextAttr}{wxtextattr}, \helpref{wxTextAttrEx}{wxtextattrex}, \helpref{wxRichTextAttr}{wxrichtextattr}, \helpref{wxRichTextCtrl}{wxrichtextctrl}
+\helpref{wxTextAttr}{wxtextattr}, \helpref{wxRichTextCtrl}{wxrichtextctrl}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
@@ -205,7 +209,7 @@ Begins a right indent, specified in tenths of a millimetre.
 
 \membersection{wxRichTextBuffer::BeginStyle}\label{wxrichtextbufferbeginstyle}
 
 
 \membersection{wxRichTextBuffer::BeginStyle}\label{wxrichtextbufferbeginstyle}
 
-\func{bool}{BeginStyle}{\param{const wxTextAttrEx\& }{style}}
+\func{bool}{BeginStyle}{\param{const wxTextAttr\& }{style}}
 
 Begins using a specified style.
 
 
 Begins using a specified style.
 
@@ -311,7 +315,7 @@ Copy the given range to the clipboard.
 
 \membersection{wxRichTextBuffer::DeleteRangeWithUndo}\label{wxrichtextbufferdeleterangewithundo}
 
 
 \membersection{wxRichTextBuffer::DeleteRangeWithUndo}\label{wxrichtextbufferdeleterangewithundo}
 
-\func{bool}{DeleteRangeWithUndo}{\param{const wxRichTextRange\& }{range}, \param{long }{initialCaretPosition}, \param{long }{newCaretPositon}, \param{wxRichTextCtrl* }{ctrl}}
+\func{bool}{DeleteRangeWithUndo}{\param{const wxRichTextRange\& }{range}, \param{wxRichTextCtrl* }{ctrl}}
 
 Submits a command to delete the given range.
 
 
 Submits a command to delete the given range.
 
@@ -477,7 +481,7 @@ Finds a handler by filename or, if supplied, type.
 
 \membersection{wxRichTextBuffer::GetBasicStyle}\label{wxrichtextbuffergetbasicstyle}
 
 
 \membersection{wxRichTextBuffer::GetBasicStyle}\label{wxrichtextbuffergetbasicstyle}
 
-\constfunc{const wxTextAttrEx\&}{GetBasicStyle}{\void}
+\constfunc{const wxTextAttr\&}{GetBasicStyle}{\void}
 
 Gets the basic (overall) style. This is the style of the whole
 buffer before further styles are applied, unlike the default style, which
 
 Gets the basic (overall) style. This is the style of the whole
 buffer before further styles are applied, unlike the default style, which
@@ -499,7 +503,7 @@ initialized.
 
 \membersection{wxRichTextBuffer::GetDefaultStyle}\label{wxrichtextbuffergetdefaultstyle}
 
 
 \membersection{wxRichTextBuffer::GetDefaultStyle}\label{wxrichtextbuffergetdefaultstyle}
 
-\constfunc{const wxTextAttrEx\&}{GetDefaultStyle}{\void}
+\constfunc{const wxTextAttr\&}{GetDefaultStyle}{\void}
 
 Returns the current default style, affecting the style currently being applied (for example, setting the default
 style to bold will cause subsequently inserted text to be bold).
 
 Returns the current default style, affecting the style currently being applied (for example, setting the default
 style to bold will cause subsequently inserted text to be bold).
@@ -526,9 +530,7 @@ Returns the object to be used to render certain aspects of the content, such as
 
 \membersection{wxRichTextBuffer::GetStyle}\label{wxrichtextbuffergetstyle}
 
 
 \membersection{wxRichTextBuffer::GetStyle}\label{wxrichtextbuffergetstyle}
 
-\func{bool}{GetStyle}{\param{long }{position}, \param{wxRichTextAttr\& }{style}}
-
-\func{bool}{GetStyle}{\param{long }{position}, \param{wxTextAttrEx\& }{style}}
+\func{bool}{GetStyle}{\param{long }{position}, \param{wxTextAttr\& }{style}}
 
 Gets the attributes at the given position.
 
 
 Gets the attributes at the given position.
 
@@ -538,7 +540,7 @@ or paragraph style alone, use \helpref{GetUncombinedStyle}{wxrichtextbuffergetun
 
 \membersection{wxRichTextBuffer::GetStyleForRange}\label{wxrichtextbuffergetstyleforrange}
 
 
 \membersection{wxRichTextBuffer::GetStyleForRange}\label{wxrichtextbuffergetstyleforrange}
 
-\func{bool}{GetStyleForRange}{\param{const wxRichTextRange\&}{ range}, \param{wxTextAttrEx\& }{style}}
+\func{bool}{GetStyleForRange}{\param{const wxRichTextRange\&}{ range}, \param{wxTextAttr\& }{style}}
 
 This function gets a style representing the common, combined attributes in the given range.
 Attributes which have different values within the specified range will not be included the style
 
 This function gets a style representing the common, combined attributes in the given range.
 Attributes which have different values within the specified range will not be included the style
@@ -573,9 +575,7 @@ Get the size of the style stack, for example to check correct nesting.
 
 \membersection{wxRichTextBuffer::GetUncombinedStyle}\label{wxrichtextbuffergetuncombinedstyle}
 
 
 \membersection{wxRichTextBuffer::GetUncombinedStyle}\label{wxrichtextbuffergetuncombinedstyle}
 
-\func{bool}{GetUncombinedStyle}{\param{long }{position}, \param{wxRichTextAttr\& }{style}}
-
-\func{bool}{GetUncombinedStyle}{\param{long }{position}, \param{wxTextAttrEx\& }{style}}
+\func{bool}{GetUncombinedStyle}{\param{long }{position}, \param{wxTextAttr\& }{style}}
 
 Gets the attributes at the given position.
 
 
 Gets the attributes at the given position.
 
@@ -606,6 +606,8 @@ The function returns one of the following values:
 #define wxRICHTEXT_HITTEST_AFTER    0x04
 // The point was on the position returned from HitTest
 #define wxRICHTEXT_HITTEST_ON       0x08
 #define wxRICHTEXT_HITTEST_AFTER    0x04
 // The point was on the position returned from HitTest
 #define wxRICHTEXT_HITTEST_ON       0x08
+// The point was on space outside content
+#define wxRICHTEXT_HITTEST_OUTSIDE  0x10
 \end{verbatim}
 }
 
 \end{verbatim}
 }
 
@@ -743,9 +745,7 @@ Saves content to a file.
 
 \membersection{wxRichTextBuffer::SetBasicStyle}\label{wxrichtextbuffersetbasicstyle}
 
 
 \membersection{wxRichTextBuffer::SetBasicStyle}\label{wxrichtextbuffersetbasicstyle}
 
-\func{void}{SetBasicStyle}{\param{const wxRichTextAttr\& }{style}}
-
-\func{void}{SetBasicStyle}{\param{const wxTextAttrEx\& }{style}}
+\func{void}{SetBasicStyle}{\param{const wxTextAttr\& }{style}}
 
 Sets the basic (overall) style. This is the style of the whole
 buffer before further styles are applied, unlike the default style, which
 
 Sets the basic (overall) style. This is the style of the whole
 buffer before further styles are applied, unlike the default style, which
@@ -754,7 +754,7 @@ style to bold will cause subsequently inserted text to be bold).
 
 \membersection{wxRichTextBuffer::SetDefaultStyle}\label{wxrichtextbuffersetdefaultstyle}
 
 
 \membersection{wxRichTextBuffer::SetDefaultStyle}\label{wxrichtextbuffersetdefaultstyle}
 
-\func{void}{SetDefaultStyle}{\param{const wxTextAttrEx\& }{style}}
+\func{void}{SetDefaultStyle}{\param{const wxTextAttr\& }{style}}
 
 Sets the default style, affecting the style currently being applied (for example, setting the default
 style to bold will cause subsequently inserted text to be bold).
 
 Sets the default style, affecting the style currently being applied (for example, setting the default
 style to bold will cause subsequently inserted text to be bold).
@@ -790,9 +790,7 @@ overriding one or more virtual functions, and setting an instance of the class u
 
 \membersection{wxRichTextBuffer::SetStyle}\label{wxrichtextbuffersetstyle}
 
 
 \membersection{wxRichTextBuffer::SetStyle}\label{wxrichtextbuffersetstyle}
 
-\func{bool}{SetStyle}{\param{const wxRichTextRange\& }{range}, \param{const wxRichTextAttr\& }{style}, \param{int }{flags $=$ wxRICHTEXT\_SETSTYLE\_WITH\_UNDO}}
-
-\func{bool}{SetStyle}{\param{const wxRichTextRange\& }{range}, \param{const wxTextAttrEx\& }{style}, \param{int }{flags $=$ wxRICHTEXT\_SETSTYLE\_WITH\_UNDO}}
+\func{bool}{SetStyle}{\param{const wxRichTextRange\& }{range}, \param{const wxTextAttr\& }{style}, \param{int }{flags $=$ wxRICHTEXT\_SETSTYLE\_WITH\_UNDO}}
 
 Sets the attributes for the given range. Pass flags to determine how the attributes are set.
 
 
 Sets the attributes for the given range. Pass flags to determine how the attributes are set.
 
@@ -807,10 +805,12 @@ This differs from the wxRichTextCtrl API, where you would specify (5,6).
 \item wxRICHTEXT\_SETSTYLE\_WITH\_UNDO: specifies that this operation should be undoable.
 \item wxRICHTEXT\_SETSTYLE\_OPTIMIZE: specifies that the style should not be applied if the
 combined style at this point is already the style in question.
 \item wxRICHTEXT\_SETSTYLE\_WITH\_UNDO: specifies that this operation should be undoable.
 \item wxRICHTEXT\_SETSTYLE\_OPTIMIZE: specifies that the style should not be applied if the
 combined style at this point is already the style in question.
-\item define wxRICHTEXT\_SETSTYLE\_PARAGRAPHS\_ONLY: specifies that the style should only be applied to paragraphs,
+\item wxRICHTEXT\_SETSTYLE\_PARAGRAPHS\_ONLY: specifies that the style should only be applied to paragraphs,
 and not the content. This allows content styling to be preserved independently from that of e.g. a named paragraph style.
 \item wxRICHTEXT\_SETSTYLE\_CHARACTERS\_ONLY: specifies that the style should only be applied to characters,
 and not the paragraph. This allows content styling to be preserved independently from that of e.g. a named paragraph style.
 and not the content. This allows content styling to be preserved independently from that of e.g. a named paragraph style.
 \item wxRICHTEXT\_SETSTYLE\_CHARACTERS\_ONLY: specifies that the style should only be applied to characters,
 and not the paragraph. This allows content styling to be preserved independently from that of e.g. a named paragraph style.
+\item wxRICHTEXT\_SETSTYLE\_RESET: resets (clears) the existing style before applying the new style.
+\item wxRICHTEXT\_SETSTYLE\_REMOVE: removes the specified style. Only the style flags are used in this operation.
 \end{itemize}
 
 \membersection{wxRichTextBuffer::SetStyleSheet}\label{wxrichtextbuffersetstylesheet}
 \end{itemize}
 
 \membersection{wxRichTextBuffer::SetStyleSheet}\label{wxrichtextbuffersetstylesheet}