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{Data structures}
  14
  15 \latexignore{\rtfignore{\wxheading{Members}}}
  16
  17 \membersection{wxRichTextStyleDefinition::wxRichTextStyleDefinition}\label{wxrichtextstyledefinitionwxrichtextstyledefinition}
  18
  19 \func{}{wxRichTextStyleDefinition}{\param{const wxString\& }{name = wxEmptyString}}
  20
  21 Constructor.
  22
  23 \membersection{wxRichTextStyleDefinition::\destruct{wxRichTextStyleDefinition}}\label{wxrichtextstyledefinitiondtor}
  24
  25 \func{}{\destruct{wxRichTextStyleDefinition}}{\void}
  26
  27 Destructor.
  28
  29 \membersection{wxRichTextStyleDefinition::GetBaseStyle}\label{wxrichtextstyledefinitiongetbasestyle}
  30
  31 \constfunc{const wxString\&}{GetBaseStyle}{\void}
  32
  33 Returns the style on which this style is based.
  34
  35 \membersection{wxRichTextStyleDefinition::GetDescription}\label{wxrichtextstyledefinitiongetdescription}
  36
  37 \constfunc{const wxString\&}{GetDescription}{\void}
  38
  39 Returns the style's description.
  40
  41 \membersection{wxRichTextStyleDefinition::GetName}\label{wxrichtextstyledefinitiongetname}
  42
  43 \constfunc{const wxString\&}{GetName}{\void}
  44
  45 Returns the style name.
  46
  47 \membersection{wxRichTextStyleDefinition::GetStyle}\label{wxrichtextstyledefinitiongetstyle}
  48
  49 \func{wxRichTextAttr\&}{GetStyle}{\void}
  50
  51 \constfunc{const wxRichTextAttr\&}{GetStyle}{\void}
  52
  53 Returns the attributes associated with this style.
  54
  55 \membersection{wxRichTextStyleDefinition::Init}\label{wxrichtextstyledefinitioninit}
  56
  57 \func{void}{Init}{\void}
  58
  59 Initialises the definition.
  60
  61 \membersection{wxRichTextStyleDefinition::SetBaseStyle}\label{wxrichtextstyledefinitionsetbasestyle}
  62
  63 \func{void}{SetBaseStyle}{\param{const wxString\& }{name}}
  64
  65 Sets the name of the style that this style is based on.
  66
  67 \membersection{wxRichTextStyleDefinition::SetDescription}\label{wxrichtextstyledefinitionsetdescription}
  68
  69 \func{void}{SetDescription}{\param{const wxString\& }{descr}}
  70
  71 Sets the style description.
  72
  73 \membersection{wxRichTextStyleDefinition::SetName}\label{wxrichtextstyledefinitionsetname}
  74
  75 \func{void}{SetName}{\param{const wxString\& }{name}}
  76
  77 Sets the name of the style.
  78
  79 \membersection{wxRichTextStyleDefinition::SetStyle}\label{wxrichtextstyledefinitionsetstyle}
  80
  81 \func{void}{SetStyle}{\param{const wxRichTextAttr\& }{style}}
  82
  83 Sets the attributes for this style.
  84