[wxWidgets.git] / docs / latex / wx / richtextliststyledefinition.tex

\section{\class{wxRichTextListStyleDefinition}}\label{wxrichtextliststyledefinition}

This class represents a list style definition, usually added to a \helpref{wxRichTextStyleSheet}{wxrichtextstylesheet}.

The class inherits paragraph attributes from wxRichTextStyleParagraphDefinition, and adds 10 further attribute objects, one for each level of a list.
When applying a list style to a paragraph, the list style's base and appropriate level attributes are merged with the
paragraph's existing attributes.

You can apply a list style to one or more paragraphs using \helpref{wxRichTextCtrl::SetListStyle}{wxrichtextctrlsetliststyle}. You
can also use the functions \helpref{wxRichTextCtrl::NumberList}{wxrichtextctrlnumberlist}, \helpref{wxRichTextCtrl::PromoteList}{wxrichtextctrlpromotelist} and 
\helpref{wxRichTextCtrl::ClearListStyle}{wxrichtextctrlclearliststyle}. As usual, there are wxRichTextBuffer versions of these functions
so that you can apply them directly to a buffer without requiring a control.

\wxheading{Derived from}

\helpref{wxRichTextParagraphStyleDefinition}{wxrichtextparagraphstyledefinition}

\wxheading{Include files}

<wx/richtext/richtextstyles.h>

\wxheading{Data structures}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxRichTextListStyleDefinition::wxRichTextListStyleDefinition}\label{wxrichtextliststyledefinitionwxrichtextliststyledefinition}

\func{}{wxRichTextListStyleDefinition}{\param{const wxString\& }{name = wxEmptyString}}

Constructor.

\membersection{wxRichTextListStyleDefinition::\destruct{wxRichTextListStyleDefinition}}\label{wxrichtextliststyledefinitiondtor}

\func{}{\destruct{wxRichTextListStyleDefinition}}{\void}

Destructor.

\membersection{wxRichTextListStyleDefinition::CombineWithParagraphStyle}\label{wxrichtextliststyledefinitioncombinewithparagraphstyle}

\func{wxRichTextAttr}{CombineWithParagraphStyle}{\param{int }{indent}, \param{const wxRichTextAttr\&}{ paraStyle}}

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.

\membersection{wxRichTextListStyleDefinition::FindLevelForIndent}\label{wxrichtextliststyledefinitionfindlevelforindent}

\constfunc{int}{FindLevelForIndent}{\param{int }{indent}}

This function finds the level (from 0 to 9) whose indentation attribute mostly closely matches {\it indent} (expressed in tenths of a millimetre).

\membersection{wxRichTextListStyleDefinition::GetCombinedStyle}\label{wxrichtextliststyledefinitioncombinewithparagraphstyle}

\constfunc{wxRichTextAttr}{GetCombinedStyle}{\param{int }{indent}}

This function combines the list style's base attributes and the level style matching the given indent, returning the combined attributes.

\membersection{wxRichTextListStyleDefinition::GetLevelAttributes}\label{wxrichtextliststyledefinitiongetlevelattributes}

\constfunc{const wxRichTextAttr*}{GetLevelAttributes}{\param{int }{level}}

Returns the style for the given level. {\it level} is a number between 0 and 9.

\membersection{wxRichTextListStyleDefinition::GetLevelCount}\label{wxrichtextliststyledefinitiongetlevelcount}

\constfunc{int}{GetLevelCount}{\void}

Returns the number of levels. This is hard-wired to 10.

Returns the style for the given level. {\it level} is a number between 0 and 9.

\membersection{wxRichTextListStyleDefinition::IsNumbered}\label{wxrichtextliststyledefinitionisnumbered}

\constfunc{int}{IsNumbered}{\param{int}{ level}}

Returns \true if the given level has numbered list attributes.

\membersection{wxRichTextListStyleDefinition::SetLevelAttributes}\label{wxrichtextliststyledefinitionsetlevelattributes}

\func{void}{SetLevelAttributes}{\param{int }{level}, \param{const wxRichTextAttr\&}{ attr}}

\func{void}{SetLevelAttributes}{\param{int }{level}, \param{int}{ leftIndent}, \param{int}{ leftSubIndent}, \param{int}{ bulletStyle}, \param{const wxString\&}{ bulletSymbol = wxEmptyString}}

Sets the style for the given level. {\it level} is a number between 0 and 9.

The first and most flexible form uses a wxRichTextAttr object, while the second form is for convenient setting of the most commonly-used attributes.
Commit	Line	Data
d2d0adc7 JS	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
62f4313b	16	\helpref{wxRichTextParagraphStyleDefinition}{wxrichtextparagraphstyledefinition}
d2d0adc7 JS	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}}
	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
	44	\membersection{wxRichTextListStyleDefinition::FindLevelForIndent}\label{wxrichtextliststyledefinitionfindlevelforindent}
	45
	46	\constfunc{int}{FindLevelForIndent}{\param{int }{indent}}
	47
	48	This function finds the level (from 0 to 9) whose indentation attribute mostly closely matches {\it indent} (expressed in tenths of a millimetre).
	49
	50	\membersection{wxRichTextListStyleDefinition::GetCombinedStyle}\label{wxrichtextliststyledefinitioncombinewithparagraphstyle}
	51
	52	\constfunc{wxRichTextAttr}{GetCombinedStyle}{\param{int }{indent}}
	53
	54	This function combines the list style's base attributes and the level style matching the given indent, returning the combined attributes.
	55
	56	\membersection{wxRichTextListStyleDefinition::GetLevelAttributes}\label{wxrichtextliststyledefinitiongetlevelattributes}
	57
	58	\constfunc{const wxRichTextAttr*}{GetLevelAttributes}{\param{int }{level}}
	59
	60	Returns the style for the given level. {\it level} is a number between 0 and 9.
	61
	62	\membersection{wxRichTextListStyleDefinition::GetLevelCount}\label{wxrichtextliststyledefinitiongetlevelcount}
	63
	64	\constfunc{int}{GetLevelCount}{\void}
	65
	66	Returns the number of levels. This is hard-wired to 10.
	67
	68	Returns the style for the given level. {\it level} is a number between 0 and 9.
	69
	70	\membersection{wxRichTextListStyleDefinition::IsNumbered}\label{wxrichtextliststyledefinitionisnumbered}
	71
	72	\constfunc{int}{IsNumbered}{\param{int}{ level}}
	73
	74	Returns \true if the given level has numbered list attributes.
	75
	76	\membersection{wxRichTextListStyleDefinition::SetLevelAttributes}\label{wxrichtextliststyledefinitionsetlevelattributes}
	77
	78	\func{void}{SetLevelAttributes}{\param{int }{level}, \param{const wxRichTextAttr\&}{ attr}}
	79
	80	\func{void}{SetLevelAttributes}{\param{int }{level}, \param{int}{ leftIndent}, \param{int}{ leftSubIndent}, \param{int}{ bulletStyle}, \param{const wxString\&}{ bulletSymbol = wxEmptyString}}
81
82	Sets the style for the given level. {\it level} is a number between 0 and 9.
83
84	The first and most flexible form uses a wxRichTextAttr object, while the second form is for convenient setting of the most commonly-used attributes.
85