[wxWidgets.git] / docs / latex / wx / richtextstylesheet.tex

\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::AddListStyle}\label{wxrichtextstylesheetaddliststyle}

\func{bool}{AddListStyle}{\param{wxRichTextListStyleDefinition* }{def}}

Adds a definition to the list 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::FindListStyle}\label{wxrichtextstylesheetfindliststyle}

\constfunc{wxRichTextListStyleDefinition*}{FindListStyle}{\param{const wxString\& }{name}}

Finds a list 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::GetDescription}\label{wxrichtextstylesheetgetdescription}

\constfunc{const wxString\&}{GetDescription}{\void}

Returns the style sheet's description.

\membersection{wxRichTextStyleSheet::GetListStyle}\label{wxrichtextstylesheetgetliststyle}

\constfunc{wxRichTextListStyleDefinition*}{GetListStyle}{\param{size\_t }{n}}

Returns the {\it n}th list style.

\membersection{wxRichTextStyleSheet::GetListStyleCount}\label{wxrichtextstylesheetgetliststylecount}

\constfunc{size\_t}{GetListStyleCount}{\void}

Returns the number of list styles.

\membersection{wxRichTextStyleSheet::GetName}\label{wxrichtextstylesheetgetname}

\constfunc{const wxString\&}{GetName}{\void}

Returns the style sheet's name.

\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::RemoveListStyle}\label{wxrichtextstylesheetremoveliststyle}

\func{bool}{RemoveListStyle}{\param{wxRichTextStyleDefinition* }{def}, \param{bool }{deleteStyle = false}}

Removes a list style.

\membersection{wxRichTextStyleSheet::RemoveParagraphStyle}\label{wxrichtextstylesheetremoveparagraphstyle}

\func{bool}{RemoveParagraphStyle}{\param{wxRichTextStyleDefinition* }{def}, \param{bool }{deleteStyle = false}}

Removes a paragraph style.

\membersection{wxRichTextStyleSheet::SetDescription}\label{wxrichtextstylesheetsetdescription}

\func{void}{SetDescription}{\param{const wxString\& }{descr}}

Sets the style sheet's description.

\membersection{wxRichTextStyleSheet::SetName}\label{wxrichtextstylesheetsetname}

\func{void}{SetName}{\param{const wxString\& }{name}}

Sets the style sheet's name.
Commit	Line	Data
5f35b46a JS	1	\section{\class{wxRichTextStyleSheet}}\label{wxrichtextstylesheet}
	2
	3	A style sheet contains named paragraph and character styles that make it
	4	easy for a user to apply combinations of attributes to a \helpref{wxRichTextCtrl}{wxrichtextctrl}.
	5
	6	You can use a \helpref{wxRichTextStyleListBox}{wxrichtextstylelistbox} in your
	7	user interface to show available styles to the user, and allow application
	8	of styles to the control.
	9
	10	\wxheading{Derived from}
	11
	12	\helpref{wxObject}{wxobject}
	13
	14	\wxheading{Include files}
	15
	16	<wx/richtext/richtextstyles.h>
	17
	18	\wxheading{Data structures}
	19
	20	\latexignore{\rtfignore{\wxheading{Members}}}
	21
	22	\membersection{wxRichTextStyleSheet::wxRichTextStyleSheet}\label{wxrichtextstylesheetwxrichtextstylesheet}
	23
	24	\func{}{wxRichTextStyleSheet}{\void}
	25
	26	Constructor.
	27
	28	\membersection{wxRichTextStyleSheet::\destruct{wxRichTextStyleSheet}}\label{wxrichtextstylesheetdtor}
	29
	30	\func{}{\destruct{wxRichTextStyleSheet}}{\void}
	31
	32	Destructor.
	33
	34	\membersection{wxRichTextStyleSheet::AddCharacterStyle}\label{wxrichtextstylesheetaddcharacterstyle}
	35
	36	\func{bool}{AddCharacterStyle}{\param{wxRichTextCharacterStyleDefinition* }{def}}
	37
	38	Adds a definition to the character style list.
	39
d2d0adc7 JS	40	\membersection{wxRichTextStyleSheet::AddListStyle}\label{wxrichtextstylesheetaddliststyle}
	41
	42	\func{bool}{AddListStyle}{\param{wxRichTextListStyleDefinition* }{def}}
	43
	44	Adds a definition to the list style list.
	45
5f35b46a JS	46	\membersection{wxRichTextStyleSheet::AddParagraphStyle}\label{wxrichtextstylesheetaddparagraphstyle}
	47
	48	\func{bool}{AddParagraphStyle}{\param{wxRichTextParagraphStyleDefinition* }{def}}
	49
	50	Adds a definition to the paragraph style list.
	51
	52	\membersection{wxRichTextStyleSheet::DeleteStyles}\label{wxrichtextstylesheetdeletestyles}
	53
	54	\func{void}{DeleteStyles}{\void}
	55
	56	Deletes all styles.
	57
	58	\membersection{wxRichTextStyleSheet::FindCharacterStyle}\label{wxrichtextstylesheetfindcharacterstyle}
	59
	60	\constfunc{wxRichTextCharacterStyleDefinition*}{FindCharacterStyle}{\param{const wxString\& }{name}}
	61
	62	Finds a character definition by name.
	63
d2d0adc7 JS	64	\membersection{wxRichTextStyleSheet::FindListStyle}\label{wxrichtextstylesheetfindliststyle}
	65
	66	\constfunc{wxRichTextListStyleDefinition*}{FindListStyle}{\param{const wxString\& }{name}}
	67
	68	Finds a list definition by name.
	69
5f35b46a JS	70	\membersection{wxRichTextStyleSheet::FindParagraphStyle}\label{wxrichtextstylesheetfindparagraphstyle}
	71
	72	\constfunc{wxRichTextParagraphStyleDefinition*}{FindParagraphStyle}{\param{const wxString\& }{name}}
	73
	74	Finds a paragraph definition by name.
	75
	76	\membersection{wxRichTextStyleSheet::GetCharacterStyle}\label{wxrichtextstylesheetgetcharacterstyle}
	77
	78	\constfunc{wxRichTextCharacterStyleDefinition*}{GetCharacterStyle}{\param{size\_t }{n}}
	79
	80	Returns the {\it n}th character style.
	81
	82	\membersection{wxRichTextStyleSheet::GetCharacterStyleCount}\label{wxrichtextstylesheetgetcharacterstylecount}
	83
	84	\constfunc{size\_t}{GetCharacterStyleCount}{\void}
	85
	86	Returns the number of character styles.
	87
1f65137f JS	88	\membersection{wxRichTextStyleSheet::GetDescription}\label{wxrichtextstylesheetgetdescription}
	89
	90	\constfunc{const wxString\&}{GetDescription}{\void}
	91
	92	Returns the style sheet's description.
	93
d2d0adc7 JS	94	\membersection{wxRichTextStyleSheet::GetListStyle}\label{wxrichtextstylesheetgetliststyle}
	95
	96	\constfunc{wxRichTextListStyleDefinition*}{GetListStyle}{\param{size\_t }{n}}
	97
	98	Returns the {\it n}th list style.
	99
	100	\membersection{wxRichTextStyleSheet::GetListStyleCount}\label{wxrichtextstylesheetgetliststylecount}
	101
	102	\constfunc{size\_t}{GetListStyleCount}{\void}
	103
	104	Returns the number of list styles.
	105
1f65137f JS	106	\membersection{wxRichTextStyleSheet::GetName}\label{wxrichtextstylesheetgetname}
	107
	108	\constfunc{const wxString\&}{GetName}{\void}
	109
	110	Returns the style sheet's name.
	111
5f35b46a JS	112	\membersection{wxRichTextStyleSheet::GetParagraphStyle}\label{wxrichtextstylesheetgetparagraphstyle}
	113
	114	\constfunc{wxRichTextParagraphStyleDefinition*}{GetParagraphStyle}{\param{size\_t }{n}}
	115
	116	Returns the {\it n}th paragraph style.
	117
	118	\membersection{wxRichTextStyleSheet::GetParagraphStyleCount}\label{wxrichtextstylesheetgetparagraphstylecount}
	119
	120	\constfunc{size\_t}{GetParagraphStyleCount}{\void}
	121
	122	Returns the number of paragraph styles.
	123
	124	\membersection{wxRichTextStyleSheet::Init}\label{wxrichtextstylesheetinit}
	125
	126	\func{void}{Init}{\void}
	127
	128	Initialises the style sheet.
	129
	130	\membersection{wxRichTextStyleSheet::RemoveCharacterStyle}\label{wxrichtextstylesheetremovecharacterstyle}
	131
	132	\func{bool}{RemoveCharacterStyle}{\param{wxRichTextStyleDefinition* }{def}, \param{bool }{deleteStyle = false}}
	133
	134	Removes a character style.
	135
d2d0adc7 JS	136	\membersection{wxRichTextStyleSheet::RemoveListStyle}\label{wxrichtextstylesheetremoveliststyle}
	137
	138	\func{bool}{RemoveListStyle}{\param{wxRichTextStyleDefinition* }{def}, \param{bool }{deleteStyle = false}}
	139
	140	Removes a list style.
	141
5f35b46a JS	142	\membersection{wxRichTextStyleSheet::RemoveParagraphStyle}\label{wxrichtextstylesheetremoveparagraphstyle}
	143
	144	\func{bool}{RemoveParagraphStyle}{\param{wxRichTextStyleDefinition* }{def}, \param{bool }{deleteStyle = false}}
	145
	146	Removes a paragraph style.
62a268cc	147
1f65137f JS	148	\membersection{wxRichTextStyleSheet::SetDescription}\label{wxrichtextstylesheetsetdescription}
	149
	150	\func{void}{SetDescription}{\param{const wxString\& }{descr}}
	151
	152	Sets the style sheet's description.
	153
	154	\membersection{wxRichTextStyleSheet::SetName}\label{wxrichtextstylesheetsetname}
	155
	156	\func{void}{SetName}{\param{const wxString\& }{name}}
	157
	158	Sets the style sheet's name.
	159