]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/richtextliststyledefinition.tex
wxDataViewCtrl DnD stubs, some reformating
[wxWidgets.git] / docs / latex / wx / richtextliststyledefinition.tex
index b2b8f470c5aedd57465892f532e2c2d606e29d86..996028e2cfbac68eaf61625d0bda005b9b408629 100644 (file)
@@ -13,12 +13,18 @@ so that you can apply them directly to a buffer without requiring a control.
 
 \wxheading{Derived from}
 
-\helpref{wxRichTextParagraphStyleDefinition}{wxrichtextparagraphstyledefinition}
+\helpref{wxRichTextParagraphStyleDefinition}{wxrichtextparagraphstyledefinition}\\
+\helpref{wxRichTextStyleDefinition}{wxrichtextstyledefinition}\\
+\helpref{wxObject}{wxobject}
 
 \wxheading{Include files}
 
 <wx/richtext/richtextstyles.h>
 
+\wxheading{Library}
+
+\helpref{wxRichtext}{librarieslist}
+
 \wxheading{Data structures}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
@@ -37,9 +43,10 @@ Destructor.
 
 \membersection{wxRichTextListStyleDefinition::CombineWithParagraphStyle}\label{wxrichtextliststyledefinitioncombinewithparagraphstyle}
 
-\func{wxRichTextAttr}{CombineWithParagraphStyle}{\param{int }{indent}, \param{const wxRichTextAttr\&}{ paraStyle}}
+\func{wxTextAttr}{CombineWithParagraphStyle}{\param{int }{indent}, \param{const wxTextAttr\&}{ paraStyle}, \param{wxRichTextStyleSheet*}{ styleSheet = NULL}}
 
 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.
+If {\it styleSheet} is specified, the base style for this definition will also be included in the result.
 
 \membersection{wxRichTextListStyleDefinition::FindLevelForIndent}\label{wxrichtextliststyledefinitionfindlevelforindent}
 
@@ -47,15 +54,23 @@ This function combines the given paragraph style with the list style's base attr
 
 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}
+\membersection{wxRichTextListStyleDefinition::GetCombinedStyle}\label{wxrichtextliststyledefinitiongetcombinedstyle}
 
-\constfunc{wxRichTextAttr}{GetCombinedStyle}{\param{int }{indent}}
+\constfunc{wxTextAttr}{GetCombinedStyle}{\param{int }{indent}, \param{wxRichTextStyleSheet*}{ styleSheet = NULL}}
 
 This function combines the list style's base attributes and the level style matching the given indent, returning the combined attributes.
+If {\it styleSheet} is specified, the base style for this definition will also be included in the result.
+
+\membersection{wxRichTextListStyleDefinition::GetCombinedStyleForLevel}\label{wxrichtextliststyledefinitioncombinewithparagraphstyleforlevel}
+
+\constfunc{wxTextAttr}{GetCombinedStyleLevel}{\param{int }{level}, \param{wxRichTextStyleSheet*}{ styleSheet = NULL}}
+
+This function combines the list style's base attributes and the style for the specified level, returning the combined attributes.
+If {\it styleSheet} is specified, the base style for this definition will also be included in the result.
 
 \membersection{wxRichTextListStyleDefinition::GetLevelAttributes}\label{wxrichtextliststyledefinitiongetlevelattributes}
 
-\constfunc{const wxRichTextAttr*}{GetLevelAttributes}{\param{int }{level}}
+\constfunc{const wxTextAttr*}{GetLevelAttributes}{\param{int }{level}}
 
 Returns the style for the given level. {\it level} is a number between 0 and 9.
 
@@ -75,11 +90,11 @@ 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{const wxTextAttr\&}{ 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.
+The first and most flexible form uses a wxTextAttr object, while the second form is for convenient setting of the most commonly-used attributes.