From: Julian Smart Date: Sat, 1 Jul 2006 20:30:58 +0000 (+0000) Subject: First cut at wxRichTextCtrl documentation X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/5f35b46aabdab414602d27bb92034c371bc09d2e 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 --- diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex index f7a2271ebb..4c095c6535 100644 --- a/docs/latex/wx/category.tex +++ b/docs/latex/wx/category.tex @@ -103,6 +103,7 @@ that are not static can have \helpref{validators}{wxvalidator} associated with t \twocolitem{\helpref{wxListCtrl}{wxlistctrl}}{A control for displaying lists of strings and/or icons, plus a multicolumn report view} \twocolitem{\helpref{wxListView}{wxlistview}}{A simpler interface ({\it fa\c{c}ade} for wxListCtrl in report mode} \twocolitem{\helpref{wxOwnerDrawnComboBox}{wxownerdrawncombobox}}{A combobox with owner-drawn list items} +\twocolitem{\helpref{wxRichTextCtrl}{wxrichtextctrl}}{Generic rich text editing control} \twocolitem{\helpref{wxTextCtrl}{wxtextctrl}}{Single or multiline text editing control} \twocolitem{\helpref{wxTreeCtrl}{wxtreectrl}}{Tree (hierarchy) control} \twocolitem{\helpref{wxScrollBar}{wxscrollbar}}{Scrollbar control} @@ -263,6 +264,7 @@ An event object contains information about a specific event. Event handlers \twocolitem{\helpref{wxPaintEvent}{wxpaintevent}}{A paint event} \twocolitem{\helpref{wxProcessEvent}{wxprocessevent}}{A process ending event} \twocolitem{\helpref{wxQueryLayoutInfoEvent}{wxquerylayoutinfoevent}}{Used to query layout information} +\twocolitem{\helpref{wxRichTextEvent}{wxrichtextevent}}{A rich text editing event} \twocolitem{\helpref{wxScrollEvent}{wxscrollevent}}{A scroll event from sliders, stand-alone scrollbars and spin buttons} \twocolitem{\helpref{wxScrollWinEvent}{wxscrollwinevent}}{A scroll event from scrolled windows} \twocolitem{\helpref{wxSizeEvent}{wxsizeevent}}{A size event} diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex index 94fe59bc49..30138b1fb6 100644 --- a/docs/latex/wx/classes.tex +++ b/docs/latex/wx/classes.tex @@ -285,6 +285,21 @@ \input regkey.tex \input renderer.tex \input rendver.tex + +\input richtextattr.tex +\input richtextbuffer.tex +\input richtextcharacterstyledefinition.tex +\input richtextctrl.tex +\input richtextevent.tex +\input richtextfilehandler.tex +\input richtexthtmlhandler.tex +\input richtextparagraphstyledefinition.tex +\input richtextrange.tex +\input richtextstyledefinition.tex +\input richtextstylelistbox.tex +\input richtextstylesheet.tex +\input richtextxmlhandler.tex + \input sashevt.tex \input sashlayw.tex \input sashwin.tex @@ -346,6 +361,8 @@ \input tcpservr.tex \input tempfile.tex \input tempfilestrm.tex +\input textattr.tex +\input textattrex.tex \input text.tex \input txtdatob.tex \input txtdrptg.tex diff --git a/docs/latex/wx/dcclipper.tex b/docs/latex/wx/dcclipper.tex index e5dfdce39e..9c43cf2a10 100644 --- a/docs/latex/wx/dcclipper.tex +++ b/docs/latex/wx/dcclipper.tex @@ -60,4 +60,3 @@ and size (\arg{w} ad \arg{h}). The clipping region is automatically unset when this object is destroyed. - diff --git a/docs/latex/wx/richtextattr.tex b/docs/latex/wx/richtextattr.tex new file mode 100644 index 0000000000..dad254d20c --- /dev/null +++ b/docs/latex/wx/richtextattr.tex @@ -0,0 +1,640 @@ +\section{\class{wxRichTextAttr}}\label{wxrichtextattr} + +wxRichTextAttr represents the character and paragraph attributes, or style, +for a range of text in a \helpref{wxRichTextCtrl}{wxrichtextctrl}. This class +is specific to wxRichTextCtrl, although you can also use the +standard \helpref{wxTextAttr}{wxtextattr} class with wxRichTextCtrl. + +When setting up a wxRichTextAttr object, pass a bitlist mask to \helpref{SetFlags}{wxrichtextattrsetflags} to +indicate which style elements should be changed. As a convenience, when you call a setter such +s SetFont, the relevant bit will be set. + +wxRichTextAttr stores attributes without a wxFont object, so is a much more +efficient way to query styles than using a \helpref{wxTextAttr}{wxtextattr} or \helpref{wxTextAttrEx}{wxtextattrex} object. + +\wxheading{Derived from} + +No base class + +\wxheading{Include files} + + + +\wxheading{Constants} + +The following values can be passed to SetAlignment to determine +paragraph alignment. + +{\small +\begin{verbatim} +enum wxTextAttrAlignment +{ + wxTEXT_ALIGNMENT_DEFAULT, + wxTEXT_ALIGNMENT_LEFT, + wxTEXT_ALIGNMENT_CENTRE, + wxTEXT_ALIGNMENT_CENTER = wxTEXT_ALIGNMENT_CENTRE, + wxTEXT_ALIGNMENT_RIGHT, + wxTEXT_ALIGNMENT_JUSTIFIED +}; +\end{verbatim} +} + +These values are passed in a bitlist to SetFlags to determine +what attributes will be considered when setting the attributes +for a text control. + +{\small +\begin{verbatim} +// Standard wxTextAttr constants + +#define wxTEXT_ATTR_TEXT_COLOUR 0x0001 +#define wxTEXT_ATTR_BACKGROUND_COLOUR 0x0002 +#define wxTEXT_ATTR_FONT_FACE 0x0004 +#define wxTEXT_ATTR_FONT_SIZE 0x0008 +#define wxTEXT_ATTR_FONT_WEIGHT 0x0010 +#define wxTEXT_ATTR_FONT_ITALIC 0x0020 +#define wxTEXT_ATTR_FONT_UNDERLINE 0x0040 +#define wxTEXT_ATTR_FONT \ + wxTEXT_ATTR_FONT_FACE | wxTEXT_ATTR_FONT_SIZE | wxTEXT_ATTR_FONT_WEIGHT \ +| wxTEXT_ATTR_FONT_ITALIC | wxTEXT_ATTR_FONT_UNDERLINE +#define wxTEXT_ATTR_ALIGNMENT 0x0080 +#define wxTEXT_ATTR_LEFT_INDENT 0x0100 +#define wxTEXT_ATTR_RIGHT_INDENT 0x0200 +#define wxTEXT_ATTR_TABS 0x0400 + +// Extra formatting flags not in wxTextAttr + +#define wxTEXT_ATTR_PARA_SPACING_AFTER 0x00000800 +#define wxTEXT_ATTR_PARA_SPACING_BEFORE 0x00001000 +#define wxTEXT_ATTR_LINE_SPACING 0x00002000 +#define wxTEXT_ATTR_CHARACTER_STYLE_NAME 0x00004000 +#define wxTEXT_ATTR_PARAGRAPH_STYLE_NAME 0x00008000 +#define wxTEXT_ATTR_BULLET_STYLE 0x00010000 +#define wxTEXT_ATTR_BULLET_NUMBER 0x00020000 +#define wxTEXT_ATTR_BULLET_SYMBOL 0x00040000 +\end{verbatim} +} + +The following styles can be passed to wxRichTextAttr::SetBulletStyle: + +{\small +\begin{verbatim} +#define wxTEXT_ATTR_BULLET_STYLE_NONE 0x0000 +#define wxTEXT_ATTR_BULLET_STYLE_ARABIC 0x0001 +#define wxTEXT_ATTR_BULLET_STYLE_LETTERS_UPPER 0x0002 +#define wxTEXT_ATTR_BULLET_STYLE_LETTERS_LOWER 0x0004 +#define wxTEXT_ATTR_BULLET_STYLE_ROMAN_UPPER 0x0008 +#define wxTEXT_ATTR_BULLET_STYLE_ROMAN_LOWER 0x0010 +#define wxTEXT_ATTR_BULLET_STYLE_SYMBOL 0x0020 +#define wxTEXT_ATTR_BULLET_STYLE_BITMAP 0x0040 +#define wxTEXT_ATTR_BULLET_STYLE_PARENTHESES 0x0080 +#define wxTEXT_ATTR_BULLET_STYLE_PERIOD 0x0100 +\end{verbatim} +} + +The following constants can be passed to wxRichTextAttr::SetLineSpacing: + +{\small +\begin{verbatim} +#define wxTEXT_ATTR_LINE_SPACING_NORMAL 10 +#define wxTEXT_ATTR_LINE_SPACING_HALF 15 +#define wxTEXT_ATTR_LINE_SPACING_TWICE 20 +\end{verbatim} +} + +\wxheading{See also} + +\helpref{wxTextAttr}{wxtextattr}, \helpref{wxTextAttrEx}{wxtextattrex}, \helpref{wxRichTextCtrl}{wxrichtextctrl} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxRichTextAttr::wxRichTextAttr}\label{wxrichtextattrwxrichtextattr} + +\func{}{wxRichTextAttr}{\void} + +\func{}{wxRichTextAttr}{\param{const wxColour\& }{colText}, \param{const wxColour\& }{colBack = wxNullColour}, \param{wxTextAttrAlignment }{alignment = wxTEXT\_ALIGNMENT\_DEFAULT}} + +\func{}{wxRichTextAttr}{\param{const wxTextAttrEx\& }{attr}} + +Constructors. + +\membersection{wxRichTextAttr::CopyTo}\label{wxrichtextattrcopyto} + +\constfunc{void}{CopyTo}{\param{wxTextAttrEx\& }{attr}} + +Copies the wxRichTextAttr attributes to a \helpref{wxTextAttrEx}{wxtextattrex} object. + +\membersection{wxRichTextAttr::CreateFont}\label{wxrichtextattrcreatefont} + +\constfunc{wxFont}{CreateFont}{\void} + +Creates a font from the font attributes. + +\membersection{wxRichTextAttr::GetAlignment}\label{wxrichtextattrgetalignment} + +\constfunc{wxTextAttrAlignment}{GetAlignment}{\void} + +Returns the alignment flags. +See \helpref{wxRichTextAttr::SetAlignment}{wxrichtextattrsetalignment} for a list of available styles. + +\membersection{wxRichTextAttr::GetBackgroundColour}\label{wxrichtextattrgetbackgroundcolour} + +\constfunc{const wxColour\&}{GetBackgroundColour}{\void} + +Returns the background colour. + +\membersection{wxRichTextAttr::GetBulletNumber}\label{wxrichtextattrgetbulletnumber} + +\constfunc{int}{GetBulletNumber}{\void} + +Returns the bullet number. + +\membersection{wxRichTextAttr::GetBulletStyle}\label{wxrichtextattrgetbulletstyle} + +\constfunc{int}{GetBulletStyle}{\void} + +Returns the bullet style. +See \helpref{wxRichTextAttr::SetBulletStyle}{wxrichtextattrsetbulletstyle} for a list of available styles. + +\membersection{wxRichTextAttr::GetBulletSymbol}\label{wxrichtextattrgetbulletsymbol} + +\constfunc{wxChar}{GetBulletSymbol}{\void} + +Returns the bullet symbol, a character. + +\membersection{wxRichTextAttr::GetCharacterStyleName}\label{wxrichtextattrgetcharacterstylename} + +\constfunc{const wxString\&}{GetCharacterStyleName}{\void} + +Returns the name of the character style. + +\membersection{wxRichTextAttr::GetFlags}\label{wxrichtextattrgetflags} + +\constfunc{long}{GetFlags}{\void} + +Returns flags indicating which attributes are applicable. +See \helpref{wxRichTextAttr::SetFlags}{wxrichtextattrsetflags} for a list of available flags. + +\membersection{wxRichTextAttr::GetFontAttributes}\label{wxrichtextattrgetfontattributes} + +\func{bool}{GetFontAttributes}{\param{const wxFont\& }{font}} + +Sets the font attributes from the given font. + +\membersection{wxRichTextAttr::GetFontFaceName}\label{wxrichtextattrgetfontfacename} + +\constfunc{const wxString\&}{GetFontFaceName}{\void} + +Returns the font face name. + +\membersection{wxRichTextAttr::GetFontSize}\label{wxrichtextattrgetfontsize} + +\constfunc{int}{GetFontSize}{\void} + +Returns the font size in points. + +\membersection{wxRichTextAttr::GetFontStyle}\label{wxrichtextattrgetfontstyle} + +\constfunc{int}{GetFontStyle}{\void} + +Returns the font style. + +\membersection{wxRichTextAttr::GetFontUnderlined}\label{wxrichtextattrgetfontunderlined} + +\constfunc{bool}{GetFontUnderlined}{\void} + +Returns \true if the font is underlined. + +\membersection{wxRichTextAttr::GetFontWeight}\label{wxrichtextattrgetfontweight} + +\constfunc{int}{GetFontWeight}{\void} + +Returns the font weight. + +\membersection{wxRichTextAttr::GetLeftIndent}\label{wxrichtextattrgetleftindent} + +\constfunc{long}{GetLeftIndent}{\void} + +Returns the left indent in tenths of a millimetre. + +\membersection{wxRichTextAttr::GetLeftSubIndent}\label{wxrichtextattrgetleftsubindent} + +\constfunc{long}{GetLeftSubIndent}{\void} + +Returns the left sub-indent in tenths of a millimetre. + +\membersection{wxRichTextAttr::GetLineSpacing}\label{wxrichtextattrgetlinespacing} + +\constfunc{int}{GetLineSpacing}{\void} + +Returns the line spacing value, one of wxTEXT\_ATTR\_LINE\_SPACING\_NORMAL, +wxTEXT\_ATTR\_LINE\_SPACING\_HALF, and wxTEXT\_ATTR\_LINE\_SPACING\_TWICE. + +\membersection{wxRichTextAttr::GetParagraphSpacingAfter}\label{wxrichtextattrgetparagraphspacingafter} + +\constfunc{int}{GetParagraphSpacingAfter}{\void} + +Returns the space in tenths of a millimeter after the paragraph. + +\membersection{wxRichTextAttr::GetParagraphSpacingBefore}\label{wxrichtextattrgetparagraphspacingbefore} + +\constfunc{int}{GetParagraphSpacingBefore}{\void} + +Returns the space in tenths of a millimeter before the paragraph. + +\membersection{wxRichTextAttr::GetParagraphStyleName}\label{wxrichtextattrgetparagraphstylename} + +\constfunc{const wxString\&}{GetParagraphStyleName}{\void} + +Returns the name of the paragraph style. + +\membersection{wxRichTextAttr::GetRightIndent}\label{wxrichtextattrgetrightindent} + +\constfunc{long}{GetRightIndent}{\void} + +Returns the right indent in tenths of a millimeter. + +\membersection{wxRichTextAttr::GetTabs}\label{wxrichtextattrgettabs} + +\constfunc{const wxArrayInt\&}{GetTabs}{\void} + +Returns an array of tab stops, each expressed in tenths of a millimeter. Each stop +is measured from the left margin and therefore each value must be larger than the last. + +\membersection{wxRichTextAttr::GetTextColour}\label{wxrichtextattrgettextcolour} + +\constfunc{const wxColour\&}{GetTextColour}{\void} + +Returns the text foreground colour. + +\membersection{wxRichTextAttr::HasAlignment}\label{wxrichtextattrhasalignment} + +\constfunc{bool}{HasAlignment}{\void} + +Returns \true if the attribute object specifies alignment. + +\membersection{wxRichTextAttr::HasBackgroundColour}\label{wxrichtextattrhasbackgroundcolour} + +\constfunc{bool}{HasBackgroundColour}{\void} + +Returns \true if the attribute object specifies a background colour. + +\membersection{wxRichTextAttr::HasBulletNumber}\label{wxrichtextattrhasbulletnumber} + +\constfunc{bool}{HasBulletNumber}{\void} + +Returns \true if the attribute object specifies a bullet number. + +\membersection{wxRichTextAttr::HasBulletStyle}\label{wxrichtextattrhasbulletstyle} + +\constfunc{bool}{HasBulletStyle}{\void} + +Returns \true if the attribute object specifies a bullet style. + +\membersection{wxRichTextAttr::HasBulletSymbol}\label{wxrichtextattrhasbulletsymbol} + +\constfunc{bool}{HasBulletSymbol}{\void} + +Returns \true if the attribute object specifies a bullet symbol. + +\membersection{wxRichTextAttr::HasCharacterStyleName}\label{wxrichtextattrhascharacterstylename} + +\constfunc{bool}{HasCharacterStyleName}{\void} + +Returns \true if the attribute object specifies a character style name. + +\membersection{wxRichTextAttr::HasFaceName}\label{wxrichtextattrhasfacename} + +\constfunc{bool}{HasFaceName}{\void} + +Returns \true if the attribute object specifies a font face name. + +\membersection{wxRichTextAttr::HasFlag}\label{wxrichtextattrhasflag} + +\constfunc{bool}{HasFlag}{\param{long }{flag}} + +Returns \true if the {\it flag} is present in the attribute object's flag bitlist. + +\membersection{wxRichTextAttr::HasFont}\label{wxrichtextattrhasfont} + +\constfunc{bool}{HasFont}{\void} + +Returns \true if the attribute object specifies any font attributes. + +\membersection{wxRichTextAttr::HasItalic}\label{wxrichtextattrhasitalic} + +\constfunc{bool}{HasItalic}{\void} + +Returns \true if the attribute object specifies italic style. + +\membersection{wxRichTextAttr::HasLeftIndent}\label{wxrichtextattrhasleftindent} + +\constfunc{bool}{HasLeftIndent}{\void} + +Returns \true if the attribute object specifies a left indent. + +\membersection{wxRichTextAttr::HasLineSpacing}\label{wxrichtextattrhaslinespacing} + +\constfunc{bool}{HasLineSpacing}{\void} + +Returns \true if the attribute object specifies line spacing. + +\membersection{wxRichTextAttr::HasParagraphSpacingAfter}\label{wxrichtextattrhasparagraphspacingafter} + +\constfunc{bool}{HasParagraphSpacingAfter}{\void} + +Returns \true if the attribute object specifies spacing after a paragraph. + +\membersection{wxRichTextAttr::HasParagraphSpacingBefore}\label{wxrichtextattrhasparagraphspacingbefore} + +\constfunc{bool}{HasParagraphSpacingBefore}{\void} + +Returns \true if the attribute object specifies spacing before a paragraph. + +\membersection{wxRichTextAttr::HasParagraphStyleName}\label{wxrichtextattrhasparagraphstylename} + +\constfunc{bool}{HasParagraphStyleName}{\void} + +Returns \true if the attribute object specifies a paragraph style name. + +\membersection{wxRichTextAttr::HasRightIndent}\label{wxrichtextattrhasrightindent} + +\constfunc{bool}{HasRightIndent}{\void} + +Returns \true if the attribute object specifies a right indent. + +\membersection{wxRichTextAttr::HasSize}\label{wxrichtextattrhassize} + +\constfunc{bool}{HasSize}{\void} + +Returns \true if the attribute object specifies a font point size. + +\membersection{wxRichTextAttr::HasTabs}\label{wxrichtextattrhastabs} + +\constfunc{bool}{HasTabs}{\void} + +Returns \true if the attribute object specifies tab stops. + +\membersection{wxRichTextAttr::HasTextColour}\label{wxrichtextattrhastextcolour} + +\constfunc{bool}{HasTextColour}{\void} + +Returns \true if the attribute object specifies a text foreground colour. + +\membersection{wxRichTextAttr::HasUnderlined}\label{wxrichtextattrhasunderlined} + +\constfunc{bool}{HasUnderlined}{\void} + +Returns \true if the attribute object specifies either underlining or no underlining. + +\membersection{wxRichTextAttr::HasWeight}\label{wxrichtextattrhasweight} + +\constfunc{bool}{HasWeight}{\void} + +Returns \true if the attribute object specifies font weight (bold, light or normal). + +\membersection{wxRichTextAttr::Init}\label{wxrichtextattrinit} + +\func{void}{Init}{\void} + +Initialise the object. + +\membersection{wxRichTextAttr::IsCharacterStyle}\label{wxrichtextattrischaracterstyle} + +\constfunc{bool}{IsCharacterStyle}{\void} + +Returns \true if the object represents a character style, that is, +the flags specify a font or a text background or foreground colour. + +\membersection{wxRichTextAttr::IsDefault}\label{wxrichtextattrisdefault} + +\constfunc{bool}{IsDefault}{\void} + +Returns \false if we have any attributes set, \true otherwise. + +\membersection{wxRichTextAttr::IsParagraphStyle}\label{wxrichtextattrisparagraphstyle} + +\constfunc{bool}{IsParagraphStyle}{\void} + +Returns \true if the object represents a paragraph style, that is, +the flags specify alignment, indentation, tabs, paragraph spacing, or +bullet style. + +\membersection{wxRichTextAttr::SetAlignment}\label{wxrichtextattrsetalignment} + +\func{void}{SetAlignment}{\param{wxTextAttrAlignment }{alignment}} + +Sets the paragraph alignment. These are the possible values for {\it alignment}: + +{\small +\begin{verbatim} +enum wxTextAttrAlignment +{ + wxTEXT_ALIGNMENT_DEFAULT, + wxTEXT_ALIGNMENT_LEFT, + wxTEXT_ALIGNMENT_CENTRE, + wxTEXT_ALIGNMENT_CENTER = wxTEXT_ALIGNMENT_CENTRE, + wxTEXT_ALIGNMENT_RIGHT, + wxTEXT_ALIGNMENT_JUSTIFIED +}; +\end{verbatim} +} + +\membersection{wxRichTextAttr::SetBackgroundColour}\label{wxrichtextattrsetbackgroundcolour} + +\func{void}{SetBackgroundColour}{\param{const wxColour\& }{colBack}} + +Sets the background colour. + +\membersection{wxRichTextAttr::SetBulletNumber}\label{wxrichtextattrsetbulletnumber} + +\func{void}{SetBulletNumber}{\param{int }{n}} + +Sets the bullet number. + +\membersection{wxRichTextAttr::SetBulletStyle}\label{wxrichtextattrsetbulletstyle} + +\func{void}{SetBulletStyle}{\param{int }{style}} + +Sets the bullet style. The following styles can be passed: + +{\small +\begin{verbatim} +#define wxTEXT_ATTR_BULLET_STYLE_NONE 0x0000 +#define wxTEXT_ATTR_BULLET_STYLE_ARABIC 0x0001 +#define wxTEXT_ATTR_BULLET_STYLE_LETTERS_UPPER 0x0002 +#define wxTEXT_ATTR_BULLET_STYLE_LETTERS_LOWER 0x0004 +#define wxTEXT_ATTR_BULLET_STYLE_ROMAN_UPPER 0x0008 +#define wxTEXT_ATTR_BULLET_STYLE_ROMAN_LOWER 0x0010 +#define wxTEXT_ATTR_BULLET_STYLE_SYMBOL 0x0020 +#define wxTEXT_ATTR_BULLET_STYLE_BITMAP 0x0040 +#define wxTEXT_ATTR_BULLET_STYLE_PARENTHESES 0x0080 +#define wxTEXT_ATTR_BULLET_STYLE_PERIOD 0x0100 +\end{verbatim} +} + +\membersection{wxRichTextAttr::SetBulletSymbol}\label{wxrichtextattrsetbulletsymbol} + +\func{void}{SetBulletSymbol}{\param{wxChar }{symbol}} + +Sets the paragraph symbol. + +\membersection{wxRichTextAttr::SetCharacterStyleName}\label{wxrichtextattrsetcharacterstylename} + +\func{void}{SetCharacterStyleName}{\param{const wxString\& }{name}} + +Sets the character style name. + +\membersection{wxRichTextAttr::SetFlags}\label{wxrichtextattrsetflags} + +\func{void}{SetFlags}{\param{long }{flags}} + +Sets the flags determining which styles are being specified. The following +flags can be passed in a bitlist: + +{\small +\begin{verbatim} +// Standard wxTextAttr constants + +#define wxTEXT_ATTR_TEXT_COLOUR 0x0001 +#define wxTEXT_ATTR_BACKGROUND_COLOUR 0x0002 +#define wxTEXT_ATTR_FONT_FACE 0x0004 +#define wxTEXT_ATTR_FONT_SIZE 0x0008 +#define wxTEXT_ATTR_FONT_WEIGHT 0x0010 +#define wxTEXT_ATTR_FONT_ITALIC 0x0020 +#define wxTEXT_ATTR_FONT_UNDERLINE 0x0040 +#define wxTEXT_ATTR_FONT \ + wxTEXT_ATTR_FONT_FACE | wxTEXT_ATTR_FONT_SIZE | wxTEXT_ATTR_FONT_WEIGHT \ +| wxTEXT_ATTR_FONT_ITALIC | wxTEXT_ATTR_FONT_UNDERLINE +#define wxTEXT_ATTR_ALIGNMENT 0x0080 +#define wxTEXT_ATTR_LEFT_INDENT 0x0100 +#define wxTEXT_ATTR_RIGHT_INDENT 0x0200 +#define wxTEXT_ATTR_TABS 0x0400 + +// Extra formatting flags not in wxTextAttr + +#define wxTEXT_ATTR_PARA_SPACING_AFTER 0x00000800 +#define wxTEXT_ATTR_PARA_SPACING_BEFORE 0x00001000 +#define wxTEXT_ATTR_LINE_SPACING 0x00002000 +#define wxTEXT_ATTR_CHARACTER_STYLE_NAME 0x00004000 +#define wxTEXT_ATTR_PARAGRAPH_STYLE_NAME 0x00008000 +#define wxTEXT_ATTR_BULLET_STYLE 0x00010000 +#define wxTEXT_ATTR_BULLET_NUMBER 0x00020000 +#define wxTEXT_ATTR_BULLET_SYMBOL 0x00040000 +\end{verbatim} +} + +\membersection{wxRichTextAttr::SetFontFaceName}\label{wxrichtextattrsetfontfacename} + +\func{void}{SetFontFaceName}{\param{const wxString\& }{faceName}} + +Sets the paragraph alignment. + +\membersection{wxRichTextAttr::SetFontSize}\label{wxrichtextattrsetfontsize} + +\func{void}{SetFontSize}{\param{int }{pointSize}} + +Sets the font size in points. + +\membersection{wxRichTextAttr::SetFontStyle}\label{wxrichtextattrsetfontstyle} + +\func{void}{SetFontStyle}{\param{int }{fontStyle}} + +Sets the font style (normal, italic or slanted). + +\membersection{wxRichTextAttr::SetFontUnderlined}\label{wxrichtextattrsetfontunderlined} + +\func{void}{SetFontUnderlined}{\param{bool }{underlined}} + +Sets the font underlining. + +\membersection{wxRichTextAttr::SetFontWeight}\label{wxrichtextattrsetfontweight} + +\func{void}{SetFontWeight}{\param{int }{fontWeight}} + +Sets the font weight. + +\membersection{wxRichTextAttr::SetLeftIndent}\label{wxrichtextattrsetleftindent} + +\func{void}{SetLeftIndent}{\param{int }{indent}, \param{int }{subIndent = 0}} + +Sets the left indent and left subindent in tenths of a millimetre. + +The sub-indent is an offset from the left of the paragraph, and is used for all but the +first line in a paragraph. A positive value will cause the first line to appear to the left +of the subsequent lines, and a negative value will cause the first line to be indented +relative to the subsequent lines. + +wxRichTextBuffer uses indentation to render a bulleted item. The left indent is the distance between +the margin and the bullet. The content of the paragraph, including the first line, starts +at leftMargin + leftSubIndent. So the distance between the left edge of the bullet and the +left of the actual paragraph is leftSubIndent. + +\membersection{wxRichTextAttr::SetLineSpacing}\label{wxrichtextattrsetlinespacing} + +\func{void}{SetLineSpacing}{\param{int }{spacing}} + +Sets the line spacing. {\it spacing} is a multiple, where 10 means single-spacing, +15 means 1.5 spacing, and 20 means double spacing. The following constants are +defined for convenience: + +{\small +\begin{verbatim} +#define wxTEXT_ATTR_LINE_SPACING_NORMAL 10 +#define wxTEXT_ATTR_LINE_SPACING_HALF 15 +#define wxTEXT_ATTR_LINE_SPACING_TWICE 20 +\end{verbatim} +} + +\membersection{wxRichTextAttr::SetParagraphSpacingAfter}\label{wxrichtextattrsetparagraphspacingafter} + +\func{void}{SetParagraphSpacingAfter}{\param{int }{spacing}} + +Sets the spacing after a paragraph, in tenths of a millimetre. + +\membersection{wxRichTextAttr::SetParagraphSpacingBefore}\label{wxrichtextattrsetparagraphspacingbefore} + +\func{void}{SetParagraphSpacingBefore}{\param{int }{spacing}} + +Sets the spacing before a paragraph, in tenths of a millimetre. + +\membersection{wxRichTextAttr::SetParagraphStyleName}\label{wxrichtextattrsetparagraphstylename} + +\func{void}{SetParagraphStyleName}{\param{const wxString\& }{name}} + +Sets the name of the paragraph style. + +\membersection{wxRichTextAttr::SetRightIndent}\label{wxrichtextattrsetrightindent} + +\func{void}{SetRightIndent}{\param{int }{indent}} + +Sets the right indent in tenths of a millimetre. + +\membersection{wxRichTextAttr::SetTabs}\label{wxrichtextattrsettabs} + +\func{void}{SetTabs}{\param{const wxArrayInt\& }{tabs}} + +Sets the tab stops, expressed in tenths of a millimetre. +Each stop is measured from the left margin and therefore each value must be larger than the last. + +\membersection{wxRichTextAttr::SetTextColour}\label{wxrichtextattrsettextcolour} + +\func{void}{SetTextColour}{\param{const wxColour\& }{colText}} + +Sets the text foreground colout. + +\membersection{wxRichTextAttr::operator=}\label{wxrichtextattroperatorassign} + +\func{void operator}{operator=}{\param{const wxTextAttrEx\& }{attr}} + +Assignment from a \helpref{wxTextAttrEx}{wxtextattr} object. + +\func{void operator}{operator=}{\param{const wxRichTextAttr\& }{attr}} + +Assignment from a \helpref{wxRichTextAttr}{wxrichtextattr} object. + +\membersection{wxRichTextAttr::wxTextAttrEx}\label{wxrichtextattrwxtextattrex} + +\constfunc{operator}{wxTextAttrEx}{\void} + +Makes a \helpref{wxTextAttrEx}{wxtextattrex} object from this object. diff --git a/docs/latex/wx/richtextbuffer.tex b/docs/latex/wx/richtextbuffer.tex new file mode 100644 index 0000000000..bcefb8c2f7 --- /dev/null +++ b/docs/latex/wx/richtextbuffer.tex @@ -0,0 +1,573 @@ +\section{\class{wxRichTextBuffer}}\label{wxrichtextbuffer} + +This class represents the whole buffer associated with a \helpref{wxRichTextCtrl}{wxrichtextctrl}. + +\wxheading{Derived from} + +wxRichTextParagraphLayoutBox + +\wxheading{Include files} + + + +\wxheading{Data structures} + +\wxheading{See also} + +\helpref{wxTextAttr}{wxtextattr}, \helpref{wxTextAttrEx}{wxtextattrex}, \helpref{wxRichTextAttr}{wxrichtextattr}, \helpref{wxRichTextCtrl}{wxrichtextctrl} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxRichTextBuffer::wxRichTextBuffer}\label{wxrichtextbufferwxrichtextbuffer} + +\func{}{wxRichTextBuffer}{\param{const wxRichTextBuffer\& }{obj}} + +Copy constructor. + +\func{}{wxRichTextBuffer}{\void} + +Default constructors. + +\membersection{wxRichTextBuffer::\destruct{wxRichTextBuffer}}\label{wxrichtextbufferdtor} + +\func{}{\destruct{wxRichTextBuffer}}{\void} + +Destructor. + +\membersection{wxRichTextBuffer::AddHandler}\label{wxrichtextbufferaddhandler} + +\func{void}{AddHandler}{\param{wxRichTextFileHandler* }{handler}} + +Adds a file handler. + +\membersection{wxRichTextBuffer::AddParagraph}\label{wxrichtextbufferaddparagraph} + +\func{wxRichTextRange}{AddParagraph}{\param{const wxString\& }{text}} + +Adds a paragraph of text. + +\membersection{wxRichTextBuffer::BatchingUndo}\label{wxrichtextbufferbatchingundo} + +\constfunc{bool}{BatchingUndo}{\void} + +Returns \true if the buffer is currently collapsing commands into a single notional command. + +\membersection{wxRichTextBuffer::BeginAlignment}\label{wxrichtextbufferbeginalignment} + +\func{bool}{BeginAlignment}{\param{wxTextAttrAlignment }{alignment}} + +Begins using alignment. + +\membersection{wxRichTextBuffer::BeginBatchUndo}\label{wxrichtextbufferbeginbatchundo} + +\func{bool}{BeginBatchUndo}{\param{const wxString\& }{cmdName}} + +Begins collapsing undo/redo commands. Note that this may not work properly +if combining commands that delete or insert content, changing ranges for +subsequent actions. + +{\it cmdName} should be the name of the combined command that will appear +next to Undo and Redo in the edit menu. + +\membersection{wxRichTextBuffer::BeginBold}\label{wxrichtextbufferbeginbold} + +\func{bool}{BeginBold}{\void} + +Begin applying bold. + +\membersection{wxRichTextBuffer::BeginCharacterStyle}\label{wxrichtextbufferbegincharacterstyle} + +\func{bool}{BeginCharacterStyle}{\param{const wxString\& }{characterStyle}} + +Begins applying the named character style. + +\membersection{wxRichTextBuffer::BeginFont}\label{wxrichtextbufferbeginfont} + +\func{bool}{BeginFont}{\param{const wxFont\& }{font}} + +Begins using this font. + +\membersection{wxRichTextBuffer::BeginFontSize}\label{wxrichtextbufferbeginfontsize} + +\func{bool}{BeginFontSize}{\param{int }{pointSize}} + +Begins using the given point size. + +\membersection{wxRichTextBuffer::BeginItalic}\label{wxrichtextbufferbeginitalic} + +\func{bool}{BeginItalic}{\void} + +Begins using italic. + +\membersection{wxRichTextBuffer::BeginLeftIndent}\label{wxrichtextbufferbeginleftindent} + +\func{bool}{BeginLeftIndent}{\param{int }{leftIndent}, \param{int }{leftSubIndent = 0}} + +Begin using {\it leftIndent} for the left indent, and optionally {\it leftSubIndent} for +the sub-indent. Both are expressed in tenths of a millimetre. + +The sub-indent is an offset from the left of the paragraph, and is used for all but the +first line in a paragraph. A positive value will cause the first line to appear to the left +of the subsequent lines, and a negative value will cause the first line to be indented +relative to the subsequent lines. + +\membersection{wxRichTextBuffer::BeginLineSpacing}\label{wxrichtextbufferbeginlinespacing} + +\func{bool}{BeginLineSpacing}{\param{int }{lineSpacing}} + +Begins line spacing using the specified value. {\it spacing} is a multiple, where 10 means single-spacing, +15 means 1.5 spacing, and 20 means double spacing. The following constants are +defined for convenience: + +{\small +\begin{verbatim} +#define wxTEXT_ATTR_LINE_SPACING_NORMAL 10 +#define wxTEXT_ATTR_LINE_SPACING_HALF 15 +#define wxTEXT_ATTR_LINE_SPACING_TWICE 20 +\end{verbatim} +} + +\membersection{wxRichTextBuffer::BeginNumberedBullet}\label{wxrichtextbufferbeginnumberedbullet} + +\func{bool}{BeginNumberedBullet}{\param{int }{bulletNumber}, \param{int }{leftIndent}, \param{int }{leftSubIndent}, \param{int }{bulletStyle = wxTEXT\_ATTR\_BULLET\_STYLE\_ARABIC|wxTEXT\_ATTR\_BULLET\_STYLE\_PERIOD}} + +Begins a numbered bullet. This call will be needed for each item in the list, and the +application should take care of incrementing the numbering. + +{\it bulletNumber} is a number, usually starting with 1. + +{\it leftIndent} and {\it leftSubIndent} are values in tenths of a millimetre. + +{\it bulletStyle} is a bitlist of the following values: + +{\small +\begin{verbatim} +#define wxTEXT_ATTR_BULLET_STYLE_NONE 0x0000 +#define wxTEXT_ATTR_BULLET_STYLE_ARABIC 0x0001 +#define wxTEXT_ATTR_BULLET_STYLE_LETTERS_UPPER 0x0002 +#define wxTEXT_ATTR_BULLET_STYLE_LETTERS_LOWER 0x0004 +#define wxTEXT_ATTR_BULLET_STYLE_ROMAN_UPPER 0x0008 +#define wxTEXT_ATTR_BULLET_STYLE_ROMAN_LOWER 0x0010 +#define wxTEXT_ATTR_BULLET_STYLE_SYMBOL 0x0020 +#define wxTEXT_ATTR_BULLET_STYLE_BITMAP 0x0040 +#define wxTEXT_ATTR_BULLET_STYLE_PARENTHESES 0x0080 +#define wxTEXT_ATTR_BULLET_STYLE_PERIOD 0x0100 +\end{verbatim} +} + +wxRichTextBuffer uses indentation to render a bulleted item. The left indent is the distance between +the margin and the bullet. The content of the paragraph, including the first line, starts +at leftMargin + leftSubIndent. So the distance between the left edge of the bullet and the +left of the actual paragraph is leftSubIndent. + +\membersection{wxRichTextBuffer::BeginParagraphSpacing}\label{wxrichtextbufferbeginparagraphspacing} + +\func{bool}{BeginParagraphSpacing}{\param{int }{before}, \param{int }{after}} + +Begins paragraph spacing; pass the before-paragraph and after-paragraph spacing in tenths of +a millimetre. + +\membersection{wxRichTextBuffer::BeginParagraphStyle}\label{wxrichtextbufferbeginparagraphstyle} + +\func{bool}{BeginParagraphStyle}{\param{const wxString\& }{paragraphStyle}} + +Begins applying the named paragraph style. + +\membersection{wxRichTextBuffer::BeginRightIndent}\label{wxrichtextbufferbeginrightindent} + +\func{bool}{BeginRightIndent}{\param{int }{rightIndent}} + +Begins a right indent, specified in tenths of a millimetre. + +\membersection{wxRichTextBuffer::BeginStyle}\label{wxrichtextbufferbeginstyle} + +\func{bool}{BeginStyle}{\param{const wxTextAttrEx\& }{style}} + +Begins using a specified style. + +\membersection{wxRichTextBuffer::BeginSuppressUndo}\label{wxrichtextbufferbeginsuppressundo} + +\func{bool}{BeginSuppressUndo}{\void} + +Begins suppressing undo/redo commands. The way undo is suppressed may be implemented +differently by each command. If not dealt with by a command implementation, then +it will be implemented automatically by not storing the command in the undo history +when the action is submitted to the command processor. + +\membersection{wxRichTextBuffer::BeginSymbolBullet}\label{wxrichtextbufferbeginsymbolbullet} + +\func{bool}{BeginSymbolBullet}{\param{wxChar }{symbol}, \param{int }{leftIndent}, \param{int }{leftSubIndent}, \param{int }{bulletStyle = wxTEXT\_ATTR\_BULLET\_STYLE\_SYMBOL}} + +Begins applying a symbol bullet, using a character from the current font. See \helpref{BeginNumberedBullet}{wxrichtextbufferbeginnumberedbullet} for +an explanation of how indentation is used to render the bulleted paragraph. + +\membersection{wxRichTextBuffer::BeginTextColour}\label{wxrichtextbufferbegintextcolour} + +\func{bool}{BeginTextColour}{\param{const wxColour\& }{colour}} + +Begins using the specified text foreground colour. + +\membersection{wxRichTextBuffer::BeginUnderline}\label{wxrichtextbufferbeginunderline} + +\func{bool}{BeginUnderline}{\void} + +Begins using underline. + +\membersection{wxRichTextBuffer::CanPasteFromClipboard}\label{wxrichtextbuffercanpastefromclipboard} + +\constfunc{bool}{CanPasteFromClipboard}{\void} + +Returns \true if content can be pasted from the clipboard. + +\membersection{wxRichTextBuffer::CleanUpHandlers}\label{wxrichtextbuffercleanuphandlers} + +\func{void}{CleanUpHandlers}{\void} + +Cleans up the file handlers. + +\membersection{wxRichTextBuffer::Clear}\label{wxrichtextbufferclear} + +\func{void}{Clear}{\void} + +Clears the buffer and resets the command processor. + +\membersection{wxRichTextBuffer::ClearStyleStack}\label{wxrichtextbufferclearstylestack} + +\func{void}{ClearStyleStack}{\void} + +Clears the style stack. + +\membersection{wxRichTextBuffer::Clone}\label{wxrichtextbufferclone} + +\constfunc{wxRichTextObject*}{Clone}{\void} + +Clones the object. + +\membersection{wxRichTextBuffer::Copy}\label{wxrichtextbuffercopy} + +\func{void}{Copy}{\param{const wxRichTextBuffer\& }{obj}} + +Copies the given buffer. + +\membersection{wxRichTextBuffer::CopyToClipboard}\label{wxrichtextbuffercopytoclipboard} + +\func{bool}{CopyToClipboard}{\param{const wxRichTextRange\& }{range}} + +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}} + +Submits a command to delete the given range. + +\membersection{wxRichTextBuffer::Dump}\label{wxrichtextbufferdump} + +\func{void}{Dump}{\void} + +\func{void}{Dump}{\param{wxTextOutputStream\& }{stream}} + +Dumps the contents of the buffer for debugging purposes. + +\membersection{wxRichTextBuffer::EndAlignment}\label{wxrichtextbufferendalignment} + +\func{bool}{EndAlignment}{\void} + +Ends alignment. + +\membersection{wxRichTextBuffer::EndAllStyles}\label{wxrichtextbufferendallstyles} + +\func{bool}{EndAllStyles}{\void} + +Ends all styles that have been started with a Begin... command. + +\membersection{wxRichTextBuffer::EndBatchUndo}\label{wxrichtextbufferendbatchundo} + +\func{bool}{EndBatchUndo}{\void} + +Ends collapsing undo/redo commands, and submits the combined command. + +\membersection{wxRichTextBuffer::EndBold}\label{wxrichtextbufferendbold} + +\func{bool}{EndBold}{\void} + +Ends using bold. + +\membersection{wxRichTextBuffer::EndCharacterStyle}\label{wxrichtextbufferendcharacterstyle} + +\func{bool}{EndCharacterStyle}{\void} + +Ends using the named character style. + +\membersection{wxRichTextBuffer::EndFont}\label{wxrichtextbufferendfont} + +\func{bool}{EndFont}{\void} + +Ends using a font. + +\membersection{wxRichTextBuffer::EndFontSize}\label{wxrichtextbufferendfontsize} + +\func{bool}{EndFontSize}{\void} + +Ends using a point size. + +\membersection{wxRichTextBuffer::EndItalic}\label{wxrichtextbufferenditalic} + +\func{bool}{EndItalic}{\void} + +Ends using italic. + +\membersection{wxRichTextBuffer::EndLeftIndent}\label{wxrichtextbufferendleftindent} + +\func{bool}{EndLeftIndent}{\void} + +Ends using a left indent. + +\membersection{wxRichTextBuffer::EndLineSpacing}\label{wxrichtextbufferendlinespacing} + +\func{bool}{EndLineSpacing}{\void} + +Ends using a line spacing. + +\membersection{wxRichTextBuffer::EndNumberedBullet}\label{wxrichtextbufferendnumberedbullet} + +\func{bool}{EndNumberedBullet}{\void} + +Ends a numbered bullet. + +\membersection{wxRichTextBuffer::EndParagraphSpacing}\label{wxrichtextbufferendparagraphspacing} + +\func{bool}{EndParagraphSpacing}{\void} + +Ends paragraph spacing. + +\membersection{wxRichTextBuffer::EndParagraphStyle}\label{wxrichtextbufferendparagraphstyle} + +\func{bool}{EndParagraphStyle}{\void} + +Ends applying a named character style. + +\membersection{wxRichTextBuffer::EndRightIndent}\label{wxrichtextbufferendrightindent} + +\func{bool}{EndRightIndent}{\void} + +Ends using a right indent. + +\membersection{wxRichTextBuffer::EndStyle}\label{wxrichtextbufferendstyle} + +\func{bool}{EndStyle}{\void} + +Ends the current style. + +\membersection{wxRichTextBuffer::EndSuppressUndo}\label{wxrichtextbufferendsuppressundo} + +\func{bool}{EndSuppressUndo}{\void} + +Ends suppressing undo/redo commands. + +\membersection{wxRichTextBuffer::EndSymbolBullet}\label{wxrichtextbufferendsymbolbullet} + +\func{bool}{EndSymbolBullet}{\void} + +Ends using a symbol bullet. + +\membersection{wxRichTextBuffer::EndTextColour}\label{wxrichtextbufferendtextcolour} + +\func{bool}{EndTextColour}{\void} + +Ends using a text foreground colour. + +\membersection{wxRichTextBuffer::EndUnderline}\label{wxrichtextbufferendunderline} + +\func{bool}{EndUnderline}{\void} + +Ends using underline. + +\membersection{wxRichTextBuffer::FindHandler}\label{wxrichtextbufferfindhandler} + +\func{wxRichTextFileHandler*}{FindHandler}{\param{int }{imageType}} + +Finds a handler by type. + +\func{wxRichTextFileHandler*}{FindHandler}{\param{const wxString\& }{extension}, \param{int }{imageType}} + +Finds a handler by extension and type. + +\func{wxRichTextFileHandler*}{FindHandler}{\param{const wxString\& }{name}} + +Finds a handler by name. + +\membersection{wxRichTextBuffer::FindHandlerFilenameOrType}\label{wxrichtextbufferfindhandlerfilenameortype} + +\func{wxRichTextFileHandler*}{FindHandlerFilenameOrType}{\param{const wxString\& }{filename}, \param{int }{imageType}} + +Finds a handler by filename or, if supplied, type. + +\membersection{wxRichTextBuffer::GetBatchedCommand}\label{wxrichtextbuffergetbatchedcommand} + +\constfunc{wxRichTextCommand*}{GetBatchedCommand}{\void} + +Gets the collapsed command. + +\membersection{wxRichTextBuffer::GetCommandProcessor}\label{wxrichtextbuffergetcommandprocessor} + +\constfunc{wxCommandProcessor*}{GetCommandProcessor}{\void} + +Gets the command processor. A text buffer always creates its own command processor when it is +initialized. + +\membersection{wxRichTextBuffer::GetExtWildcard}\label{wxrichtextbuffergetextwildcard} + +\func{wxString}{GetExtWildcard}{\param{bool }{combine = false}, \param{bool }{save = false}, \param{wxArrayInt* }{types = NULL}} + +Gets a wildcard incorporating all visible handlers. If {\it types} is present, +it will be filled with the file type corresponding to each filter. This can be +used to determine the type to pass to \helpref{LoadFile}{wxrichtextbuffergetextwildcard} given a selected filter. + +\membersection{wxRichTextBuffer::GetHandlers}\label{wxrichtextbuffergethandlers} + +\func{wxList\&}{GetHandlers}{\void} + +Returns the list of file handlers. + +\membersection{wxRichTextBuffer::GetStyleSheet}\label{wxrichtextbuffergetstylesheet} + +\constfunc{wxRichTextStyleSheet*}{GetStyleSheet}{\void} + +Returns the current style sheet associated with the buffer, if any. + +\membersection{wxRichTextBuffer::GetStyleStackSize}\label{wxrichtextbuffergetstylestacksize} + +\constfunc{size\_t}{GetStyleStackSize}{\void} + +Get the size of the style stack, for example to check correct nesting. + +\membersection{wxRichTextBuffer::HitTest}\label{wxrichtextbufferhittest} + +\func{int}{HitTest}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pt}, \param{long\& }{textPosition}} + +Finds the text position for the given position, putting the position in {\it textPosition} if +one is found. {\it pt} is in logical units (a zero y position is +at the beginning of the buffer). + +The function returns one of the following values: + +{\small +\begin{verbatim} +// The point was not on this object +#define wxRICHTEXT_HITTEST_NONE 0x01 +// The point was before the position returned from HitTest +#define wxRICHTEXT_HITTEST_BEFORE 0x02 +// The point was after the position returned from HitTest +#define wxRICHTEXT_HITTEST_AFTER 0x04 +// The point was on the position returned from HitTest +#define wxRICHTEXT_HITTEST_ON 0x08 +\end{verbatim} +} + +\membersection{wxRichTextBuffer::Init}\label{wxrichtextbufferinit} + +\func{void}{Init}{\void} + +Initialisation. + +\membersection{wxRichTextBuffer::InitStandardHandlers}\label{wxrichtextbufferinitstandardhandlers} + +\func{void}{InitStandardHandlers}{\void} + +Initialises the standard handlers. Currently, only the plain text loading/saving handler +is initialised by default. + +\membersection{wxRichTextBuffer::InsertHandler}\label{wxrichtextbufferinserthandler} + +\func{void}{InsertHandler}{\param{wxRichTextFileHandler* }{handler}} + +Inserts a handler at the front of the list. + +\membersection{wxRichTextBuffer::InsertImageWithUndo}\label{wxrichtextbufferinsertimagewithundo} + +\func{bool}{InsertImageWithUndo}{\param{long }{pos}, \param{const wxRichTextImageBlock\& }{imageBlock}, \param{wxRichTextCtrl* }{ctrl}} + +Submits a command to insert the given image. + +\membersection{wxRichTextBuffer::InsertNewlineWithUndo}\label{wxrichtextbufferinsertnewlinewithundo} + +\func{bool}{InsertNewlineWithUndo}{\param{long }{pos}, \param{wxRichTextCtrl* }{ctrl}} + +Submits a command to insert a newline. + +\membersection{wxRichTextBuffer::InsertTextWithUndo}\label{wxrichtextbufferinserttextwithundo} + +\func{bool}{InsertTextWithUndo}{\param{long }{pos}, \param{const wxString\& }{text}, \param{wxRichTextCtrl* }{ctrl}} + +Submits a command to insert the given text. + +\membersection{wxRichTextBuffer::IsModified}\label{wxrichtextbufferismodified} + +\constfunc{bool}{IsModified}{\void} + +Returns \true if the buffer has been modified. + +\membersection{wxRichTextBuffer::LoadFile}\label{wxrichtextbufferloadfile} + +\func{bool}{LoadFile}{\param{wxInputStream\& }{stream}, \param{int }{type = wxRICHTEXT\_TYPE\_ANY}} + +Loads content from a stream. + +\func{bool}{LoadFile}{\param{const wxString\& }{filename}, \param{int }{type = wxRICHTEXT\_TYPE\_ANY}} + +Loads content from a file. + +\membersection{wxRichTextBuffer::Modify}\label{wxrichtextbuffermodify} + +\func{void}{Modify}{\param{bool }{modify = true}} + +Marks the buffer as modified or unmodified. + +\membersection{wxRichTextBuffer::PasteFromClipboard}\label{wxrichtextbufferpastefromclipboard} + +\func{bool}{PasteFromClipboard}{\param{long }{position}} + +Pastes the clipboard content to the buffer at the given position. + +\membersection{wxRichTextBuffer::RemoveHandler}\label{wxrichtextbufferremovehandler} + +\func{bool}{RemoveHandler}{\param{const wxString\& }{name}} + +Removes a handler. + +\membersection{wxRichTextBuffer::Reset}\label{wxrichtextbufferreset} + +\func{void}{Reset}{\void} + +The same as \helpref{Clear}{wxrichtextbufferclear}, plus an empty paragraph is added. + +\membersection{wxRichTextBuffer::SaveFile}\label{wxrichtextbuffersavefile} + +\func{bool}{SaveFile}{\param{wxOutputStream\& }{stream}, \param{int }{type = wxRICHTEXT\_TYPE\_ANY}} + +Saves content to a stream. + +\func{bool}{SaveFile}{\param{const wxString\& }{filename}, \param{int }{type = wxRICHTEXT\_TYPE\_ANY}} + +Saves content to a file. + +\membersection{wxRichTextBuffer::SetStyleSheet}\label{wxrichtextbuffersetstylesheet} + +\func{void}{SetStyleSheet}{\param{wxRichTextStyleSheet* }{styleSheet}} + +Sets the current style sheet, if any. This will allow the application to use +named character and paragraph styles found in the style sheet. + +\membersection{wxRichTextBuffer::SubmitAction}\label{wxrichtextbuffersubmitaction} + +\func{bool}{SubmitAction}{\param{wxRichTextAction* }{action}} + +Submit an action immediately, or delay it according to whether collapsing is on. + +\membersection{wxRichTextBuffer::SuppressingUndo}\label{wxrichtextbuffersuppressingundo} + +\constfunc{bool}{SuppressingUndo}{\void} + +Returns \true if undo suppression is currently on. + diff --git a/docs/latex/wx/richtextcharacterstyledefinition.tex b/docs/latex/wx/richtextcharacterstyledefinition.tex new file mode 100644 index 0000000000..04995f286a --- /dev/null +++ b/docs/latex/wx/richtextcharacterstyledefinition.tex @@ -0,0 +1,27 @@ +\section{\class{wxRichTextCharacterStyleDefinition}}\label{wxrichtextcharacterstyledefinition} + +This class represents a character style definition, usually added to a \helpref{wxRichTextStyleSheet}{wxrichtextstylesheet}. + +\wxheading{Derived from} + +\helpref{wxRichTextStyleDefinition}{wxrichtextstyledefinition} + +\wxheading{Include files} + + + +\wxheading{Data structures} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxRichTextCharacterStyleDefinition::wxRichTextCharacterStyleDefinition}\label{wxrichtextcharacterstyledefinitionwxrichtextcharacterstyledefinition} + +\func{}{wxRichTextCharacterStyleDefinition}{\param{const wxString\& }{name = wxEmptyString}} + +Constructor. + +\membersection{wxRichTextCharacterStyleDefinition::\destruct{wxRichTextCharacterStyleDefinition}}\label{wxrichtextcharacterstyledefinitiondtor} + +\func{}{\destruct{wxRichTextCharacterStyleDefinition}}{\void} + +Destructor. diff --git a/docs/latex/wx/richtextctrl.bmp b/docs/latex/wx/richtextctrl.bmp new file mode 100644 index 0000000000..29bfb472fc Binary files /dev/null and b/docs/latex/wx/richtextctrl.bmp differ diff --git a/docs/latex/wx/richtextctrl.gif b/docs/latex/wx/richtextctrl.gif new file mode 100644 index 0000000000..c900aa5963 Binary files /dev/null and b/docs/latex/wx/richtextctrl.gif differ diff --git a/docs/latex/wx/richtextctrl.tex b/docs/latex/wx/richtextctrl.tex new file mode 100644 index 0000000000..04193110fb --- /dev/null +++ b/docs/latex/wx/richtextctrl.tex @@ -0,0 +1,1205 @@ +\section{\class{wxRichTextCtrl}}\label{wxrichtextctrl} + +wxRichTextCtrl provides a generic, ground-up implementation of a text control +capable of showing multiple styles and images. + +\wxheading{Derived from} + +wxTextCtrlBase + +\wxheading{Include files} + + + +\wxheading{Data structures} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxRichTextCtrl::wxRichTextCtrl}\label{wxrichtextctrlwxrichtextctrl} + +\func{}{wxRichTextCtrl}{\void} + +\func{}{wxRichTextCtrl}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = -1}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxRE\_MULTILINE}} + +Constructors. + +\membersection{wxRichTextCtrl::\destruct{wxRichTextCtrl}}\label{wxrichtextctrldtor} + +\func{}{\destruct{wxRichTextCtrl}}{\void} + +Destructor. + +\membersection{wxRichTextCtrl::AddImage}\label{wxrichtextctrladdimage} + +\func{wxRichTextRange}{AddImage}{\param{const wxImage\& }{image}} + +Adds an image to the control's buffer. + +\membersection{wxRichTextCtrl::AddParagraph}\label{wxrichtextctrladdparagraph} + +\func{wxRichTextRange}{AddParagraph}{\param{const wxString\& }{text}} + +Adds a new paragraph of text to the end of the buffer. + +\membersection{wxRichTextCtrl::AppendText}\label{wxrichtextctrlappendtext} + +\func{void}{AppendText}{\param{const wxString\& }{text}} + +Sets the insertion point to the end of the buffer and writes the text. + +\membersection{wxRichTextCtrl::ApplyAlignmentToSelection}\label{wxrichtextctrlapplyalignmenttoselection} + +\func{bool}{ApplyAlignmentToSelection}{\param{wxTextAttrAlignment }{alignment}} + +Applies the given alignment to the selection (undoable). + +For alignment values, see \helpref{wxTextAttrEx}{wxtextattrex}. + +\membersection{wxRichTextCtrl::ApplyBoldToSelection}\label{wxrichtextctrlapplyboldtoselection} + +\func{bool}{ApplyBoldToSelection}{\void} + +Apples bold to the selection (undoable). + +\membersection{wxRichTextCtrl::ApplyItalicToSelection}\label{wxrichtextctrlapplyitalictoselection} + +\func{bool}{ApplyItalicToSelection}{\void} + +Applies italic to the selection (undoable). + +\membersection{wxRichTextCtrl::ApplyUnderlineToSelection}\label{wxrichtextctrlapplyunderlinetoselection} + +\func{bool}{ApplyUnderlineToSelection}{\void} + +Applies underline to the selection (undoable). + +\membersection{wxRichTextCtrl::BatchingUndo}\label{wxrichtextctrlbatchingundo} + +\constfunc{bool}{BatchingUndo}{\void} + +Returns \true if undo commands are being batched. + +\membersection{wxRichTextCtrl::BeginAlignment}\label{wxrichtextctrlbeginalignment} + +\func{bool}{BeginAlignment}{\param{wxTextAttrAlignment }{alignment}} + +Begins using alignment + +For alignment values, see \helpref{wxTextAttrEx}{wxtextattrex}. + +\membersection{wxRichTextCtrl::BeginBatchUndo}\label{wxrichtextctrlbeginbatchundo} + +\func{bool}{BeginBatchUndo}{\param{const wxString\& }{cmdName}} + +Starts batching undo history for commands. + +\membersection{wxRichTextCtrl::BeginBold}\label{wxrichtextctrlbeginbold} + +\func{bool}{BeginBold}{\void} + +Begins using bold. + +\membersection{wxRichTextCtrl::BeginCharacterStyle}\label{wxrichtextctrlbegincharacterstyle} + +\func{bool}{BeginCharacterStyle}{\param{const wxString\& }{characterStyle}} + +Begins using the named character style. + +\membersection{wxRichTextCtrl::BeginFont}\label{wxrichtextctrlbeginfont} + +\func{bool}{BeginFont}{\param{const wxFont\& }{font}} + +Begins using this font. + +\membersection{wxRichTextCtrl::BeginFontSize}\label{wxrichtextctrlbeginfontsize} + +\func{bool}{BeginFontSize}{\param{int }{pointSize}} + +Begins using the given point size. + +\membersection{wxRichTextCtrl::BeginItalic}\label{wxrichtextctrlbeginitalic} + +\func{bool}{BeginItalic}{\void} + +Begins using italic. + +\membersection{wxRichTextCtrl::BeginLeftIndent}\label{wxrichtextctrlbeginleftindent} + +\func{bool}{BeginLeftIndent}{\param{int }{leftIndent}, \param{int }{leftSubIndent = 0}} + +Begins applying a left indent and subindent in tenths of a millimetre. + +The sub-indent is an offset from the left of the paragraph, and is used for all but the +first line in a paragraph. A positive value will cause the first line to appear to the left +of the subsequent lines, and a negative value will cause the first line to be indented +relative to the subsequent lines. + +wxRichTextBuffer uses indentation to render a bulleted item. The left indent is the distance between +the margin and the bullet. The content of the paragraph, including the first line, starts +at leftMargin + leftSubIndent. So the distance between the left edge of the bullet and the +left of the actual paragraph is leftSubIndent. + +\membersection{wxRichTextCtrl::BeginLineSpacing}\label{wxrichtextctrlbeginlinespacing} + +\func{bool}{BeginLineSpacing}{\param{int }{lineSpacing}} + +Begins appling line spacing. {\it spacing} is a multiple, where 10 means single-spacing, +15 means 1.5 spacing, and 20 means double spacing. The following constants are +defined for convenience: + + +{\small +\begin{verbatim} +#define wxTEXT_ATTR_LINE_SPACING_NORMAL 10 +#define wxTEXT_ATTR_LINE_SPACING_HALF 15 +#define wxTEXT_ATTR_LINE_SPACING_TWICE 20 +\end{verbatim} +} + +\membersection{wxRichTextCtrl::BeginNumberedBullet}\label{wxrichtextctrlbeginnumberedbullet} + +\func{bool}{BeginNumberedBullet}{\param{int }{bulletNumber}, \param{int }{leftIndent}, \param{int }{leftSubIndent}, \param{int }{bulletStyle = wxTEXT\_ATTR\_BULLET\_STYLE\_ARABIC|wxTEXT\_ATTR\_BULLET\_STYLE\_PERIOD}} + +Begins a numbered bullet. This call will be needed for each item in the list, and the +application should take care of incrementing the numbering. + +{\it bulletNumber} is a number, usually starting with 1. + +{\it leftIndent} and {\it leftSubIndent} are values in tenths of a millimetre. + +{\it bulletStyle} is a bitlist of the following values: + +{\small +\begin{verbatim} +#define wxTEXT_ATTR_BULLET_STYLE_NONE 0x0000 +#define wxTEXT_ATTR_BULLET_STYLE_ARABIC 0x0001 +#define wxTEXT_ATTR_BULLET_STYLE_LETTERS_UPPER 0x0002 +#define wxTEXT_ATTR_BULLET_STYLE_LETTERS_LOWER 0x0004 +#define wxTEXT_ATTR_BULLET_STYLE_ROMAN_UPPER 0x0008 +#define wxTEXT_ATTR_BULLET_STYLE_ROMAN_LOWER 0x0010 +#define wxTEXT_ATTR_BULLET_STYLE_SYMBOL 0x0020 +#define wxTEXT_ATTR_BULLET_STYLE_BITMAP 0x0040 +#define wxTEXT_ATTR_BULLET_STYLE_PARENTHESES 0x0080 +#define wxTEXT_ATTR_BULLET_STYLE_PERIOD 0x0100 +\end{verbatim} +} + +wxRichTextBuffer uses indentation to render a bulleted item. The left indent is the distance between +the margin and the bullet. The content of the paragraph, including the first line, starts +at leftMargin + leftSubIndent. So the distance between the left edge of the bullet and the +left of the actual paragraph is leftSubIndent. + +\membersection{wxRichTextCtrl::BeginParagraphSpacing}\label{wxrichtextctrlbeginparagraphspacing} + +\func{bool}{BeginParagraphSpacing}{\param{int }{before}, \param{int }{after}} + +Begins paragraph spacing; pass the before-paragraph and after-paragraph spacing in tenths of +a millimetre. + +\membersection{wxRichTextCtrl::BeginParagraphStyle}\label{wxrichtextctrlbeginparagraphstyle} + +\func{bool}{BeginParagraphStyle}{\param{const wxString\& }{paragraphStyle}} + +Begins applying the named paragraph style. + +\membersection{wxRichTextCtrl::BeginRightIndent}\label{wxrichtextctrlbeginrightindent} + +\func{bool}{BeginRightIndent}{\param{int }{rightIndent}} + +Begins a right indent, specified in tenths of a millimetre. + +\membersection{wxRichTextCtrl::BeginStyle}\label{wxrichtextctrlbeginstyle} + +\func{bool}{BeginStyle}{\param{const wxTextAttrEx\& }{style}} + +Begins applying a style. + +\membersection{wxRichTextCtrl::BeginSuppressUndo}\label{wxrichtextctrlbeginsuppressundo} + +\func{bool}{BeginSuppressUndo}{\void} + +Starts suppressing undo history for commands. + +\membersection{wxRichTextCtrl::BeginSymbolBullet}\label{wxrichtextctrlbeginsymbolbullet} + +\func{bool}{BeginSymbolBullet}{\param{wxChar }{symbol}, \param{int }{leftIndent}, \param{int }{leftSubIndent}, \param{int }{bulletStyle = wxTEXT\_ATTR\_BULLET\_STYLE\_SYMBOL}} + +Begins applying a symbol bullet, using a character from the current font. See \helpref{BeginNumberedBullet}{wxrichtextctrlbeginnumberedbullet} for +an explanation of how indentation is used to render the bulleted paragraph. + +\membersection{wxRichTextCtrl::BeginTextColour}\label{wxrichtextctrlbegintextcolour} + +\func{bool}{BeginTextColour}{\param{const wxColour\& }{colour}} + +Begins using this colour. + +\membersection{wxRichTextCtrl::BeginUnderline}\label{wxrichtextctrlbeginunderline} + +\func{bool}{BeginUnderline}{\void} + +Begins using underlining. + +\membersection{wxRichTextCtrl::CanCopy}\label{wxrichtextctrlcancopy} + +\constfunc{bool}{CanCopy}{\void} + +Returns \true if selected content can be copied to the clipboard. + +\membersection{wxRichTextCtrl::CanCut}\label{wxrichtextctrlcancut} + +\constfunc{bool}{CanCut}{\void} + +Returns \true if selected content can be copied to the clipboard and deleted. + +\membersection{wxRichTextCtrl::CanDeleteSelection}\label{wxrichtextctrlcandeleteselection} + +\constfunc{bool}{CanDeleteSelection}{\void} + +Returns \true if selected content can be deleted. + +\membersection{wxRichTextCtrl::CanPaste}\label{wxrichtextctrlcanpaste} + +\constfunc{bool}{CanPaste}{\void} + +Returns \true if the clipboard content can be pasted to the buffer. + +\membersection{wxRichTextCtrl::CanRedo}\label{wxrichtextctrlcanredo} + +\constfunc{bool}{CanRedo}{\void} + +Returns \true if there is a command in the command history that can be redone. + +\membersection{wxRichTextCtrl::CanUndo}\label{wxrichtextctrlcanundo} + +\constfunc{bool}{CanUndo}{\void} + +Returns \true if there is a command in the command history that can be undone. + +\membersection{wxRichTextCtrl::Clear}\label{wxrichtextctrlclear} + +\func{void}{Clear}{\void} + +Clears the buffer content, leaving a single empty paragraph. Cannot be undone. + +\membersection{wxRichTextCtrl::Command}\label{wxrichtextctrlcommand} + +\func{void}{Command}{\param{wxCommandEvent\& }{event}} + +Sends the event to the control. + +\membersection{wxRichTextCtrl::Copy}\label{wxrichtextctrlcopy} + +\func{void}{Copy}{\void} + +Copies the selected content (if any) to the clipboard. + +\membersection{wxRichTextCtrl::Create}\label{wxrichtextctrlcreate} + +\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = -1}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxRE\_MULTILINE}} + +Creates the underlying window. + +\membersection{wxRichTextCtrl::Cut}\label{wxrichtextctrlcut} + +\func{void}{Cut}{\void} + +Copies the selected content (if any) to the clipboard and deletes the selection. +This is undoable. + +\membersection{wxRichTextCtrl::DeleteSelectedContent}\label{wxrichtextctrldeleteselectedcontent} + +\func{bool}{DeleteSelectedContent}{\param{long* }{newPos = NULL}} + +Deletes content if there is a selection, e.g. when pressing a key. +Returns the new caret position in {\it newPos}, or leaves it if there +was no action. This is undoable. + +\membersection{wxRichTextCtrl::DeleteSelection}\label{wxrichtextctrldeleteselection} + +\func{void}{DeleteSelection}{\void} + +Deletes the content in the selection, if any. This is undoable. + +\membersection{wxRichTextCtrl::DiscardEdits}\label{wxrichtextctrldiscardedits} + +\func{void}{DiscardEdits}{\void} + +Sets the buffer's modified status to \false, and clears the buffer's command history. + +\membersection{wxRichTextCtrl::DoGetBestSize}\label{wxrichtextctrldogetbestsize} + +\constfunc{wxSize}{DoGetBestSize}{\void} + +Currently this simply returns {\tt wxSize(10, 10)}. + +\membersection{wxRichTextCtrl::EndAlignment}\label{wxrichtextctrlendalignment} + +\func{bool}{EndAlignment}{\void} + +Ends alignment. + +\membersection{wxRichTextCtrl::EndAllStyles}\label{wxrichtextctrlendallstyles} + +\func{bool}{EndAllStyles}{\void} + +Ends application of all styles in the current style stack. + +\membersection{wxRichTextCtrl::EndBatchUndo}\label{wxrichtextctrlendbatchundo} + +\func{bool}{EndBatchUndo}{\void} + +Ends batching undo command history. + +\membersection{wxRichTextCtrl::EndBold}\label{wxrichtextctrlendbold} + +\func{bool}{EndBold}{\void} + +Ends using bold. + +\membersection{wxRichTextCtrl::EndCharacterStyle}\label{wxrichtextctrlendcharacterstyle} + +\func{bool}{EndCharacterStyle}{\void} + +Ends application of a named character style. + +\membersection{wxRichTextCtrl::EndFont}\label{wxrichtextctrlendfont} + +\func{bool}{EndFont}{\void} + +Ends using a font. + +\membersection{wxRichTextCtrl::EndFontSize}\label{wxrichtextctrlendfontsize} + +\func{bool}{EndFontSize}{\void} + +Ends using a point size. + +\membersection{wxRichTextCtrl::EndItalic}\label{wxrichtextctrlenditalic} + +\func{bool}{EndItalic}{\void} + +Ends using italic. + +\membersection{wxRichTextCtrl::EndLeftIndent}\label{wxrichtextctrlendleftindent} + +\func{bool}{EndLeftIndent}{\void} + +Ends left indent. + +\membersection{wxRichTextCtrl::EndLineSpacing}\label{wxrichtextctrlendlinespacing} + +\func{bool}{EndLineSpacing}{\void} + +Ends line spacing. + +\membersection{wxRichTextCtrl::EndNumberedBullet}\label{wxrichtextctrlendnumberedbullet} + +\func{bool}{EndNumberedBullet}{\void} + +Ends application of a numbered bullet. + +\membersection{wxRichTextCtrl::EndParagraphSpacing}\label{wxrichtextctrlendparagraphspacing} + +\func{bool}{EndParagraphSpacing}{\void} + +Ends paragraph spacing. + +\membersection{wxRichTextCtrl::EndParagraphStyle}\label{wxrichtextctrlendparagraphstyle} + +\func{bool}{EndParagraphStyle}{\void} + +Ends application of a named character style. + +\membersection{wxRichTextCtrl::EndRightIndent}\label{wxrichtextctrlendrightindent} + +\func{bool}{EndRightIndent}{\void} + +Ends right indent. + +\membersection{wxRichTextCtrl::EndStyle}\label{wxrichtextctrlendstyle} + +\func{bool}{EndStyle}{\void} + +Ends the current style. + +\membersection{wxRichTextCtrl::EndSuppressUndo}\label{wxrichtextctrlendsuppressundo} + +\func{bool}{EndSuppressUndo}{\void} + +Ends suppressing undo command history. + +\membersection{wxRichTextCtrl::EndSymbolBullet}\label{wxrichtextctrlendsymbolbullet} + +\func{bool}{EndSymbolBullet}{\void} + +Ends applying a symbol bullet. + +\membersection{wxRichTextCtrl::EndTextColour}\label{wxrichtextctrlendtextcolour} + +\func{bool}{EndTextColour}{\void} + +Ends applying a text colour. + +\membersection{wxRichTextCtrl::EndUnderline}\label{wxrichtextctrlendunderline} + +\func{bool}{EndUnderline}{\void} + +End applying underlining. + +\membersection{wxRichTextCtrl::ExtendSelection}\label{wxrichtextctrlextendselection} + +\func{bool}{ExtendSelection}{\param{long }{oldPosition}, \param{long }{newPosition}, \param{int }{flags}} + +Helper function for extending the selection, returning \true if the selection was +changed. Selections are in caret positions. + +\membersection{wxRichTextCtrl::FindNextWordPosition}\label{wxrichtextctrlfindnextwordposition} + +\constfunc{long}{FindNextWordPosition}{\param{int }{direction = 1}} + +Helper function for finding the caret position for the next word. Direction +is 1 (forward) or -1 (backwards). + +\membersection{wxRichTextCtrl::Freeze}\label{wxrichtextctrlfreeze} + +\func{void}{Freeze}{\void} + +Call this function to prevent refresh and allow fast updates, and then \helpref{Thaw}{wxrichtextctrlthaw} to +refresh the control. + +\membersection{wxRichTextCtrl::GetBasicStyle}\label{wxrichtextctrlgetbasicstyle} + +\constfunc{const wxTextAttrEx\&}{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 +only affects the style currently being applied (for example, setting the default +style to bold will cause subsequently inserted text to be bold). + +\membersection{wxRichTextCtrl::GetBuffer}\label{wxrichtextctrlgetbuffer} + +\constfunc{const wxRichTextBuffer\&}{GetBuffer}{\void} + +\func{wxRichTextBuffer\&}{GetBuffer}{\void} + +Returns the buffer associated with the control. + +\membersection{wxRichTextCtrl::GetCaretPosition}\label{wxrichtextctrlgetcaretposition} + +\constfunc{long}{GetCaretPosition}{\void} + +Returns the current caret position. + +\membersection{wxRichTextCtrl::GetCaretPositionForIndex}\label{wxrichtextctrlgetcaretpositionforindex} + +\func{bool}{GetCaretPositionForIndex}{\param{long }{position}, \param{wxRect\& }{rect}} + +Returns the caret height and position for the given character position + +\membersection{wxRichTextCtrl::GetCommandProcessor}\label{wxrichtextctrlgetcommandprocessor} + +\constfunc{wxCommandProcessor*}{GetCommandProcessor}{\void} + +Gets the command processor associated with the control's buffer. + +\membersection{wxRichTextCtrl::GetDefaultStyleEx}\label{wxrichtextctrlgetdefaultstyleex} + +\constfunc{const wxTextAttrEx\&}{GetDefaultStyleEx}{\void} + +Returns the current default style, which can be used to change how subsequently inserted +text is displayed. When wxTextAttrEx is merged with wxTextAttr, this function +will become GetDefaultStyle. + +\membersection{wxRichTextCtrl::GetDelayedLayoutThreshold}\label{wxrichtextctrlgetdelayedlayoutthreshold} + +\constfunc{long}{GetDelayedLayoutThreshold}{\void} + +Gets the size of the buffer beyond which layout is delayed during resizing. +This optimizes sizing for large buffers. The default is 20000. + +\membersection{wxRichTextCtrl::GetFilename}\label{wxrichtextctrlgetfilename} + +\constfunc{wxString}{GetFilename}{\void} + +Gets the current filename associated with the control. + +\membersection{wxRichTextCtrl::GetFirstVisiblePosition}\label{wxrichtextctrlgetfirstvisibleposition} + +\constfunc{long}{GetFirstVisiblePosition}{\void} + +Returns the first visible position in the current view. + +\membersection{wxRichTextCtrl::GetInsertionPoint}\label{wxrichtextctrlgetinsertionpoint} + +\constfunc{long}{GetInsertionPoint}{\void} + +Returns the current insertion point. + +\membersection{wxRichTextCtrl::GetLastPosition}\label{wxrichtextctrlgetlastposition} + +\constfunc{wxTextPos}{GetLastPosition}{\void} + +Returns the last position in the buffer. + +\membersection{wxRichTextCtrl::GetLineLength}\label{wxrichtextctrlgetlinelength} + +\constfunc{int}{GetLineLength}{\param{long }{lineNo}} + +Returns the length of the specified line in characters. + +\membersection{wxRichTextCtrl::GetLineText}\label{wxrichtextctrlgetlinetext} + +\constfunc{wxString}{GetLineText}{\param{long }{lineNo}} + +Returns the text for the given line. + +\membersection{wxRichTextCtrl::GetLogicalPoint}\label{wxrichtextctrlgetlogicalpoint} + +\constfunc{wxPoint}{GetLogicalPoint}{\param{const wxPoint\& }{ptPhysical}} + +Transforms physical window position to logical (unscrolled) position. + +\membersection{wxRichTextCtrl::GetNumberOfLines}\label{wxrichtextctrlgetnumberoflines} + +\constfunc{int}{GetNumberOfLines}{\void} + +Returns the number of lines in the buffer. + +\membersection{wxRichTextCtrl::GetPhysicalPoint}\label{wxrichtextctrlgetphysicalpoint} + +\constfunc{wxPoint}{GetPhysicalPoint}{\param{const wxPoint\& }{ptLogical}} + +Transforms logical (unscrolled) position to physical window position. + +\membersection{wxRichTextCtrl::GetRange}\label{wxrichtextctrlgetrange} + +\constfunc{wxString}{GetRange}{\param{long }{from}, \param{long }{to}} + +Gets the text for the given range. + +\membersection{wxRichTextCtrl::GetSelection}\label{wxrichtextctrlgetselection} + +\constfunc{void}{GetSelection}{\param{long* }{from}, \param{long* }{to}} + +Returns the range of the current selection. If the return values {\it from} and {\it to} are the same, there is no selection. + +\membersection{wxRichTextCtrl::GetSelectionRange}\label{wxrichtextctrlgetselectionrange} + +\constfunc{const wxRichTextRange\&}{GetSelectionRange}{\void} + +Returns the selection range in character positions. -1, -1 means no selection. + +\membersection{wxRichTextCtrl::GetStringSelection}\label{wxrichtextctrlgetstringselection} + +\constfunc{wxString}{GetStringSelection}{\void} + +Returns the text within the current selection range, if any. + +\membersection{wxRichTextCtrl::GetStyle}\label{wxrichtextctrlgetstyle} + +\constfunc{bool}{GetStyle}{\param{long }{position}, \param{wxRichTextAttr\& }{style}} + +\constfunc{bool}{GetStyle}{\param{long }{position}, \param{wxTextAttrEx\& }{style}} + +Gets the attributes at the given position. The wxRichTextAttr version is generally more efficient +because it does not use wxFont objects. + +\membersection{wxRichTextCtrl::GetStyleSheet}\label{wxrichtextctrlgetstylesheet} + +\constfunc{wxRichTextStyleSheet*}{GetStyleSheet}{\void} + +Returns the style sheet associated with the control, if any. A style sheet allows named +character and paragraph styles to be applied. + +\membersection{wxRichTextCtrl::GetValue}\label{wxrichtextctrlgetvalue} + +\constfunc{wxString}{GetValue}{\void} + +Returns the content of the entire control as a string. + +\membersection{wxRichTextCtrl::GetVisibleLineForCaretPosition}\label{wxrichtextctrlgetvisiblelineforcaretposition} + +\constfunc{wxRichTextLine*}{GetVisibleLineForCaretPosition}{\param{long }{caretPosition}} + +Internal helper function returning the line for the visible caret position. If the caret is +shown at the very end of the line, it means the next character is actually +on the following line. So this function gets the line we're expecting to find +if this is the case. + +\membersection{wxRichTextCtrl::HasCharacterAttributes}\label{wxrichtextctrlhascharacterattributes} + +\constfunc{bool}{HasCharacterAttributes}{\param{const wxRichTextRange\& }{range}, \param{const wxTextAttrEx\& }{style}} + +\constfunc{bool}{HasCharacterAttributes}{\param{const wxRichTextRange\& }{range}, \param{const wxRichTextAttr\& }{style}} + +Test if this whole range has character attributes of the specified kind. If any +of the attributes are different within the range, the test fails. You +can use this to implement, for example, bold button updating. {\it style} must have +flags indicating which attributes are of interest. + +\membersection{wxRichTextCtrl::HasParagraphAttributes}\label{wxrichtextctrlhasparagraphattributes} + +\constfunc{bool}{HasParagraphAttributes}{\param{const wxRichTextRange\& }{range}, \param{const wxTextAttrEx\& }{style}} + +\constfunc{bool}{HasParagraphAttributes}{\param{const wxRichTextRange\& }{range}, \param{const wxRichTextAttr\& }{style}} + +Test if this whole range has paragraph attributes of the specified kind. If any +of the attributes are different within the range, the test fails. You +can use this to implement, for example, centering button updating. {\it style} must have +flags indicating which attributes are of interest. + +\membersection{wxRichTextCtrl::HasSelection}\label{wxrichtextctrlhasselection} + +\constfunc{bool}{HasSelection}{\void} + +Returns \true if there is a selection. + +\membersection{wxRichTextCtrl::HitTest}\label{wxrichtextctrlhittest} + +\constfunc{wxTextCtrlHitTestResult}{HitTest}{\param{const wxPoint\& }{pt}, \param{long* }{pos}} + +\constfunc{wxTextCtrlHitTestResult}{HitTest}{\param{const wxPoint\& }{pt}, \param{wxTextCoord* }{col}, \param{wxTextCoord* }{row}} + +Finds the character at the given position in pixels. + +{\it pt} is in device coords (not adjusted for the client area origin nor for scrolling). + +\membersection{wxRichTextCtrl::Init}\label{wxrichtextctrlinit} + +\func{void}{Init}{\void} + +Initialises the members of the control. + +\membersection{wxRichTextCtrl::InitCommandEvent}\label{wxrichtextctrlinitcommandevent} + +\constfunc{void}{InitCommandEvent}{\param{wxCommandEvent\& }{event}} + +Initialises the command event. + +\membersection{wxRichTextCtrl::IsEditable}\label{wxrichtextctrliseditable} + +\constfunc{bool}{IsEditable}{\void} + +Returns \true if the control is editable. + +\membersection{wxRichTextCtrl::IsFrozen}\label{wxrichtextctrlisfrozen} + +\constfunc{bool}{IsFrozen}{\void} + +Returns \true if Freeze has been called without a Thaw. + +\membersection{wxRichTextCtrl::IsModified}\label{wxrichtextctrlismodified} + +\constfunc{bool}{IsModified}{\void} + +Returns \true if the buffer has been modified. + +\membersection{wxRichTextCtrl::IsMultiLine}\label{wxrichtextctrlismultiline} + +\constfunc{bool}{IsMultiLine}{\void} + +Returns \true if the control is multiline. + +\membersection{wxRichTextCtrl::IsPositionVisible}\label{wxrichtextctrlispositionvisible} + +\constfunc{bool}{IsPositionVisible}{\param{long }{pos}} + +Returns \true if the given position is visible on the screen. + +\membersection{wxRichTextCtrl::IsSelectionAligned}\label{wxrichtextctrlisselectionaligned} + +\constfunc{bool}{IsSelectionAligned}{\param{wxTextAttrAlignment }{alignment}} + +Returns \true if all of the selection is aligned according to the specified flag. + +\membersection{wxRichTextCtrl::IsSelectionBold}\label{wxrichtextctrlisselectionbold} + +\constfunc{bool}{IsSelectionBold}{\void} + +Returns \true if all of the selection is bold. + +\membersection{wxRichTextCtrl::IsSelectionItalics}\label{wxrichtextctrlisselectionitalics} + +\constfunc{bool}{IsSelectionItalics}{\void} + +Returns \true if all of the selection is italic. + +\membersection{wxRichTextCtrl::IsSelectionUnderlined}\label{wxrichtextctrlisselectionunderlined} + +\constfunc{bool}{IsSelectionUnderlined}{\void} + +Returns \true if all of the selection is underlined. + +\membersection{wxRichTextCtrl::IsSingleLine}\label{wxrichtextctrlissingleline} + +\constfunc{bool}{IsSingleLine}{\void} + +Returns \true if the control is single-line. Currently wxRichTextCtrl does not +support single-line editing. + +\membersection{wxRichTextCtrl::KeyboardNavigate}\label{wxrichtextctrlkeyboardnavigate} + +\func{bool}{KeyboardNavigate}{\param{int }{keyCode}, \param{int }{flags}} + +Helper function implementing keyboard navigation. + +\membersection{wxRichTextCtrl::LayoutContent}\label{wxrichtextctrllayoutcontent} + +\func{bool}{LayoutContent}{\param{bool }{onlyVisibleRect = false}} + +Lays out the buffer, which must be done before certain operations, such as +setting the caret position. This function should not normally be required by the +application. + +\membersection{wxRichTextCtrl::LoadFile}\label{wxrichtextctrlloadfile} + +\func{bool}{LoadFile}{\param{const wxString\& }{file}, \param{int }{type = wxRICHTEXT\_TYPE\_ANY}} + +Loads content into the control's buffer using the given type. If the specified type +is wxRICHTEXT\_TYPE\_ANY, the type is deduced from the filename extension. + +This function looks for a suitable \helpref{wxRichTextFileHandler}{wxrichtextfilehandler} object. + +\membersection{wxRichTextCtrl::MarkDirty}\label{wxrichtextctrlmarkdirty} + +\func{void}{MarkDirty}{\void} + +Marks the buffer as modified. + +\membersection{wxRichTextCtrl::MoveCaret}\label{wxrichtextctrlmovecaret} + +\func{bool}{MoveCaret}{\param{long }{pos}, \param{bool }{showAtLineStart = false}} + +Move the caret to the given character position. + +\membersection{wxRichTextCtrl::MoveCaretBack}\label{wxrichtextctrlmovecaretback} + +\func{void}{MoveCaretBack}{\param{long }{oldPosition}} + +Move the caret one visual step forward: this may mean setting a flag +and keeping the same position if we're going from the end of one line +to the start of the next, which may be the exact same caret position. + +\membersection{wxRichTextCtrl::MoveCaretForward}\label{wxrichtextctrlmovecaretforward} + +\func{void}{MoveCaretForward}{\param{long }{oldPosition}} + +Move the caret one visual step forward: this may mean setting a flag +and keeping the same position if we're going from the end of one line +to the start of the next, which may be the exact same caret position. + +\membersection{wxRichTextCtrl::MoveDown}\label{wxrichtextctrlmovedown} + +\func{bool}{MoveDown}{\param{int }{noLines = 1}, \param{int }{flags = 0}} + +Moves the caret down. + +\membersection{wxRichTextCtrl::MoveEnd}\label{wxrichtextctrlmoveend} + +\func{bool}{MoveEnd}{\param{int }{flags = 0}} + +Moves to the end of the buffer. + +\membersection{wxRichTextCtrl::MoveHome}\label{wxrichtextctrlmovehome} + +\func{bool}{MoveHome}{\param{int }{flags = 0}} + +Moves to the start of the buffer. + +\membersection{wxRichTextCtrl::MoveLeft}\label{wxrichtextctrlmoveleft} + +\func{bool}{MoveLeft}{\param{int }{noPositions = 1}, \param{int }{flags = 0}} + +Moves left. + +\membersection{wxRichTextCtrl::MoveRight}\label{wxrichtextctrlmoveright} + +\func{bool}{MoveRight}{\param{int }{noPositions = 1}, \param{int }{flags = 0}} + +Moves right. + +\membersection{wxRichTextCtrl::MoveToLineEnd}\label{wxrichtextctrlmovetolineend} + +\func{bool}{MoveToLineEnd}{\param{int }{flags = 0}} + +Moves to the end of the line. + +\membersection{wxRichTextCtrl::MoveToLineStart}\label{wxrichtextctrlmovetolinestart} + +\func{bool}{MoveToLineStart}{\param{int }{flags = 0}} + +Moves to the start of the line. + +\membersection{wxRichTextCtrl::MoveToParagraphEnd}\label{wxrichtextctrlmovetoparagraphend} + +\func{bool}{MoveToParagraphEnd}{\param{int }{flags = 0}} + +Moves to the end of the paragraph. + +\membersection{wxRichTextCtrl::MoveToParagraphStart}\label{wxrichtextctrlmovetoparagraphstart} + +\func{bool}{MoveToParagraphStart}{\param{int }{flags = 0}} + +Moves to the start of the paragraph. + +\membersection{wxRichTextCtrl::MoveUp}\label{wxrichtextctrlmoveup} + +\func{bool}{MoveUp}{\param{int }{noLines = 1}, \param{int }{flags = 0}} + +Moves up. + +\membersection{wxRichTextCtrl::Newline}\label{wxrichtextctrlnewline} + +\func{bool}{Newline}{\void} + +Insert a newline (actually paragraph) at the current insertion point. + +\membersection{wxRichTextCtrl::OnClear}\label{wxrichtextctrlonclear} + +\func{void}{OnClear}{\param{wxCommandEvent\& }{event}} + +Standard handler for the wxID\_CLEAR command. + +\membersection{wxRichTextCtrl::OnContextMenu}\label{wxrichtextctrloncontextmenu} + +\func{void}{OnContextMenu}{\param{wxContextMenuEvent\& }{event}} + +Shows a standard context menu with undo, redo, cut, copy, paste, clear, and select all commands. + +\membersection{wxRichTextCtrl::OnCopy}\label{wxrichtextctrloncopy} + +\func{void}{OnCopy}{\param{wxCommandEvent\& }{event}} + +Standard handler for the wxID\_COPY command. + +\membersection{wxRichTextCtrl::OnCut}\label{wxrichtextctrloncut} + +\func{void}{OnCut}{\param{wxCommandEvent\& }{event}} + +Standard handler for the wxID\_CUT command. + +\membersection{wxRichTextCtrl::OnDropFiles}\label{wxrichtextctrlondropfiles} + +\func{void}{OnDropFiles}{\param{wxDropFilesEvent\& }{event}} + +Loads the first dropped file. + +\membersection{wxRichTextCtrl::OnPaste}\label{wxrichtextctrlonpaste} + +\func{void}{OnPaste}{\param{wxCommandEvent\& }{event}} + +Standard handler for the wxID\_PASTE command. + +\membersection{wxRichTextCtrl::OnRedo}\label{wxrichtextctrlonredo} + +\func{void}{OnRedo}{\param{wxCommandEvent\& }{event}} + +Standard handler for the wxID\_REDO command. + +\membersection{wxRichTextCtrl::OnSelectAll}\label{wxrichtextctrlonselectall} + +\func{void}{OnSelectAll}{\param{wxCommandEvent\& }{event}} + +Standard handler for the wxID\_SELECTALL command. + +\membersection{wxRichTextCtrl::OnUndo}\label{wxrichtextctrlonundo} + +\func{void}{OnUndo}{\param{wxCommandEvent\& }{event}} + +Standard handler for the wxID\_PASTE command. + +\membersection{wxRichTextCtrl::OnUpdateClear}\label{wxrichtextctrlonupdateclear} + +\func{void}{OnUpdateClear}{\param{wxUpdateUIEvent\& }{event}} + +Standard update handler for the wxID\_CLEAR command. + +\membersection{wxRichTextCtrl::OnUpdateCopy}\label{wxrichtextctrlonupdatecopy} + +\func{void}{OnUpdateCopy}{\param{wxUpdateUIEvent\& }{event}} + +Standard update handler for the wxID\_COPY command. + +\membersection{wxRichTextCtrl::OnUpdateCut}\label{wxrichtextctrlonupdatecut} + +\func{void}{OnUpdateCut}{\param{wxUpdateUIEvent\& }{event}} + +Standard update handler for the wxID\_CUT command. + +\membersection{wxRichTextCtrl::OnUpdatePaste}\label{wxrichtextctrlonupdatepaste} + +\func{void}{OnUpdatePaste}{\param{wxUpdateUIEvent\& }{event}} + +Standard update handler for the wxID\_PASTE command. + +\membersection{wxRichTextCtrl::OnUpdateRedo}\label{wxrichtextctrlonupdateredo} + +\func{void}{OnUpdateRedo}{\param{wxUpdateUIEvent\& }{event}} + +Standard update handler for the wxID\_REDO command. + +\membersection{wxRichTextCtrl::OnUpdateSelectAll}\label{wxrichtextctrlonupdateselectall} + +\func{void}{OnUpdateSelectAll}{\param{wxUpdateUIEvent\& }{event}} + +Standard update handler for the wxID\_SELECTALL command. + +\membersection{wxRichTextCtrl::OnUpdateUndo}\label{wxrichtextctrlonupdateundo} + +\func{void}{OnUpdateUndo}{\param{wxUpdateUIEvent\& }{event}} + +Standard update handler for the wxID\_UNDO command. + +\membersection{wxRichTextCtrl::PageDown}\label{wxrichtextctrlpagedown} + +\func{bool}{PageDown}{\param{int }{noPages = 1}, \param{int }{flags = 0}} + +Moves one or more pages down. + +\membersection{wxRichTextCtrl::PageUp}\label{wxrichtextctrlpageup} + +\func{bool}{PageUp}{\param{int }{noPages = 1}, \param{int }{flags = 0}} + +Moves one or more pages up. + +\membersection{wxRichTextCtrl::PaintBackground}\label{wxrichtextctrlpaintbackground} + +\func{void}{PaintBackground}{\param{wxDC\& }{dc}} + +Paints the background. + +\membersection{wxRichTextCtrl::Paste}\label{wxrichtextctrlpaste} + +\func{void}{Paste}{\void} + +Pastes content from the clipboard to the buffer. + +\membersection{wxRichTextCtrl::PositionCaret}\label{wxrichtextctrlpositioncaret} + +\func{void}{PositionCaret}{\void} + +Internal function to position the visible caret according to the current caret position. + +\membersection{wxRichTextCtrl::PositionToXY}\label{wxrichtextctrlpositiontoxy} + +\constfunc{bool}{PositionToXY}{\param{long }{pos}, \param{long* }{x}, \param{long* }{y}} + +Converts a text position to zero-based column and line numbers. + +\membersection{wxRichTextCtrl::Redo}\label{wxrichtextctrlredo} + +\func{void}{Redo}{\void} + +Redoes the current command. + +\membersection{wxRichTextCtrl::Remove}\label{wxrichtextctrlremove} + +\func{void}{Remove}{\param{long }{from}, \param{long }{to}} + +Removes the content in the specified range. + +\membersection{wxRichTextCtrl::Replace}\label{wxrichtextctrlreplace} + +\func{void}{Replace}{\param{long }{from}, \param{long }{to}, \param{const wxString\& }{value}} + +Replaces the content in the specified range with the string specified by {\it value}. + +\membersection{wxRichTextCtrl::SaveFile}\label{wxrichtextctrlsavefile} + +\func{bool}{SaveFile}{\param{const wxString\& }{file = wxEmptyString}, \param{int }{type = wxRICHTEXT\_TYPE\_ANY}} + +Saves the buffer content using the given type. If the specified type +is wxRICHTEXT\_TYPE\_ANY, the type is deduced from the filename extension. + +This function looks for a suitable \helpref{wxRichTextFileHandler}{wxrichtextfilehandler} object. + +\membersection{wxRichTextCtrl::ScrollIntoView}\label{wxrichtextctrlscrollintoview} + +\func{bool}{ScrollIntoView}{\param{long }{position}, \param{int }{keyCode}} + +Scrolls {\it position} into view. This function takes a caret position. + +\membersection{wxRichTextCtrl::SelectAll}\label{wxrichtextctrlselectall} + +\func{void}{SelectAll}{\void} + +Selects all the text in the buffer. + +\membersection{wxRichTextCtrl::SelectNone}\label{wxrichtextctrlselectnone} + +\func{void}{SelectNone}{\void} + +Cancels any selection. + +\membersection{wxRichTextCtrl::SetBasicStyle}\label{wxrichtextctrlsetbasicstyle} + +\func{void}{SetBasicStyle}{\param{const wxRichTextAttr\& }{style}} + +\func{void}{SetBasicStyle}{\param{const wxTextAttrEx\& }{style}} + +Sets the basic (overall) style. This is the style of the whole +buffer before further styles are applied, unlike the default style, which +only affects the style currently being applied (for example, setting the default +style to bold will cause subsequently inserted text to be bold). + +\membersection{wxRichTextCtrl::SetCaretPosition}\label{wxrichtextctrlsetcaretposition} + +\func{void}{SetCaretPosition}{\param{long }{position}, \param{bool }{showAtLineStart = false}} + +The caret position is the character position just before the caret. +A value of -1 means the caret is at the start of the buffer. + +\membersection{wxRichTextCtrl::SetDefaultStyle}\label{wxrichtextctrlsetdefaultstyle} + +\func{bool}{SetDefaultStyle}{\param{const wxTextAttrEx\& }{style}} + +Sets the current default style, which can be used to change how subsequently inserted +text is displayed. + +\membersection{wxRichTextCtrl::SetDefaultStyleToCursorStyle}\label{wxrichtextctrlsetdefaultstyletocursorstyle} + +\func{bool}{SetDefaultStyleToCursorStyle}{\void} + +Sets the default style to the style under the cursor. + +\membersection{wxRichTextCtrl::SetDelayedLayoutThreshold}\label{wxrichtextctrlsetdelayedlayoutthreshold} + +\func{void}{SetDelayedLayoutThreshold}{\param{long }{threshold}} + +Sets the size of the buffer beyond which layout is delayed during resizing. +This optimizes sizing for large buffers. The default is 20000. + +\membersection{wxRichTextCtrl::SetEditable}\label{wxrichtextctrlseteditable} + +\func{void}{SetEditable}{\param{bool }{editable}} + +Makes the control editable, or not. + +\membersection{wxRichTextCtrl::SetFilename}\label{wxrichtextctrlsetfilename} + +\func{void}{SetFilename}{\param{const wxString\& }{filename}} + +Sets the current filename. + +\membersection{wxRichTextCtrl::SetFont}\label{wxrichtextctrlsetfont} + +\func{bool}{SetFont}{\param{const wxFont\& }{font}} + +Sets the font, and also the basic and default attributes (see \helpref{SetDefaultStyle}{wxrichtextctrlsetdefaultstyle}). + +\membersection{wxRichTextCtrl::SetInsertionPoint}\label{wxrichtextctrlsetinsertionpoint} + +\func{void}{SetInsertionPoint}{\param{long }{pos}} + +Sets the insertion point. + +\membersection{wxRichTextCtrl::SetInsertionPointEnd}\label{wxrichtextctrlsetinsertionpointend} + +\func{void}{SetInsertionPointEnd}{\void} + +Sets the insertion point to the end of the text control. + +\membersection{wxRichTextCtrl::SetSelection}\label{wxrichtextctrlsetselection} + +\func{void}{SetSelection}{\param{long }{from}, \param{long }{to}} + +Sets the selection to the given range. + +\membersection{wxRichTextCtrl::SetSelectionRange}\label{wxrichtextctrlsetselectionrange} + +\func{void}{SetSelectionRange}{\param{const wxRichTextRange\& }{range}} + +Sets the selection to the given range. + +\membersection{wxRichTextCtrl::SetStyle}\label{wxrichtextctrlsetstyle} + +\func{bool}{SetStyle}{\param{const wxRichTextRange\& }{range}, \param{const wxRichTextAttr\& }{style}} + +\func{bool}{SetStyle}{\param{long }{start}, \param{long }{end}, \param{const wxTextAttrEx\& }{style}} + +Sets the attributes for the given range. The wxRichTextAttr version is more efficient +because it does not use wxFont objects. + +\membersection{wxRichTextCtrl::SetStyleSheet}\label{wxrichtextctrlsetstylesheet} + +\func{void}{SetStyleSheet}{\param{wxRichTextStyleSheet* }{styleSheet}} + +Sets the style sheet associated with the control. A style sheet allows named +character and paragraph styles to be applied. + +\membersection{wxRichTextCtrl::SetValue}\label{wxrichtextctrlsetvalue} + +\func{void}{SetValue}{\param{const wxString\& }{value}} + +Replaces existing content with the given text. + +\membersection{wxRichTextCtrl::SetupScrollbars}\label{wxrichtextctrlsetupscrollbars} + +\func{void}{SetupScrollbars}{\param{bool }{atTop = false}} + +A helper function setting up scrollbars, for example after a resize. + +\membersection{wxRichTextCtrl::ShowPosition}\label{wxrichtextctrlshowposition} + +\func{void}{ShowPosition}{\param{long }{pos}} + +Scrolls the buffer so that the given position is in view. + +\membersection{wxRichTextCtrl::SuppressingUndo}\label{wxrichtextctrlsuppressingundo} + +\constfunc{bool}{SuppressingUndo}{\void} + +Returns \true if undo history suppression is on. + +\membersection{wxRichTextCtrl::Thaw}\label{wxrichtextctrlthaw} + +\func{void}{Thaw}{\void} + +Call this function to end a Freeze and refresh the display. + +\membersection{wxRichTextCtrl::Undo}\label{wxrichtextctrlundo} + +\func{void}{Undo}{\void} + +Undoes the command at the top of the command history, if there is one. + +\membersection{wxRichTextCtrl::WordLeft}\label{wxrichtextctrlwordleft} + +\func{bool}{WordLeft}{\param{int }{noWords = 1}, \param{int }{flags = 0}} + +Moves a number of words to the left. + +\membersection{wxRichTextCtrl::WordRight}\label{wxrichtextctrlwordright} + +\func{bool}{WordRight}{\param{int }{noWords = 1}, \param{int }{flags = 0}} + +Move a nuber of words to the right. + +\membersection{wxRichTextCtrl::WriteImage}\label{wxrichtextctrlwriteimage} + +\func{bool}{WriteImage}{\param{const wxString\& }{filename}, \param{int }{bitmapType}} + +Loads an image from a file and writes it at the current insertion point. + +\func{bool}{WriteImage}{\param{const wxRichTextImageBlock\& }{imageBlock}} + +Writes an image block at the current insertion point. + +\func{bool}{WriteImage}{\param{const wxBitmap\& }{bitmap}, \param{int }{bitmapType = wxBITMAP\_TYPE\_PNG}} + +\func{bool}{WriteImage}{\param{const wxImage\& }{image}, \param{int }{bitmapType = wxBITMAP\_TYPE\_PNG}} + +Write a bitmap or image at the current insertion point. Supply an optional type to use +for internal and file storage of the raw data. + +\membersection{wxRichTextCtrl::WriteText}\label{wxrichtextctrlwritetext} + +\func{void}{WriteText}{\param{const wxString\& }{text}} + +Writes text at the current position. + +\membersection{wxRichTextCtrl::XYToPosition}\label{wxrichtextctrlxytoposition} + +\constfunc{long}{XYToPosition}{\param{long }{x}, \param{long }{y}} + +Translates from column and line number to position. diff --git a/docs/latex/wx/richtextevent.tex b/docs/latex/wx/richtextevent.tex new file mode 100644 index 0000000000..6214a6dea7 --- /dev/null +++ b/docs/latex/wx/richtextevent.tex @@ -0,0 +1,70 @@ +\section{\class{wxRichTextEvent}}\label{wxrichtextevent} + +This is the event class for wxRichTextCtrl notifications. Note that event generation +is very incomplete; we need to implement events such as selection of text, deletion, +insertion, and so on. + +\wxheading{Event table macros} + +To process a rich text event, use these event handler macros to direct input to a member +function that takes a wxRichTextEvent argument. + +\twocolwidtha{7cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{{\bf EVT\_RICHTEXT\_LEFT\_CLICK(id, func)}}{Process a wxEVT\_COMMAND\_RICHTEXT\_LEFT\_CLICK event. Not currently implemented.} +\twocolitem{{\bf EVT\_RICHTEXT\_RIGHT\_CLICK(id, func)}}{Process a wxEVT\_COMMAND\_RICHTEXT\_RIGHT\_CLICK event. Not currently implemented.} +\twocolitem{{\bf EVT\_RICHTEXT\_MIDDLE\_CLICK(id, func)}}{Process a wxEVT\_COMMAND\_RICHTEXT\_MIDDLE\_CLICK event. Not currently implemented.} +\twocolitem{{\bf EVT\_RICHTEXT\_LEFT\_DCLICK(id, func)}}{Process a wxEVT\_COMMAND\_RICHTEXT\_LEFT\_DCLICK event. Not currently implemented.} +\twocolitem{{\bf EVT\_RICHTEXT\_RETURN(id, func)}}{Process a wxEVT\_COMMAND\_RICHTEXT\_RETURN event, generated when the user presses the return key.} +\end{twocollist}% + +\wxheading{Derived from} + +\helpref{wxNotifyEvent}{wxnotifyevent} + +\wxheading{Include files} + + + +\wxheading{Data structures} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxRichTextEvent::wxRichTextEvent}\label{wxrichtexteventwxrichtextevent} + +\func{}{wxRichTextEvent}{\param{const wxRichTextEvent\& }{event}} + +\func{}{wxRichTextEvent}{\param{wxEventType }{commandType = wxEVT\_NULL}, \param{int }{winid = 0}} + +Constructors. + +\membersection{wxRichTextEvent::Clone}\label{wxrichtexteventclone} + +\constfunc{wxEvent*}{Clone}{\void} + +Clones the event. + +\membersection{wxRichTextEvent::GetFlags}\label{wxrichtexteventgetflags} + +\constfunc{int}{GetFlags}{\void} + +Returns flags indicating modifier keys pressed. + +\membersection{wxRichTextEvent::GetIndex}\label{wxrichtexteventgetindex} + +\constfunc{int}{GetIndex}{\void} + +Not currently used. + +\membersection{wxRichTextEvent::SetFlags}\label{wxrichtexteventsetflags} + +\func{void}{SetFlags}{\param{int }{flags}} + +Sets flags indicating modifier keys pressed. Possible values are wxRICHTEXT\_CTRL\_DOWN, +wxRICHTEXT\_SHIFT\_DOWN, andwxRICHTEXT\_ALT\_DOWN. + +\membersection{wxRichTextEvent::SetIndex}\label{wxrichtexteventsetindex} + +\func{void}{SetIndex}{\param{int }{n}} + +Not currently used. diff --git a/docs/latex/wx/richtextfilehandler.tex b/docs/latex/wx/richtextfilehandler.tex new file mode 100644 index 0000000000..0e6c27c1b9 --- /dev/null +++ b/docs/latex/wx/richtextfilehandler.tex @@ -0,0 +1,130 @@ +\section{\class{wxRichTextFileHandler}}\label{wxrichtextfilehandler} + +This is the base class for file handlers, for loading and/or saving content +associated with a \helpref{wxRichTextBuffer}{wxrichtextbuffer}. + +\wxheading{Derived from} + +\helpref{wxObject}{wxobject} + +\wxheading{Include files} + + + +\wxheading{Data structures} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxRichTextFileHandler::wxRichTextFileHandler}\label{wxrichtextfilehandlerwxrichtextfilehandler} + +\func{}{wxRichTextFileHandler}{\param{const wxString\& }{name = wxEmptyString}, \param{const wxString\& }{ext = wxEmptyString}, \param{int }{type = 0}} + +Constructor. + +\membersection{wxRichTextFileHandler::CanHandle}\label{wxrichtextfilehandlercanhandle} + +\constfunc{bool}{CanHandle}{\param{const wxString\& }{filename}} + +Override this function and return \true if this handler can we handle {\it filename}. By default, +this function checks the extension. + +\membersection{wxRichTextFileHandler::CanLoad}\label{wxrichtextfilehandlercanload} + +\constfunc{bool}{CanLoad}{\void} + +Override and return \true if this handler can load content. + +\membersection{wxRichTextFileHandler::CanSave}\label{wxrichtextfilehandlercansave} + +\constfunc{bool}{CanSave}{\void} + +Override and return \true if this handler can save content. + +\membersection{wxRichTextFileHandler::DoLoadFile}\label{wxrichtextfilehandlerdoloadfile} + +\func{bool}{DoLoadFile}{\param{wxRichTextBuffer* }{buffer}, \param{wxInputStream\& }{stream}} + +Override to load content from {\it stream} into {\it buffer}. + +\membersection{wxRichTextFileHandler::DoSaveFile}\label{wxrichtextfilehandlerdosavefile} + +\func{bool}{DoSaveFile}{\param{wxRichTextBuffer* }{buffer}, \param{wxOutputStream\& }{stream}} + +Override to save content to {\it stream} from {\it buffer}. + +\membersection{wxRichTextFileHandler::GetEncoding}\label{wxrichtextfilehandlergetencoding} + +\constfunc{const wxString\&}{GetEncoding}{\void} + +Returns the encoding associated with the handler (if any). + +\membersection{wxRichTextFileHandler::GetExtension}\label{wxrichtextfilehandlergetextension} + +\constfunc{wxString}{GetExtension}{\void} + +Returns the extension associated with the handler. + +\membersection{wxRichTextFileHandler::GetName}\label{wxrichtextfilehandlergetname} + +\constfunc{wxString}{GetName}{\void} + +Returns the name of the handler. + +\membersection{wxRichTextFileHandler::GetType}\label{wxrichtextfilehandlergettype} + +\constfunc{int}{GetType}{\void} + +Returns the type of the handler. + +\membersection{wxRichTextFileHandler::IsVisible}\label{wxrichtextfilehandlerisvisible} + +\constfunc{bool}{IsVisible}{\void} + +Returns \true if this handler should be visible to the user. + +\membersection{wxRichTextFileHandler::LoadFile}\label{wxrichtextfilehandlerloadfile} + +\func{bool}{LoadFile}{\param{wxRichTextBuffer* }{buffer}, \param{wxInputStream\& }{stream}} + +\func{bool}{LoadFile}{\param{wxRichTextBuffer* }{buffer}, \param{const wxString\& }{filename}} + +Loads content from a stream or file. Not all handlers will implement file loading. + +\membersection{wxRichTextFileHandler::SaveFile}\label{wxrichtextfilehandlersavefile} + +\func{bool}{SaveFile}{\param{wxRichTextBuffer* }{buffer}, \param{wxOutputStream\& }{stream}} + +\func{bool}{SaveFile}{\param{wxRichTextBuffer* }{buffer}, \param{const wxString\& }{filename}} + +Saves content to a stream or file. Not all handlers will implement file saving. + +\membersection{wxRichTextFileHandler::SetEncoding}\label{wxrichtextfilehandlersetencoding} + +\func{void}{SetEncoding}{\param{const wxString\& }{encoding}} + +Sets the encoding to use when saving a file. If empty, a suitable encoding is chosen. + +\membersection{wxRichTextFileHandler::SetExtension}\label{wxrichtextfilehandlersetextension} + +\func{void}{SetExtension}{\param{const wxString\& }{ext}} + +Sets the default extension to recognise. + +\membersection{wxRichTextFileHandler::SetName}\label{wxrichtextfilehandlersetname} + +\func{void}{SetName}{\param{const wxString\& }{name}} + +Sets the name of the handler. + +\membersection{wxRichTextFileHandler::SetType}\label{wxrichtextfilehandlersettype} + +\func{void}{SetType}{\param{int }{type}} + +Sets the handler type. + +\membersection{wxRichTextFileHandler::SetVisible}\label{wxrichtextfilehandlersetvisible} + +\func{void}{SetVisible}{\param{bool }{visible}} + +Sets whether the handler should be visible to the user (via the application's load and save +dialogs). diff --git a/docs/latex/wx/richtexthtmlhandler.tex b/docs/latex/wx/richtexthtmlhandler.tex new file mode 100644 index 0000000000..17a90e9137 --- /dev/null +++ b/docs/latex/wx/richtexthtmlhandler.tex @@ -0,0 +1,27 @@ +\section{\class{wxRichTextHTMLHandler}}\label{wxrichtexthtmlhandler} + +Handles HTML output (only) for \helpref{wxRichTextCtrl}{wxrichtextctrl} content. + +\wxheading{Derived from} + +\helpref{wxRichTextFileHandler}{wxrichtextfilehandler} + +\wxheading{Include files} + + + +\wxheading{Data structures} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxRichTextHTMLHandler::wxRichTextHTMLHandler}\label{wxrichtexthtmlhandlerwxrichtexthtmlhandler} + +\func{}{wxRichTextHTMLHandler}{\param{const wxString\& }{name = wxT("HTML")}, \param{const wxString\& }{ext = wxT("html")}, \param{int }{type = wxRICHTEXT\_TYPE\_HTML}} + +Constructor. + +\membersection{wxRichTextHTMLHandler::DoSaveFile}\label{wxrichtexthtmlhandlerdosavefile} + +\func{bool}{DoSaveFile}{\param{wxRichTextBuffer* }{buffer}, \param{wxOutputStream\& }{stream}} + +Saves the buffer content to the HTML stream. diff --git a/docs/latex/wx/richtextoverview.tex b/docs/latex/wx/richtextoverview.tex new file mode 100644 index 0000000000..e9a5116a6d --- /dev/null +++ b/docs/latex/wx/richtextoverview.tex @@ -0,0 +1,34 @@ +\section{wxRichTextCtrl overview}\label{wxrichtextctrloverview} + +Classes: \helpref{wxRichTextCtrl}{wxrichtextctrl}, \helpref{wxRichTextBuffer}{wxrichtextbuffer}, +\helpref{wxRichTextAttr}{wxrichtextattr}, \helpref{wxTextAttrEx}{wxtextattrex}, +\helpref{wxRichTextCharacterStyleDefinition}{wxrichtextcharacterstyledefinition}, +\helpref{wxRichTextParagraphStyleDefinition}{wxrichtextparagraphstyledefinition}, +\helpref{wxRichTextStyleSheet}{wxrichtextstylesheet}, +\helpref{wxRichTextStyleListBox}{wxrichtextstylelistbox}, +\helpref{wxRichTextEvent}{wxrichtextevent}, \helpref{wxRichTextRange}{wxrichtextrange}, +\helpref{wxRichTextFileHandler}{wxrichtextfilehandler}, \helpref{wxRichTextHTMLHandler}{wxrichtexthtmlhandler}, +\helpref{wxRichTextXMLHandler}{wxrichtextxmlhandler} + +wxRichTextCtrl provides a generic implementation of a rich text editor + +The following screenshot shows the wxRichTextCtrl sample in action: + +$$\image{8cm;0cm}{richtextctrl.gif}$$ + +\wxheading{Example}\label{wxrichtextctrlexample} + +TODO + +{\small +\begin{verbatim} +\end{verbatim} +} + +\wxheading{Programming with wxRichTextCtrl} + +TODO + +\wxheading{How wxRichTextCtrl is implemented} + +TODO diff --git a/docs/latex/wx/richtextparagraphstyledefinition.tex b/docs/latex/wx/richtextparagraphstyledefinition.tex new file mode 100644 index 0000000000..c6491d0409 --- /dev/null +++ b/docs/latex/wx/richtextparagraphstyledefinition.tex @@ -0,0 +1,39 @@ +\section{\class{wxRichTextParagraphStyleDefinition}}\label{wxrichtextparagraphstyledefinition} + +This class represents a paragraph style definition, usually added to a \helpref{wxRichTextStyleSheet}{wxrichtextstylesheet}. + +\wxheading{Derived from} + +\helpref{wxRichTextStyleDefinition}{wxrichtextstyledefinition} + +\wxheading{Include files} + + + +\wxheading{Data structures} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxRichTextParagraphStyleDefinition::wxRichTextParagraphStyleDefinition}\label{wxrichtextparagraphstyledefinitionwxrichtextparagraphstyledefinition} + +\func{}{wxRichTextParagraphStyleDefinition}{\param{const wxString\& }{name = wxEmptyString}} + +Constructor. + +\membersection{wxRichTextParagraphStyleDefinition::\destruct{wxRichTextParagraphStyleDefinition}}\label{wxrichtextparagraphstyledefinitiondtor} + +\func{}{\destruct{wxRichTextParagraphStyleDefinition}}{\void} + +Destructor. + +\membersection{wxRichTextParagraphStyleDefinition::GetNextStyle}\label{wxrichtextparagraphstyledefinitiongetnextstyle} + +\constfunc{const wxString\&}{GetNextStyle}{\void} + +Returns the style that should normally follow this style. + +\membersection{wxRichTextParagraphStyleDefinition::SetNextStyle}\label{wxrichtextparagraphstyledefinitionsetnextstyle} + +\func{void}{SetNextStyle}{\param{const wxString\& }{name}} + +Sets the style that should normally follow this style. diff --git a/docs/latex/wx/richtextrange.tex b/docs/latex/wx/richtextrange.tex new file mode 100644 index 0000000000..fd3d0fa622 --- /dev/null +++ b/docs/latex/wx/richtextrange.tex @@ -0,0 +1,122 @@ +\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} + + + +\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. diff --git a/docs/latex/wx/richtextstyledefinition.tex b/docs/latex/wx/richtextstyledefinition.tex new file mode 100644 index 0000000000..19e5fcc514 --- /dev/null +++ b/docs/latex/wx/richtextstyledefinition.tex @@ -0,0 +1,72 @@ +\section{\class{wxRichTextStyleDefinition}}\label{wxrichtextstyledefinition} + +This is a base class for paragraph and character styles. + +\wxheading{Derived from} + +\helpref{wxObject}{wxobject} + +\wxheading{Include files} + + + +\wxheading{Data structures} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxRichTextStyleDefinition::wxRichTextStyleDefinition}\label{wxrichtextstyledefinitionwxrichtextstyledefinition} + +\func{}{wxRichTextStyleDefinition}{\param{const wxString\& }{name = wxEmptyString}} + +Constructor. + +\membersection{wxRichTextStyleDefinition::\destruct{wxRichTextStyleDefinition}}\label{wxrichtextstyledefinitiondtor} + +\func{}{\destruct{wxRichTextStyleDefinition}}{\void} + +Destructor. + +\membersection{wxRichTextStyleDefinition::GetBaseStyle}\label{wxrichtextstyledefinitiongetbasestyle} + +\constfunc{const wxString\&}{GetBaseStyle}{\void} + +Returns the style on which this style is based. + +\membersection{wxRichTextStyleDefinition::GetName}\label{wxrichtextstyledefinitiongetname} + +\constfunc{const wxString\&}{GetName}{\void} + +Returns the style name. + +\membersection{wxRichTextStyleDefinition::GetStyle}\label{wxrichtextstyledefinitiongetstyle} + +\func{wxRichTextAttr\&}{GetStyle}{\void} + +\constfunc{const wxRichTextAttr\&}{GetStyle}{\void} + +Returns the attributes associated with this style. + +\membersection{wxRichTextStyleDefinition::Init}\label{wxrichtextstyledefinitioninit} + +\func{void}{Init}{\void} + +Initialises the definition. + +\membersection{wxRichTextStyleDefinition::SetBaseStyle}\label{wxrichtextstyledefinitionsetbasestyle} + +\func{void}{SetBaseStyle}{\param{const wxString\& }{name}} + +Sets the name of the style that this style is based on. + +\membersection{wxRichTextStyleDefinition::SetName}\label{wxrichtextstyledefinitionsetname} + +\func{void}{SetName}{\param{const wxString\& }{name}} + +Sets the name of the style. + +\membersection{wxRichTextStyleDefinition::SetStyle}\label{wxrichtextstyledefinitionsetstyle} + +\func{void}{SetStyle}{\param{const wxRichTextAttr\& }{style}} + +Sets the attributes for this style. + diff --git a/docs/latex/wx/richtextstylelistbox.tex b/docs/latex/wx/richtextstylelistbox.tex new file mode 100644 index 0000000000..c546751105 --- /dev/null +++ b/docs/latex/wx/richtextstylelistbox.tex @@ -0,0 +1,96 @@ +\section{\class{wxRichTextStyleListBox}}\label{wxrichtextstylelistbox} + +This is a listbox that can display the styles in a \helpref{wxRichTextStyleSheet}{wxrichtextstylesheet}, +and apply the selection to an associated \helpref{wxRichTextCtrl}{wxrichtextctrl}. + +See {\tt samples/richtext} for an example of how to use it. + +\wxheading{Derived from} + +\helpref{wxHtmlListBox}{wxhtmllistbox} + +\wxheading{Include files} + + + +\wxheading{Data structures} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxRichTextStyleListBox::wxRichTextStyleListBox}\label{wxrichtextstylelistboxwxrichtextstylelistbox} + +\func{}{wxRichTextStyleListBox}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = 0}} + +Constructor. + +\membersection{wxRichTextStyleListBox::\destruct{wxRichTextStyleListBox}}\label{wxrichtextstylelistboxdtor} + +\func{}{\destruct{wxRichTextStyleListBox}}{\void} + +Destructor. + +\membersection{wxRichTextStyleListBox::ConvertTenthsMMToPixels}\label{wxrichtextstylelistboxconverttenthsmmtopixels} + +\constfunc{int}{ConvertTenthsMMToPixels}{\param{wxDC\& }{dc}, \param{int }{units}} + +Converts units in tenths of a millimetre to device units. + +\membersection{wxRichTextStyleListBox::CreateHTML}\label{wxrichtextstylelistboxcreatehtml} + +\constfunc{wxString}{CreateHTML}{\param{wxRichTextStyleDefinition* }{def}} + +Creates a suitable HTML fragment for a definition. + +\membersection{wxRichTextStyleListBox::GetRichTextCtrl}\label{wxrichtextstylelistboxgetrichtextctrl} + +\constfunc{wxRichTextCtrl*}{GetRichTextCtrl}{\void} + +Returns the \helpref{wxRichTextCtrl}{wxrichtextctrl} associated with this listbox. + +\membersection{wxRichTextStyleListBox::GetStyle}\label{wxrichtextstylelistboxgetstyle} + +\constfunc{wxRichTextStyleDefinition*}{GetStyle}{\param{size\_t }{i}} + +Gets a style for a listbox index. + +\membersection{wxRichTextStyleListBox::GetStyleSheet}\label{wxrichtextstylelistboxgetstylesheet} + +\constfunc{wxRichTextStyleSheet*}{GetStyleSheet}{\void} + +Returns the style sheet associated with this listbox. + +\membersection{wxRichTextStyleListBox::OnGetItem}\label{wxrichtextstylelistboxongetitem} + +\constfunc{wxString}{OnGetItem}{\param{size\_t }{n}} + +Returns the HTML for this item. + +\membersection{wxRichTextStyleListBox::OnLeftDown}\label{wxrichtextstylelistboxonleftdown} + +\func{void}{OnLeftDown}{\param{wxMouseEvent\& }{event}} + +Implements left click behaviour, applying the clicked style to the wxRichTextCtrl. + +\membersection{wxRichTextStyleListBox::OnSelect}\label{wxrichtextstylelistboxonselect} + +\func{void}{OnSelect}{\param{wxCommandEvent\& }{event}} + +Reacts to selection. + +\membersection{wxRichTextStyleListBox::SetRichTextCtrl}\label{wxrichtextstylelistboxsetrichtextctrl} + +\func{void}{SetRichTextCtrl}{\param{wxRichTextCtrl* }{ctrl}} + +Associates the listbox with a \helpref{wxRichTextCtrl}{wxrichtextctrl}. + +\membersection{wxRichTextStyleListBox::SetStyleSheet}\label{wxrichtextstylelistboxsetstylesheet} + +\func{void}{SetStyleSheet}{\param{wxRichTextStyleSheet* }{styleSheet}} + +Associates the control with a style sheet. + +\membersection{wxRichTextStyleListBox::UpdateStyles}\label{wxrichtextstylelistboxupdatestyles} + +\func{void}{UpdateStyles}{\void} + +Updates the list from the associated style sheet. diff --git a/docs/latex/wx/richtextstylesheet.tex b/docs/latex/wx/richtextstylesheet.tex new file mode 100644 index 0000000000..04fbf34231 --- /dev/null +++ b/docs/latex/wx/richtextstylesheet.tex @@ -0,0 +1,104 @@ +\section{\class{wxRichTextStyleSheet}}\label{wxrichtextstylesheet} + +A style sheet contains named paragraph and character styles that make it +easy for a user to apply combinations of attributes to a \helpref{wxRichTextCtrl}{wxrichtextctrl}. + +You can use a \helpref{wxRichTextStyleListBox}{wxrichtextstylelistbox} in your +user interface to show available styles to the user, and allow application +of styles to the control. + +\wxheading{Derived from} + +\helpref{wxObject}{wxobject} + +\wxheading{Include files} + + + +\wxheading{Data structures} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxRichTextStyleSheet::wxRichTextStyleSheet}\label{wxrichtextstylesheetwxrichtextstylesheet} + +\func{}{wxRichTextStyleSheet}{\void} + +Constructor. + +\membersection{wxRichTextStyleSheet::\destruct{wxRichTextStyleSheet}}\label{wxrichtextstylesheetdtor} + +\func{}{\destruct{wxRichTextStyleSheet}}{\void} + +Destructor. + +\membersection{wxRichTextStyleSheet::AddCharacterStyle}\label{wxrichtextstylesheetaddcharacterstyle} + +\func{bool}{AddCharacterStyle}{\param{wxRichTextCharacterStyleDefinition* }{def}} + +Adds a definition to the character style list. + +\membersection{wxRichTextStyleSheet::AddParagraphStyle}\label{wxrichtextstylesheetaddparagraphstyle} + +\func{bool}{AddParagraphStyle}{\param{wxRichTextParagraphStyleDefinition* }{def}} + +Adds a definition to the paragraph style list. + +\membersection{wxRichTextStyleSheet::DeleteStyles}\label{wxrichtextstylesheetdeletestyles} + +\func{void}{DeleteStyles}{\void} + +Deletes all styles. + +\membersection{wxRichTextStyleSheet::FindCharacterStyle}\label{wxrichtextstylesheetfindcharacterstyle} + +\constfunc{wxRichTextCharacterStyleDefinition*}{FindCharacterStyle}{\param{const wxString\& }{name}} + +Finds a character definition by name. + +\membersection{wxRichTextStyleSheet::FindParagraphStyle}\label{wxrichtextstylesheetfindparagraphstyle} + +\constfunc{wxRichTextParagraphStyleDefinition*}{FindParagraphStyle}{\param{const wxString\& }{name}} + +Finds a paragraph definition by name. + +\membersection{wxRichTextStyleSheet::GetCharacterStyle}\label{wxrichtextstylesheetgetcharacterstyle} + +\constfunc{wxRichTextCharacterStyleDefinition*}{GetCharacterStyle}{\param{size\_t }{n}} + +Returns the {\it n}th character style. + +\membersection{wxRichTextStyleSheet::GetCharacterStyleCount}\label{wxrichtextstylesheetgetcharacterstylecount} + +\constfunc{size\_t}{GetCharacterStyleCount}{\void} + +Returns the number of character styles. + +\membersection{wxRichTextStyleSheet::GetParagraphStyle}\label{wxrichtextstylesheetgetparagraphstyle} + +\constfunc{wxRichTextParagraphStyleDefinition*}{GetParagraphStyle}{\param{size\_t }{n}} + +Returns the {\it n}th paragraph style. + +\membersection{wxRichTextStyleSheet::GetParagraphStyleCount}\label{wxrichtextstylesheetgetparagraphstylecount} + +\constfunc{size\_t}{GetParagraphStyleCount}{\void} + +Returns the number of paragraph styles. + +\membersection{wxRichTextStyleSheet::Init}\label{wxrichtextstylesheetinit} + +\func{void}{Init}{\void} + +Initialises the style sheet. + +\membersection{wxRichTextStyleSheet::RemoveCharacterStyle}\label{wxrichtextstylesheetremovecharacterstyle} + +\func{bool}{RemoveCharacterStyle}{\param{wxRichTextStyleDefinition* }{def}, \param{bool }{deleteStyle = false}} + +Removes a character style. + +\membersection{wxRichTextStyleSheet::RemoveParagraphStyle}\label{wxrichtextstylesheetremoveparagraphstyle} + +\func{bool}{RemoveParagraphStyle}{\param{wxRichTextStyleDefinition* }{def}, \param{bool }{deleteStyle = false}} + +Removes a paragraph style. diff --git a/docs/latex/wx/richtextxmlhandler.tex b/docs/latex/wx/richtextxmlhandler.tex new file mode 100644 index 0000000000..224d132eff --- /dev/null +++ b/docs/latex/wx/richtextxmlhandler.tex @@ -0,0 +1,104 @@ +\section{\class{wxRichTextXMLHandler}}\label{wxrichtextxmlhandler} + +A handler for loading and saving content in an XML format specific +to wxRichTextBuffer. You can either add the handler to the buffer +and load and save through the buffer or control API, or you can +create an instance of the handler on the stack and call its +functions directly. + +\wxheading{Derived from} + +\helpref{wxRichTextFileHandler}{wxrichtextfilehandler} + +\wxheading{Include files} + + + +\wxheading{Data structures} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxRichTextXMLHandler::wxRichTextXMLHandler}\label{wxrichtextxmlhandlerwxrichtextxmlhandler} + +\func{}{wxRichTextXMLHandler}{\param{const wxString\& }{name = wxT("XML")}, \param{const wxString\& }{ext = wxT("xml")}, \param{int }{type = wxRICHTEXT\_TYPE\_XML}} + +Constructor. + +\membersection{wxRichTextXMLHandler::CanLoad}\label{wxrichtextxmlhandlercanload} + +\constfunc{bool}{CanLoad}{\void} + +Returns \true. + +\membersection{wxRichTextXMLHandler::CanSave}\label{wxrichtextxmlhandlercansave} + +\constfunc{bool}{CanSave}{\void} + +Returns \true. + +\membersection{wxRichTextXMLHandler::CreateStyle}\label{wxrichtextxmlhandlercreatestyle} + +\func{wxString}{CreateStyle}{\param{const wxTextAttrEx\& }{attr}, \param{bool }{isPara = false}} + +Creates XML code for a given character or paragraph style. + +\membersection{wxRichTextXMLHandler::DoLoadFile}\label{wxrichtextxmlhandlerdoloadfile} + +\func{bool}{DoLoadFile}{\param{wxRichTextBuffer* }{buffer}, \param{wxInputStream\& }{stream}} + +Loads buffer context from the given stream. + +\membersection{wxRichTextXMLHandler::DoSaveFile}\label{wxrichtextxmlhandlerdosavefile} + +\func{bool}{DoSaveFile}{\param{wxRichTextBuffer* }{buffer}, \param{wxOutputStream\& }{stream}} + +Saves buffer context to the given stream. + +\membersection{wxRichTextXMLHandler::ExportXML}\label{wxrichtextxmlhandlerexportxml} + +\func{bool}{ExportXML}{\param{wxOutputStream\& }{stream}, \param{wxMBConv* }{convMem}, \param{wxMBConv* }{convFile}, \param{wxRichTextObject\& }{obj}, \param{int }{level}} + +Recursively exports an object to the stream. + +\membersection{wxRichTextXMLHandler::GetNodeContent}\label{wxrichtextxmlhandlergetnodecontent} + +\func{wxString}{GetNodeContent}{\param{wxXmlNode* }{node}} + +Helper function: gets node context. + +\membersection{wxRichTextXMLHandler::GetParamNode}\label{wxrichtextxmlhandlergetparamnode} + +\func{wxXmlNode*}{GetParamNode}{\param{wxXmlNode* }{node}, \param{const wxString\& }{param}} + +Helper function: gets a named parameter from the XML node. + +\membersection{wxRichTextXMLHandler::GetParamValue}\label{wxrichtextxmlhandlergetparamvalue} + +\func{wxString}{GetParamValue}{\param{wxXmlNode* }{node}, \param{const wxString\& }{param}} + +Helper function: gets a named parameter from the XML node. + +\membersection{wxRichTextXMLHandler::GetStyle}\label{wxrichtextxmlhandlergetstyle} + +\func{bool}{GetStyle}{\param{wxTextAttrEx\& }{attr}, \param{wxXmlNode* }{node}, \param{bool }{isPara = false}} + +Helper function: gets style parameters from the given XML node. + +\membersection{wxRichTextXMLHandler::GetText}\label{wxrichtextxmlhandlergettext} + +\func{wxString}{GetText}{\param{wxXmlNode* }{node}, \param{const wxString\& }{param = wxEmptyString}, \param{bool }{translate = false}} + +Helper function: gets text from the node. + +\membersection{wxRichTextXMLHandler::HasParam}\label{wxrichtextxmlhandlerhasparam} + +\func{bool}{HasParam}{\param{wxXmlNode* }{node}, \param{const wxString\& }{param}} + +Helper function: returns \true if the node has the given parameter. + +\membersection{wxRichTextXMLHandler::ImportXML}\label{wxrichtextxmlhandlerimportxml} + +\func{bool}{ImportXML}{\param{wxRichTextBuffer* }{buffer}, \param{wxXmlNode* }{node}} + +Recursively imports an object. + diff --git a/docs/latex/wx/text.tex b/docs/latex/wx/text.tex index 7808739ee7..5992858843 100644 --- a/docs/latex/wx/text.tex +++ b/docs/latex/wx/text.tex @@ -1,257 +1,3 @@ -%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxTextAttr %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\section{\class{wxTextAttr}}\label{wxtextattr} - -wxTextAttr represents the character and paragraph attributes, or style, for a range of text in a\rtfsp -\helpref{wxTextCtrl}{wxtextctrl}. - -When setting up a wxTextAttr object, pass a bitlist mask to SetFlags to indicate -which style elements should be changed. As a convenience, when you call a -setter such as SetFont, the relevant bit will be set. - -\wxheading{Derived from} - -No base class - -\wxheading{Include files} - - - -\wxheading{Typedefs} - -\texttt{wxTextPos} is the type containing the index of a position in a text -control. \texttt{wxTextCoord} contains the index of a column or a row in the -control. - -Note that although both of these types should probably have been unsigned, due -to backwards compatibility reasons, are defined as \texttt{long} currently. -Their use (instead of plain \texttt{long}) is still encouraged as it makes the -code more readable. - -\wxheading{Constants} - -The following values can be passed to SetAlignment to determine -paragraph alignment. - -{\small -\begin{verbatim} -enum wxTextAttrAlignment -{ - wxTEXT_ALIGNMENT_DEFAULT, - wxTEXT_ALIGNMENT_LEFT, - wxTEXT_ALIGNMENT_CENTRE, - wxTEXT_ALIGNMENT_CENTER = wxTEXT_ALIGNMENT_CENTRE, - wxTEXT_ALIGNMENT_RIGHT, - wxTEXT_ALIGNMENT_JUSTIFIED -}; -\end{verbatim} -} - -These values are passed in a bitlist to SetFlags to determine -what attributes will be considered when setting the attributes -for a text control. - -{\small -\begin{verbatim} -#define wxTEXT_ATTR_TEXT_COLOUR 0x0001 -#define wxTEXT_ATTR_BACKGROUND_COLOUR 0x0002 -#define wxTEXT_ATTR_FONT_FACE 0x0004 -#define wxTEXT_ATTR_FONT_SIZE 0x0008 -#define wxTEXT_ATTR_FONT_WEIGHT 0x0010 -#define wxTEXT_ATTR_FONT_ITALIC 0x0020 -#define wxTEXT_ATTR_FONT_UNDERLINE 0x0040 -#define wxTEXT_ATTR_FONT \ - wxTEXT_ATTR_FONT_FACE | wxTEXT_ATTR_FONT_SIZE | wxTEXT_ATTR_FONT_WEIGHT \ -| wxTEXT_ATTR_FONT_ITALIC | wxTEXT_ATTR_FONT_UNDERLINE -#define wxTEXT_ATTR_ALIGNMENT 0x0080 -#define wxTEXT_ATTR_LEFT_INDENT 0x0100 -#define wxTEXT_ATTR_RIGHT_INDENT 0x0200 -#define wxTEXT_ATTR_TABS 0x0400 -\end{verbatim} -} - -\latexignore{\rtfignore{\wxheading{Members}}} - - -\membersection{wxTextAttr::wxTextAttr}\label{wxtextattrctor} - -\func{}{wxTextAttr}{\void} - -\func{}{wxTextAttr}{\param{const wxColour\& }{colText}, \param{const wxColour\& }{colBack = wxNullColour}, - \param{const wxFont\& }{font = wxNullFont}, \param{wxTextAttrAlignment }{alignment = wxTEXT\_ALIGNMENT\_DEFAULT}} - -The constructors initialize one or more of the text foreground colour, background -colour, font, and alignment. The values not initialized in the constructor can be set -later, otherwise \helpref{wxTextCtrl::SetStyle}{wxtextctrlsetstyle} will use -the default values for them. - - -\membersection{wxTextAttr::GetAlignment}\label{wxtextattrgetalignment} - -\constfunc{wxTextAttrAlignment}{GetAlignment}{\void} - -Returns the paragraph alignment. - - -\membersection{wxTextAttr::GetBackgroundColour}\label{wxtextattrgetbackgroundcolour} - -\constfunc{const wxColour\&}{GetBackgroundColour}{\void} - -Return the background colour specified by this attribute. - - -\membersection{wxTextAttr::GetFont}\label{wxtextattrgetfont} - -\constfunc{const wxFont\&}{GetFont}{\void} - -Return the text font specified by this attribute. - - -\membersection{wxTextAttr::GetLeftIndent}\label{wxtextattrgetleftindent} - -\constfunc{int}{GetLeftIndent}{\void} - -Returns the left indent in tenths of a millimetre. - - -\membersection{wxTextAttr::GetLeftSubIndent}\label{wxtextattrgetleftsubindent} - -\constfunc{int}{GetLeftSubIndent}{\void} - -Returns the left sub indent for all lines but the first line in a paragraph in -tenths of a millimetre. - - -\membersection{wxTextAttr::GetRightIndent}\label{wxtextattrgetrightindent} - -\constfunc{int}{GetRightIndent}{\void} - -Returns the right indent in tenths of a millimetre. - - -\membersection{wxTextAttr::GetTabs}\label{wxtextattrgettabs} - -\constfunc{const wxArrayInt\&}{GetTabs}{\void} - -Returns the array of integers representing the tab stops. Each -array element specifies the tab stop in tenths of a millimetre. - - -\membersection{wxTextAttr::GetTextColour}\label{wxtextattrgettextcolour} - -\constfunc{const wxColour\&}{GetTextColour}{\void} - -Return the text colour specified by this attribute. - - -\membersection{wxTextAttr::HasBackgroundColour}\label{wxtextattrhasbackgroundcolour} - -\constfunc{bool}{HasBackgroundColour}{\void} - -Returns {\tt true} if this style specifies the background colour to use. - - -\membersection{wxTextAttr::HasFont}\label{wxtextattrhasfont} - -\constfunc{bool}{HasFont}{\void} - -Returns {\tt true} if this style specifies the font to use. - - -\membersection{wxTextAttr::HasTextColour}\label{wxtextattrhastextcolour} - -\constfunc{bool}{HasTextColour}{\void} - -Returns {\tt true} if this style specifies the foreground colour to use. - - -\membersection{wxTextAttr::GetFlags}\label{wxtextattrgetflags} - -\func{long}{GetFlags}{\void} - -Returns a bitlist indicating which attributes will be set. - - -\membersection{wxTextAttr::IsDefault}\label{wxtextattrisdefault} - -\constfunc{bool}{IsDefault}{\void} - -Returns {\tt true} if this style specifies any non-default attributes. - - -\membersection{wxTextAttr::Merge}\label{wxtextattrmerge} - -\func{void}{Merge}{\param{const wxTextAttr\&}{ overlay}} - -Copies all defined/valid properties from \arg{overlay} to current object. - -\func{static wxTextAttr}{Merge}{\param{const wxTextAttr\&}{ base}, \param{const wxTextAttr\&}{ overlay}} - -Creates a new {\tt wxTextAttr} which is a merge of \arg{base} and -\arg{overlay}. Properties defined in \arg{overlay} take precedence over those -in \arg{base}. Properties undefined/invalid in both are undefined in the -result. - - -\membersection{wxTextAttr::SetAlignment}\label{wxtextattrsetalignment} - -\func{void}{SetAlignment}{\param{wxTextAttrAlignment}{ alignment}} - -Sets the paragraph alignment. - - -\membersection{wxTextAttr::SetBackgroundColour}\label{wxtextattrsetbackgroundcolour} - -\func{void}{SetBackgroundColour}{\param{const wxColour\& }{colour}} - -Sets the background colour. - - -\membersection{wxTextAttr::SetFlags}\label{wxtextattrsetflags} - -\func{void}{SetFlags}{\param{long}{ flags}} - -Pass a bitlist indicating which attributes will be set. - - -\membersection{wxTextAttr::SetFont}\label{wxtextattrsetfont} - -\func{void}{SetFont}{\param{const wxFont\&}{ font}} - -Sets the text font. - - -\membersection{wxTextAttr::SetLeftIndent}\label{wxtextattrsetleftindent} - -\func{void}{SetLeftIndent}{\param{int }{indent}, \param{int }{subIndent = 0}} - -Sets the left indent in tenths of a millimetre. -subIndent sets the indent for all lines but the first line in a paragraph -relative to the first line. - - -\membersection{wxTextAttr::SetRightIndent}\label{wxtextattrsetrightindent} - -\func{void}{SetRightIndent}{\param{int }{indent}} - -Sets the right indent in tenths of a millimetre. - - -\membersection{wxTextAttr::SetTabs}\label{wxtextattrsettabs} - -\func{void}{SetTabs}{\param{const wxArrayInt\&}{ tabs}} - -Sets the array of integers representing the tab stops. Each -array element specifies the tab stop in tenths of a millimetre. - - -\membersection{wxTextAttr::SetTextColour}\label{wxtextattrsettextcolour} - -\func{void}{SetTextColour}{\param{const wxColour\& }{colour}} - -Sets the text colour. - - %%%%%%%%%%%%%%%%%%%%%%%%%%%% wxTextCtrl %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{\class{wxTextCtrl}}\label{wxtextctrl} diff --git a/docs/latex/wx/textattr.tex b/docs/latex/wx/textattr.tex new file mode 100644 index 0000000000..348153a69b --- /dev/null +++ b/docs/latex/wx/textattr.tex @@ -0,0 +1,252 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxTextAttr %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\section{\class{wxTextAttr}}\label{wxtextattr} + +wxTextAttr represents the character and paragraph attributes, or style, for a range of text in a\rtfsp +\helpref{wxTextCtrl}{wxtextctrl}. + +When setting up a wxTextAttr object, pass a bitlist mask to SetFlags to indicate +which style elements should be changed. As a convenience, when you call a +setter such as SetFont, the relevant bit will be set. + +\wxheading{Derived from} + +No base class + +\wxheading{Include files} + + + +\wxheading{Typedefs} + +\texttt{wxTextPos} is the type containing the index of a position in a text +control. \texttt{wxTextCoord} contains the index of a column or a row in the +control. + +Note that although both of these types should probably have been unsigned, due +to backwards compatibility reasons, are defined as \texttt{long} currently. +Their use (instead of plain \texttt{long}) is still encouraged as it makes the +code more readable. + +\wxheading{Constants} + +The following values can be passed to SetAlignment to determine +paragraph alignment. + +{\small +\begin{verbatim} +enum wxTextAttrAlignment +{ + wxTEXT_ALIGNMENT_DEFAULT, + wxTEXT_ALIGNMENT_LEFT, + wxTEXT_ALIGNMENT_CENTRE, + wxTEXT_ALIGNMENT_CENTER = wxTEXT_ALIGNMENT_CENTRE, + wxTEXT_ALIGNMENT_RIGHT, + wxTEXT_ALIGNMENT_JUSTIFIED +}; +\end{verbatim} +} + +These values are passed in a bitlist to SetFlags to determine +what attributes will be considered when setting the attributes +for a text control. + +{\small +\begin{verbatim} +#define wxTEXT_ATTR_TEXT_COLOUR 0x0001 +#define wxTEXT_ATTR_BACKGROUND_COLOUR 0x0002 +#define wxTEXT_ATTR_FONT_FACE 0x0004 +#define wxTEXT_ATTR_FONT_SIZE 0x0008 +#define wxTEXT_ATTR_FONT_WEIGHT 0x0010 +#define wxTEXT_ATTR_FONT_ITALIC 0x0020 +#define wxTEXT_ATTR_FONT_UNDERLINE 0x0040 +#define wxTEXT_ATTR_FONT \ + wxTEXT_ATTR_FONT_FACE | wxTEXT_ATTR_FONT_SIZE | wxTEXT_ATTR_FONT_WEIGHT \ +| wxTEXT_ATTR_FONT_ITALIC | wxTEXT_ATTR_FONT_UNDERLINE +#define wxTEXT_ATTR_ALIGNMENT 0x0080 +#define wxTEXT_ATTR_LEFT_INDENT 0x0100 +#define wxTEXT_ATTR_RIGHT_INDENT 0x0200 +#define wxTEXT_ATTR_TABS 0x0400 +\end{verbatim} +} + +\latexignore{\rtfignore{\wxheading{Members}}} + + +\membersection{wxTextAttr::wxTextAttr}\label{wxtextattrctor} + +\func{}{wxTextAttr}{\void} + +\func{}{wxTextAttr}{\param{const wxColour\& }{colText}, \param{const wxColour\& }{colBack = wxNullColour}, + \param{const wxFont\& }{font = wxNullFont}, \param{wxTextAttrAlignment }{alignment = wxTEXT\_ALIGNMENT\_DEFAULT}} + +The constructors initialize one or more of the text foreground colour, background +colour, font, and alignment. The values not initialized in the constructor can be set +later, otherwise \helpref{wxTextCtrl::SetStyle}{wxtextctrlsetstyle} will use +the default values for them. + + +\membersection{wxTextAttr::GetAlignment}\label{wxtextattrgetalignment} + +\constfunc{wxTextAttrAlignment}{GetAlignment}{\void} + +Returns the paragraph alignment. + + +\membersection{wxTextAttr::GetBackgroundColour}\label{wxtextattrgetbackgroundcolour} + +\constfunc{const wxColour\&}{GetBackgroundColour}{\void} + +Return the background colour specified by this attribute. + + +\membersection{wxTextAttr::GetFont}\label{wxtextattrgetfont} + +\constfunc{const wxFont\&}{GetFont}{\void} + +Return the text font specified by this attribute. + + +\membersection{wxTextAttr::GetLeftIndent}\label{wxtextattrgetleftindent} + +\constfunc{int}{GetLeftIndent}{\void} + +Returns the left indent in tenths of a millimetre. + + +\membersection{wxTextAttr::GetLeftSubIndent}\label{wxtextattrgetleftsubindent} + +\constfunc{int}{GetLeftSubIndent}{\void} + +Returns the left sub indent for all lines but the first line in a paragraph in +tenths of a millimetre. + + +\membersection{wxTextAttr::GetRightIndent}\label{wxtextattrgetrightindent} + +\constfunc{int}{GetRightIndent}{\void} + +Returns the right indent in tenths of a millimetre. + + +\membersection{wxTextAttr::GetTabs}\label{wxtextattrgettabs} + +\constfunc{const wxArrayInt\&}{GetTabs}{\void} + +Returns the array of integers representing the tab stops. Each +array element specifies the tab stop in tenths of a millimetre. + + +\membersection{wxTextAttr::GetTextColour}\label{wxtextattrgettextcolour} + +\constfunc{const wxColour\&}{GetTextColour}{\void} + +Return the text colour specified by this attribute. + + +\membersection{wxTextAttr::HasBackgroundColour}\label{wxtextattrhasbackgroundcolour} + +\constfunc{bool}{HasBackgroundColour}{\void} + +Returns {\tt true} if this style specifies the background colour to use. + + +\membersection{wxTextAttr::HasFont}\label{wxtextattrhasfont} + +\constfunc{bool}{HasFont}{\void} + +Returns {\tt true} if this style specifies the font to use. + + +\membersection{wxTextAttr::HasTextColour}\label{wxtextattrhastextcolour} + +\constfunc{bool}{HasTextColour}{\void} + +Returns {\tt true} if this style specifies the foreground colour to use. + + +\membersection{wxTextAttr::GetFlags}\label{wxtextattrgetflags} + +\func{long}{GetFlags}{\void} + +Returns a bitlist indicating which attributes will be set. + + +\membersection{wxTextAttr::IsDefault}\label{wxtextattrisdefault} + +\constfunc{bool}{IsDefault}{\void} + +Returns {\tt true} if this style specifies any non-default attributes. + + +\membersection{wxTextAttr::Merge}\label{wxtextattrmerge} + +\func{void}{Merge}{\param{const wxTextAttr\&}{ overlay}} + +Copies all defined/valid properties from \arg{overlay} to current object. + +\func{static wxTextAttr}{Merge}{\param{const wxTextAttr\&}{ base}, \param{const wxTextAttr\&}{ overlay}} + +Creates a new {\tt wxTextAttr} which is a merge of \arg{base} and +\arg{overlay}. Properties defined in \arg{overlay} take precedence over those +in \arg{base}. Properties undefined/invalid in both are undefined in the +result. + + +\membersection{wxTextAttr::SetAlignment}\label{wxtextattrsetalignment} + +\func{void}{SetAlignment}{\param{wxTextAttrAlignment}{ alignment}} + +Sets the paragraph alignment. + + +\membersection{wxTextAttr::SetBackgroundColour}\label{wxtextattrsetbackgroundcolour} + +\func{void}{SetBackgroundColour}{\param{const wxColour\& }{colour}} + +Sets the background colour. + + +\membersection{wxTextAttr::SetFlags}\label{wxtextattrsetflags} + +\func{void}{SetFlags}{\param{long}{ flags}} + +Pass a bitlist indicating which attributes will be set. + + +\membersection{wxTextAttr::SetFont}\label{wxtextattrsetfont} + +\func{void}{SetFont}{\param{const wxFont\&}{ font}} + +Sets the text font. + + +\membersection{wxTextAttr::SetLeftIndent}\label{wxtextattrsetleftindent} + +\func{void}{SetLeftIndent}{\param{int }{indent}, \param{int }{subIndent = 0}} + +Sets the left indent in tenths of a millimetre. +subIndent sets the indent for all lines but the first line in a paragraph +relative to the first line. + + +\membersection{wxTextAttr::SetRightIndent}\label{wxtextattrsetrightindent} + +\func{void}{SetRightIndent}{\param{int }{indent}} + +Sets the right indent in tenths of a millimetre. + + +\membersection{wxTextAttr::SetTabs}\label{wxtextattrsettabs} + +\func{void}{SetTabs}{\param{const wxArrayInt\&}{ tabs}} + +Sets the array of integers representing the tab stops. Each +array element specifies the tab stop in tenths of a millimetre. + + +\membersection{wxTextAttr::SetTextColour}\label{wxtextattrsettextcolour} + +\func{void}{SetTextColour}{\param{const wxColour\& }{colour}} + +Sets the text colour. diff --git a/docs/latex/wx/textattrex.tex b/docs/latex/wx/textattrex.tex new file mode 100644 index 0000000000..80c8275045 --- /dev/null +++ b/docs/latex/wx/textattrex.tex @@ -0,0 +1,333 @@ +\section{\class{wxTextAttrEx}}\label{wxtextattrex} + +wxTextAttrEx is an extended version of wxTextAttr with more paragraph attributes. +Currently it is only used with \helpref{wxRichTextCtrl}{wxrichtextctrl}. + +It is intended that eventually, the members of wxTextAttrEx will +be folded into wxTextAttr, and wxTextAttr will be the official +cross-platform API for text controls that support attributes. +However, for now, wxTextAttrEx is provided as a means of enabling +extra functionality in wxRichTextCtrl, while retaining some compatibility +with the wxTextAttr API. + +The most efficient method of accessing wxRichTextCtrl functionality +is a third attribute class, \helpref{wxRichTextAttr}{wxrichtextattr}, which +optimizes its storage to allow it to be used for implementing objects +in a buffer, as well as access to that buffer. + +This section only documents the additional members; see \helpref{wxTextAttr}{wxtextattr} for +the remaining functions. + +\wxheading{Derived from} + +\helpref{wxTextAttr}{wxtextattr} + +\wxheading{Include files} + + + +\wxheading{Constants} + +The following values can be passed to SetAlignment to determine +paragraph alignment. + +{\small +\begin{verbatim} +enum wxTextAttrAlignment +{ + wxTEXT_ALIGNMENT_DEFAULT, + wxTEXT_ALIGNMENT_LEFT, + wxTEXT_ALIGNMENT_CENTRE, + wxTEXT_ALIGNMENT_CENTER = wxTEXT_ALIGNMENT_CENTRE, + wxTEXT_ALIGNMENT_RIGHT, + wxTEXT_ALIGNMENT_JUSTIFIED +}; +\end{verbatim} +} + +These values are passed in a bitlist to SetFlags to determine +what attributes will be considered when setting the attributes +for a text control. + +{\small +\begin{verbatim} +// Standard wxTextAttr constants + +#define wxTEXT_ATTR_TEXT_COLOUR 0x0001 +#define wxTEXT_ATTR_BACKGROUND_COLOUR 0x0002 +#define wxTEXT_ATTR_FONT_FACE 0x0004 +#define wxTEXT_ATTR_FONT_SIZE 0x0008 +#define wxTEXT_ATTR_FONT_WEIGHT 0x0010 +#define wxTEXT_ATTR_FONT_ITALIC 0x0020 +#define wxTEXT_ATTR_FONT_UNDERLINE 0x0040 +#define wxTEXT_ATTR_FONT \ + wxTEXT_ATTR_FONT_FACE | wxTEXT_ATTR_FONT_SIZE | wxTEXT_ATTR_FONT_WEIGHT \ +| wxTEXT_ATTR_FONT_ITALIC | wxTEXT_ATTR_FONT_UNDERLINE +#define wxTEXT_ATTR_ALIGNMENT 0x0080 +#define wxTEXT_ATTR_LEFT_INDENT 0x0100 +#define wxTEXT_ATTR_RIGHT_INDENT 0x0200 +#define wxTEXT_ATTR_TABS 0x0400 + +// Extra formatting flags not in wxTextAttr + +#define wxTEXT_ATTR_PARA_SPACING_AFTER 0x00000800 +#define wxTEXT_ATTR_PARA_SPACING_BEFORE 0x00001000 +#define wxTEXT_ATTR_LINE_SPACING 0x00002000 +#define wxTEXT_ATTR_CHARACTER_STYLE_NAME 0x00004000 +#define wxTEXT_ATTR_PARAGRAPH_STYLE_NAME 0x00008000 +#define wxTEXT_ATTR_BULLET_STYLE 0x00010000 +#define wxTEXT_ATTR_BULLET_NUMBER 0x00020000 +#define wxTEXT_ATTR_BULLET_SYMBOL 0x00040000 +\end{verbatim} +} + +The following styles can be passed to wxRichTextAttr::SetBulletStyle: + +{\small +\begin{verbatim} +#define wxTEXT_ATTR_BULLET_STYLE_NONE 0x0000 +#define wxTEXT_ATTR_BULLET_STYLE_ARABIC 0x0001 +#define wxTEXT_ATTR_BULLET_STYLE_LETTERS_UPPER 0x0002 +#define wxTEXT_ATTR_BULLET_STYLE_LETTERS_LOWER 0x0004 +#define wxTEXT_ATTR_BULLET_STYLE_ROMAN_UPPER 0x0008 +#define wxTEXT_ATTR_BULLET_STYLE_ROMAN_LOWER 0x0010 +#define wxTEXT_ATTR_BULLET_STYLE_SYMBOL 0x0020 +#define wxTEXT_ATTR_BULLET_STYLE_BITMAP 0x0040 +#define wxTEXT_ATTR_BULLET_STYLE_PARENTHESES 0x0080 +#define wxTEXT_ATTR_BULLET_STYLE_PERIOD 0x0100 +\end{verbatim} +} + +The following constants can be passed to wxRichTextAttr::SetLineSpacing: + +{\small +\begin{verbatim} +#define wxTEXT_ATTR_LINE_SPACING_NORMAL 10 +#define wxTEXT_ATTR_LINE_SPACING_HALF 15 +#define wxTEXT_ATTR_LINE_SPACING_TWICE 20 +\end{verbatim} +} + +\wxheading{See also} + +\helpref{wxTextAttr}{wxtextattr}, \helpref{wxRichTextAttr}{wxrichtextattr}, \helpref{wxRichTextCtrl}{wxrichtextctrl} + +\latexignore{\rtfignore{\wxheading{Members}}} + + +\membersection{wxTextAttrEx::wxTextAttrEx}\label{wxtextattrexwxtextattrex} + +\func{}{wxTextAttrEx}{\void} + + +\func{}{wxTextAttrEx}{\param{const wxTextAttrEx\& }{attr}} + +Constructors. + +\membersection{wxTextAttrEx::GetBulletNumber}\label{wxtextattrexgetbulletnumber} + +\constfunc{int}{GetBulletNumber}{\void} + +Returns the bullet number. + +\membersection{wxTextAttrEx::GetBulletStyle}\label{wxtextattrexgetbulletstyle} + +\constfunc{int}{GetBulletStyle}{\void} + +Returns the bullet style. +See \helpref{wxTextAttrEx::SetBulletStyle}{wxtextattrexsetbulletstyle} for a list of available styles. + +\membersection{wxTextAttrEx::GetBulletSymbol}\label{wxtextattrexgetbulletsymbol} + +\constfunc{wxChar}{GetBulletSymbol}{\void} + +Returns the bullet symbol, a character. + +\membersection{wxTextAttrEx::GetCharacterStyleName}\label{wxtextattrexgetcharacterstylename} + +\constfunc{const wxString\&}{GetCharacterStyleName}{\void} + +Returns the name of the character style. + +\membersection{wxTextAttrEx::GetLineSpacing}\label{wxtextattrexgetlinespacing} + +\constfunc{int}{GetLineSpacing}{\void} + +Returns the line spacing value, one of wxTEXT\_ATTR\_LINE\_SPACING\_NORMAL, +wxTEXT\_ATTR\_LINE\_SPACING\_HALF, and wxTEXT\_ATTR\_LINE\_SPACING\_TWICE. + +\membersection{wxTextAttrEx::GetParagraphSpacingAfter}\label{wxtextattrexgetparagraphspacingafter} + +\constfunc{int}{GetParagraphSpacingAfter}{\void} + +Returns the space in tenths of a millimeter after the paragraph. + +\membersection{wxTextAttrEx::GetParagraphSpacingBefore}\label{wxtextattrexgetparagraphspacingbefore} + +\constfunc{int}{GetParagraphSpacingBefore}{\void} + +Returns the space in tenths of a millimeter before the paragraph. + +\membersection{wxTextAttrEx::GetParagraphStyleName}\label{wxtextattrexgetparagraphstylename} + +\constfunc{const wxString\&}{GetParagraphStyleName}{\void} + +Returns the name of the paragraph style. + +\membersection{wxTextAttrEx::HasBulletNumber}\label{wxtextattrexhasbulletnumber} + +\constfunc{bool}{HasBulletNumber}{\void} + +Returns \true if the attribute object specifies a bullet number. + +\membersection{wxTextAttrEx::HasBulletStyle}\label{wxtextattrexhasbulletstyle} + +\constfunc{bool}{HasBulletStyle}{\void} + +Returns \true if the attribute object specifies a bullet style. + +\membersection{wxTextAttrEx::HasBulletSymbol}\label{wxtextattrexhasbulletsymbol} + +\constfunc{bool}{HasBulletSymbol}{\void} + +Returns \true if the attribute object specifies a bullet symbol. + +\membersection{wxTextAttrEx::HasCharacterStyleName}\label{wxtextattrexhascharacterstylename} + +\constfunc{bool}{HasCharacterStyleName}{\void} + +Returns \true if the attribute object specifies a character style name. + +\membersection{wxTextAttrEx::HasLineSpacing}\label{wxtextattrexhaslinespacing} + +\constfunc{bool}{HasLineSpacing}{\void} + +Returns \true if the attribute object specifies line spacing. + +\membersection{wxTextAttrEx::HasParagraphSpacingAfter}\label{wxtextattrexhasparagraphspacingafter} + +\constfunc{bool}{HasParagraphSpacingAfter}{\void} + +Returns \true if the attribute object specifies spacing after a paragraph. + +\membersection{wxTextAttrEx::HasParagraphSpacingBefore}\label{wxtextattrexhasparagraphspacingbefore} + +\constfunc{bool}{HasParagraphSpacingBefore}{\void} + +Returns \true if the attribute object specifies spacing before a paragraph. + +\membersection{wxTextAttrEx::HasParagraphStyleName}\label{wxtextattrexhasparagraphstylename} + +\constfunc{bool}{HasParagraphStyleName}{\void} + +Returns \true if the attribute object specifies a paragraph style name. + +\membersection{wxTextAttrEx::Init}\label{wxtextattrexinit} + +\func{void}{Init}{\void} + +Initialises this object. + +\membersection{wxTextAttrEx::IsCharacterStyle}\label{wxtextattrexischaracterstyle} + +\constfunc{bool}{IsCharacterStyle}{\void} + +Returns \true if the object represents a character style, that is, +the flags specify a font or a text background or foreground colour. + +\membersection{wxTextAttrEx::IsDefault}\label{wxtextattrexisdefault} + +\constfunc{bool}{IsDefault}{\void} + +Returns \false if we have any attributes set, \true otherwise. + +\membersection{wxTextAttrEx::IsParagraphStyle}\label{wxtextattrexisparagraphstyle} + +\constfunc{bool}{IsParagraphStyle}{\void} + +Returns \true if the object represents a paragraph style, that is, +the flags specify alignment, indentation, tabs, paragraph spacing, or +bullet style. + +\membersection{wxTextAttrEx::SetBulletNumber}\label{wxtextattrexsetbulletnumber} + +\func{void}{SetBulletNumber}{\param{int }{n}} + +Sets the bullet number. + +\membersection{wxTextAttrEx::SetBulletStyle}\label{wxtextattrexsetbulletstyle} + +\func{void}{SetBulletStyle}{\param{int }{style}} + +Sets the bullet style. The following styles can be passed: + +{\small +\begin{verbatim} +#define wxTEXT_ATTR_BULLET_STYLE_NONE 0x0000 +#define wxTEXT_ATTR_BULLET_STYLE_ARABIC 0x0001 +#define wxTEXT_ATTR_BULLET_STYLE_LETTERS_UPPER 0x0002 +#define wxTEXT_ATTR_BULLET_STYLE_LETTERS_LOWER 0x0004 +#define wxTEXT_ATTR_BULLET_STYLE_ROMAN_UPPER 0x0008 +#define wxTEXT_ATTR_BULLET_STYLE_ROMAN_LOWER 0x0010 +#define wxTEXT_ATTR_BULLET_STYLE_SYMBOL 0x0020 +#define wxTEXT_ATTR_BULLET_STYLE_BITMAP 0x0040 +#define wxTEXT_ATTR_BULLET_STYLE_PARENTHESES 0x0080 +#define wxTEXT_ATTR_BULLET_STYLE_PERIOD 0x0100 +\end{verbatim} +} + +\membersection{wxTextAttrEx::SetBulletSymbol}\label{wxtextattrexsetbulletsymbol} + +\func{void}{SetBulletSymbol}{\param{wxChar }{symbol}} + +Sets the paragraph symbol. + +\membersection{wxTextAttrEx::SetCharacterStyleName}\label{wxtextattrexsetcharacterstylename} + +\func{void}{SetCharacterStyleName}{\param{const wxString\& }{name}} + +Sets the character style name. + +\membersection{wxTextAttrEx::SetLineSpacing}\label{wxtextattrexsetlinespacing} + +\func{void}{SetLineSpacing}{\param{int }{spacing}} + +Sets the line spacing. {\it spacing} is a multiple, where 10 means single-spacing, +15 means 1.5 spacing, and 20 means double spacing. The following constants are +defined for convenience: + +{\small +\begin{verbatim} +#define wxTEXT_ATTR_LINE_SPACING_NORMAL 10 +#define wxTEXT_ATTR_LINE_SPACING_HALF 15 +#define wxTEXT_ATTR_LINE_SPACING_TWICE 20 +\end{verbatim} +} + +\membersection{wxTextAttrEx::SetParagraphSpacingAfter}\label{wxtextattrexsetparagraphspacingafter} + +\func{void}{SetParagraphSpacingAfter}{\param{int }{spacing}} + +Sets the spacing after a paragraph, in tenths of a millimetre. + +\membersection{wxTextAttrEx::SetParagraphSpacingBefore}\label{wxtextattrexsetparagraphspacingbefore} + +\func{void}{SetParagraphSpacingBefore}{\param{int }{spacing}} + +Sets the spacing before a paragraph, in tenths of a millimetre. + +\membersection{wxTextAttrEx::SetParagraphStyleName}\label{wxtextattrexsetparagraphstylename} + +\func{void}{SetParagraphStyleName}{\param{const wxString\& }{name}} + +Sets the name of the paragraph style. + +\membersection{wxTextAttrEx::operator=}\label{wxtextattrexoperatorassign} + +\func{void operator}{operator=}{\param{const wxTextAttr\& }{attr}} + +Assignment from a wxTextAttr object. + +\func{void operator}{operator=}{\param{const wxTextAttrEx\& }{attr}} + +Assignment from a wxTextAttrEx object. diff --git a/docs/latex/wx/topics.tex b/docs/latex/wx/topics.tex index fed6b972c2..624e734dba 100644 --- a/docs/latex/wx/topics.tex +++ b/docs/latex/wx/topics.tex @@ -59,6 +59,7 @@ This chapter contains a selection of topic overviews. \input tdb.tex \input tipc.tex \input wxhtml.tex +\input richtextoverview.tex \input tenvvars.tex \input wxPython.tex \input re_syntax.tex