Documented new menu label functions

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

diff --git a/docs/latex/wx/richtextattr.tex b/docs/latex/wx/richtextattr.tex
index 2c3631d44a2c4892d80f4cc19dea49e4818408e1..9bec6fcd3248718f821992308c30016f1370af33 100644 (file)
--- a/docs/latex/wx/richtextattr.tex
+++ b/docs/latex/wx/richtextattr.tex
@@ -20,6 +20,10 @@ No base class
 
 <wx/richtext/richtextbuffer.h>
 
 
 <wx/richtext/richtextbuffer.h>
 

+\wxheading{Library}
+
+\helpref{wxRichtext}{librarieslist}
+

 \wxheading{Constants}
 
 The following values can be passed to wxRichTextAttr::SetAlignment to determine
 \wxheading{Constants}
 
 The following values can be passed to wxRichTextAttr::SetAlignment to determine


@@ -80,6 +84,7 @@ for a text control.
 #define wxTEXT_ATTR_URL                     0x00200000
 #define wxTEXT_ATTR_PAGE_BREAK              0x00400000
 #define wxTEXT_ATTR_EFFECTS                 0x00800000
 #define wxTEXT_ATTR_URL                     0x00200000
 #define wxTEXT_ATTR_PAGE_BREAK              0x00400000
 #define wxTEXT_ATTR_EFFECTS                 0x00800000

+#define wxTEXT_ATTR_OUTLINE_LEVEL           0x01000000

 \end{verbatim}
 }
 
 \end{verbatim}
 }
 


@@ -154,11 +159,22 @@ Of these, only wxTEXT\_ATTR\_EFFECT\_CAPITALS and wxTEXT\_ATTR\_EFFECT\_STRIKETH
 
 Constructors.
 
 
 Constructors.
 

-\membersection{wxRichTextAttr::CopyTo}\label{wxrichtextattrcopyto}
+\membersection{wxRichTextAttr::Apply}\label{wxrichtextattrapply}
+
+\func{bool}{Combine}{\param{const wxRichTextAttrEx\& }{style}, \param{const wxRichTextAttrEx* }{compareWith = NULL}}
+
+Applies the attributes in {\it style} to the original object, but not those attributes from {\it style} that are the same as those in {\it compareWith} (if passed).
+
+See also \helpref{wxRichTextAttr::Combine}{wxrichtextattrcombine} for a function that does almost the same but returns a new object instead of modifying the original object.
+
+\membersection{wxRichTextAttr::Combine}\label{wxrichtextattrcombine}

 
 

-\constfunc{void}{CopyTo}{\param{wxTextAttrEx\& }{attr}}
+\constfunc{wxRichTextAttr}{Combine}{\param{const wxRichTextAttrEx\& }{style}, \param{const wxRichTextAttrEx* }{compareWith = NULL}}

 
 

-Copies the wxRichTextAttr attributes to a \helpref{wxTextAttrEx}{wxtextattrex} object.
+Combines 'this' with {\it style}, but not applying attributes from {\it style} that are the same as those in {\it compareWith} (if passed).
+A wxRichTextAttr object is returned and the original object is not changed.
+
+See also \helpref{wxRichTextAttr::Apply}{wxrichtextattrapply} for a function that does almost the same but modifies the original object instead of returning a new one.

 
 \membersection{wxRichTextAttr::CreateFont}\label{wxrichtextattrcreatefont}
 
 
 \membersection{wxRichTextAttr::CreateFont}\label{wxrichtextattrcreatefont}
 


@@ -297,6 +313,12 @@ wxTEXT\_ATTR\_LINE\_SPACING\_HALF, and wxTEXT\_ATTR\_LINE\_SPACING\_TWICE.
 
 Returns the name of the list style.
 
 
 Returns the name of the list style.
 

+\membersection{wxRichTextAttr::GetOutlineLevel}\label{wxrichtextattrgetoutlinelevel}
+
+\constfunc{bool}{GetOutlineLevel}{\void}
+
+Returns the outline level.
+

 \membersection{wxRichTextAttr::GetParagraphSpacingAfter}\label{wxrichtextattrgetparagraphspacingafter}
 
 \constfunc{int}{GetParagraphSpacingAfter}{\void}
 \membersection{wxRichTextAttr::GetParagraphSpacingAfter}\label{wxrichtextattrgetparagraphspacingafter}
 
 \constfunc{int}{GetParagraphSpacingAfter}{\void}


@@ -397,9 +419,9 @@ Returns \true if the attribute object specifies bullet text (usually specifying
 
 Returns \true if the attribute object specifies a character style name.
 
 
 Returns \true if the attribute object specifies a character style name.
 

-\membersection{wxRichTextAttr::HasFaceName}\label{wxrichtextattrhasfacename}
+\membersection{wxRichTextAttr::HasFontFaceName}\label{wxrichtextattrhasfontfacename}

 
 

-\constfunc{bool}{HasFaceName}{\void}
+\constfunc{bool}{HasFontFaceName}{\void}

 
 Returns \true if the attribute object specifies a font face name.
 
 
 Returns \true if the attribute object specifies a font face name.
 


@@ -415,9 +437,9 @@ Returns \true if the {\it flag} is present in the attribute object's flag bitlis
 
 Returns \true if the attribute object specifies any font attributes.
 
 
 Returns \true if the attribute object specifies any font attributes.
 

-\membersection{wxRichTextAttr::HasItalic}\label{wxrichtextattrhasitalic}
+\membersection{wxRichTextAttr::HasFontItalic}\label{wxrichtextattrhasfontitalic}

 
 

-\constfunc{bool}{HasItalic}{\void}
+\constfunc{bool}{HasFontItalic}{\void}

 
 Returns \true if the attribute object specifies italic style.
 
 
 Returns \true if the attribute object specifies italic style.
 


@@ -439,6 +461,12 @@ Returns \true if the attribute object specifies line spacing.
 
 Returns \true if the attribute object specifies a list style name.
 
 
 Returns \true if the attribute object specifies a list style name.
 

+\membersection{wxRichTextAttr::HasOutlineLevel}\label{wxrichtextattrhasoutlinelevel}
+
+\constfunc{bool}{HasOutlineLevel}{\void}
+
+Returns \true if the attribute object specifies an outline level.
+

 \membersection{wxRichTextAttr::HasPageBreak}\label{wxrichtextattrhaspagebreak}
 
 \constfunc{bool}{HasPageBreak}{\void}
 \membersection{wxRichTextAttr::HasPageBreak}\label{wxrichtextattrhaspagebreak}
 
 \constfunc{bool}{HasPageBreak}{\void}


@@ -469,9 +497,9 @@ Returns \true if the attribute object specifies a paragraph style name.
 
 Returns \true if the attribute object specifies a right indent.
 
 
 Returns \true if the attribute object specifies a right indent.
 

-\membersection{wxRichTextAttr::HasSize}\label{wxrichtextattrhassize}
+\membersection{wxRichTextAttr::HasFontSize}\label{wxrichtextattrhasfontsize}

 
 

-\constfunc{bool}{HasSize}{\void}
+\constfunc{bool}{HasFontSize}{\void}

 
 Returns \true if the attribute object specifies a font point size.
 
 
 Returns \true if the attribute object specifies a font point size.
 


@@ -487,23 +515,29 @@ Returns \true if the attribute object specifies tab stops.
 
 Returns \true if the attribute object specifies a text foreground colour.
 
 
 Returns \true if the attribute object specifies a text foreground colour.
 

-\membersection{wxRichTextAttr::HasUnderlined}\label{wxrichtextattrhasunderlined}
+\membersection{wxRichTextAttr::HasTextEffects}\label{wxrichtextattrhastexteffects}
+
+\constfunc{bool}{HasTextEffects}{\void}
+
+Returns \true if the attribute object specifies text effects.
+
+\membersection{wxRichTextAttr::HasFontUnderlined}\label{wxrichtextattrhasfontunderlined}

 
 

-\constfunc{bool}{HasUnderlined}{\void}
+\constfunc{bool}{HasFontUnderlined}{\void}

 
 Returns \true if the attribute object specifies either underlining or no underlining.
 
 
 Returns \true if the attribute object specifies either underlining or no underlining.
 

-\membersection{wxRichTextAttr::HasWeight}\label{wxrichtextattrhasweight}
+\membersection{wxRichTextAttr::HasURL}\label{wxrichtextattrhasurl}

 
 

-\constfunc{bool}{HasWeight}{\void}
+\constfunc{bool}{HasURL}{\void}

 
 

-Returns \true if the attribute object specifies font weight (bold, light or normal).
+Returns \true if the attribute object specifies a URL.

 
 

-\membersection{wxRichTextAttr::Init}\label{wxrichtextattrinit}
+\membersection{wxRichTextAttr::HasFontWeight}\label{wxrichtextattrhasfontweight}

 
 

-\func{void}{Init}{\void}
+\constfunc{bool}{HasFontWeight}{\void}

 
 

-Initialise the object.
+Returns \true if the attribute object specifies font weight (bold, light or normal).

 
 \membersection{wxRichTextAttr::IsCharacterStyle}\label{wxrichtextattrischaracterstyle}
 
 
 \membersection{wxRichTextAttr::IsCharacterStyle}\label{wxrichtextattrischaracterstyle}
 


@@ -658,6 +692,7 @@ flags can be passed in a bitlist:
 #define wxTEXT_ATTR_URL                     0x00200000
 #define wxTEXT_ATTR_PAGE_BREAK              0x00400000
 #define wxTEXT_ATTR_EFFECTS                 0x00800000
 #define wxTEXT_ATTR_URL                     0x00200000
 #define wxTEXT_ATTR_PAGE_BREAK              0x00400000
 #define wxTEXT_ATTR_EFFECTS                 0x00800000

+#define wxTEXT_ATTR_OUTLINE_LEVEL           0x01000000

 \end{verbatim}
 }
 
 \end{verbatim}
 }
 


@@ -729,6 +764,14 @@ defined for convenience:
 
 Sets the list style name.
 
 
 Sets the list style name.
 

+\membersection{wxRichTextAttr::SetOutlineLevel}\label{wxrichtextattrsetoutlinelevel}
+
+\func{void}{SetOutlineLevel}{\param{int}{ level}}
+
+Specifies the outline level. Zero represents normal text. At present, the outline level is
+not used, but may be used in future for determining list levels and for applications
+that need to store document structure information.
+

 \membersection{wxRichTextAttr::SetPageBreak}\label{wxrichtextattrsetpagebreak}
 
 \func{void}{SetPageBreak}{\param{bool}{ pageBreak = true}}
 \membersection{wxRichTextAttr::SetPageBreak}\label{wxrichtextattrsetpagebreak}
 
 \func{void}{SetPageBreak}{\param{bool}{ pageBreak = true}}