projects / wxWidgets.git / blame
| 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 | ||
| 40 | \membersection{wxRichTextStyleSheet::AddParagraphStyle}\label{wxrichtextstylesheetaddparagraphstyle} | |
| 41 | ||
| 42 | \func{bool}{AddParagraphStyle}{\param{wxRichTextParagraphStyleDefinition* }{def}} | |
| 43 | ||
| 44 | Adds a definition to the paragraph style list. | |
| 45 | ||
| 46 | \membersection{wxRichTextStyleSheet::DeleteStyles}\label{wxrichtextstylesheetdeletestyles} | |
| 47 | ||
| 48 | \func{void}{DeleteStyles}{\void} | |
| 49 | ||
| 50 | Deletes all styles. | |
| 51 | ||
| 52 | \membersection{wxRichTextStyleSheet::FindCharacterStyle}\label{wxrichtextstylesheetfindcharacterstyle} | |
| 53 | ||
| 54 | \constfunc{wxRichTextCharacterStyleDefinition*}{FindCharacterStyle}{\param{const wxString\& }{name}} | |
| 55 | ||
| 56 | Finds a character definition by name. | |
| 57 | ||
| 58 | \membersection{wxRichTextStyleSheet::FindParagraphStyle}\label{wxrichtextstylesheetfindparagraphstyle} | |
| 59 | ||
| 60 | \constfunc{wxRichTextParagraphStyleDefinition*}{FindParagraphStyle}{\param{const wxString\& }{name}} | |
| 61 | ||
| 62 | Finds a paragraph definition by name. | |
| 63 | ||
| 64 | \membersection{wxRichTextStyleSheet::GetCharacterStyle}\label{wxrichtextstylesheetgetcharacterstyle} | |
| 65 | ||
| 66 | \constfunc{wxRichTextCharacterStyleDefinition*}{GetCharacterStyle}{\param{size\_t }{n}} | |
| 67 | ||
| 68 | Returns the {\it n}th character style. | |
| 69 | ||
| 70 | \membersection{wxRichTextStyleSheet::GetCharacterStyleCount}\label{wxrichtextstylesheetgetcharacterstylecount} | |
| 71 | ||
| 72 | \constfunc{size\_t}{GetCharacterStyleCount}{\void} | |
| 73 | ||
| 74 | Returns the number of character styles. | |
| 75 | ||
| 76 | \membersection{wxRichTextStyleSheet::GetParagraphStyle}\label{wxrichtextstylesheetgetparagraphstyle} | |
| 77 | ||
| 78 | \constfunc{wxRichTextParagraphStyleDefinition*}{GetParagraphStyle}{\param{size\_t }{n}} | |
| 79 | ||
| 80 | Returns the {\it n}th paragraph style. | |
| 81 | ||
| 82 | \membersection{wxRichTextStyleSheet::GetParagraphStyleCount}\label{wxrichtextstylesheetgetparagraphstylecount} | |
| 83 | ||
| 84 | \constfunc{size\_t}{GetParagraphStyleCount}{\void} | |
| 85 | ||
| 86 | Returns the number of paragraph styles. | |
| 87 | ||
| 88 | \membersection{wxRichTextStyleSheet::Init}\label{wxrichtextstylesheetinit} | |
| 89 | ||
| 90 | \func{void}{Init}{\void} | |
| 91 | ||
| 92 | Initialises the style sheet. | |
| 93 | ||
| 94 | \membersection{wxRichTextStyleSheet::RemoveCharacterStyle}\label{wxrichtextstylesheetremovecharacterstyle} | |
| 95 | ||
| 96 | \func{bool}{RemoveCharacterStyle}{\param{wxRichTextStyleDefinition* }{def}, \param{bool }{deleteStyle = false}} | |
| 97 | ||
| 98 | Removes a character style. | |
| 99 | ||
| 100 | \membersection{wxRichTextStyleSheet::RemoveParagraphStyle}\label{wxrichtextstylesheetremoveparagraphstyle} | |
| 101 | ||
| 102 | \func{bool}{RemoveParagraphStyle}{\param{wxRichTextStyleDefinition* }{def}, \param{bool }{deleteStyle = false}} | |
| 103 | ||
| 104 | Removes a paragraph style. | |
| 62a268cc | 105 |