projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 5f35b46a JS |
1 | \section{\class{wxRichTextStyleDefinition}}\label{wxrichtextstyledefinition} |
| 2 | ||
| 3 | This is a base class for paragraph and character styles. | |
| 4 | ||
| 5 | \wxheading{Derived from} | |
| 6 | ||
| 7 | \helpref{wxObject}{wxobject} | |
| 8 | ||
| 9 | \wxheading{Include files} | |
| 10 | ||
| 11 | <wx/richtext/richtextstyles.h> | |
| 12 | ||
| a7af285d VZ |
13 | \wxheading{Library} |
| 14 | ||
| 15 | \helpref{wxRichtext}{librarieslist} | |
| 16 | ||
| 5f35b46a JS |
17 | \wxheading{Data structures} |
| 18 | ||
| 19 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 20 | ||
| 21 | \membersection{wxRichTextStyleDefinition::wxRichTextStyleDefinition}\label{wxrichtextstyledefinitionwxrichtextstyledefinition} | |
| 22 | ||
| 23 | \func{}{wxRichTextStyleDefinition}{\param{const wxString\& }{name = wxEmptyString}} | |
| 24 | ||
| 25 | Constructor. | |
| 26 | ||
| 27 | \membersection{wxRichTextStyleDefinition::\destruct{wxRichTextStyleDefinition}}\label{wxrichtextstyledefinitiondtor} | |
| 28 | ||
| 29 | \func{}{\destruct{wxRichTextStyleDefinition}}{\void} | |
| 30 | ||
| 31 | Destructor. | |
| 32 | ||
| 33 | \membersection{wxRichTextStyleDefinition::GetBaseStyle}\label{wxrichtextstyledefinitiongetbasestyle} | |
| 34 | ||
| 35 | \constfunc{const wxString\&}{GetBaseStyle}{\void} | |
| 36 | ||
| 37 | Returns the style on which this style is based. | |
| 38 | ||
| 1f65137f JS |
39 | \membersection{wxRichTextStyleDefinition::GetDescription}\label{wxrichtextstyledefinitiongetdescription} |
| 40 | ||
| 41 | \constfunc{const wxString\&}{GetDescription}{\void} | |
| 42 | ||
| 43 | Returns the style's description. | |
| 44 | ||
| 5f35b46a JS |
45 | \membersection{wxRichTextStyleDefinition::GetName}\label{wxrichtextstyledefinitiongetname} |
| 46 | ||
| 47 | \constfunc{const wxString\&}{GetName}{\void} | |
| 48 | ||
| 49 | Returns the style name. | |
| 50 | ||
| 51 | \membersection{wxRichTextStyleDefinition::GetStyle}\label{wxrichtextstyledefinitiongetstyle} | |
| 52 | ||
| 44cc96a8 | 53 | \func{wxTextAttr\&}{GetStyle}{\void} |
| 5f35b46a | 54 | |
| 44cc96a8 | 55 | \constfunc{const wxTextAttr\&}{GetStyle}{\void} |
| 5f35b46a JS |
56 | |
| 57 | Returns the attributes associated with this style. | |
| 58 | ||
| 336d8ae9 | 59 | \membersection{wxRichTextStyleDefinition::GetStyleMergedWithBase}\label{wxrichtextstyledefinitiongetstylemergedwithbase} |
| 5f35b46a | 60 | |
| 44cc96a8 | 61 | \constfunc{wxTextAttr}{GetStyleMergedWithBase}{\param{wxRichTextStyleSheet*}{ sheet}} |
| 5f35b46a | 62 | |
| 336d8ae9 | 63 | Returns the style attributes combined with the attributes of the specified base style, if any. This function works recursively. |
| 5f35b46a JS |
64 | |
| 65 | \membersection{wxRichTextStyleDefinition::SetBaseStyle}\label{wxrichtextstyledefinitionsetbasestyle} | |
| 66 | ||
| 67 | \func{void}{SetBaseStyle}{\param{const wxString\& }{name}} | |
| 68 | ||
| 69 | Sets the name of the style that this style is based on. | |
| 70 | ||
| 1f65137f JS |
71 | \membersection{wxRichTextStyleDefinition::SetDescription}\label{wxrichtextstyledefinitionsetdescription} |
| 72 | ||
| 73 | \func{void}{SetDescription}{\param{const wxString\& }{descr}} | |
| 74 | ||
| 75 | Sets the style description. | |
| 76 | ||
| 5f35b46a JS |
77 | \membersection{wxRichTextStyleDefinition::SetName}\label{wxrichtextstyledefinitionsetname} |
| 78 | ||
| 79 | \func{void}{SetName}{\param{const wxString\& }{name}} | |
| 80 | ||
| 81 | Sets the name of the style. | |
| 82 | ||
| 83 | \membersection{wxRichTextStyleDefinition::SetStyle}\label{wxrichtextstyledefinitionsetstyle} | |
| 84 | ||
| 44cc96a8 | 85 | \func{void}{SetStyle}{\param{const wxTextAttr\& }{style}} |
| 5f35b46a JS |
86 | |
| 87 | Sets the attributes for this style. | |
| 88 |