1 \section{\class{wxRichTextListStyleDefinition
}}\label{wxrichtextliststyledefinition
}
3 This class represents a list style definition, usually added to a
\helpref{wxRichTextStyleSheet
}{wxrichtextstylesheet
}.
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.
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.
14 \wxheading{Derived from
}
16 \helpref{wxRichTextParagraphStyleDefinition
}{wxrichtextparagraphstyledefinition
}
18 \wxheading{Include files
}
20 <wx/richtext/richtextstyles.h>
24 \helpref{wxRichtext
}{librarieslist
}
26 \wxheading{Data structures
}
28 \latexignore{\rtfignore{\wxheading{Members
}}}
30 \membersection{wxRichTextListStyleDefinition::wxRichTextListStyleDefinition
}\label{wxrichtextliststyledefinitionwxrichtextliststyledefinition
}
32 \func{}{wxRichTextListStyleDefinition
}{\param{const wxString\&
}{name = wxEmptyString
}}
36 \membersection{wxRichTextListStyleDefinition::
\destruct{wxRichTextListStyleDefinition
}}\label{wxrichtextliststyledefinitiondtor
}
38 \func{}{\destruct{wxRichTextListStyleDefinition
}}{\void}
42 \membersection{wxRichTextListStyleDefinition::CombineWithParagraphStyle
}\label{wxrichtextliststyledefinitioncombinewithparagraphstyle
}
44 \func{wxRichTextAttr
}{CombineWithParagraphStyle
}{\param{int
}{indent
},
\param{const wxRichTextAttr\&
}{ paraStyle
},
\param{wxRichTextStyleSheet*
}{ styleSheet = NULL
}}
46 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.
47 If
{\it styleSheet
} is specified, the base style for this definition will also be included in the result.
49 \membersection{wxRichTextListStyleDefinition::FindLevelForIndent
}\label{wxrichtextliststyledefinitionfindlevelforindent
}
51 \constfunc{int
}{FindLevelForIndent
}{\param{int
}{indent
}}
53 This function finds the level (from
0 to
9) whose indentation attribute mostly closely matches
{\it indent
} (expressed in tenths of a millimetre).
55 \membersection{wxRichTextListStyleDefinition::GetCombinedStyle
}\label{wxrichtextliststyledefinitioncombinewithparagraphstyle
}
57 \constfunc{wxRichTextAttr
}{GetCombinedStyle
}{\param{int
}{indent
},
\param{wxRichTextStyleSheet*
}{ styleSheet = NULL
}}
59 This function combines the list style's base attributes and the level style matching the given indent, returning the combined attributes.
60 If
{\it styleSheet
} is specified, the base style for this definition will also be included in the result.
62 \membersection{wxRichTextListStyleDefinition::GetCombinedStyleForLevel
}\label{wxrichtextliststyledefinitioncombinewithparagraphstyleforlevel
}
64 \constfunc{wxRichTextAttr
}{GetCombinedStyleLevel
}{\param{int
}{level
},
\param{wxRichTextStyleSheet*
}{ styleSheet = NULL
}}
66 This function combines the list style's base attributes and the style for the specified level, returning the combined attributes.
67 If
{\it styleSheet
} is specified, the base style for this definition will also be included in the result.
69 \membersection{wxRichTextListStyleDefinition::GetLevelAttributes
}\label{wxrichtextliststyledefinitiongetlevelattributes
}
71 \constfunc{const wxRichTextAttr*
}{GetLevelAttributes
}{\param{int
}{level
}}
73 Returns the style for the given level.
{\it level
} is a number between
0 and
9.
75 \membersection{wxRichTextListStyleDefinition::GetLevelCount
}\label{wxrichtextliststyledefinitiongetlevelcount
}
77 \constfunc{int
}{GetLevelCount
}{\void}
79 Returns the number of levels. This is hard-wired to
10.
81 Returns the style for the given level.
{\it level
} is a number between
0 and
9.
83 \membersection{wxRichTextListStyleDefinition::IsNumbered
}\label{wxrichtextliststyledefinitionisnumbered
}
85 \constfunc{int
}{IsNumbered
}{\param{int
}{ level
}}
87 Returns
\true if the given level has numbered list attributes.
89 \membersection{wxRichTextListStyleDefinition::SetLevelAttributes
}\label{wxrichtextliststyledefinitionsetlevelattributes
}
91 \func{void
}{SetLevelAttributes
}{\param{int
}{level
},
\param{const wxRichTextAttr\&
}{ attr
}}
93 \func{void
}{SetLevelAttributes
}{\param{int
}{level
},
\param{int
}{ leftIndent
},
\param{int
}{ leftSubIndent
},
\param{int
}{ bulletStyle
},
\param{const wxString\&
}{ bulletSymbol = wxEmptyString
}}
95 Sets the style for the given level.
{\it level
} is a number between
0 and
9.
97 The first and most flexible form uses a wxRichTextAttr object, while the second form is for convenient setting of the most commonly-used attributes.