Some documentation enhancements for wxRichTextCtrl

Comment fixes


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@43240 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
2006-11-09 20:22:33 +00:00
parent d6d8b17280
commit 1f65137f8d
12 changed files with 483 additions and 34 deletions

View File

@@ -64,6 +64,13 @@ Returns the encoding associated with the handler (if any).
Returns the extension associated with the handler.
\membersection{wxRichTextFileHandler::GetFlags}\label{wxrichtextfilehandlergetflags}
\constfunc{int}{GetFlags}{\void}
Returns 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.
\membersection{wxRichTextFileHandler::GetName}\label{wxrichtextfilehandlergetname}
\constfunc{wxString}{GetName}{\void}
@@ -110,6 +117,18 @@ Sets the encoding to use when saving a file. If empty, a suitable encoding is ch
Sets the default extension to recognise.
\membersection{wxRichTextFileHandler::SetFlags}\label{wxrichtextfilehandlersetflags}
\func{void}{SetFlags}{\param{int }{flags}}
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
call the control or buffer's SetHandlerFlags function to set the flags that will
be used for subsequent load and save operations.
\membersection{wxRichTextFileHandler::SetName}\label{wxrichtextfilehandlersetname}
\func{void}{SetName}{\param{const wxString\& }{name}}