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
This commit is contained in:
Julian Smart
2006-07-01 20:30:58 +00:00
parent b3f6656af6
commit 5f35b46aab
23 changed files with 3848 additions and 255 deletions

View File

@@ -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}

View File

@@ -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

View File

@@ -60,4 +60,3 @@ and size (\arg{w} ad \arg{h}).
The clipping region is automatically unset when this object is destroyed.

View File

@@ -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}
<wx/richtext/richtextbuffer.h>
\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.

View File

@@ -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}
<wx/richtext/richtextbuffer.h>
\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.

View File

@@ -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}
<wx/richtext/richtextstyles.h>
\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.

Binary file not shown.

After

Width:  |  Height:  |  Size: 343 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 59 KiB

File diff suppressed because it is too large Load Diff

View File

@@ -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}
<wx/richtext/richtextctrl.h>
\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.

View File

@@ -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}
<wx/richtext/richtextbuffer.h>
\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).

View File

@@ -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}
<wx/richtext/richtexthtml.h>
\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.

View File

@@ -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

View File

@@ -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}
<wx/richtext/richtextstyles.h>
\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.

View File

@@ -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}
<wx/richtext/richtextbuffer.h>
\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.

View File

@@ -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}
<wx/richtext/richtextstyles.h>
\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.

View File

@@ -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}
<wx/richtext/richtextstyles.h>
\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.

View File

@@ -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}
<wx/richtext/richtextstyles.h>
\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.

View File

@@ -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}
<wx/richtext/richtextxml.h>
\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.

View File

@@ -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}
<wx/textctrl.h>
\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}

252
docs/latex/wx/textattr.tex Normal file
View File

@@ -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}
<wx/textctrl.h>
\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.

View File

@@ -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}
<wx/richtext/richtextbuffer.h>
\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.

View File

@@ -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