docs/latex/wx/richtextliststyledefinition.tex

   1 \section{\class{wxRichTextListStyleDefinition}}\label{wxrichtextliststyledefinition}
   2
   3 This class represents a list style definition, usually added to a \helpref{wxRichTextStyleSheet}{wxrichtextstylesheet}.
   4
   5 The class inherits paragraph attributes from wxRichTextStyleParagraphDefinition, and adds 10 further attribute objects, one for each level of a list.
   6 When applying a list style to a paragraph, the list style's base and appropriate level attributes are merged with the
   7 paragraph's existing attributes.
   8
   9 You can apply a list style to one or more paragraphs using \helpref{wxRichTextCtrl::SetListStyle}{wxrichtextctrlsetliststyle}. You
  10 can also use the functions \helpref{wxRichTextCtrl::NumberList}{wxrichtextctrlnumberlist}, \helpref{wxRichTextCtrl::PromoteList}{wxrichtextctrlpromotelist} and
  11 \helpref{wxRichTextCtrl::ClearListStyle}{wxrichtextctrlclearliststyle}. As usual, there are wxRichTextBuffer versions of these functions
  12 so that you can apply them directly to a buffer without requiring a control.
  13
  14 \wxheading{Derived from}
  15
  16 \helpref{wxRichTextParagraphStyleDefinition}{wxrichtextparagraphstyledefinition}\\
  17 \helpref{wxRichTextStyleDefinition}{wxrichtextstyledefinition}\\
  18 \helpref{wxObject}{wxobject}
  19
  20 \wxheading{Include files}
  21
  22 <wx/richtext/richtextstyles.h>
  23
  24 \wxheading{Library}
  25
  26 \helpref{wxRichtext}{librarieslist}
  27
  28 \wxheading{Data structures}
  29
  30 \latexignore{\rtfignore{\wxheading{Members}}}
  31
  32 \membersection{wxRichTextListStyleDefinition::wxRichTextListStyleDefinition}\label{wxrichtextliststyledefinitionwxrichtextliststyledefinition}
  33
  34 \func{}{wxRichTextListStyleDefinition}{\param{const wxString\& }{name = wxEmptyString}}
  35
  36 Constructor.
  37
  38 \membersection{wxRichTextListStyleDefinition::\destruct{wxRichTextListStyleDefinition}}\label{wxrichtextliststyledefinitiondtor}
  39
  40 \func{}{\destruct{wxRichTextListStyleDefinition}}{\void}
  41
  42 Destructor.
  43
  44 \membersection{wxRichTextListStyleDefinition::CombineWithParagraphStyle}\label{wxrichtextliststyledefinitioncombinewithparagraphstyle}
  45
  46 \func{wxTextAttr}{CombineWithParagraphStyle}{\param{int }{indent}, \param{const wxTextAttr\&}{ paraStyle}, \param{wxRichTextStyleSheet*}{ styleSheet = NULL}}
  47
  48 This function combines the given paragraph style with the list style's base attributes and level style matching the given indent, returning the combined attributes.
  49 If {\it styleSheet} is specified, the base style for this definition will also be included in the result.
  50
  51 \membersection{wxRichTextListStyleDefinition::FindLevelForIndent}\label{wxrichtextliststyledefinitionfindlevelforindent}
  52
  53 \constfunc{int}{FindLevelForIndent}{\param{int }{indent}}
  54
  55 This function finds the level (from 0 to 9) whose indentation attribute mostly closely matches {\it indent} (expressed in tenths of a millimetre).
  56
  57 \membersection{wxRichTextListStyleDefinition::GetCombinedStyle}\label{wxrichtextliststyledefinitiongetcombinedstyle}
  58
  59 \constfunc{wxTextAttr}{GetCombinedStyle}{\param{int }{indent}, \param{wxRichTextStyleSheet*}{ styleSheet = NULL}}
  60
  61 This function combines the list style's base attributes and the level style matching the given indent, returning the combined attributes.
  62 If {\it styleSheet} is specified, the base style for this definition will also be included in the result.
  63
  64 \membersection{wxRichTextListStyleDefinition::GetCombinedStyleForLevel}\label{wxrichtextliststyledefinitioncombinewithparagraphstyleforlevel}
  65
  66 \constfunc{wxTextAttr}{GetCombinedStyleLevel}{\param{int }{level}, \param{wxRichTextStyleSheet*}{ styleSheet = NULL}}
  67
  68 This function combines the list style's base attributes and the style for the specified level, returning the combined attributes.
  69 If {\it styleSheet} is specified, the base style for this definition will also be included in the result.
  70
  71 \membersection{wxRichTextListStyleDefinition::GetLevelAttributes}\label{wxrichtextliststyledefinitiongetlevelattributes}
  72
  73 \constfunc{const wxTextAttr*}{GetLevelAttributes}{\param{int }{level}}
  74
  75 Returns the style for the given level. {\it level} is a number between 0 and 9.
  76
  77 \membersection{wxRichTextListStyleDefinition::GetLevelCount}\label{wxrichtextliststyledefinitiongetlevelcount}
  78
  79 \constfunc{int}{GetLevelCount}{\void}
  80
  81 Returns the number of levels. This is hard-wired to 10.
  82
  83 Returns the style for the given level. {\it level} is a number between 0 and 9.
  84
  85 \membersection{wxRichTextListStyleDefinition::IsNumbered}\label{wxrichtextliststyledefinitionisnumbered}
  86
  87 \constfunc{int}{IsNumbered}{\param{int}{ level}}
  88
  89 Returns \true if the given level has numbered list attributes.
  90
  91 \membersection{wxRichTextListStyleDefinition::SetLevelAttributes}\label{wxrichtextliststyledefinitionsetlevelattributes}
  92
  93 \func{void}{SetLevelAttributes}{\param{int }{level}, \param{const wxTextAttr\&}{ attr}}
  94
  95 \func{void}{SetLevelAttributes}{\param{int }{level}, \param{int}{ leftIndent}, \param{int}{ leftSubIndent}, \param{int}{ bulletStyle}, \param{const wxString\&}{ bulletSymbol = wxEmptyString}}
  96
  97 Sets the style for the given level. {\it level} is a number between 0 and 9.
  98
  99 The first and most flexible form uses a wxTextAttr object, while the second form is for convenient setting of the most commonly-used attributes.
 100