Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

removed @NULL,@true,@false tags from the function prototypes; fixed * and & displacing in the prototypes; changed @param as discussed on wx-dev; use @see instead of @sa; better indentation for @returns,@remarks,@see paragraphs; other misc fixes

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52407 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-09 12:33:59 +00:00
parent 0aaf0255e4
commit 4cc4bfafe5
256 changed files with 8880 additions and 10701 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
interface/richtext/richtextstyles.h
View File

@@ -305,7 +305,7 @@ public:
void OnSelect(wxCommandEvent& event);
/**
If @e applyOnSelection is @true, clicking on a style name in the list will
If @a applyOnSelection is @true, clicking on a style name in the list will
immediately
apply the style to the associated rich text control.
*/
@@ -461,45 +461,44 @@ public:
/**
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 @e styleSheet is specified, the base style for this definition will also be
If @a styleSheet is specified, the base style for this definition will also be
included in the result.
*/
wxTextAttr CombineWithParagraphStyle(int indent,
const wxTextAttr& paraStyle,
wxRichTextStyleSheet* styleSheet = @NULL);
wxRichTextStyleSheet* styleSheet = NULL);
/**
This function finds the level (from 0 to 9) whose indentation attribute mostly
closely matches @e indent (expressed in tenths of a millimetre).
closely matches @a indent (expressed in tenths of a millimetre).
*/
int FindLevelForIndent(int indent);
/**
This function combines the list style's base attributes and the level style
matching the given indent, returning the combined attributes.
If @e styleSheet is specified, the base style for this definition will also be
If @a styleSheet is specified, the base style for this definition will also be
included in the result.
*/
wxTextAttr GetCombinedStyle(int indent,
wxRichTextStyleSheet* styleSheet = @NULL);
wxRichTextStyleSheet* styleSheet = NULL);
/**
This function combines the list style's base attributes and the style for the
specified level, returning the combined attributes.
If @e styleSheet is specified, the base style for this definition will also be
If @a styleSheet is specified, the base style for this definition will also be
included in the result.
*/
wxTextAttr GetCombinedStyleLevel(int level,
wxRichTextStyleSheet* styleSheet = @NULL);
wxRichTextStyleSheet* styleSheet = NULL);
/**
Returns the style for the given level. @e level is a number between 0 and 9.
Returns the style for the given level. @a level is a number between 0 and 9.
*/
const wxTextAttr* GetLevelAttributes(int level);
/**
Returns the number of levels. This is hard-wired to 10.
Returns the style for the given level. @e level is a number between 0 and 9.
*/
int GetLevelCount();
@@ -511,8 +510,7 @@ public:
//@{
/**
Sets the style for the given level. @e level is a number between 0 and 9.
Sets the style for the given level. @a level is a number between 0 and 9.
The first and most flexible form uses a wxTextAttr object, while the second
form is for convenient setting of the most commonly-used attributes.
*/
@@ -641,25 +639,25 @@ public:
Removes a character style.
*/
bool RemoveCharacterStyle(wxRichTextStyleDefinition* def,
bool deleteStyle = @false);
bool deleteStyle = false);
/**
Removes a list style.
*/
bool RemoveListStyle(wxRichTextStyleDefinition* def,
bool deleteStyle = @false);
bool deleteStyle = false);
/**
Removes a paragraph style.
*/
bool RemoveParagraphStyle(wxRichTextStyleDefinition* def,
bool deleteStyle = @false);
bool deleteStyle = false);
/**
Removes a style.
*/
bool RemoveStyle(wxRichTextStyleDefinition* def,
bool deleteStyle = @false);
bool deleteStyle = false);
/**
Sets the style sheet's description.