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:
104
docs/latex/wx/richtextstylesheet.tex
Normal file
104
docs/latex/wx/richtextstylesheet.tex
Normal 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.
|
Reference in New Issue
Block a user