]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/richtextstyledefinition.tex
Minor doc updates
[wxWidgets.git] / docs / latex / wx / richtextstyledefinition.tex
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
13 \wxheading{Library}
14
15 \helpref{wxRichtext}{librarieslist}
16
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
39 \membersection{wxRichTextStyleDefinition::GetDescription}\label{wxrichtextstyledefinitiongetdescription}
40
41 \constfunc{const wxString\&}{GetDescription}{\void}
42
43 Returns the style's description.
44
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
53 \func{wxTextAttr\&}{GetStyle}{\void}
54
55 \constfunc{const wxTextAttr\&}{GetStyle}{\void}
56
57 Returns the attributes associated with this style.
58
59 \membersection{wxRichTextStyleDefinition::GetStyleMergedWithBase}\label{wxrichtextstyledefinitiongetstylemergedwithbase}
60
61 \constfunc{wxTextAttr}{GetStyleMergedWithBase}{\param{wxRichTextStyleSheet*}{ sheet}}
62
63 Returns the style attributes combined with the attributes of the specified base style, if any. This function works recursively.
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
71 \membersection{wxRichTextStyleDefinition::SetDescription}\label{wxrichtextstyledefinitionsetdescription}
72
73 \func{void}{SetDescription}{\param{const wxString\& }{descr}}
74
75 Sets the style description.
76
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
85 \func{void}{SetStyle}{\param{const wxTextAttr\& }{style}}
86
87 Sets the attributes for this style.
88