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
  18 \wxheading{Include files}
  19
  20 <wx/richtext/richtextstyles.h>
  21
  22 \wxheading{Data structures}
  23
  24 \latexignore{\rtfignore{\wxheading{Members}}}
  25
  26 \membersection{wxRichTextListStyleDefinition::wxRichTextListStyleDefinition}\label{wxrichtextliststyledefinitionwxrichtextliststyledefinition}
  27
  28 \func{}{wxRichTextListStyleDefinition}{\param{const wxString\& }{name = wxEmptyString}}
  29
  30 Constructor.
  31
  32 \membersection{wxRichTextListStyleDefinition::\destruct{wxRichTextListStyleDefinition}}\label{wxrichtextliststyledefinitiondtor}
  33
  34 \func{}{\destruct{wxRichTextListStyleDefinition}}{\void}
  35
  36 Destructor.
  37
  38 \membersection{wxRichTextListStyleDefinition::CombineWithParagraphStyle}\label{wxrichtextliststyledefinitioncombinewithparagraphstyle}
  39
  40 \func{wxRichTextAttr}{CombineWithParagraphStyle}{\param{int }{indent}, \param{const wxRichTextAttr\&}{ paraStyle}, \param{wxRichTextStyleSheet*}{ styleSheet = NULL}}
  41
  42 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.
  43 If {\it styleSheet} is specified, the base style for this definition will also be included in the result.
  44
  45 \membersection{wxRichTextListStyleDefinition::FindLevelForIndent}\label{wxrichtextliststyledefinitionfindlevelforindent}
  46
  47 \constfunc{int}{FindLevelForIndent}{\param{int }{indent}}
  48
  49 This function finds the level (from 0 to 9) whose indentation attribute mostly closely matches {\it indent} (expressed in tenths of a millimetre).
  50
  51 \membersection{wxRichTextListStyleDefinition::GetCombinedStyle}\label{wxrichtextliststyledefinitioncombinewithparagraphstyle}
  52
  53 \constfunc{wxRichTextAttr}{GetCombinedStyle}{\param{int }{indent}, \param{wxRichTextStyleSheet*}{ styleSheet = NULL}}
  54
  55 This function combines the list style's base attributes and the level style matching the given indent, returning the combined attributes.
  56 If {\it styleSheet} is specified, the base style for this definition will also be included in the result.
  57
  58 \membersection{wxRichTextListStyleDefinition::GetCombinedStyleForLevel}\label{wxrichtextliststyledefinitioncombinewithparagraphstyleforlevel}
  59
  60 \constfunc{wxRichTextAttr}{GetCombinedStyleLevel}{\param{int }{level}, \param{wxRichTextStyleSheet*}{ styleSheet = NULL}}
  61
  62 This function combines the list style's base attributes and the style for the specified level, returning the combined attributes.
  63 If {\it styleSheet} is specified, the base style for this definition will also be included in the result.
  64
  65 \membersection{wxRichTextListStyleDefinition::GetLevelAttributes}\label{wxrichtextliststyledefinitiongetlevelattributes}
  66
  67 \constfunc{const wxRichTextAttr*}{GetLevelAttributes}{\param{int }{level}}
  68
  69 Returns the style for the given level. {\it level} is a number between 0 and 9.
  70
  71 \membersection{wxRichTextListStyleDefinition::GetLevelCount}\label{wxrichtextliststyledefinitiongetlevelcount}
  72
  73 \constfunc{int}{GetLevelCount}{\void}
  74
  75 Returns the number of levels. This is hard-wired to 10.
  76
  77 Returns the style for the given level. {\it level} is a number between 0 and 9.
  78
  79 \membersection{wxRichTextListStyleDefinition::IsNumbered}\label{wxrichtextliststyledefinitionisnumbered}
  80
  81 \constfunc{int}{IsNumbered}{\param{int}{ level}}
  82
  83 Returns \true if the given level has numbered list attributes.
  84
  85 \membersection{wxRichTextListStyleDefinition::SetLevelAttributes}\label{wxrichtextliststyledefinitionsetlevelattributes}
  86
  87 \func{void}{SetLevelAttributes}{\param{int }{level}, \param{const wxRichTextAttr\&}{ attr}}
  88
  89 \func{void}{SetLevelAttributes}{\param{int }{level}, \param{int}{ leftIndent}, \param{int}{ leftSubIndent}, \param{int}{ bulletStyle}, \param{const wxString\&}{ bulletSymbol = wxEmptyString}}
  90
  91 Sets the style for the given level. {\it level} is a number between 0 and 9.
  92
  93 The first and most flexible form uses a wxRichTextAttr object, while the second form is for convenient setting of the most commonly-used attributes.
  94