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

93
interface/richtext/richtextbuffer.h
View File

@@ -71,8 +71,7 @@ public:
Begins collapsing undo/redo commands. Note that this may not work properly
if combining commands that delete or insert content, changing ranges for
subsequent actions.
@e cmdName should be the name of the combined command that will appear
@a cmdName should be the name of the combined command that will appear
next to Undo and Redo in the edit menu.
*/
bool BeginBatchUndo(const wxString& cmdName);
@@ -103,10 +102,9 @@ public:
bool BeginItalic();
/**
Begin using @e leftIndent for the left indent, and optionally @e leftSubIndent
Begin using @a leftIndent for the left indent, and optionally @a leftSubIndent
for
the sub-indent. Both are expressed in tenths of a millimetre.
The sub-indent is an offset from the left of the paragraph, and is used for all
but the
first line in a paragraph. A positive value will cause the first line to appear
@@ -129,20 +127,16 @@ public:
Begins using a specified list style. Optionally, you can also pass a level and
a number.
*/
bool BeginListStyle(const wxString& listStyle, int level=1,
int number=1);
bool BeginListStyle(const wxString& listStyle, int level = 1,
int number = 1);
/**
Begins a numbered bullet. This call will be needed for each item in the list,
and the
application should take care of incrementing the numbering.
@e bulletNumber is a number, usually starting with 1.
@e leftIndent and @e leftSubIndent are values in tenths of a millimetre.
@e bulletStyle is a bitlist of the following values:
@a bulletNumber is a number, usually starting with 1.
@a leftIndent and @a leftSubIndent are values in tenths of a millimetre.
@a bulletStyle is a bitlist of the following values:
wxRichTextBuffer uses indentation to render a bulleted item. The left indent is
the distance between
@@ -246,11 +240,8 @@ public:
/**
Clears the list style from the given range, clearing list-related attributes
and applying any named paragraph style associated with each paragraph.
@e flags is a bit list of the following:
@a flags is a bit list of the following:
wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
See also SetListStyle(), PromoteList(), NumberList().
*/
bool ClearListStyle(const wxRichTextRange& range,
@@ -396,7 +387,7 @@ public:
/**
Ends applying a URL.
*/
#define bool EndURL() /* implementation is private */
bool EndURL();
/**
Ends using underline.
@@ -447,13 +438,13 @@ public:
const wxTextAttr GetDefaultStyle();
/**
Gets a wildcard incorporating all visible handlers. If @e types is present,
Gets a wildcard incorporating all visible handlers. If @a types is present,
it will be filled with the file type corresponding to each filter. This can be
used to determine the type to pass to @ref getextwildcard() LoadFile given a
selected filter.
*/
wxString GetExtWildcard(bool combine = @false, bool save = @false,
wxArrayInt* types = @NULL);
wxString GetExtWildcard(bool combine = false, bool save = false,
wxArrayInt* types = NULL);
/**
Returns the list of file handlers.
@@ -468,7 +459,6 @@ public:
/**
Gets the attributes at the given position.
This function gets the combined style - that is, the style you see on the
screen as a result
of combining base style, paragraph style and character style attributes. To get
@@ -483,13 +473,11 @@ public:
Attributes which have different values within the specified range will not be
included the style
flags.
The function is used to get the attributes to display in the formatting dialog:
the user
can edit the attributes common to the selection, and optionally specify the
values of further
attributes to be applied uniformly.
To apply the edited attributes, you can use SetStyle() specifying
the wxRICHTEXT_SETSTYLE_OPTIMIZE flag, which will only apply attributes that
are different
@@ -522,13 +510,11 @@ public:
/**
Gets the attributes at the given position.
This function gets the @e uncombined style - that is, the attributes associated
with the
paragraph or character content, and not necessarily the combined attributes you
see on the
screen. To get the combined attributes, use GetStyle().
If you specify (any) paragraph attribute in @e style's flags, this function
will fetch
the paragraph attributes. Otherwise, it will return the character attributes.
@@ -536,11 +522,10 @@ public:
bool GetUncombinedStyle(long position, wxTextAttr& style);
/**
Finds the text position for the given position, putting the position in @e
Finds the text position for the given position, putting the position in @a
textPosition if
one is found. @e pt is in logical units (a zero y position is
one is found. @a pt is in logical units (a zero y position is
at the beginning of the buffer).
The function returns one of the following values:
*/
int HitTest(wxDC& dc, const wxPoint& pt, long& textPosition);
@@ -598,7 +583,7 @@ public:
/**
Marks the buffer as modified or unmodified.
*/
void Modify(bool modify = @true);
void Modify(bool modify = true);
//@{
/**
@@ -606,15 +591,12 @@ public:
attributes are set.
Either the style definition or the name of the style definition (in the current
sheet) can be passed.
@e flags is a bit list of the following:
@a flags is a bit list of the following:
wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from @e
startFrom, otherwise existing attributes are used.
wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @e listLevel should be used
wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used
as the level for all paragraphs, otherwise the current indentation will be used.
See also SetListStyle(), PromoteList(), ClearListStyle().
*/
bool NumberList(const wxRichTextRange& range,
@@ -636,20 +618,17 @@ public:
//@{
/**
Promotes or demotes the paragraphs in the given range. A positive @e promoteBy
Promotes or demotes the paragraphs in the given range. A positive @a promoteBy
produces a smaller indent, and a negative number
produces a larger indent. Pass flags to determine how the attributes are set.
Either the style definition or the name of the style definition (in the current
sheet) can be passed.
@e flags is a bit list of the following:
@a flags is a bit list of the following:
wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from @e
startFrom, otherwise existing attributes are used.
wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @e listLevel should be used
wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used
as the level for all paragraphs, otherwise the current indentation will be used.
See also SetListStyle(), See also SetListStyle(), ClearListStyle().
*/
bool PromoteList(int promoteBy, const wxRichTextRange& range,
@@ -664,10 +643,10 @@ public:
/**
Removes an event handler from the buffer's list of handlers, deleting the
object if @e deleteHandler is @true.
object if @a deleteHandler is @true.
*/
bool RemoveEventHandler(wxEvtHandler* handler,
bool deleteHandler = @false);
bool deleteHandler = false);
/**
Removes a handler.
@@ -701,7 +680,6 @@ public:
Sets the default style, affecting the style currently being applied (for
example, setting the default
style to bold will cause subsequently inserted text to be bold).
This is not cumulative - setting the default style will replace the previous
default style.
*/
@@ -713,15 +691,12 @@ public:
the attributes are set.
Either the style definition or the name of the style definition (in the current
sheet) can be passed.
@e flags is a bit list of the following:
@a flags is a bit list of the following:
wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from @e
startFrom, otherwise existing attributes are used.
wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @e listLevel should be used
wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used
as the level for all paragraphs, otherwise the current indentation will be used.
See also NumberList(), PromoteList(), ClearListStyle().
*/
bool SetListStyle(const wxRichTextRange& range,
@@ -737,7 +712,7 @@ public:
//@}
/**
Sets @e renderer as the object to be used to render certain aspects of the
Sets @a renderer as the object to be used to render certain aspects of the
content, such as bullets.
You can override default rendering by deriving a new class from
wxRichTextRenderer or wxRichTextStdRenderer,
@@ -749,15 +724,12 @@ public:
/**
Sets the attributes for the given range. Pass flags to determine how the
attributes are set.
The end point of range is specified as the last character position of the span
of text.
So, for example, to set the style for a character at position 5, use the range
(5,5).
This differs from the wxRichTextCtrl API, where you would specify (5,6).
@e flags may contain a bit list of the following values:
@a flags may contain a bit list of the following values:
wxRICHTEXT_SETSTYLE_NONE: no style flag.
wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this operation should be
undoable.
@@ -837,12 +809,12 @@ public:
bool CanSave();
/**
Override to load content from @e stream into @e buffer.
Override to load content from @a stream into @e buffer.
*/
bool DoLoadFile(wxRichTextBuffer* buffer, wxInputStream& stream);
/**
Override to save content to @e stream from @e buffer.
Override to save content to @a stream from @e buffer.
*/
bool DoSaveFile(wxRichTextBuffer* buffer, wxOutputStream& stream);
@@ -912,7 +884,6 @@ public:
Sets flags that change the behaviour of loading or saving. See the
documentation for each
handler class to see what flags are relevant for each handler.
You call this function directly if you are using a file handler explicitly
(without
going through the text control or buffer LoadFile/SaveFile API). Or, you can
@@ -1041,22 +1012,22 @@ public:
wxRichTextRange ToInternal();
/**
Adds @e range to this range.
Adds @a range to this range.
*/
wxRichTextRange operator+(const wxRichTextRange& range);
/**
Subtracts @e range from this range.
Subtracts @a range from this range.
*/
wxRichTextRange operator-(const wxRichTextRange& range);
/**
Assigns @e range to this range.
Assigns @a range to this range.
*/
void operator=(const wxRichTextRange& range);
/**
Returns @true if @e range is the same as this range.
Returns @true if @a range is the same as this range.
*/
bool operator==(const wxRichTextRange& range);
};

99
interface/richtext/richtextctrl.h
View File

@@ -23,7 +23,7 @@ public:
Constructors.
*/
wxRichTextEvent(const wxRichTextEvent& event);
wxRichTextEvent(wxEventType commandType = wxEVT_@NULL,
wxRichTextEvent(wxEventType commandType = wxEVT_NULL,
int winid = 0);
//@}
@@ -160,7 +160,6 @@ public:
/**
Applies the given alignment to the selection (undoable).
For alignment values, see wxTextAttr.
*/
bool ApplyAlignmentToSelection(wxTextAttrAlignment alignment);
@@ -183,13 +182,12 @@ public:
/**
Applies the style sheet to the buffer, matching paragraph styles in the sheet
against named styles
in the buffer. This might be useful if the styles have changed. If @e sheet is
in the buffer. This might be useful if the styles have changed. If @a sheet is
@NULL, the
sheet set with SetStyleSheet is used.
Currently this applies paragraph styles only.
*/
bool ApplyStyleSheet(wxRichTextStyleSheet* sheet = @NULL);
bool ApplyStyleSheet(wxRichTextStyleSheet* sheet = NULL);
/**
Applies underline to the selection (undoable).
@@ -203,7 +201,6 @@ public:
/**
Begins using alignment
For alignment values, see wxTextAttr.
*/
bool BeginAlignment(wxTextAttrAlignment alignment);
@@ -240,7 +237,6 @@ public:
/**
Begins applying a left indent and subindent in tenths of a millimetre.
The sub-indent is an offset from the left of the paragraph, and is used for all
but the
first line in a paragraph. A positive value will cause the first line to appear
@@ -248,7 +244,6 @@ public:
of the subsequent lines, and a negative value will cause the first line to be
indented
relative to the subsequent lines.
wxRichTextBuffer uses indentation to render a bulleted item. The left indent is
the distance between
the margin and the bullet. The content of the paragraph, including the first
@@ -271,20 +266,16 @@ public:
Begins using a specified list style. Optionally, you can also pass a level and
a number.
*/
bool BeginListStyle(const wxString& listStyle, int level=1,
int number=1);
bool BeginListStyle(const wxString& listStyle, int level = 1,
int number = 1);
/**
Begins a numbered bullet. This call will be needed for each item in the list,
and the
application should take care of incrementing the numbering.
@e bulletNumber is a number, usually starting with 1.
@e leftIndent and @e leftSubIndent are values in tenths of a millimetre.
@e bulletStyle is a bitlist of the following values:
@a bulletNumber is a number, usually starting with 1.
@a leftIndent and @a leftSubIndent are values in tenths of a millimetre.
@a bulletStyle is a bitlist of the following values:
wxRichTextBuffer uses indentation to render a bulleted item. The left indent is
the distance between
@@ -392,11 +383,8 @@ public:
/**
Clears the list style from the given range, clearing list-related attributes
and applying any named paragraph style associated with each paragraph.
@e flags is a bit list of the following:
@a flags is a bit list of the following:
wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
See also SetListStyle(), PromoteList(), NumberList().
*/
bool ClearListStyle(const wxRichTextRange& range,
@@ -430,7 +418,7 @@ public:
Copies the selected content (if any) to the clipboard and deletes the selection.
This is undoable.
*/
#define void Cut() /* implementation is private */
void Cut();
/**
Deletes the content within the given range.
@@ -442,7 +430,7 @@ public:
Returns the new caret position in @e newPos, or leaves it if there
was no action. This is undoable.
*/
bool DeleteSelectedContent(long* newPos = @NULL);
bool DeleteSelectedContent(long* newPos = NULL);
/**
Deletes the content in the selection, if any. This is undoable.
@@ -558,7 +546,7 @@ public:
/**
Ends applying a URL.
*/
#define bool EndURL() /* implementation is private */
bool EndURL();
/**
End applying underlining.
@@ -683,7 +671,6 @@ public:
/**
Gets the text for the given range.
The end point of range is specified as the last character position of the span
of text, plus one.
*/
@@ -691,11 +678,9 @@ public:
/**
Returns the range of the current selection.
The end point of range is specified as the last character position of the span
of text, plus one.
If the return values @e from and @e to are the same, there is no selection.
If the return values @a from and @a to are the same, there is no selection.
*/
void GetSelection(long* from, long* to);
@@ -711,7 +696,6 @@ public:
/**
Gets the attributes at the given position.
This function gets the combined style - that is, the style you see on the
screen as a result
of combining base style, paragraph style and character style attributes. To get
@@ -737,13 +721,11 @@ public:
/**
Gets the attributes at the given position.
This function gets the @e uncombined style - that is, the attributes associated
with the
paragraph or character content, and not necessarily the combined attributes you
see on the
screen. To get the combined attributes, use GetStyle().
If you specify (any) paragraph attribute in @e style's flags, this function
will fetch
the paragraph attributes. Otherwise, it will return the character attributes.
@@ -767,7 +749,7 @@ public:
/**
Test if this whole range has character attributes of the specified kind. If any
of the attributes are different within the range, the test fails. You
can use this to implement, for example, bold button updating. @e style must have
can use this to implement, for example, bold button updating. @a style must have
flags indicating which attributes are of interest.
*/
bool HasCharacterAttributes(const wxRichTextRange& range,
@@ -776,7 +758,7 @@ public:
/**
Test if this whole range has paragraph attributes of the specified kind. If any
of the attributes are different within the range, the test fails. You
can use this to implement, for example, centering button updating. @e style
can use this to implement, for example, centering button updating. @a style
must have
flags indicating which attributes are of interest.
*/
@@ -791,8 +773,7 @@ public:
//@{
/**
Finds the character at the given position in pixels.
@e pt is in device coords (not adjusted for the client area origin nor for
@a pt is in device coords (not adjusted for the client area origin nor for
scrolling).
*/
wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long* pos);
@@ -816,9 +797,9 @@ public:
the caret,
and therefore the UI needs to reflect the default style and not the style at
the caret.
Below is an example of code that uses this function to determine whether the UI
should show that the current style is bold.
See also SetAndShowDefaultStyle().
*/
bool IsDefaultStyleShowing();
@@ -885,7 +866,7 @@ public:
setting the caret position. This function should not normally be required by the
application.
*/
bool LayoutContent(bool onlyVisibleRect = @false);
bool LayoutContent(bool onlyVisibleRect = false);
/**
Inserts a line break at the current insertion point. A line break forces
@@ -900,7 +881,6 @@ public:
Loads content into the control's buffer using the given type. If the specified
type
is wxRICHTEXT_TYPE_ANY, the type is deduced from the filename extension.
This function looks for a suitable wxRichTextFileHandler object.
*/
bool LoadFile(const wxString& file,
@@ -914,7 +894,7 @@ public:
/**
Move the caret to the given character position.
*/
bool MoveCaret(long pos, bool showAtLineStart = @false);
bool MoveCaret(long pos, bool showAtLineStart = false);
/**
Move the caret one visual step forward: this may mean setting a flag
@@ -991,15 +971,12 @@ public:
attributes are set.
Either the style definition or the name of the style definition (in the current
sheet) can be passed.
@e flags is a bit list of the following:
@a flags is a bit list of the following:
wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from @e
startFrom, otherwise existing attributes are used.
wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @e listLevel should be used
wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used
as the level for all paragraphs, otherwise the current indentation will be used.
See also SetListStyle(), PromoteList(), ClearListStyle().
*/
bool NumberList(const wxRichTextRange& range,
@@ -1128,20 +1105,17 @@ public:
//@{
/**
Promotes or demotes the paragraphs in the given range. A positive @e promoteBy
Promotes or demotes the paragraphs in the given range. A positive @a promoteBy
produces a smaller indent, and a negative number
produces a larger indent. Pass flags to determine how the attributes are set.
Either the style definition or the name of the style definition (in the current
sheet) can be passed.
@e flags is a bit list of the following:
@a flags is a bit list of the following:
wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from @e
startFrom, otherwise existing attributes are used.
wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @e listLevel should be used
wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used
as the level for all paragraphs, otherwise the current indentation will be used.
See also SetListStyle(), See also SetListStyle(), ClearListStyle().
*/
bool PromoteList(int promoteBy, const wxRichTextRange& range,
@@ -1173,14 +1147,13 @@ public:
/**
Saves the buffer content using the given type. If the specified type
is wxRICHTEXT_TYPE_ANY, the type is deduced from the filename extension.
This function looks for a suitable wxRichTextFileHandler object.
*/
bool SaveFile(const wxString& file = wxEmptyString,
int type = wxRICHTEXT_TYPE_ANY);
/**
Scrolls @e position into view. This function takes a caret position.
Scrolls @a position into view. This function takes a caret position.
*/
bool ScrollIntoView(long position, int keyCode);
@@ -1195,10 +1168,9 @@ public:
void SelectNone();
/**
Sets @e attr as the default style and tells the control that the UI should
Sets @a attr as the default style and tells the control that the UI should
reflect
this attribute until the user moves the caret.
See also IsDefaultStyleShowing().
*/
void SetAndShowDefaultStyle(const wxTextAttr& attr);
@@ -1216,7 +1188,7 @@ public:
A value of -1 means the caret is at the start of the buffer.
*/
void SetCaretPosition(long position,
bool showAtLineStart = @false);
bool showAtLineStart = false);
/**
Sets the current default style, which can be used to change how subsequently
@@ -1275,15 +1247,12 @@ public:
the attributes are set.
Either the style definition or the name of the style definition (in the current
sheet) can be passed.
@e flags is a bit list of the following:
@a flags is a bit list of the following:
wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from @e
startFrom, otherwise existing attributes are used.
wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @e listLevel should be used
wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used
as the level for all paragraphs, otherwise the current indentation will be used.
See also NumberList(), PromoteList(), ClearListStyle().
*/
bool SetListStyle(const wxRichTextRange& range,
@@ -1300,7 +1269,6 @@ public:
/**
Sets the selection to the given range.
The end point of range is specified as the last character position of the span
of text, plus one.
So, for example, to set the selection for a character at position 5, use the
@@ -1310,7 +1278,6 @@ public:
/**
Sets the selection to the given range.
The end point of range is specified as the last character position of the span
of text, plus one.
So, for example, to set the selection for a character at position 5, use the
@@ -1321,7 +1288,6 @@ public:
//@{
/**
Sets the attributes for the given range.
The end point of range is specified as the last character position of the span
of text, plus one.
So, for example, to set the style for a character at position 5, use the range
@@ -1336,14 +1302,11 @@ public:
/**
Sets the attributes for the given range, passing flags to determine how the
attributes are set.
The end point of range is specified as the last character position of the span
of text, plus one.
So, for example, to set the style for a character at position 5, use the range
(5,6).
@e flags may contain a bit list of the following values:
@a flags may contain a bit list of the following values:
wxRICHTEXT_SETSTYLE_NONE: no style flag.
wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this operation should be
undoable.
@@ -1385,7 +1348,7 @@ public:
/**
A helper function setting up scrollbars, for example after a resize.
*/
void SetupScrollbars(bool atTop = @false);
void SetupScrollbars(bool atTop = false);
/**
Scrolls the buffer so that the given position is in view.

28
interface/richtext/richtextformatdlg.h
View File

@@ -121,25 +121,19 @@ public:
Constructors.
@param flags
The pages to show.
The pages to show.
@param parent
The dialog's parent.
The dialog's parent.
@param id
The dialog's identifier.
The dialog's identifier.
@param title
The dialog's caption.
The dialog's caption.
@param pos
The dialog's position.
The dialog's position.
@param size
The dialog's size.
The dialog's size.
@param style
The dialog's window style.
The dialog's window style.
*/
wxRichTextFormattingDialog(long flags, wxWindow* parent);
const wxPoint& pos = wxDefaultPosition, const wxSize& sz = wxDefaultSize, long style = wxDEFAULT_DIALOG_STYLE)
@@ -238,17 +232,17 @@ public:
void SetImageList(wxImageList* imageList);
/**
Sets the attributes and optionally updates the display, if @e update is @true.
Sets the attributes and optionally updates the display, if @a update is @true.
*/
bool SetStyle(const wxTextAttr& style, bool update = @true);
bool SetStyle(const wxTextAttr& style, bool update = true);
/**
Sets the style definition and optionally update the display, if @e update is @c
Sets the style definition and optionally update the display, if @a update is @c
@true.
*/
bool SetStyleDefinition(const wxRichTextStyleDefinition& styleDef,
wxRichTextStyleSheet* sheet,
bool update = @true);
bool update = true);
/**
Updates the display.

2
interface/richtext/richtexthtml.h
View File

@@ -40,7 +40,6 @@ class wxRichTextHTMLHandler : public wxRichTextFileHandler
public:
/**
, @b const wxString&@e ext = wxT("html"), @b int@e type = wxRICHTEXT_TYPE_HTML)
Constructor.
*/
wxRichTextHTMLHandler();
@@ -94,7 +93,6 @@ public:
There should be 7 elements, one for each HTML font size, each element
specifying the maximum point size for that
HTML font size.
For example:
*/
void SetFontSizeMapping(const wxArrayInt& fontSizeMapping);

6
interface/richtext/richtextprint.h
View File

@@ -172,7 +172,6 @@ class wxRichTextPrintout : public wxPrintout
public:
/**
)
Constructor.
*/
wxRichTextPrintout();
@@ -250,7 +249,6 @@ class wxRichTextPrinting : public wxObject
public:
/**
, @b wxWindow*@e parentWindow = @NULL)
Constructor. Optionally pass a title to be used in the preview frame and
printing wait dialog, and
also a parent window for these windows.
@@ -314,7 +312,7 @@ public:
bool PreviewBuffer(const wxRichTextBuffer& buffer);
/**
Shows a preview window for the given file. @e richTextFile can be a text file
Shows a preview window for the given file. @a richTextFile can be a text file
or XML file, or other file
depending on the available file handlers.
*/
@@ -326,7 +324,7 @@ public:
bool PrintBuffer(const wxRichTextBuffer& buffer);
/**
Prints the given file. @e richTextFile can be a text file or XML file, or other
Prints the given file. @a richTextFile can be a text file or XML file, or other
file
depending on the available file handlers.
*/

24
interface/richtext/richtextstyledlg.h
View File

@@ -25,90 +25,71 @@ public:
//@{
/**
Constructors.
To create a dialog, pass a bitlist of @e flags (see below), a style sheet, a
To create a dialog, pass a bitlist of @a flags (see below), a style sheet, a
text control to apply a selected style to (or @NULL), followed by the usual window parameters.
To specify the operations available to the user, pass a combination of these
values to @e flags:
@b wxRICHTEXT_ORGANISER_DELETE_STYLES
Provides a button for deleting styles.
@b wxRICHTEXT_ORGANISER_CREATE_STYLES
Provides buttons for creating styles.
@b wxRICHTEXT_ORGANISER_APPLY_STYLES
Provides a button for applying the currently selected style to the selection.
@b wxRICHTEXT_ORGANISER_EDIT_STYLES
Provides a button for editing styles.
@b wxRICHTEXT_ORGANISER_RENAME_STYLES
Provides a button for renaming styles.
@b wxRICHTEXT_ORGANISER_OK_CANCEL
Provides OK and Cancel buttons.
@b wxRICHTEXT_ORGANISER_RENUMBER
Provides a checkbox for specifying that the selection should be renumbered.
The following flags determine what will be displayed in the style list:
@b wxRICHTEXT_ORGANISER_SHOW_CHARACTER
Displays character styles only.
@b wxRICHTEXT_ORGANISER_SHOW_PARAGRAPH
Displays paragraph styles only.
@b wxRICHTEXT_ORGANISER_SHOW_LIST
Displays list styles only.
@b wxRICHTEXT_ORGANISER_SHOW_ALL
Displays all styles.
The following symbols define commonly-used combinations of flags:
@b wxRICHTEXT_ORGANISER_ORGANISE
Enable all style editing operations so the dialog behaves as a style organiser.
@b wxRICHTEXT_ORGANISER_BROWSE
Show a list of all styles and their previews, but only allow application of a
style or
cancellation of the dialog. This makes the dialog behave as a style browser.
@b wxRICHTEXT_ORGANISER_BROWSE_NUMBERING
Enables only list style browsing, plus a control to specify renumbering. This
allows the dialog to be used for applying list styles to the selection.
*/
@@ -125,12 +106,11 @@ public:
Applies the selected style to selection in the given control or the control
passed to the constructor.
*/
bool ApplyStyle(wxRichTextCtrl* ctrl = @NULL);
bool ApplyStyle(wxRichTextCtrl* ctrl = NULL);
/**
, @b const wxPoint&@e pos = wxDefaultPosition, @b const wxSize&@e size =
wxDefaultSize, @b long@e style = wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER|wxSYSTEM_MENU|wxCLOSE_BOX)
Creates the dialog. See
*/
bool Create(int flags, wxRichTextStyleSheet* sheet,

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.

31
interface/richtext/richtextsymboldlg.h
View File

@@ -83,34 +83,26 @@ public:
Constructors.
@param symbol
The initial symbol to show. Specify a single character in a string, or an empty
string.
The initial symbol to show. Specify a single character in a string, or an
empty string.
@param initialFont
The initial font to be displayed in the font list. If empty, the item normal
text will be selected.
The initial font to be displayed in the font list. If empty, the item
normal text will be selected.
@param normalTextFont
The font the dialog will use to display the symbols if the initial font is
The font the dialog will use to display the symbols if the initial font is
empty.
@param parent
The dialog's parent.
The dialog's parent.
@param id
The dialog's identifier.
The dialog's identifier.
@param title
The dialog's caption.
The dialog's caption.
@param pos
The dialog's position.
The dialog's position.
@param size
The dialog's size.
The dialog's size.
@param style
The dialog's window style.
The dialog's window style.
*/
wxSymbolPickerDialog(const wxString& symbol,
const wxString& initialFont,
@@ -124,7 +116,6 @@ public:
/**
, @b const wxPoint&@e pos = wxDefaultPosition, @b const wxSize&@e size =
wxDefaultSize, @b long@e style = wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER|wxCLOSE_BOX)
Creation: see @ref wxsymbolpickerdialog() "the constructor" for details about
the parameters.
*/

7
interface/richtext/richtextxml.h
View File

@@ -24,7 +24,6 @@ class wxRichTextXMLHandler : public wxRichTextFileHandler
public:
/**
, @b const wxString&@e ext = wxT("xml"), @b int@e type = wxRICHTEXT_TYPE_XML)
Constructor.
*/
wxRichTextXMLHandler();
@@ -42,7 +41,7 @@ public:
/**
Creates XML code for a given character or paragraph style.
*/
wxString CreateStyle(const wxTextAttr& attr, bool isPara = @false);
wxString CreateStyle(const wxTextAttr& attr, bool isPara = false);
/**
Loads buffer context from the given stream.
@@ -81,14 +80,14 @@ public:
Helper function: gets style parameters from the given XML node.
*/
bool GetStyle(wxTextAttr& attr, wxXmlNode* node,
bool isPara = @false);
bool isPara = false);
/**
Helper function: gets text from the node.
*/
wxString GetText(wxXmlNode* node,
const wxString& param = wxEmptyString,
bool translate = @false);
bool translate = false);
/**
Helper function: returns @true if the node has the given parameter.