X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/523d2f145ef7d8e653fbe1f16797c1f0b4d91c16..6d0f32ddb8e1aec3b8707db31ed244758c242672:/docs/latex/wx/richtextbuffer.tex diff --git a/docs/latex/wx/richtextbuffer.tex b/docs/latex/wx/richtextbuffer.tex index 4140882573..76b48fc6d3 100644 --- a/docs/latex/wx/richtextbuffer.tex +++ b/docs/latex/wx/richtextbuffer.tex @@ -10,11 +10,15 @@ wxRichTextParagraphLayoutBox +\wxheading{Library} + +\helpref{wxRichtext}{librarieslist} + \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}}} @@ -205,7 +209,7 @@ Begins a right indent, specified in tenths of a millimetre. \membersection{wxRichTextBuffer::BeginStyle}\label{wxrichtextbufferbeginstyle} -\func{bool}{BeginStyle}{\param{const wxTextAttrEx\& }{style}} +\func{bool}{BeginStyle}{\param{const wxTextAttr\& }{style}} Begins using a specified style. @@ -311,7 +315,7 @@ Copy the given range to the clipboard. \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. @@ -477,7 +481,7 @@ Finds a handler by filename or, if supplied, type. \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 @@ -499,7 +503,7 @@ initialized. \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). @@ -526,9 +530,7 @@ Returns the object to be used to render certain aspects of the content, such as \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. @@ -538,7 +540,7 @@ or paragraph style alone, use \helpref{GetUncombinedStyle}{wxrichtextbuffergetun \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 @@ -573,9 +575,7 @@ Get the size of the style stack, for example to check correct nesting. \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. @@ -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 +// The point was on space outside content +#define wxRICHTEXT_HITTEST_OUTSIDE 0x10 \end{verbatim} } @@ -743,9 +745,7 @@ Saves content to a file. \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 @@ -754,7 +754,7 @@ style to bold will cause subsequently inserted text to be bold). \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). @@ -790,9 +790,7 @@ overriding one or more virtual functions, and setting an instance of the class u \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. @@ -812,6 +810,7 @@ and not the content. This allows content styling to be preserved independently f \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}