git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/richtextstylesheet.tex

... / ...

Commit	Line	Data
	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
	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
	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::AddStyle}\label{wxrichtextstylesheetaddstyle}
	53
	54	\func{bool}{AddStyle}{\param{wxRichTextStyleDefinition* }{def}}
	55
	56	Adds a definition to the appropriate style list.
	57
	58	\membersection{wxRichTextStyleSheet::DeleteStyles}\label{wxrichtextstylesheetdeletestyles}
	59
	60	\func{void}{DeleteStyles}{\void}
	61
	62	Deletes all styles.
	63
	64	\membersection{wxRichTextStyleSheet::FindCharacterStyle}\label{wxrichtextstylesheetfindcharacterstyle}
	65
	66	\constfunc{wxRichTextCharacterStyleDefinition*}{FindCharacterStyle}{\param{const wxString\& }{name}}
	67
	68	Finds a character definition by name.
	69
	70	\membersection{wxRichTextStyleSheet::FindListStyle}\label{wxrichtextstylesheetfindliststyle}
	71
	72	\constfunc{wxRichTextListStyleDefinition*}{FindListStyle}{\param{const wxString\& }{name}}
	73
	74	Finds a list definition by name.
	75
	76	\membersection{wxRichTextStyleSheet::FindParagraphStyle}\label{wxrichtextstylesheetfindparagraphstyle}
	77
	78	\constfunc{wxRichTextParagraphStyleDefinition*}{FindParagraphStyle}{\param{const wxString\& }{name}}
	79
	80	Finds a paragraph definition by name.
	81
	82	\membersection{wxRichTextStyleSheet::FindStyle}\label{wxrichtextstylesheetfindstyle}
	83
	84	\constfunc{wxRichTextStyleDefinition*}{FindStyle}{\param{const wxString\& }{name}}
	85
	86	Finds a style definition by name.
	87
	88	\membersection{wxRichTextStyleSheet::GetCharacterStyle}\label{wxrichtextstylesheetgetcharacterstyle}
	89
	90	\constfunc{wxRichTextCharacterStyleDefinition*}{GetCharacterStyle}{\param{size\_t }{n}}
	91
	92	Returns the {\it n}th character style.
	93
	94	\membersection{wxRichTextStyleSheet::GetCharacterStyleCount}\label{wxrichtextstylesheetgetcharacterstylecount}
	95
	96	\constfunc{size\_t}{GetCharacterStyleCount}{\void}
	97
	98	Returns the number of character styles.
	99
	100	\membersection{wxRichTextStyleSheet::GetDescription}\label{wxrichtextstylesheetgetdescription}
	101
	102	\constfunc{const wxString\&}{GetDescription}{\void}
	103
	104	Returns the style sheet's description.
	105
	106	\membersection{wxRichTextStyleSheet::GetListStyle}\label{wxrichtextstylesheetgetliststyle}
	107
	108	\constfunc{wxRichTextListStyleDefinition*}{GetListStyle}{\param{size\_t }{n}}
	109
	110	Returns the {\it n}th list style.
	111
	112	\membersection{wxRichTextStyleSheet::GetListStyleCount}\label{wxrichtextstylesheetgetliststylecount}
	113
	114	\constfunc{size\_t}{GetListStyleCount}{\void}
	115
	116	Returns the number of list styles.
	117
	118	\membersection{wxRichTextStyleSheet::GetName}\label{wxrichtextstylesheetgetname}
	119
	120	\constfunc{const wxString\&}{GetName}{\void}
	121
	122	Returns the style sheet's name.
	123
	124	\membersection{wxRichTextStyleSheet::GetParagraphStyle}\label{wxrichtextstylesheetgetparagraphstyle}
	125
	126	\constfunc{wxRichTextParagraphStyleDefinition*}{GetParagraphStyle}{\param{size\_t }{n}}
	127
	128	Returns the {\it n}th paragraph style.
	129
	130	\membersection{wxRichTextStyleSheet::GetParagraphStyleCount}\label{wxrichtextstylesheetgetparagraphstylecount}
	131
	132	\constfunc{size\_t}{GetParagraphStyleCount}{\void}
	133
	134	Returns the number of paragraph styles.
	135
	136	\membersection{wxRichTextStyleSheet::RemoveCharacterStyle}\label{wxrichtextstylesheetremovecharacterstyle}
	137
	138	\func{bool}{RemoveCharacterStyle}{\param{wxRichTextStyleDefinition* }{def}, \param{bool }{deleteStyle = false}}
	139
	140	Removes a character style.
	141
	142	\membersection{wxRichTextStyleSheet::RemoveListStyle}\label{wxrichtextstylesheetremoveliststyle}
	143
	144	\func{bool}{RemoveListStyle}{\param{wxRichTextStyleDefinition* }{def}, \param{bool }{deleteStyle = false}}
	145
	146	Removes a list style.
	147
	148	\membersection{wxRichTextStyleSheet::RemoveParagraphStyle}\label{wxrichtextstylesheetremoveparagraphstyle}
	149
	150	\func{bool}{RemoveParagraphStyle}{\param{wxRichTextStyleDefinition* }{def}, \param{bool }{deleteStyle = false}}
	151
	152	Removes a paragraph style.
	153
	154	\membersection{wxRichTextStyleSheet::RemoveStyle}\label{wxrichtextstylesheetremovestyle}
	155
	156	\func{bool}{RemoveStyle}{\param{wxRichTextStyleDefinition* }{def}, \param{bool }{deleteStyle = false}}
	157
	158	Removes a style.
	159
	160	\membersection{wxRichTextStyleSheet::SetDescription}\label{wxrichtextstylesheetsetdescription}
	161
	162	\func{void}{SetDescription}{\param{const wxString\& }{descr}}
	163
	164	Sets the style sheet's description.
	165
	166	\membersection{wxRichTextStyleSheet::SetName}\label{wxrichtextstylesheetsetname}
	167
	168	\func{void}{SetName}{\param{const wxString\& }{name}}
	169
	170	Sets the style sheet's name.
	171