documentation for wxAppTraits (patch 1518295 from Francesco)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@43576 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2006-07-24 18:20:18 +00:00
parent cb349f69fa
commit 336d8ae9a3
13 changed files with 408 additions and 232 deletions

View File

@@ -155,11 +155,22 @@ Of these, only wxTEXT\_ATTR\_EFFECT\_CAPITALS and wxTEXT\_ATTR\_EFFECT\_STRIKETH
Constructors.
\membersection{wxRichTextAttr::CopyTo}\label{wxrichtextattrcopyto}
\membersection{wxRichTextAttr::Apply}\label{wxrichtextattrapply}
\constfunc{void}{CopyTo}{\param{wxTextAttrEx\& }{attr}}
\func{bool}{Combine}{\param{const wxRichTextAttrEx\& }{style}, \param{const wxRichTextAttrEx* }{compareWith = NULL}}
Copies the wxRichTextAttr attributes to a \helpref{wxTextAttrEx}{wxtextattrex} object.
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{wxRichTextAttr}{Combine}{\param{const wxRichTextAttrEx\& }{style}, \param{const wxRichTextAttrEx* }{compareWith = NULL}}
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}
@@ -404,9 +415,9 @@ Returns \true if the attribute object specifies bullet text (usually specifying
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.
@@ -422,9 +433,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.
\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.
@@ -482,9 +493,9 @@ Returns \true if the attribute object specifies a paragraph style name.
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.
@@ -506,9 +517,9 @@ Returns \true if the attribute object specifies a text foreground colour.
Returns \true if the attribute object specifies text effects.
\membersection{wxRichTextAttr::HasUnderlined}\label{wxrichtextattrhasunderlined}
\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.
@@ -518,18 +529,12 @@ Returns \true if the attribute object specifies either underlining or no underli
Returns \true if the attribute object specifies a URL.
\membersection{wxRichTextAttr::HasWeight}\label{wxrichtextattrhasweight}
\membersection{wxRichTextAttr::HasFontWeight}\label{wxrichtextattrhasfontweight}
\constfunc{bool}{HasWeight}{\void}
\constfunc{bool}{HasFontWeight}{\void}
Returns \true if the attribute object specifies font weight (bold, light or normal).
\membersection{wxRichTextAttr::Init}\label{wxrichtextattrinit}
\func{void}{Init}{\void}
Initialise the object.
\membersection{wxRichTextAttr::IsCharacterStyle}\label{wxrichtextattrischaracterstyle}
\constfunc{bool}{IsCharacterStyle}{\void}

View File

@@ -37,9 +37,10 @@ Destructor.
\membersection{wxRichTextListStyleDefinition::CombineWithParagraphStyle}\label{wxrichtextliststyledefinitioncombinewithparagraphstyle}
\func{wxRichTextAttr}{CombineWithParagraphStyle}{\param{int }{indent}, \param{const wxRichTextAttr\&}{ paraStyle}}
\func{wxRichTextAttr}{CombineWithParagraphStyle}{\param{int }{indent}, \param{const wxRichTextAttr\&}{ 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}
@@ -49,9 +50,17 @@ This function finds the level (from 0 to 9) whose indentation attribute mostly c
\membersection{wxRichTextListStyleDefinition::GetCombinedStyle}\label{wxrichtextliststyledefinitioncombinewithparagraphstyle}
\constfunc{wxRichTextAttr}{GetCombinedStyle}{\param{int }{indent}}
\constfunc{wxRichTextAttr}{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{wxRichTextAttr}{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}

View File

@@ -52,11 +52,11 @@ Returns the style name.
Returns the attributes associated with this style.
\membersection{wxRichTextStyleDefinition::Init}\label{wxrichtextstyledefinitioninit}
\membersection{wxRichTextStyleDefinition::GetStyleMergedWithBase}\label{wxrichtextstyledefinitiongetstylemergedwithbase}
\func{void}{Init}{\void}
\constfunc{wxRichTextAttr}{GetStyleMergedWithBase}{\param{wxRichTextStyleSheet*}{ sheet}}
Initialises the definition.
Returns the style attributes combined with the attributes of the specified base style, if any. This function works recursively.
\membersection{wxRichTextStyleDefinition::SetBaseStyle}\label{wxrichtextstyledefinitionsetbasestyle}

View File

@@ -49,6 +49,12 @@ Adds a definition to the list style list.
Adds a definition to the paragraph style list.
\membersection{wxRichTextStyleSheet::AddStyle}\label{wxrichtextstylesheetaddstyle}
\func{bool}{AddStyle}{\param{wxRichTextStyleDefinition* }{def}}
Adds a definition to the appropriate style list.
\membersection{wxRichTextStyleSheet::DeleteStyles}\label{wxrichtextstylesheetdeletestyles}
\func{void}{DeleteStyles}{\void}
@@ -73,6 +79,12 @@ Finds a list definition by name.
Finds a paragraph definition by name.
\membersection{wxRichTextStyleSheet::FindStyle}\label{wxrichtextstylesheetfindstyle}
\constfunc{wxRichTextStyleDefinition*}{FindStyle}{\param{const wxString\& }{name}}
Finds a style definition by name.
\membersection{wxRichTextStyleSheet::GetCharacterStyle}\label{wxrichtextstylesheetgetcharacterstyle}
\constfunc{wxRichTextCharacterStyleDefinition*}{GetCharacterStyle}{\param{size\_t }{n}}
@@ -121,12 +133,6 @@ Returns the {\it n}th paragraph style.
Returns the number of paragraph styles.
\membersection{wxRichTextStyleSheet::Init}\label{wxrichtextstylesheetinit}
\func{void}{Init}{\void}
Initialises the style sheet.
\membersection{wxRichTextStyleSheet::RemoveCharacterStyle}\label{wxrichtextstylesheetremovecharacterstyle}
\func{bool}{RemoveCharacterStyle}{\param{wxRichTextStyleDefinition* }{def}, \param{bool }{deleteStyle = false}}
@@ -145,6 +151,12 @@ Removes a list style.
Removes a paragraph style.
\membersection{wxRichTextStyleSheet::RemoveStyle}\label{wxrichtextstylesheetremovestyle}
\func{bool}{RemoveStyle}{\param{wxRichTextStyleDefinition* }{def}, \param{bool }{deleteStyle = false}}
Removes a style.
\membersection{wxRichTextStyleSheet::SetDescription}\label{wxrichtextstylesheetsetdescription}
\func{void}{SetDescription}{\param{const wxString\& }{descr}}