diff options
Diffstat (limited to 'doc/api-documentation/man/man3/unicodertf.3')
-rw-r--r-- | doc/api-documentation/man/man3/unicodertf.3 | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/doc/api-documentation/man/man3/unicodertf.3 b/doc/api-documentation/man/man3/unicodertf.3 new file mode 100644 index 0000000..9f58e75 --- /dev/null +++ b/doc/api-documentation/man/man3/unicodertf.3 @@ -0,0 +1,55 @@ +.TH "UnicodeRTF" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +UnicodeRTF \- This filter converts UTF-8 text into RTF Unicode tags. +.SH SYNOPSIS +.br +.PP +\fC#include <unicodertf.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBUnicodeRTF\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen, const \fBSWKey\fR *key)" +.br +.RI "\fIThis is the main filter function.\fR" +.in -1c +.SH DETAILED DESCRIPTION +.PP +This filter converts UTF-8 text into RTF Unicode tags. +.PP +Definition at line 30 of file unicodertf.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char UnicodeRTF::ProcessText (char * text, int maxlen, const \fBSWKey\fR * key)\fC [virtual]\fR +.PP +This is the main filter function. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.TP +\fB\fIkey\fR\fR +sorry I don't know +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file |